Definition List Element (dl)
The dl element creates a list of terms and corresponding definitions. It's suitable for both simple definitions and complex, multi-paragraph explanations.
The dl element serves these primary purposes:
-
Organizing terms and their definitions in a structured format
-
Representing name-value pairs with detailed explanations
Key characteristics of the dl element:
-
Contains one or more
dlentryelements, each with a term (dt) and definition (dd) -
Supports complex content within definitions, including lists and notes
-
Can be nested within other block elements
A dl element consists of these optional and required elements:
- Definition list entry (
dlentry) - A required element that contains one or more
dt(definition term) elements and one or moredd(definition description) elements. - Definition term (
dt) - A required element that contains a term or item being defined. Each term should have at least one corresponding description (
dd). - Definition description (
dd) - A required element that contains the description or definition of the term. Each term should have at least one corresponding description (
dd). - Definition list heading (
dlhead) -
An optional header element used when definition lists are presented as a table, which is a less common output format for this element. It contains two required elements: definition term heading (
dthd) and definition description heading (ddhd).
Content within the dl element typically follows these output formatting rules:
-
Terms typically appear in bold or distinctive formatting
-
Definitions, often with multiple paragraphs, typically appear under the term
-
Supports both horizontal (term and description are side by side) and vertical (description appears in a new line) layouts in output
-
Can be presented as a table with headings (
dlhead), which is a less common output format for this element
Use dl instead of tables to:
-
Define technical terms or concepts
-
List parameters or components and their descriptions
-
List configuration settings and properties and their explanations
-
Provide structured name-value pairs
The dl element added to a concept topic in the Heretto CCMS Content Editor.
The DITA source of the dl element with the surrounding context of a concept:
<concept id="concept-9784" xml:lang="en-us">
<title>Coffee Brewing Methods</title>
<shortdesc>(...)</shortdesc>
<prolog>
<author translate="no" type="creator">Heretto User<user@heretto.com></author>
</prolog>
<conbody>
<dl>
<dlentry>
<dt>Hario V-60</dt>
<dd>Use the Hario V-60 for a balanced cup of coffee that neither highlights nor restricts the presentation of a coffee's flavor notes. The V-60 is preferred for its ability to handle the Heretto blend and for enabling individual brewing preferences. It is a single cup brewing method that requires a gooseneck kettle, demitasse spoon, kitchen scale, and timer. The ideal water temperature is between 197 and 204 degrees Fahrenheit. The brewing process involves a specific technique for adding water and letting the coffee bloom, resulting in a classic pour-over cup of coffee.</dd>
</dlentry>
<dlentry>
<dt>Chemex: Six Cup</dt>
<dd>Use the six cup Chemex to highlight the floral and fruity flavors of a coffee, and for sharing. It is recommended for coffees with strong fruit and floral qualities, such as those from sub-Saharan regions. The thicker Chemex filters capture more insolubles, which enhances the floral and fruity notes while reducing earthy flavors. Similar to the V-60, the Chemex brewing process requires a gooseneck kettle, demitasse spoon, kitchen scale, and timer, with water at the same recommended temperature. The brewing technique includes a blooming phase and a specific water pouring routine to bring out the best in fruit-forward coffees.</dd>
</dlentry>
</dl>
</conbody>
</concept>