Glossary · Information types
DITA reference
Also known as: reference topic
In DITA, a reference is a topic type for information that readers look up rather than read from start to finish, such as specifications, parameters or command syntax. Its body element <refbody> is organized in sections, tables and property lists.
- DITA
- Information typing
In one sentence
A DITA reference is the topic type for look-up information — specifications, parameters and syntax — organized in sections and property tables.
Example
The reference “Air filter specifications” with a property table listing filter class, dimensions and replacement interval.
Explained in context
Context cards connect this term with others to answer one question. Also in British English and German.
How it applies
- Technical documentation: References hold the facts readers look up rather than read: technical data, parameter lists, error codes, command syntax, spare parts.
- Structure: The reference body (
<refbody>) contains sections, tables, simple tables, syntax (<refsyn>) and property tables (<properties>), whose rows hold a type, value and description for each property. - AI and retrieval: Property tables are close to structured data. Each row can be extracted as a fact — “maximum operating temperature: 40 °C” — and used to answer precise questions or to populate a knowledge graph.
Reference vs. concept
A reference answers “what is the value of …”, a concept answers “what is … and why”. If a table needs paragraphs of explanation around it, the explanation belongs in a concept that links to the reference.
In DITA markup
<reference id="filter-specs">
<title>Air filter specifications</title>
<refbody>
<properties>
<property><proptype>Filter class</proptype><propvalue>ISO ePM10 50%</propvalue></property>
<property><proptype>Replacement interval</proptype><propvalue>500 operating hours</propvalue></property>
</properties>
</refbody>
</reference>