XML representation of Unified Standard Format Markup Scripture files. This schema is intended for use with Holy Bible files only. This schema is copyright 2005-2006 EBT and SIL; released under the Gnu Lesser Public License or the Common Public License, as explained in LICENSING.txt.
Three-letter Ethnologue code or two-letter ISO language code, optionally followed by a dialect indicator.
Remark or comment, not for publication.
This element contains one book of the Bible or optionally some front or back matter. The id attribute is for the three-letter code for this book of the Bible (or FRT for front matter and BAK for back matter).
From the \id marker line. The first three characters of the contents of this element MUST be the three-letter code for this book of the Bible (or FRT for front matter and BAK for back matter).
Optional USFM version. Normally this is only present in files sourced from USFM/USX version 3.0 or later.
Remark or comment, not for publication, such as notes about translation status.
Short book name for a running header, like "Matthew".
Chapter label, like "Chapter" or "Psalm" in the target language. If used like this, this label should be placed before any chapter start labels. If cl occurs after a chapter start tag, it is the exact text to display for that chapter's heading (i. e. for displaying a chapter number in words instead of numerals or for an alternate numbering system besides Arabic/Latin).
The p element contains not only the \p marker's contents, but also every kind of paragraph and heading or title. If this is used for something other than \p, then the sfm attribute MUST be set to indicate which kind of paragraph, or heading is intended. Headings, and paragraphs are in the same group because they all correspond to paragraphs in a word processing document. This element includes \ps, \psi, and \nb. Note that some common paragraph elements (q, d, and s) could have been included in this element, too, but have their own element tags for convenience in manual editing of the XML.
Poetry line "paragraph"
The main title of a book of the Bible, such as "The Good News According to Matthew"
Descriptive title of a Psalm (Hebrew title)
Section heading (not part of the Scripture text).
This marker is a place to encode proposed markers such as \pub, \pref, \conc, \glo, \idx, \cov, \spine, \and environment markers.
Blank line between stanzas of poetry; not to be used before or after a section header. This element should be empty.
This element surrounds content generated from other elements. This tag and its contents is discarded when converting back to USFM.
Chapter starting point. It contains the chapter number, possibly with a chapter name designator, NOT the whole chapter. The chapter number itself should be specified in the id attribute, and is used to generate the contents of the tag, if empty. If not empty, it may be used for the displayed form of the chapter designator in the vernacular language.
Alternate chapter designation for this chapter starting point. It contains the chapter number, possibly with a chapter name designator, NOT the whole chapter. The chapter number itself is in the contents of this element.
Table of contents entry in the vernacular: level 1 = long title; level 2 = short title; level 3 = abbreviation
Table of contents entry in an alternate language or language of wider communication: level 1 = long title; level 2 = short title; level 3 = abbreviation
Table (i. e. for tables of weights and measures in helps).
Row
Table column heading
Table column heading, right aligned
Table column entry within this row. The level attribute gives the position of the column.
Table column entry, right justified. The level attribute gives the position of the column.
The v element contains the verse starting point, NOT the verse itself. The contents of this element are generated automatically from the id attribute, and may be just a verse number or verse range, possibly with formatting information (like bold and superscript).
ve is used as a milestone element marking the end of a verse. Content, if any, is treated as a comment. It should be placed just after the last of the canonical text of a verse, but before any subtitles or headers associated with the next verse.
Chapter starting point. It contains the chapter number, possibly with a chapter name designator, NOT the whole chapter. The chapter number itself should be specified in the id attribute, and is used to generate the contents of the tag, if empty. If not empty, it may be used for the displayed form of the chapter designator in the vernacular language.
Footnote
Encoding of the corresponding USFM file. (Encoding of this XML file is given in the XML header.)
Canonical Hebrew notation, like canonical title, but after the poem.
Encoding of the corresponding USFM file. (Encoding of this XML file is given in the XML header.)
This type consists of the mixed text and tags that can appear inside any paragraph.
This element contains the chapter starting point MARKER, NOT the chapter itself. The chapter is assumed to end at the beginning of the next chapter or at the end of the book element. The marker is normally generated from the id attribute, overwriting whatever this element contained before.
The v element contains the verse starting point, NOT the verse itself. The contents of this element are generated automatically from the id attribute, and may be just a verse number or verse range, possibly with formatting information (like bold and superscript).
ve is used as a milestone element marking the end of a verse. Content, if any, is treated as a comment. It should be placed just after the last of the canonical text of a verse, but before any subtitles or headers associated with the next verse.
Quoted text; Old Testament quotes in the New Testament or other quoted text, such as Jesus' direct quotes. The who attribute may be used to distinguish between these, but USFM makes no distinction. This markup may result in a different character formatting.
Name of Diety: used only to mark God's proper name or a translation of this Name. This may result in special character formatting, such as small caps.
Transliterated or foreign words.
This marker can be used to encode any standard format marker not corresponding to a specific element with its own name. This should only be used if there is no other suitable element to use for your application within this schema.
Alternate chapter numbering scheme chapter start marker
Published chapter marker, which may be used to override the numeric marker generated from the c element.
Alternate verse number (starting point).
Published verse marker (starting point); overrides marker generated from v id attribute.
Special marking for "Selah." in the target language. This may cause right alignment of this word or phrase in an otherwise left-aligned or fully justified paragraph, or may have no effect.
This is intended to mark the first character of a line of acrostic poetry, which may result in the letter being rendered in bold face or may have no effect.
Table (i. e. for tables of weights and measures in helps).
Row
Table column heading
Table column heading, right aligned
Table column entry within this row. The level attribute gives the position of the column.
Table column entry, right justified. The level attribute gives the position of the column.
This element contains material that was automatically generated from another marker, such as drop cap actual implementation at the start of verse 1 from an earlier \c tag.
Footnote
Extended Footnote
Manually designated footnote mark -- NOT RECOMMENDED FOR USE.
Crossreference: a footnote used just to indicate a crossreference. It may be positioned differently than footnotes designated with f, and it may use different calling sequences than f does.
Extended crossreference: a footnote used just to indicate a crossreference. It may be positioned differently than footnotes designated with f, and it may use different calling sequences than f does.
Passage of text based on a secondary language source. For example, places where the source text is in Aramaic and not Hebrew could be optionally rendered with a different type style.
Omit in editions not containing the Deuterocanon. Deuterocanonical/LXX additions or insertions in the Protocanonical text. May optionally be rendered differently.
Quoted book title; may toggle italics setting in introductory material.
Proper name; may map to a character style or be ignored.
Keyword-- may map to a character style or be ignored.
Ordinal number ending; may be superscripted and underlined.
Superscript.
Additional material; supplied words to make sense in a target language when the translation style is very literal. This would be used to mark the italics in the KJV, for example.
Signature of the author of an epistle, such as "Greetings from Paul." This may or may not be rendered differently.
Bold; not recommended for use.
Italic; not recommended for use.
Bold Italic; not recommended for use. Note that character styles do not stack. Only one may apply at a time.
Smallcap text; not recommended for use. Use nd or other appropriate element instead.
Normal text within other formatting: not recommended for use.
Figure suggestion for illustrations, figures, and maps. The subelements of this element must appear in the order given, as they appear in this order within one \fig ... \fig* container, separated with vertical bars (|).
Picture description in English. This material does not show up on the printed page.
Picture file name. (Used to be a catalog picture reference field, but now it is used for the file name of the acutal picture.)
Picture size for calculation only (not printed).
Picture location/range Book, chapter, and verse (not printed).
Picture copyright info (printed)
Picture caption to be printed.
Picture reference (book, chapter, and verse) to be printed.
Index entry-- not printed as part of the text.
Word level attributes, usually Greek/Hebrew lemma
Used to indicate the Strong's number of a word. Hebrew words are prefixed with "H" and Greek with "G".
If the word form is plural, "plural" may be set to "true". If the word form is singular, "plural" must not be set to "true".
Lemma (root word for lexicon entry of the enclosed word)
Morphology tag using Dr. Maurice Robinson's scheme, explained at http://byztxt.com/download/PARSINGS.TXT and mirrored at http://eBible.org/usfx/parsings.txt.
Source location, like "gnt5:51.1.2.1" for GNT version 5 text, book 51, chapter 1, verse 2, word 1.
Word level attributes, usually Greek/Hebrew lemma
Ruby gloss
Hebrew word list entry-- not printed as part of the text.
Greek word list entry-- not printed as part of the text.
Worldlist/glossary/dictionary reference. This word is to appear in the word list.
This element does not map to any USFM element directly, but its contents do. Its purpose is to facilitate conversion to/from OSIS, XSEM, or similar markup. This corresponds to an OSIS q element with an sID attribute, except that this element contains exactly the quotation punctuation intended by the translator, and which is copied directly into USFM text. It is used in combination with quoteEnd and quoteRemind. All conformant USFX readers are expected to simply use the contents of this element (normally a quotation mark) as part of the text, unless that reader is part of a process to generate or regenerate quotation marks from markup. When converting from OSIS or XSEM, it is the duty of the converting process to supply the correct quotation punctuation, if any, and put it in the contents of this element. When generating or regenerating quotation punctuation from markup, the existing contents of this element are discarded and replaced with the correct punctuation. If the who attribute is set to "Jesus" the import process may optionally generate \wj markup, as well.
This element contains automatically generated open quote reminders at paragraph beginnings. It would normally be generated automatically from quoteStart and quoteEnd elements.
This element ends the most recent un-ended quotation started with quoteStart. This is not a USFM equivalent code, but exists to facilitate conversion to/from OSIS. See the comments for quoteStart for usage.
Introduction outline references range character style
Words of Jesus
Character style
Footnote hyperlink start-- not part of USFM, but equivalent to the GBF RB tag.
This is a milestone (normally empty) element that indicates that the previous word (usually "you" or a verb with an implied "you") is addressed to more than one person. Not in USFM. Equivalent to GBF WTP.
Milestone marker to indicate that the immediately previously mentioned person (name or pronoun) is being addressed directly (first person). Used for some semiautomatic translation applications. Not in USFM; equivalent to GBF WTf.
Chapter label, like "Chapter" or "Psalm" in the target language. If used, this label should be placed before any chapter start labels.
Discretionary, optional line break (for a preferred place to break a line in a title, heading, or poetry line). This is the exact equivalent of the USFM "//" mark, and should be inserted as a milestone with no content.
Scripture reference in the format TLA.c.v, where TLA is the SIL/UBS three letter abbreviation for the book, c is the chapter number, and v is the verse number.
Color red, used to mark ANY direct quotes of God the Father, Son, and Holy Spirit
Color green, used for a class of speaker in color-coded Bible translations like the SourceView Bible.
Color blue, used to mark a class of speaker in color-coded Bible translations like the SourceView Bible and RGB Bible.
Color yellow or gold, used to designate a class of speaker in color-coded Bible translations like the RGB Bible.
Generic paragraph not covered by others, syntax like USX.
Generic character style not covered by more specific elements, mirroring USX usage.
Milestone for OSIS-like speaker markers, mirroring USX usage.
Jump linking marker to define anchors (landing targets), Scripture reference targets (link-href), Internet URLs (link-href), and/or link titles (link-title).
This type consists of the mixed text and tags that can appear in a string such as a title.
Quoted text; Old Testament quotes in the New Testament or other quoted text, such as Jesus' direct quotes. The who attribute may be used to distinguish between these, but USFM makes no distinction. This markup may result in a different character formatting.
Name of Diety: used only to mark God's proper name or a translation of this Name. This may result in special character formatting, such as small caps.
Transliterated or foreign words.
This is intended to mark the first character of a line of acrostic poetry, which may result in the letter being rendered in bold face or may have no effect.
Footnote
Extended Footnote
Crossreference: a footnote used just to indicate a crossreference. It may be positioned differently than footnotes designated with f, and it may use different calling sequences than f does.
Extended crossreference: a footnote used just to indicate a crossreference. It may be positioned differently than footnotes designated with f, and it may use different calling sequences than f does.
Passage of text based on a secondary language source. For example, places where the source text is in Aramaic and not Hebrew could be optionally rendered with a different type style.
Omit in editions not containing the Deuterocanon. Deuterocanonical/LXX additions or insertions in the Protocanonical text. May optionally be rendered differently.
Quoted book title; may toggle italics setting in introductory material.
Proper name; may map to a character style or be ignored.
Keyword-- may map to a character style or be ignored.
Ordinal number ending; may be superscripted and underlined.
Superscript
Additional material; supplied words to make sense in a target language when the translation style is very literal. This would be used to mark the italics in the KJV, for example.
Bold; not recommended for use.
Italic; not recommended for use.
Bold Italic; not recommended for use. Note that character styles do not stack. Only one may apply at a time.
Smallcap text; not recommended for use. Use nd or other appropriate element instead.
Figure suggestion for illustrations, figures, and maps. The subelements of this element must appear in the order given, as they appear in this order within one \fig ... \fig* container, separated with vertical bars (|).
Picture description in English. This material does not show up on the printed page.
Picture file name. (Used to be a catalog picture reference field, but now it is used for the file name of the acutal picture.)
Picture size for calculation only (not printed).
Picture location/range Book, chapter, and verse (not printed).
Picture copyright info (printed)
Picture caption to be printed.
Picture reference (book, chapter, and verse) to be printed.
Index entry-- not printed as part of the text.
Word list entry-- not printed as part of the text.
Used to indicate the Strong's number of a word. Hebrew words are prefixed with "H" and Greek with "G".
If the word form is plural, "plural" may be set to "true". If the word form is singular, "plural" must not be set to "true".
Lemma (root word for lexicon entry of the enclosed word)
Morphology tag using Dr. Maurice Robinson's scheme, explained at http://byztxt.com/download/PARSINGS.TXT and mirrored at http://eBible.org/usfx/parsings.txt.
Hebrew word list entry-- not printed as part of the text.
Greek word list entry-- not printed as part of the text.
Worldlist/glossary/dictionary reference. This word is to appear in the word list.
Words of Jesus
Character style
Footnote hyperlink start-- not part of USFM, but equivalent to the GBF RB tag.
This is a milestone (normally empty) element that indicates that the previous word (usually "you" or a verb with an implied "you") is addressed to more than one person. Not in USFM. Equivalent to GBF WTP.
Milestone marker to indicate that the immediately previously mentioned person (name or pronoun) is being addressed directly (first person). Used for some semiautomatic translation applications. Not in USFM; equivalent to GBF WTf.
Discretionary, optional line break (for a preferred place to break a line in a title, heading, or poetry line). This is the exact equivalent of the USFM "//" mark, and should be inserted as a milestone with no content.
Scripture reference in the format TLA.c.v, where TLA is the SIL/UBS three letter abbreviation for the book, c is the chapter number, and v is the verse number.
Bible passage reference specification. Attributes are src for source (i. e. the verse this reference is in, like "MAT.1.23"), and tgt for the target (i. e. the verse or range of verses this reference is pointing to, like "ISA.7.14" or "ISA.7.14-ISA.7.15"), and web for an Internet URL, like "http://eBible.org/web/webfaq.htm". Only one of tgt or web should be specified. An least one of these three attributes should be specified. Text string content of the element is the human-readable vernacular reference to be displayed, like "Mt. 1:23" or "Matthew 1:23".
Word level attributes, usually Greek/Hebrew lemma
Used to indicate the Strong's number of a word. Hebrew words are prefixed with "H" and Greek with "G".
If the word form is plural, "plural" may be set to "true". If the word form is singular, "plural" must not be set to "true".
Lemma (root word for lexicon entry of the enclosed word)
Morphology tag using Dr. Maurice Robinson's scheme, explained at http://byztxt.com/download/PARSINGS.TXT and mirrored at http://eBible.org/usfx/parsings.txt.
Source location, like "gnt5:51.1.2.1" for GNT version 5 text, book 51, chapter 1, verse 2, word 1.
Witness list (list of manuscript designations containing this reading)
Jump linking marker to define anchors (landing targets), Scripture reference targets (link-href), Internet URLs (link-href), and/or link titles (link-title).
Generic character style not covered by more specific elements, mirroring USX usage.