Versions Compared

Key

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

...

Section
show-titlefalse
titleDescription

Renders an intra-document link to a

Static Document Link
documentContent Marker Macro
 or a
Static Document Link
documentSection Macro
. This macro is a specialized form of the 
Static Document Link
documentStatic Document Link Macro
 with proper defaults for the special use case of linking to content within the same document.

The macro currently does not check if the link is actually valid, but it provides the autocomplete feature for the anchor parameter. This makes it easier for users to select the correct location, but it does not prevent losing the target in case the anchor name is changed later. To prevent this teams may choose to define identifiers in the referenced content and explicitly set a label and link to this identiferidentifier. In case the section title is rephrased later, the link would still be valid.

...