<shortdesc>
The <shortdesc>
element provides a short description of the 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 search results. The element can occur both in topics and
maps.
The short description should be a single, concise paragraph containing one or two sentences of no more than 50 words.
The content of the <shortdesc>
element SHOULD be rendered as the initial paragraph of the
topic.
Use the <shortdesc>
element when the first paragraph of topic
content is simple enough to be suitable for use as a link preview or for summaries.
Otherwise use the <abstract>
element to provide richer content around
the <shortdesc>
. See the abstract description for
more information about the behavior of <shortdesc>
in an
abstract.
While the <shortdesc>
element is optional, it is recommended that
topics contain this element. When a topic contains only one paragraph, it is preferable to
include the text in the <shortdesc>
and omit the topic body or leave
it empty.
The <shortdesc>
element can be used in DITA maps and
associated with <topicref>
elements. This enables map authors to
accomplish the following goals:
@copy-to
attribute is specified. Processors might not implement this
behavior.When processors generate link previews that are based on the map context,
they SHOULD use the content of the
<shortdesc>
that is located in the map rather than the
<shortdesc>
that is located in the DITA topic. However, processors
SHOULD use the content of the
<shortdesc>
element in the DITA topic when they render the topic
itself, unless the @copy-to
attribute is specified on the topic reference to
the element.
When a <shortdesc>
element applies to an entire DITA
map, it serves as description only.
See appendix for information about this element in OASIS document type shells.
"- topic/shortdesc " when used in topics, and "- map/shortdesc " when used in maps.
The following example demonstrates the use of a stand-alone
<shortdesc>
inside of a concept topic.
<concept id="concept"> <title>Introduction to Bird Calling</title> <shortdesc>If you wish to attract more birds to your Acme Bird Feeder, learn the art of bird calling. Bird calling is an efficient way to alert more birds to the presence of your bird feeder.</shortdesc> <conbody> <p>Bird calling requires learning:</p> <ul> <li>Popular and classical bird songs</li> <li>How to whistle like a bird</li> </ul> </conbody> </concept>
<topicref href="myThing.dita"> <topicmeta> <navtitle>Navigation title for my topic</navtitle> <shortdesc>A description of myThing that is specific to this context.</shortdesc> </topicmeta> </topicref> <topicref href="http://www.example.org" scope="external"> <topicmeta> <navtitle>Example website</navtitle> <shortdesc>The example.org address is often used in examples</shortdesc> </topicmeta> </topicref>
<abstract>
with phrase-level short description<abstract>The abstract is being used to provide more complex content. <shortdesc>The shortdesc must be directly contained by the abstract.</shortdesc> The abstract can put text around the shortdesc. </abstract>
<abstract>
with block-level short description<abstract><p>The abstract is being used to provide more complex content.</p> <shortdesc>The shortdesc must be directly contained by the abstract.</shortdesc> <p>The abstract can put text around the shortdesc.</p> </abstract>
The shortdesc must be directly contained by the abstract.
The abstract can put text around the shortdesc.
<abstract>
with multiple short descriptions<abstract>The abstract is being used to provide more complex content. <shortdesc>The shortdesc must be directly contained by the abstract.</shortdesc> <p>The abstract can put text around the shortdesc.</p> <shortdesc>There can be more than one shortdesc.</shortdesc> </abstract>
The abstract can put text around the shortdesc.
There can be more than one shortdesc.
The following attributes are available on this element: Universal attribute group and outputclass.
Return to main page.
dita-v1.3-errata01-os-part1-base-complete Standards Track Work Product | Copyright © OASIS Open 2016. All Rights Reserved. | 25 October 2016 |