shortdesc

The short description (<shortdesc>) element occurs between the topic title and the topic body, as the initial paragraph-like content of a topic. The short description, which represents the purpose or theme of the topic, is also intended to be used as a link preview and for searching.

Contains

( text data or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or term or q or boolean or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or tm or image) (any number)

Contained by

topic, concept, task, reference

Contained by

topicmeta

Inheritance

topic/shortdesc

Attributes

Name	Description	Data Type	Default Value	Required?
%id-atts; (id, conref)	A set of related attributes, described at %id-atts;	parameter entity	PE not applicable	Not applicable
%global-atts; (xtrf, xtrc)	A set of related attributes, described at %global-atts;	parameter entity	PE not applicable	Not applicable
class, outputclass	Common attributes described in Other common DITA attributes

Example

<task id="abstractexample">
   <title>Abstract Example</title>
      <shortdesc>This documentation addresses messages...</shortdesc>
   <taskbody>...</taskbody>
</task>