Home
Syntax and mark-up
Short descriptions
The short description (or shortdesc) is arguably the most important component of a DITA topic, and is also one of the most difficult elements to write. Short descriptions should be written for every topic.
Purpose of short descriptions
Short descriptions typically perform three different functions: providing an overview in the first paragraph of the topic, as link preview text (or hover text) in hypertext outputs, and as part of the subordinate topic preview text in the parent of the topic.

Introduction
Information types and topics
Topics are the building blocks of modular documents, and organising topics by semantic information types is one of the architectural features of DITA.
DITA map files
Syntax and mark-up
- Organisation of DITA elements
  Elements in DITA are grouped together into a number of categories for organisational and comprehension purposes.
- Working with mark-up
- Element domains
  Elements in DITA are arranged into domains for organisational purposes and technical reasons.
- Short descriptions
  The short description (or shortdesc) is arguably the most important component of a DITA topic, and is also one of the most difficult elements to write. Short descriptions should be written for every topic.
  - Purpose of short descriptions
    Short descriptions typically perform three different functions: providing an overview in the first paragraph of the topic, as link preview text (or hover text) in hypertext outputs, and as part of the subordinate topic preview text in the parent of the topic.
  - Guidelines for crafting short descriptions
    Short descriptions are difficult and time consuming to write. Following guidelines for shortdesc creation will make the task easier, and result in more consistent descriptions.
  - Abstracts
    Abstracts can contain multiple shortdesc elements, which are typically processed slightly differently to standalone shortdesc elements.
  - Cross-references and typography in shortdesc elements
    Although it is possible to embed a phrase (ph) element in a shortdesc, and then include formatting and xref elements within the phrase, it is not a semantically sound practice.
  - Making shortdesc elements compulsory
    It is possible for publishing teams to make the use of short descriptions mandatory through specialisation and constraints mechanisms within DITA.
  - Short descriptions in the ditamap
    Short descriptions specified in a DITA topic can be overridden by alternative short description elements in the ditamap.
- Lists
  The purpose of a list is to make it easier for the reader to understand sequences of information and collections of like information. Different types of lists are used for different information structures.
- Paragraphs
  Paragraphs are the basic components of topics. A paragraph (p) element should be a self-contained unit dealing with one idea or point, typically expressed in two or more related sentences. The p element should be used when no other semantically-specific block element is available.
- Procedures and steps
  The purpose of procedural documents is to explain to the reader how to accomplish tasks. The task information type is specifically designed for procedures, with a well-defined structure built around steps.
- Tables
  The purpose of a table is to structure, organise and present factual data that a user will need to look up or reference. There are two general purpose table types in DITA: table and simpletable.
- Phrases
  The semantics of words and phrases in DITA content is expressed through a broad range of phrase elements.
- Special characters and dates
Language and punctuation
Graphics and figures
Cross-referencing
Cross-references are a means of binding individual topics into a coherent and navigable document.
Content re-use
Metadata, conditional processing, and indexing
The DITA documentation process
DITA authoring concepts
Moving from style-based authoring to a structured authoring methodology such as DITA requires a radically different approach to writing.

Purpose of short descriptions

Short descriptions typically perform three different functions: providing an overview in the first paragraph of the topic, as link preview text (or hover text) in hypertext outputs, and as part of the subordinate topic preview text in the parent of the topic.

The short description (shortdesc) element allows a writer to provide a short overview of the content of the topic. The shortdesc is typically generated as the first content paragraph (after the title) in the output. However, some processors can omit the short description from the topic entirely. The shortdesc is also typically used for link previews (in hypertext output formats), and for subordinate topic preview summaries in parent topics. Again, some processors may not generate the shortdesc elements in this way. Some processors may also truncate the short description in a link preview or subordinate topic preview.

Screen capture of Web page with short description topic preview — Figure 1. Example of short descriptions as subordinate topic previews in HTML output

Screen capture showing mouse-hover popup text displaying short description of link target — Figure 2. Example of short description as link previews in HTML output

Short descriptions can be defined in the topic, or in the topicmeta section of the topicref in the ditamap.

The short description should normally be defined in the topic. Only if the topic has a different purpose in a particular ditamap should the short description be defined in the map.

Subordinate topic previews and link previews serve as progressive disclosure devices, which aim to provide the reader with an understanding of what the linked topic contains, without having to follow the link. This allows the user to navigate through the online document more efficiently.

As the first paragraph of the topic, the short description can serve as an overview that allows the reader to quickly decide whether to read on. This purpose is more readily achieved by the systematic use of short descriptions, and visually identifying the short description in the output with distinctive styling (thematic unity).

Example of short description styled distinctively in HTML output — Figure 3. Example of short description styled distinctively in HTML output