Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionThe short description describes the content of the document. This information is typically displayed in document lists, where the name is rendered side by side with the short description.
 

Doctypesectionhide
NameShort Description
 

Parent
Parent Property
property-nameName
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags
Tag List
propertyTags
 

Iteration
Iteration
valuefilled
hide
Sort Key000120hide
Section
show-titlefalse
titleDescription

The short description is a short paragraph of one to three sentences. It describes the content of the document and is a tool for the readers to determine, if they are interested to read the document or skip it.

Typically short descriptions are displayed on top of a document and in document lists. The short description is rendered together with the name and maybe more metadata from the document's properties. This supports readers with navigating the documentation.

References Box

For information on how to write expressive short descriptions, please have a look at Writing Short Descriptions.

...