search

gbif / doc-documentation-guidelines

Guidelines for authoring digital documentation for GBIF
https://docs.gbif.org/documentation-guidelines/en/
Other
0 stars 1 forks source link

Hyperlinks/anchors within a document #6

Closed pzermoglio closed 4 years ago

pzermoglio commented 5 years ago

In some documents, particularly in their digital form, it is important to include quick references to other sections of the same or other documents. This is easily done in the commonly used text editors (e.g., word, google docs, etc.) but if done in the regular way, it does not transfer well when passing to adocs. What would be the recommendation for authors about this? How should they denote links and anchors?

kcopas commented 5 years ago

If anything, this capability seems overdeveloped in AsciiDoc: https://asciidoctor.org/docs/user-manual/#xref

Our documentation should adapt and simplify this guidance to the most frequent and relevant uses.

kcopas commented 4 years ago

Asciidoc provides automated TOCs and links to all sections preceded by a header style. All good here.