ion-docs
ion-docs copied to clipboard
Proposal re prefixes on AsciiDoc tags
For pedagogical intentions, the 1.1 book covers topics in more than one place. We have the "by example" chapters that cover things with a narrative and incremental manner, the (currently incoming) "reference" chapters that are more thorough and topically arranged, and eventually the "specification" chapters that would be the most crisp, precise, and canonical form.
This structure leads to the need for cross-links that target topics within particular subsections of the book. For example, sometimes we'll want to link to the coverage of macro signatures in the "Macros by Example" chapter, and other times in the relevant reference chapter, others in the grammar.
To enable clarity here, I propose that we use AsciiDoc tag prefixes as follows:
eg:_tag_links into the by-example sectionsref:_tag_links into the reference sectionsspec:_tag_links into the formal specificationgloss:_tag_links into the glossarygram:_tag_links into the grammar
This stems from the AsciiDoc standard to prefix section-tags with sec:.