3.10.3 Reference elements
Reference topics describe factual material about
a subject, such as the commands in a programming language. This format
is also suitable for bibliographies, catalogues, the list of ingredients
for recipes, and similar collections of structured descriptive prose.
For more details on when to use reference and other information types,
please refer to the DITA architectural specification.
<reference> element defines a top-level container for a reference topic. Reference topics document programming constructs or facts about a product. Examples of reference topics include (but are not limited to) product specifications, environmental specifications, equipment lists, parts lists, required tools, language elements, class descriptions, commands, functions, and API information. All of these topics provide quick access to facts, but they do not contain a deeper explanation of related concepts or tasks.
<refbody> element is a container for the main content of the reference topic. Reference topics limit the body structure to tables (both simple and standard), property lists, syntax sections, and generic sections and examples, in any sequence or number.
<refbodydiv> element is similar to the
<bodydiv> element in that it provides an informal container for content that
might be grouped within a reference. Reference topics place many restrictions on their content compared to generic topics; the
<refbodydiv> element maintains these restrictions by only allowing elements that are already available within the body of a reference. There are no additional semantics attached to the
<refbodydiv> element; it is purely a grouping element provided to help organize content.
<refsyn> element is a special section inside a reference topic. The section often contains syntax or signature content (for example, the calling syntax for a command-line utility or an API signature). The
<refsyn> contains a brief, possibly diagrammatic description of the subject's interface or high-level structure.
<properties> element gives a list of properties for the subject of the current topic, for example whether a class is public or protected. Each property can include the type, value, and a description. The typical rendering is usually in a table-like format. To represent multiple values for a single type, create additional property elements and use only the
<propvalue> element (and
<propdesc> when needed) for each successive value.
<prophead> element supports headings for the
<proptypehd> element supports headings for the type column of a properties table.
<propvaluehd> element supports headings for the value column of a properties table.
<propdeschd> element supports headings for the description column of a properties table.
<property> element represents a single property of the current topic's subject. For example, if the current reference topic describes a programming class, the property might show that the class is protected rather than public. The
<property> element generally appears together with a series of other properties; it contains three optional elements to provide a type, value, or description of the property.
<proptype> element describes the type of the property.
<propvalue> element indicates one or more values for the current property type. Values
can be placed in separate
<property> elements if they need separate descriptions. The
<proptype> element need not be repeated.
<propdesc> element is used to provide a short description of the property type and its listed values.