13.5.3 Specifying output formats for related and fixed links

To specify formats for various types of related links:

[RelatedLinks]
; HeadInlineFormat = format for inline heads (Prev, Next, Parent)
HeadInlineFormat = Strong
; HeadBlockFormat = format for list heads (Child, Sib, Related)
HeadBlockFormat = RelatedHead
; TopicTitleFormat = block format for topic title lines (including
; those with inline heads)
TopicTitleFormat = RelatedTopic
; ShortdescFormat = block format to use for link description
ShortdescFormat = RelatedDesc

To specify a format for fixed links to generated lists:

[RelatedLinks]
; AddedLinksFormat = format to use, default RelatedTopic
AddedLinksFormat = RelatedHead

Configure link formats in the appropriate format configuration file; see §7.2.1 Understanding where to define output formats.

To configure components of fixed-link entries:

[RelatedLinks]
; AddedLinksSpacer = text to put between added links, can include
; <U+nnnn/> for symbols, and <br/> for a line break
AddedLinksSpacer = <spc/><U+2022/><spc/>
; AddedLinksStart = text to put before first link, default none
AddedLinksStart =
; AddedLinksEnd = text to put after last link, default none
AddedLinksEnd =

These settings use format-component processing, so can include any format-component properties except <name/>, which is meaningless in this context. See §8. Configuring format components.

With the default values, if you turn on all fixed-link options, you get a row of links below the related links that looks something like this, where each term is a link to the corresponding generated list:

Contents * Figures * Tables * Glossary * Index

See §13.2 Appending links to topics.

Previous Topic:  13.5.2 Labeling related links

Next Topic:  13.5.4 Inserting dividers between topics and lists of links

Parent Topic:  13.5 Formatting links in output

Sibling Topics:

13.5.1 Understanding how DITA2Go presents related links

13.5.2 Labeling related links

13.5.4 Inserting dividers between topics and lists of links