Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
show-titlefalse
titleDescription

The description section of a document informs about its content and intention. This is a descriptive abstract, similar to a table of contents, and a longer form of the Short Description document property.

The description helps potential readers to decide, whether or not relevant information can be found in the document.

Info Box

Some document types may interpret this property different. A Glossary Item for instance, puts the definition of the term in the description section. A Role describes the role instead of describing what the intention of a particular role document instance is.

Since the location of this section typically makes the intention of the text obvious, the section title may be hidden. For more information please refer to No need to render the Section Title in Tips.

Section
titleSubordinate Sections
Display Table
doctypesection
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name
Section
hidetrue
titleDesignation

Describe the content of this document so that readers are able to decide whether to read further or not. This is an descriptive abstract, similar to a table of contents.

For more information please refer to Description

Section
required-permissionswrite-access
titleNotes

...