Identification

Top  Previous  Next

Markers in this section:

\id, \ide, \sts, \rem, \h, \toc1, \toc2, \toc3

\id_<CODE>_(Name of file, Book name, Language, Last edited, Date etc.)

·File identification.
·This is the initial USFM marker in any scripture text file.
·CODE is normally the standard 3 letter UBS/SIL scripture book abbreviation.

 

hmtoggle_arrow1Example

Text - Matthew (GNT)

\id MAT 41MATGNT92.PTX, Good News Translation, June 2003

Formatting Example

The text following this marker is not normally used in any formatted presentation.

\ide_<ENCODING>

·An optional character encoding specification.
·This marker should be used to specify the character encoding of the text within the file. For example: CP-1252, CP-1251, UTF-8, UTF-16, OR Custom <specify font name>. If the character encoding does not conform to a known standard, but is rather a customized solution for the project, a minimum of the name of the font used for the project should be included. For archive purposes, texts which rely upon a custom encoding solution should be converted to Unicode, if at all possible.

 

hmtoggle_arrow1Examples

Text - Matthew (GNT)

\ide UTF-8

\ide CP-1252

\ide Custom (TGUARANI.TTF)

Formatting Example

The text following this marker is not normally used in any formatted presentation.

\sts_<STATUS CODE>

·Project text status tracking.
·The contents of the status marker can be defined by the downstream system being used to track project status.
·Multiple status entries can be contained in a book to indicate that various portion of the text are present with different draft levels. If an entire book is complete at a given status level, only one status entry is required.

 

information

For UBS TMS tracked projects the contents of the field must be a single digit, as follows:

·1 (first draft)
·2 (team draft)
·3 (reviewed draft)
·4 (clean text)

 

hmtoggle_arrow1Example

Text

\sts 2

Formatting Example

The text following this marker is not normally used in any formatted presentation.

\rem_text...

·Used for adding brief comments by a translator, consultant, or support person.

 

hmtoggle_arrow1Example

Text

\rem Assigned to <translator's name>.

\rem First draft complete, waiting for checks.

Formatting Example

The text following this marker is not normally used in any formatted presentation.

\h#_text...

·Running header text.
·The variable # represents distinct components or levels of text required for the running header presentation (e.g. inside, outside, sub-division/section etc.).

 

hmtoggle_arrow1Example

Text - Matthew (GNT)

\h Matthew

Formatting Example

h

\toc1_text...

·Long table of contents text.

\toc2_text...

·Short table of contents text.

\toc3_text...

·Book abbreviation.

 

hmtoggle_arrow1Example

Text - Matthew (GNT)

\h Matthew

\toc1 The Gospel According to Matthew

\toc2 Matthew

\toc3 Mat

Formatting Example

toc

 

information

Implementing toc1 and toc2:

 

The \toc1, \toc2, and \toc3 markers are provided to assist publishing tools in automating the generation of a table of contents. They can be included in the main text file for each scripture book, after \h. They are not for use directly within the front matter (FRT) peripheral file.

 

If you are working with the Publishing Assistant InDesign publishing path, the following markup is needed for generating an automatic table of contents:

·Addition of \toc1 (and optionally \toc2) markers after \h, within each scripture book (\toc3 is not yet supported).
·Addition of the "\periph Table of Contents" (USFM 2.0 = \toc) sub-group marker within the FRT peripheral file.

Complete details of this process are provided in the linkWeb Publishing Assistant User Guide.