Schema usfx-2006-03-09.xsd


schema location:  C:\sil\Onyx\usfx-2006-03-09.xsd
 
Elements  Complex types 
usfx  pType 


element usfx
diagram
children languageCode rem book
annotation
documentation 
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.

element usfx/languageCode
diagram
type xs:string
annotation
documentation 
Three-letter Ethnologue code or two-letter ISO language code, optionally followed by a dialect indicator.

element usfx/rem
diagram
type xs:string
annotation
documentation 
Remark or comment, not for publication.

element usfx/book
diagram
children id ide rem h cl p q mt d s sectionBoundary b generated c
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  optional      
annotation
documentation 
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).

element usfx/book/id
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
annotation
documentation 
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).

element usfx/book/ide
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
charset  xs:string  optional      
annotation
documentation 
Encoding of the corresponding USFM file. (Encoding of this XML file is given in the XML header.)

element usfx/book/rem
diagram
type xs:string
annotation
documentation 
Remark or comment, not for publication, such as notes about translation status.

element usfx/book/h
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
annotation
documentation 
Short book name for a running header, like "Matthew".

element usfx/book/cl
diagram
type xs:string
annotation
documentation 
Chapter label, like "Chapter" or "Psalm" in the target language. If used, this label should be placed before any chapter start labels.

element usfx/book/p
diagram
type pType
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
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.

element usfx/book/q
diagram
type pType
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
Poetry line "paragraph"

element usfx/book/mt
diagram
type pType
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
The main title of a book of the Bible, such as "The Good News According to Matthew"

element usfx/book/d
diagram
type pType
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
Descriptive title of a Psalm (Hebrew title)

element usfx/book/s
diagram
type pType
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
Section heading (not part of the Scripture text).

element usfx/book/sectionBoundary
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
sfm  xs:string  required      
level  xs:unsignedByte  optional      
annotation
documentation 
This marker is a place to encode proposed markers such as \pub, \toc, \pref, \conc, \glo, \idx, \cov, \spine, \and environment markers. 

element usfx/book/b
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
Blank line between stanzas of poetry; not to be used before or after a section header. This element should be empty.

element usfx/book/generated
diagram
type extension of xs:string
annotation
documentation 
This element surrounds content generated from other elements. This tag and its contents is discarded when converting back to USFM.

element usfx/book/c
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  optional      
annotation
documentation 
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, which are optional and may be discarded.

complexType pType
diagram
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
used by
elements pType/add pType/cs usfx/book/d pType/dc usfx/book/mt usfx/book/p usfx/book/q pType/qt usfx/book/s pType/sls pType/table/tr/tc pType/table/tr/tcr pType/table/tr/th pType/table/tr/thr pType/tl pType/wj
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
This type consists of the mixed text and tags that can appear inside any paragraph.

element pType/c
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
annotation
documentation 
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.

element pType/v
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string        
annotation
documentation 
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).

element pType/qt
diagram
type pType
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
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.

element pType/nd
diagram
type xs:string
annotation
documentation 
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.

element pType/tl
diagram
type pType
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
Transliterated or foreign words.

element pType/milestone
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
sfm  xs:string  required      
level  xs:unsignedByte  optional      
attribute  xs:string  optional      
annotation
documentation 
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.

element pType/ca
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:string  required      
annotation
documentation 
Alternate chapter numbering scheme chapter start marker

element pType/cp
diagram
type xs:string
annotation
documentation 
Published chapter marker, which may be used to override the numeric marker generated from the c element.

element pType/va
diagram
type xs:string
annotation
documentation 
Alternate verse number (starting point).

element pType/vp
diagram
type xs:string
annotation
documentation 
Published verse marker (starting point); overrides marker generated from v id attribute.

element pType/qs
diagram
type xs:string
annotation
documentation 
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.

element pType/qac
diagram
type xs:string
annotation
documentation 
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.

element pType/table
diagram
children tr
annotation
documentation 
Table (i. e. for tables of weights and measures in helps).

element pType/table/tr
diagram
children th thr tc tcr
annotation
documentation 
Row

element pType/table/tr/th
diagram
type pType
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
Table column heading

element pType/table/tr/thr
diagram
type pType
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
Table column heading, right aligned

element pType/table/tr/tc
diagram
type pType
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
Table column entry within this row. The level attribute gives the position of the column.

element pType/table/tr/tcr
diagram
type pType
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
Table column entry, right justified. The level attribute gives the position of the column.

element pType/generated
diagram
type xs:string
annotation
documentation 
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.

element pType/f
diagram
children fr fk fq fqa fv ft fdc generated
attributes
Name  Type  Use  Default  Fixed  Annotation
caller  xs:string  optional  +    
sfm  xs:string  optional      
annotation
documentation 
Footnote

element pType/f/fr
diagram
type xs:string
annotation
documentation 
Footnote reference: the chapter and verse that this note refers to, to be printed (normally at the beginning of the note).

element pType/f/fk
diagram
type xs:string
annotation
documentation 
Footnote keyword; the specified word(s) for which the footnote is being provided.

element pType/f/fq
diagram
type xs:string
annotation
documentation 
Quotation from the Scripture text; the current and/or alternative translation of a portion of the Scripture.

element pType/f/fqa
diagram
type xs:string
annotation
documentation 
Alternative translation (may be rendered differently than fq to distinguish between current and alternative readings, if desired).

element pType/f/fv
diagram
type xs:string
annotation
documentation 
Footnote verse number; a verse number in the text of the footnote.

element pType/f/ft
diagram
type xs:string
annotation
documentation 
The actual text of the footnote. This is equivalent to text not enclosed in an element within f.

element pType/f/fdc
diagram
type xs:string
annotation
documentation 
The text within this element is to be omitted in editions not containing the Deuterocanon.

element pType/f/generated
diagram
type xs:string

element pType/fm
diagram
type xs:string
annotation
documentation 
Manually designated footnote mark -- NOT RECOMMENDED FOR USE.

element pType/x
diagram
children xo xk xq xt xdc generated
attributes
Name  Type  Use  Default  Fixed  Annotation
caller  xs:string  optional  +    
sfm  xs:string  optional      
annotation
documentation 
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.

element pType/x/xo
diagram
type xs:string
annotation
documentation 
Cross reference origin; the chapter and verse location the target references refer to.

element pType/x/xk
diagram
type xs:string
annotation
documentation 
Cross reference keyword

element pType/x/xq
diagram
type xs:string
annotation
documentation 
Quotation from the Scripture text.

element pType/x/xt
diagram
type xs:string
annotation
documentation 
Target references; a list of the target cross references for the origin reference.

element pType/x/xdc
diagram
type xs:string
annotation
documentation 
Omit for editions not containing the Deuterocanon.

element pType/x/generated
diagram
type xs:string

element pType/sls
diagram
type pType
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
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.

element pType/dc
diagram
type pType
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
Omit in editions not containing the Deuterocanon. Deuterocanonical/LXX additions or insertions in the Protocanonical text. May optionally be rendered differently.

element pType/bk
diagram
type xs:string
annotation
documentation 
Quoted book title; may toggle italics setting in introductory material.

element pType/pn
diagram
type xs:string
annotation
documentation 
Proper name; may map to a character style or be ignored.

element pType/k
diagram
type xs:string
annotation
documentation 
Keyword-- may map to a character style or be ignored.

element pType/ord
diagram
type xs:string
annotation
documentation 
Ordinal number ending; may be superscripted and underlined.

element pType/add
diagram
type pType
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
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.

element pType/sig
diagram
type xs:string
annotation
documentation 
Signature of the author of an epistle, such as "Greetings from Paul." This may or may not be rendered differently.

element pType/bd
diagram
type xs:string
annotation
documentation 
Bold; not recommended for use.

element pType/it
diagram
type xs:string
annotation
documentation 
Italic; not recommended for use.

element pType/bdit
diagram
type xs:string
annotation
documentation 
Bold Italic; not recommended for use. Note that character styles do not stack. Only one may apply at a time.

element pType/sc
diagram
type xs:string
annotation
documentation 
Smallcap text; not recommended for use. Use nd or other appropriate element instead.

element pType/no
diagram
type xs:string
annotation
documentation 
Normal text within other formatting: not recommended for use.

element pType/fig
diagram
children description catalog size location copyright caption reference
annotation
documentation 
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 (|).

element pType/fig/description
diagram
type xs:string
annotation
documentation 
Picture description in English.  This material does not show up on the printed page.

element pType/fig/catalog
diagram
type xs:string
annotation
documentation 
Picture catolog identification or file name. This material does not show up on the printed page.

element pType/fig/size
diagram
type xs:string
annotation
documentation 
Picture size for calculation only (not printed).

element pType/fig/location
diagram
type xs:string
annotation
documentation 
Picture location/range Book, chapter, and verse (not printed).

element pType/fig/copyright
diagram
type xs:string
annotation
documentation 
Picture copyright info (printed)

element pType/fig/caption
diagram
type xs:string
annotation
documentation 
Picture caption to be printed.

element pType/fig/reference
diagram
type xs:string
annotation
documentation 
Picture reference (book, chapter, and verse) to be printed.

element pType/ndx
diagram
type xs:string
annotation
documentation 
Index entry-- not printed as part of the text.

element pType/w
diagram
type xs:string
annotation
documentation 
Word list entry-- not printed as part of the text.

element pType/wh
diagram
type xs:string
annotation
documentation 
Hebrew word list entry-- not printed as part of the text.

element pType/wg
diagram
type xs:string
annotation
documentation 
Greek word list entry-- not printed as part of the text.

element pType/wr
diagram
type xs:string
annotation
documentation 
Worldlist/glossary/dictionary reference. This word is to appear in the word list.

element pType/quoteStart
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
who  xs:string  optional      
annotation
documentation 
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.

element pType/quoteRemind
diagram
type xs:string
annotation
documentation 
This element contains automatically generated open quote reminders at paragraph beginnings. It would normally be generated automatically from quoteStart and quoteEnd elements.

element pType/quoteEnd
diagram
type xs:string
annotation
documentation 
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.

element pType/ior
diagram
type xs:string
annotation
documentation 
Introduction outline references range character style

element pType/wj
diagram
type pType
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
Words of Jesus

element pType/cs
diagram
type pType
children c v qt nd tl milestone ca cp va vp qs qac table generated f fm x sls dc bk pn k ord add sig bd it bdit sc no fig ndx w wh wg wr quoteStart quoteRemind quoteEnd ior wj cs fs wtp da cl
attributes
Name  Type  Use  Default  Fixed  Annotation
level  xs:unsignedByte  optional      
sfm  xs:string  optional      
style  xs:string  optional      
annotation
documentation 
Character style

element pType/fs
diagram
type xs:string
annotation
documentation 
Footnote hyperlink start-- not part of USFM, but equivalent to the GBF RB tag.

element pType/wtp
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
sfm  xs:string  optional      
annotation
documentation 
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.

element pType/da
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
sfm  xs:string  optional      
annotation
documentation 
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 USFX; equivalent to GBF WTf.

element pType/cl
diagram
type xs:string
annotation
documentation 
Chapter label, like "Chapter" or "Psalm" in the target language. If used, this label should be placed before any chapter start labels.


XML Schema documentation generated with
XMLSPY Schema Editor http://www.altova.com/xmlspy