redhat-documentation / asciidoc-markup-conventions

How to use AsciiDoc mark-up to properly style elements in Red Hat documentation
https://access.redhat.com/documentation/
17 stars 16 forks source link

Unify & fix anchor IDs #2

Closed rkratky closed 6 years ago

rkratky commented 6 years ago

@asteflova:

Looking at the table[1], I noticed one thing.

The mark-up for anchors is either [[anchor]] or [#anchor]. I recommend adding [id='anchor']. It's the only one that seems to work with attributes in appendices. To be more specific:

An anchor like this in an appendix:

  [#{assembly}-section_header]

gives this error when building with ccutil:

  asciidoctor: ERROR: master.adoc: line 67: invalid part,
  must have at least one section (e.g., chapter, appendix, etc.)

But with an anchor like this:

  [id='{assembly}-section_header']

the book builds correctly.

[1] https://redhat-documentation.github.io/asciidoc-markup-conventions/