Lists

Lists in USFM and USX

In USFM, a list is composed of a series of paragraphs marked with a sub-set of paragraph types for lists.

Selected character spans within a list item are marked with character types for lists.

USX predictably represents USFM list paragraph and character types with corresponding <para> and <char> tags. USX >= 3.2 adds a new <list>…</list> container which is expressed in USFM syntax using a list start and end milestone pair.

USFM
USX
USJ

Example 1. USFM list structure

\list-s\*
\lh optional list header
\li1 list entry 1
\li1 list entry 2
\li3 list entry 3
\lf optional list footer
\list-e\*

Example 2. USX list structure

<list>
<para style="lh">optional list header</para>
<para style="li1">list entry 1</para>
<para style="li1">list entry 2</para>
<para style="li1">list entry 3</para>
<para style="lf">optional list footer</para>
</list>

Example 3. USX list structure

{
  "content": [
    {
      "type": "para",
      "marker": "lh",
      "content": [
        "optional list header"
      ]
    },
    {
      "type": "para",
      "marker": "li1",
      "content": [
        "list entry 1"
      ]
    },
    {
      "type": "para",
      "marker": "li1",
      "content": [
        "list entry 2"
      ]
    },
    {
      "type": "para",
      "marker": "li1",
      "content": [
        "list entry 3"
      ]
    },
    {
      "type": "para",
      "marker": "lf",
      "content": [
        "optional list footer"
      ]
    },
  ]
}

Diagrams

USFM
USX

Embedded Elements

[ListChar] — Character Types for Lists