A definition list (<dl>) 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.
You can also provide an optional heading for the terms and definitions, 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.
Doctype | Content model |
---|---|
topic, map, concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap, classifyMap, subjectScheme, machineryTask, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary | ( (dlhead) (optional) then (dlentry) (one or more) ) |
<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>
<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. The second example may, but need not, be rendered as follows.
Name | Description | Data Type | Default Value | Required? |
---|---|---|---|---|
compact | Indicates close vertical spacing between the list items.
Expanded spacing is the default value. The output result of compact spacing
depends on the processor or browser. Allowed values are:
|
(yes | no | -dita-use-conref-target) | #IMPLIED | No |
spectitle | The specialized title attribute allows architects of specialized types to define a fixed or default title for a specialized element. Not intended for direct use by authors. | CDATA | #IMPLIED | No |
univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) | A set of related attributes, described in univ-atts attribute group | |||
global-atts attribute group (xtrf, xtrc) | A set of related attributes, described in global-atts attribute group | |||
class, outputclass | Common attributes described in Other common DITA attributes |
Return to main page.
OASIS DITA Version 1.2 -- OASIS Standard, 1 December 2010
Copyright © OASIS Open 2005, 2010. All Rights Reserved.