13.3 Including descriptions with related links

By default, DITA2Go does not include descriptions with links. To include text from map desc, shortdesc, or linktext elements:

[RelatedLinks]
; UseRelDescription = No (default, do not include any descriptions)
; or Yes (include description from map shortdesc, linktext, or desc)
UseRelDescription = Yes

To include shortdesc content in the title attribute of the heading it applies to, instead of as a paragraph following the heading:

[RelatedLinks]
; UseRelDescAsTitle = No (default, treat descriptions as text if used)
; or Yes (use descriptions without formatting as title attributes)
UseRelDescAsTitle = Yes

When UseRelDescAsTitle=Yes, the shortdesc text appears with a mouseover in HTML output. This setting is effective only if you also set UseRelDescription=Yes.

Note:  For the topic itself, the shortdesc always appears after the title, unless you specify otherwise; see §6.12.2 Including shortdesc content in the title attribute.

See also:

§6.13 Deciding where to display title and shortdesc

Previous Topic:  13.2.2 Appending fixed links to topics

Next Topic:  13.4 Generating associative links for Help output

Parent Topic:  13. Processing related and associative links

Sibling Topics:

13.1 Generating and including related links

13.2 Appending links to topics

13.4 Generating associative links for Help output

13.5 Formatting links in output

13.6 Changing link path for peer related links