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.
Short descriptions in the ditamap
Short descriptions specified in a DITA topic can be overridden by alternative short description elements in the ditamap.

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.

Short descriptions in the ditamap

Short descriptions specified in a DITA topic can be overridden by alternative short description elements in the ditamap.

A short description (shortdesc) element naturally belongs in the topic. The short description is typically rendered in the output as:

the first paragraph of the topic
link preview text (in hypertext outputs)
subordinate topic preview text in the topic's parent

In some circumstances, you may want to override the subordinate topic preview text with a publication-specific, alternative short description. To do this, you need to specify the alternative short description in the ditamap. This is done by adding a shortdesc element to the topicmeta element within the topicref.

An example of the topicref mark-up is:

<topicref href="c_starting_xrw.dita" format="dita">
  <topicmeta>
    <shortdesc>The XRW is started by entering the PIN into the security
    keypad, and then turning the ignition key.</shortdesc>
  </topicmeta>
</topicref>

Note:

Setting a linktext element within the topicref's topicmeta will similarly result in the generated hierarchical links in hypertext output using this alternative link text, rather than the topic's title.