Versions Compared

Old Version 19

changes.mady.by.user Rick Larsen

Saved on

compared with

New Version Current

changes.mady.by.user Rick Larsen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

...


Warning
titleChanging Section Titles

When a section title is changed, external and internal links will be be broken. Do a search for the _anchor_title to find internal links. 

Links

When including external URLs in documentation, to avoid displaying the entire URL, use this following Asciidoctor format:

http://google.com[link text]

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.
    • Introduction ({introduction-prefix}): Overview of concepts, standards, and capabilities.
    • Quick Start ({quickstart-prefix}): Instructions for a test or demo instance.
    • Managing ({managing-prefix}): Instructions for a hardened production instance.
    • Using ({using-prefix}): Instructions for users querying and ingesting data.
    • Integrating ({integrating-prefix}): Instructions for integrators connecting to an instance externally
    • Architecture ({architecture-prefix}): Description of system architecture.
    • Developing ({developing-prefix}): Instructions for creating custom implementation of components.
    • Reference ({reference-prefix}): Reference material for configurations and features.
    • Metadata Reference ({metadata-prefix}): Reference for metadata schemas and attributes.
  • 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

...