ion-docs icon indicating copy to clipboard operation
ion-docs copied to clipboard

Proposal re prefixes on AsciiDoc tags

Open toddjonker opened this issue 2 years ago • 0 comments
trafficstars

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 sections
  • ref:_tag_ links into the reference sections
  • spec:_tag_ links into the formal specification
  • gloss:_tag_ links into the glossary
  • gram:_tag_ links into the grammar

This stems from the AsciiDoc standard to prefix section-tags with sec:.

toddjonker avatar Jun 08 '23 00:06 toddjonker