Under maintenance

Heretto Help

Ordered List Element (ol)

The ol element creates numbered or sequenced lists, organizing items that have an explicit order, sequence, priority, or numerical significance.

The ol element serves these primary purposes:

  • Organizes information in a specific sequence or prioritized order

  • Creates visual progression between list items to indicate steps or hierarchy

  • Groups concepts, options, or components that have a deliberate ranking or order

  • Provides a consistent structure for presenting sequential information

Key characteristics of the ol element:

  • Must contain one or more list item (li) elements

  • Typically renders with sequential numbers or other ordered markers preceding each item

  • Can be nested within other list items to create hierarchical structured sequences

Content within the ordered list element generally follows these output formatting rules:

  • Each list item appears on a new line with consistent indentation

  • Sequential markers (typically numbers) precede each item with consistent spacing

  • Markers automatically increment based on position in the list

  • Nested lists use different marker styles to indicate hierarchy levels

  • Line wrapping within list items maintains alignment with the first line

Use ol to:

  • Present ranked items where position indicates importance or priority

  • Create hierarchical structures where numbering provides context

  • Present chronological events or historical sequences

  • Structure content that users need to read sequentially rather than scan randomly

  • Indicate a deliberate count or quantity of items

Tip:

When possible, choose semantically appropriate ol alternatives:

  • Use steps in task topics for procedural sequences or steps

  • Use substeps for secondary sequences within step elements

The ol element used to list coffee top coffee producing steps in a concept topic in the Heretto CCMS Content Editor:

Layer 1

The DITA source of the ol element with the surrounding context of a concept:

<concept id="concept-8824" xml:lang="en-us">
    <title>Top Coffee Producing Countries</title>
    <shortdesc>Coffee production is concentrated in specific regions, with five countries accounting for over 70% of global coffee exports.</shortdesc>
    <prolog>
        <author translate="no" type="creator">Heretto User &lt;user@heretto.com&gt;</author>
    </prolog>
    <conbody>
        <p>The following ranked list shows the top five coffee producing countries by annual export volume:</p>
        <ol>
            <li>
                <p>Brazil (3.8 million metric tons)</p>
            </li>
            <li>
                <p>Vietnam (1.7 million metric tons)</p>
            </li>
            <li>
                <p>Colombia (850,000 metric tons)</p>
            </li>
            <li>
                <p>Indonesia (760,000 metric tons)</p>
            </li>
            <li>
                <p>Ethiopia (470,000 metric tons)</p>
            </li>
        </ol>
        <p>This ranking reflects both the quantity produced and the significance of coffee to each nation's agricultural exports.</p>
    </conbody>
</concept>