From dita-tools
Removes unsupported block titles like .Example and .Note from AsciiDoc procedure modules using Ruby script for DITA task compatibility. Useful when fixing titles or preparing files for DITA conversion.
npx claudepluginhub redhat-documentation/redhat-docs-agent-tools --plugin dita-toolsThis skill is limited to using the following tools:
Remove unsupported block titles from procedure modules for DITA compatibility.
Fixes unsupported block titles in AsciiDoc files for DITA compatibility by remediating invalid contexts like source blocks, paragraphs, lists, and admonitions using a Ruby script. Use for BlockTitle warnings or DITA prep.
Assesses CQA parameters P8-P11 for titles and short descriptions in Red Hat modular documentation, checking clarity, character limits, DITA conventions, and quality criteria.
Reviews AsciiDoc (.adoc) files for Red Hat modular documentation compliance: module types (concept, procedure, reference), assembly structure, anchor IDs with _{context}, context variables, and include directives.
Share bugs, ideas, or general feedback.
Remove unsupported block titles from procedure modules for DITA compatibility.
This skill uses the task_title.rb Ruby script to find and remove block titles in procedure modules that are not supported for DITA task mapping.
The Vale rule TaskTitle.yml detects block titles (lines starting with . or ..) in procedure modules that are not one of the supported titles:
.Prerequisite / .Prerequisites.Procedure.Verification.Result / .Results.Troubleshooting / .Troubleshooting steps.Next step / .Next steps.Additional resourcesAny other block title like:
.Example.Important.Note.Overview.Configuration fileBefore:
:_mod-docs-content-type: PROCEDURE
[id="configuring-app"]
= Configuring the application
.Overview
This procedure configures the application.
.Prerequisites
* You have access.
.Configuration file
The following shows the config file format:
.Procedure
. Edit the file.
. Save changes.
.Example output
[source,text]
----
Success
----
.Verification
* Check the status.
After:
:_mod-docs-content-type: PROCEDURE
[id="configuring-app"]
= Configuring the application
This procedure configures the application.
.Prerequisites
* You have access.
The following shows the config file format:
.Procedure
. Edit the file.
. Save changes.
[source,text]
----
Success
----
.Verification
* Check the status.
DITA tasks have a fixed structure with specific elements (prereq, context, steps, result, postreq, etc.). Block titles that don't map to these elements cause conversion errors.
When the user asks to remove unsupported titles:
:_mod-docs-content-type: PROCEDURE)ruby scripts/task_title.rb <file>
To preview changes without modifying files:
ruby scripts/task_title.rb <file> --dry-run
ruby scripts/task_title.rb <file> -o <output.adoc>
find <folder> -name "*.adoc" -exec ruby scripts/task_title.rb {} \;
:_mod-docs-content-type: PROCEDURE are skipped+ are not removed (they're block titles for content within steps)<file>: Removed N unsupported title(s)
Line 5: .Overview
Line 15: .Example output
Or:
<file>: No unsupported titles found
Or:
<file>: Not a procedure module (skipped)
The Ruby script is located at: scripts/task_title.rb
This skill addresses the warning from: .vale/styles/AsciiDocDITA/TaskTitle.yml