User Extensions

Users may create and use non-standard markup extensions. User created markers should always begin with z. For Example: \zmyp or <para style="zmyp">. User extended markup is NOT considered part of the USFM/USX standard. An application or processor is not required to provide support for user extensions, and is also free to ignore this markup when it is encountered in a text.

Defining Extensions

A basic specification for markup extensions used in a text should be provided in a file named markers.ext. For each marker, supply the following:

\marker

Marker text

\category

Marker category, from the following list:

  • Paragraph

    • header - Header/identification paragraph

    • title - Book title paragraph

    • introduction - Introduction text paragraph

    • sectionpara - Section heading paragraph

    • versepara - Verse text paragraph

    • list - List paragraph (verse text)

    • otherpara - Other (non verse text) paragraph

  • Note

    • crossreference - Cross Reference container

    • footnote - Footnote container

  • Character

    • char - Character-level container (span)

    • introchar - Introduction text character span

    • listchar - List text character span

    • footnotechar - Footnote text character span

    • crossreferencechar - Cross reference text character span

  • Milestone

    • milestone - Milestone

  • Other

    • internal - Internal

\description

Marker description

\attribute

As needed - Required or optional attribute (used with Character marker categories). If more than one attribute is specified for the marker, provide a separate \attribute field for each.

Examples

Example 1. markers.ext
\marker zmyp
\category versepara
\description An paragraph marker extension.
Example 2. markers.ext
\marker zmyc
\category char
\description A character marker extension.
\attribute x-myattr1