Add substitution strings for the templates to be directly usable by the newdoc script #83
Conversation
This file contains 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
msuchane
commented
Sep 21, 2018
| [id='a-collection-of-modules'] | ||
| // If the assembly is reused in other assemblies in a guide, include {context} in the ID: [id='a-collection-of-modules-{context}']. | ||
| = A collection of modules | ||
| [id='${module_id}'] |
There was a problem hiding this comment.
I wasn't sure here: Do we want to default to assembly IDs having context or not? Alternatively, should I add an ifdef statement to take care of the two scenarios automatically?
|
I must admit, I feel like the substitution strings make it harder for human eyes to make sense of the templates, and they were complicated enough before I started with this. On the other hand, if the templates are to be usable for automatic generators, which makes working with them much easier, certain parts must be unambiguous for computers, which probably means using some sort of additional markup or programming language syntax like I have used. |
|
A lot has changed since this PR was submitted, so I'm closing this PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 PR edits template files so that they have machine-readable substitution strings in the format of the Python Template module. This makes it possible for the newdoc[1] script to download templates each time a file is generated to make sure writers always have the most up-to-date version.
Bits that have been changed:
Additionally, this PR changes the
parent-contextattribute to be assembly-specific:parent-context-of-(assembly-ID). The attribute is composed automatically by newdoc when creating a new file. The reasoning is explained in issue#71, which is fixed with this change.[1] https://github.com/redhat-documentation/tools/tree/master/newdoc