Formatting conventions in the XHTML version of the specification
The DITA specification uses the content of the DITA <shortdesc> element to provide link previews for its readers. These link previews are visually highlighted by a border and a colored background. The link previews are not normative; they contain the content of the <shortdesc> element for the child topic, which is rendered in a normative context as the first paragraph of the topic; the content is identical in both renditions. The link previews serve as enhanced navigation aids, enabling readers to more easily locate content. This usability enhancement is one of the ways in which the specification illustrates the capabilities of DITA and exemplifies DITA best practices.
The following screen capture illustrates how link previews are displayed in the XHTML version of the specification:
To ease readers in navigating from one topic to another, each XHTML file generated by a DITA topic contains the following navigation links at the bottom:
- Parent topic
- Takes readers to the parent topic, which the topic referenced by the closest topic in the containment hierarchy
- Previous topic
- Takes readers to the previous topic in the reading sequence
- Next topic
- Takes readers to the next topic in the reading sequence
- Return to main page
- Takes readers to the place in the table of contents for the current topic in the reading sequence
The following screen capture illustrates how navigation links are displayed in the XHTML version of the specification:
When readers hover over the navigation links, the short description of the DITA topic also is displayed.