Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionOrganizing documents in a hierarchical manner is sometimes very helpful to help readers to orientate in the documentation. The children section automatically lists the child documents, usually with the name and short description. 
Doctypesectionhide
NameChildren 
Parent
Parent Property
property-nameName
 
Categories
Name List
doctypecategory
propertyCategories
 
Tags
Tag List
propertyTags
 
Iteration
Iteration
valuefinished
hide
Sort Key000110hide
Section
show-titlefalse
titleDescription

It is often helpful to organize documents in a hierarchical manner. For some document types there is a natural hierarchy.

Example Box

Roles, for instance, may be divided in team and user roles. The team role may be subdivided into testers, architects and developers. Developers may be further split into front-end, service and storage developers. Define the roles as they fit to your project.

To list the children, use the Display Table Macro. Consider using the list representation, if you only want to show the name and short description. This representation is usually shorter and easier to read.

Caution Box

Some document types may have different names for this section. The are typically called subordinate elements of a given doctype like "Subordinate Topics" or "Subordinate Roles".

Document types may add additional sections selecting child documents of other document types or selection criteria.

...