Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
Short DescriptionIn order to not duplicate the information about common properties provided by all doctypes, this box allows to reference the topic that provides this information.
 

Doctypedocmodulehide
NameNote Box referencing common Document Properties
 

Parent
Parent Property
property-nameName
 

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags
Tag List
propertyTags
 

Iteration

Iteration
value

facade

finished

 
hide
Type
Name List
doctypemodule-type
render-no-hits-as-blanktrue
namesBox
propertyType
 

Sort Keyhide
Section
titleDescription

The following placeholders are provided to configure the output:

NameDescription
doctype-nameThe name of the document type (doctype) that is documented. Provided this box as a reference to common document properties that are supported by theis document type by default.
Section
titleBox

The document type ${doctype-name} provides the following properties:

Note Box

Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.

...

Section
titleSubordinate Modules
Display Table
doctypedocmodule
render-no-hits-as-blanktrue
selectName, Short Descriptionsort-bySort Key, Name
restrict-to-immediate-childrentrue
sort-bySort Key, Name
Section
titleTranscluded By
Display Table
render-no-hits-as-blanktrue
selectName, Short Description, Doctype
sort-bySort Key, Name
where$<TranscludedDocumentTitles>=[${Space Key}.${Name}]

...