dl

Darwin Information Typing Architecture (DITA) Version 1.3 Part 3: All-Inclusive Edition

version
1.3
author
OASIS DITA Technical Committee

A dl element is a list of terms and corresponding definitions. The term (dt) is usually flush left. The description or definition (dd) is usually either indented and on the next line, or on the same line to the right of the term. However, actual rendering is up to the rendering engine.

An optional heading for the terms and definitions can be provided using the dlhead element, which contains header elements for those columns. The default formatting for the dlhead generally looks like a table with a heading row, but this is also up to the rendering engine.

Content models

See appendix for information about this element in OASIS document type shells.

Inheritance

- topic/dl

Examples

Figure. Simple definition list example
<dl>
<dlentry>
<dt>Bytes returned</dt>
<dd>The number of bytes of data returned.</dd>
</dlentry>
<dlentry>
<dt>Bytes available</dt>
<dd>The number of bytes of data available to be returned.</dd>
</dlentry>
<dlentry><dt>Handle</dt>
<dd>The returned handle value</dd>
</dlentry>
</dl>
Figure. Definition list with a heading
<dl>
 <dlhead>
  <dthd>Image File View Selection</dthd>
  <ddhd>Resulting Information</ddhd>
 </dlhead>
 <dlentry>
  <dt>File Type</dt>
  <dd>Image's file extension</dd>
 </dlentry>
 <dlentry>
  <dt>Image Class</dt>
  <dd>Image is raster, vector, metafile or 3D</dd>
 </dlentry>
 <dlentry>
  <dt>Number of pages</dt>
  <dd>Number of pages in the image</dd>
 </dlentry>
 <dlentry>
  <dt>Fonts</dt>
  <dd>Names of the fonts contained within a vector image</dd>
 </dlentry>
</dl>

Rendering of definition lists will vary by application and by display format. Processors MIGHT render the second example as follows.

Image File View Selection
Resulting Information
File Type
Image's file extension
Image Class
Image is raster, vector, metafile or 3D
Number of pages
Number of pages in the image
Fonts
Names of the fonts contained within a vector image

Attributes

The following attributes are available on this element: Universal attribute group, outputclass, compact, and spectitle.