Peripherals¶
The following strategy should be used for applying USX markup to project peripheral contents.
Content should be created in separate files according to the general groupings presented in the table below. As with scripture text books, a book element with appropriate @code
attribute is used for identifying the overall content of the peripheral file. Within each peripheral file, divisions (sub-sections) of content are denoted using the element <periph> followed by an additional division title. Content is added to books and divisions by re-purposing the most appropriate existing USFM marker for the selected content.
Some back matter content is large enough that it is most practical to store it within its own book file (Concordance, Glossary, Topical Index, Names Index). Content self contained within a separate book file does not require an additional identifier (only book @code
).
Peripheral Books and Divisions¶
Front Matter
|
Introductions
|
Back Matter
|
---|---|---|
Divisions |
Divisions |
Divisions |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Additional Back Matter |
|
|
Concordance
|
|
|
Glossary
|
|
|
Topical Index
|
|
|
Names Index
|
|
|
Other
|
|
Divisions |
|
|
||
|
Peripheral Identifiers¶
For books containing a peripheral division, the <periph> container element should identify the content using a standard peripheral identifier id
attribute. The defined id
values are shown in the peripheral divisions table above. The set of standardized identifiers allow software processes to easily select content for recognized peripheral divisions. The <periph> element’s alt
attribute provides an alternate title or identifier (possibly vernacular) for the peripheral content.
Text samples with peripheral division identifier attributes:
<?xml version="1.0" encoding="utf-8"?>
<usx version="3.0">
<book code="FRT" style="id">Good News Translation Front Matter</book>
<periph alt="Title Page" id="title">
<para style="mt1">Holy Bible</para>
<para style="mt3">with</para>
<para style="mt2">Deuterocanonicals/Apocrypha</para>
</periph>
</usx>
<?xml version="1.0" encoding="utf-8"?>
<usx version="3.0">
<book code="FRT" style="id">Good News Translation Front Matter</book>
<periph alt="Foreword" id="foreword">
<para style="h">Foreword</para>
<para style="mt1">Foreword</para>
<para style="p">The <char style="bk">Good News
Translation</char> of the Bible is a translation which
seeks to state clearly and accurately the meaning of the
original texts in words and forms that are widely accepted
by people who use English as a means of
communication.</para>
</periph>
</usx>
<?xml version="1.0" encoding="utf-8"?>
<usx version="3.0">
<book code="FRT" style="id">Good News Translation Front Matter</book>
<periph alt="Table of Contents" id="contents">
<para style="h">Contents</para>
<para style="mt1">Contents</para>
<para style="s">Old Testament</para>
<table>
<row style="tr">
<cell style="th1" align="start">Name</cell>
<cell style="th2" align="start">Page</cell>
<cell style="th3" align="start">Name</cell>
<cell style="th3" align="start">Page</cell>
</row>
<row style="tr">
<cell style="th1" align="start">Genesis</cell>
<cell style="th2" align="start">#</cell>
<cell style="th3" align="start">Ecclesiastes</cell>
<cell style="th3" align="start">#</cell>
</row>
...
</table>
...
</periph>
</usx>
User Defined Peripheral Divisions¶
A project may add peripheral content for a division not defined in the current USX set. The new division should be enclosed in <periph> container element and with a user defined id
attribute beginning with the prefix x-
.
USX compliant publishing applications should consider the pre-defined divisions and identifiers as a reference for content to support.
Markup for Peripheral Divisions¶
In the following topics there is a recommendation and a brief description of the USX <para> and <char> @style types which will be most appropriate for use in each peripheral content division. The recommended markup is sufficient for most projects and should be used as a first option. However, in general, any suitable <para> and <char> @style types may be used if the required content cannot be adequately encoded using the recommended set.