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:

** header

A header/identification paragraph. These are the paragraphs that occur before any titles or introduction

** title

A book title paragraph occuring before and possibly after introductory material

** introduction

Introduction text paragraph

** sectionpara

Section heading paragraph occuring before and associated with a following paragraph. May not include verses

** versepara

Verse text paragraph may include verses

** list

List paragraph (verse text)

** otherpara

Other (non verse text) paragraph

** cell

A table cell acts much like a paragraph.

** crossreference

Cross Reference container

** footnote

Footnote container

** char

Character-level container (span). Must be explicitly closed, in USFM.

** introchar

Introduction text character span only found in introduction paragraphs

** listchar

List text character span only found in list paragraphs

** footnotechar

Footnote text character span only found in footnotes. Are implicitly closed by another footnotechar or the end of the footnote, in USFM.

** crossreferencechar

Cross reference text character span only found in crossreferences. Are implicitly closed by another crossreferencechar or the end of the crossreference, in USFM.

** milestone

Milestone

** standalone

A milestone with no parameters. In USFM it has no final \* closer.

  • Other

** internal

Has explicitly programmed behaviour that is not covered by other categories. An extension marker may not be labelled internal.

** attribute

A special kind of internal marker that is treated as a separate marker in USFM but as an attribute in USX/USJ.

\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