Introduction
...
Warning | ||
---|---|---|
| ||
When a section title is changed, external and internal links will be be broken. Do a search for the |
Links
External Links
When including external URLs in documentation, to avoid displaying the entire URL, use this following Asciidoctor format:
http://google.com[link text]
Internal Links
EXPERIMENTAL - This section refers to new functionality created in version 2.14.0
Special formatting is used to create links within and between pages of documentation. Links can send user to a separate section of the current document or another page in the documentation library. These are the conventions of creating those links
<<{target-prefix}anchor_text,Display Text>>
- The Asciidoc syntax for an internal link is wrapped in double angle-brackets
<< >>
. - Each target document template file sets a set of properties for the other target documents that will resolve and send the reader to that page.
- Next, use the anchor text you are linking to. (minus the leading underscore-- that is added by the prefix property,
- A comma separates the anchor itself from the display text.
- Display text should describe the information being linked to. This is often the section header, but, if needed, should be modified to fit the sentence and context of the paragraph where the link appears.
Anchors
Section headings create automated anchors based on the text of the header with a leading underscore and spaces replaced with underscores.
== Section Heading
becomes
_section_heading
Manual anchors can also be created to link to any arbitrary spot in the text and should follow the same conventions in most cases. Asciidoctor anchors have a syntax as follows:
[[_manual_anchor]]Anchor Text
- The square brackets define an anchor.
- Use the leading underscore instead of the prefix because this anchor is only a destination, not a link.
- The anchor text is arbitrary. Manual anchors should usually be used for captions or the start of a relevant
Special Formatting Conventions
...