`<reference>`

The <reference> element is the top-level element for a reference topic. A reference topic can include specialized sections for programming syntax and property tables, as well as standard sections, tables, and examples.

Usage information

For information about the purpose and content model of a reference topic, see Reference.

Specialization hierarchy

The <reference> element is specialized from <topic>. It is defined in the reference module.

Attributes

The following attributes are available on this element: architectural attributes and universal attributes.

For this element, the @id attribute is required.

The following attributes are available on this element: universal attributes and the attributes defined below.

@DITAArchVersion (architectural attributes): Specifies the version of the DITA architecture that is in use. This attribute is in the namespace http://dita.oasis-open.org/architecture/2005/. This attribute is specified in the topic and map modules, and it uses a default value of the current version of DITA. The current default is 2.0.
@id: For this element, the @id attribute is required.
@specializations (architectural attributes): Specifies the attribute-domain specializations that are included in the document-type shell. This attribute is set as a default within the document-type shell. The value varies depending on what domains are integrated into the document-type shell. For example, a grammar file that includes the specialized attributes @audience, @deliveryTarget, and @newBaseAtt would set the value to @props/audience @props/deliveryTarget @base/newBaseAtt.
@xmlns:ditaarch (architectural attributes): Declares the default DITA namespace. This namespace is declared as such in the RNG modules for <topic> and <map>, but it is specified as an attribute in the equivalent DTD-based modules. The value is fixed to http://dita.oasis-open.org/architecture/2005/.

Example

This section is non-normative.

The following code sample shows how a reference topic can be used:

<reference id="requiredTools">
  <title>Tools required to maintain Acme machinery</title>
  <refbody>
    <section>
      <title>Small tools</title>
      <ul>
        <li>Hard hat</li>
        <li>Hammer</li>
        <li>Nail</li>
        <li>Metal polish</li>
        <!-- .... -->
      </ul>
    </section>
    <section>
      <title>Expensive tools</title>
      <!-- .... -->
    </section>
  </refbody>
</reference>