New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Syntax for peripheral (\periph) identifiers #28

klassenjm opened this Issue Jul 8, 2016 · 0 comments


None yet
1 participant

klassenjm commented Jul 8, 2016


To ensure that an id is applied correctly for any USX which is generated from USFM, peripheral identifiers may be specifically associated with a USFM \periph division marker. Standardized identifiers will allow software to easily select content for recognized peripheral divisions. The syntax for peripheral identifiers follows the USFM 3.0 recommendation for assigning word-level attributes (USFM 3.0 #24): attribute = "value". The attribute name is id. The value is wrapped in quotes.

See: Common peripheral identifiers (USFM 3.0 #29)

A related USX 3.0 proposal exists at: ubsicap/usx#21

User Defined Peripheral Division Identifiers

A project text which includes peripheral content beyond the common peripheral identifiers (USFM 3.0 #29) should add the prefix x- to a user defined id value.


Example USFM with optional division id attributes:

\id FRT
\periph Title Page|id="title"
\mt1 Holy Bible
\mt3 with
\mt2 Deuterocanonicals/Apocrypha
\periph Foreword|id="foreword"
\h Foreword
\mt1 Foreword
\p The \bk Good News Translation\bk* 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.
\periph Table of Contents|id="contents"
\h Table of Contents
\mt Contents
\s Old Testament
\tr  \th1 Name  \thr2 Page \th3 Name \thr4 Page
\tr \tc1 Genesis \tcr2 # \tc3 Ecclesiastes \tcr4 #
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment