13.1 Generating and including related links

Which related links DITA2Go generates or includes by default depends on the type of link and the source of the link. Table 13-1 shows how each type of link is treated by default. See also §13.2 Appending links to topics.

Table 13-1 Default treatment of related links by link source and type

Source of related links

Default

Link types

Inferred relationships (not in reltables) in DITA maps

Ignore

previous/next

parent/child

sibling

Reltables and DITA topic related-links elements

Include

previous/next

parent/child

sibling

DITA topic related-links elements

Exclude

ancestor/descendant

cousin

friend

To change the default action for any type of related link:

Generate inferred previous/next, parent/child, or sibling links from maps

Exclude previous/next, parent/child, or sibling links in topics or reltables

Include ancestor/descendant, cousin, or friend links in topics

Generate inferred previous/next, parent/child, or sibling links from maps

By default, DITA2Go ignores previous/next links, parent/child links, and sibling links that exist in DITA maps outside of reltables. To specify which of these links to generate from inferred relationships in maps:

[RelatedLinks]
; GeneratePrevNext = No (default) or Yes (generate Previous Topic
; and Next Topic links based on map position)
GeneratePrevNext = Yes
; GenerateParentChild = No (default) or Yes (generate Parent Topic
; and Child Topics links based on map position)
GenerateParentChild = Yes
; GenerateSiblings = No (default) or Yes (generate Related Topic
; links for siblings in the map)
GenerateSiblings = Yes

These links are attached to topics based on map position. See also §6.12.4 Including children of topic headings.

Exclude previous/next, parent/child, or sibling links in topics or reltables

By default, DITA2Go includes previous/next links, parent/child links, and sibling links that occur in reltables and in DITA topic related-links elements. To exclude any of these links:

[RelatedLinks]
; UsePrevNext = Yes (default, use links with role previous or next)
; or No (ignore such links in related-links)
UsePrevNext = No
; UseParent = Yes (default, use links with role parent) or No 
UseParent = No
; UseChildren = Yes (default, use links with role child) or No)
UseChildren = No
; UseSiblings = Yes (default, use links with role sibling) or No
UseSiblings = No

See also §6.12.4 Including children of topic headings.

Include ancestor/descendant, cousin, or friend links in topics

To include ancestor/descendant, cousin, and friend links that occur in DITA topic related-links elements:

[RelatedLinks]
; UseAncestors = No (default, ignore links with role ancestor)
; or Yes (use such links)
UseAncestors = Yes
; UseDescendants = No (default, ignore links with role descendant)
; or Yes (use such links)
UseDescendants = Yes
; UseCousins = No (default, ignore links with role cousin) or Yes
UseCousins = Yes
; UseFriends = No (default, ignore links with role friend) or Yes
UseFriends = Yes

Previous Topic:  13. Processing related and associative links

Next Topic:  13.2 Appending links to topics

Parent Topic:  13. Processing related and associative links

Sibling Topics:

13.2 Appending links to topics

13.3 Including descriptions with related links

13.4 Generating associative links for Help output

13.5 Formatting links in output

13.6 Changing link path for peer related links