Add a complete list of supported block titles #48
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
|
This time I did not forget to update the test file. |
Contributor
Author
|
Hi @mmuehlfeldRH, I am not sure if you get notified when a new pull request is opened so I am tagging you just in case. |
Collaborator
|
Thanks for your update. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the definitive list of titles that are recognized during the DITA conversion and mapped to the corresponding
<prereq>,<step>/<steps-unordered>,<result>,<tasktroubleshooting>,<postreq>, and<related-links>elements. It also matches the corresponding vale rule that can be used to report unsupported block titles in procedures.I have also removed the mention that these need to be in this order because while it makes sense and DITA insists on this order, the conversion tooling actually maps them correctly regardless in what order they appear. This re-shuffling is necessary because any contents preceding the first block title in AsciiDoc is mapped to
<context>and while in our documentation it comes first, in DITA it appears after the<prereq>element.The same update has already been merged in the official Modular Documentation project.