Release Notes

---

3.0

USFM 3.0 additions or revisions are highlighted throughout this documentation using the badge

April 2018

Marker Additions

• USFM version identifier: \usfm

• Alternate language table of contents texts: \toca#

• List of witnesses in footnotes (for crtical editions): \fw …\fw*

• Target references “added” text: \xta …\xta*

• Superscript: \sup …\sup*

• Translator’s section (chunk) milestones: \ts-s\* and \ts-e\*

Marker Revisions

• Revised syntax for ruby glosses (CJK texts): \rb …\rb*

  • Add descriptive attribute gloss for \rb …\rb*

• Added default link-href linking attribute for \xt …\xt*

• Changed common attributes for milestones:

  • Replace single id with separate start sid and end eid milestone attributes.
    This update aligns USFM with the corresponding single <ms> milestone element in USX, where the id attrubute content would not be unique for <ms>.

• Changed name of linking attribute link-name to link-id.

• Restored \pr for use as “text refrain”.

Syntax and Features

• Clarify and support syntax for standalone milestones.

• Document best practice for attributes containing multiple values, or multiple parts (see the gloss attribute for \rb …\rb*)

3.0rc1

October 2016

Marker Additions

• Letter opening: \po

• List header and footer elements: \lh and \lf

• Embedded list: \lim#

• Hebrew note: \qd

• Semantic division: \sd#

• Aramaic wordlist entry: \wa …\wa*

• Geographic proper name (Chinese texts): \png …\png*

• Target references “added” text: \xta …\xta*

• Published cross reference origin text: \xop …\xop*

• Structured list items: \lik …\lik* and \liv# …\liv#*

• List item total: \litl …\litl*

• Link text: \jmp …\jmp*

• Common peripheral identifiers

• Ruby glosses (CJK texts): \rb …\rb*

• Quotation start / end milestones: \qt#-s\* and \qt#-e\*

Marker Revisions

• Support citation form for wordlist / glossary text (update \w …\w*).

• Support for explicit table cell column spanning.

• Revised syntax for figures / illustrations applying descriptive attributes: \fig …\fig*

• Deprecated cross reference and footnote DC content markers: \xdc …\xdc* and \fdc …\fdc*

• Deprecated combined marker for proper name within translator’s addition: \addpn …\addpn*

• Deprecated numbered running header: \h#

• Deprecated pronunciation info marker: \pro …\pro* in favour of ruby annotations proposal.

Syntax and Features

• Syntax for assigning word-level descriptive attributes.

  • Descriptive attributes for \w …\w*

  • Descriptive attributes for \fig …\fig*

• Syntax for assigning word-level linking attributes.

• Syntax for milestones.

  • Quotation start / end milestones: \qt#-s\* and \qt#-e\*.

• Syntax for peripheral (\periph) identifiers.

Standard Reference

• Clarify and document specification regarding whitespace and new lines.

2.5

October 2013

Validation (stylesheet) configuration update for ParaTExt 7.5 release.

2.4

June 2013

Marker Additions

• Support for nesting character markup.

Full support for the nested character markup syntax has been included in Paratext >=7.4, Publishing Assistant >=4.1, and the XML export format from Paratext known as “USX”.

2.35

February 2012

Primarily a documentation update.

Paratext 7.3 and beyond provides support for study Bible content authoring, within a single project text, through an enhanced multi-pane editing window. Earlier USFM documentation releases discussed study Bible content markup using one or two additional related project texts. This multi-project authoring configuration is no longer recommended now that there is workable authoring environment supporting a single-project study Bible text. Information relating to study Bible content markup and authoring practice in this documentation supersedes any reference to separate notes or sidebar projects in the earlier release notes (below).

• Deprecated \fs (footnote summary text) - not required when working within a single project study Bible text.

2.3

July 2010

Version numbers for the base USFM stylesheet and the study Bible notes and sidebars stylesheets have been synchronized to 2.3. This reflects the readiness of the ParaTExt 7.1 editor to support study Bible authoring.

Marker Additions

• Added study Bible cross reference marker \ex for adding additional cross-references to the notes project.

Marker Revisions

• DEPRECATED - Study Bible footnote marker \fs for marking a footnote summary text.

• Permit cross references to be added to the study Bible notes project.

• Revised markup specification for study Bible sidebars (now use any title, paragraph, poetry, table, or special text marker elements).

2.2

October 2008

Marker Additions

• Added character markers \xot …\xot* and \xnt …\xnt* for uniquely marking target references to OT and NT passages (use of these markers is optional)

• Added \iqt …\iqt* to mark (scripture) quotations appearing in the introduction.

Marker Revisions

• \imte# now includes an optional numeric variable (multiple levels).

• No-break space should now be marked using ~ (tilde), not !$

2.1

April 2007

Marker Additions

• Added \ili for marking introduction list items.

• Reviewed and finalized Peripheral content markup:

  • Added new back matter books CNC, GLO, TDX, NDX.

  • Added INT book for scripture division Introductions.

  • Updated scheme for marking content divisions in FRT, INT, BAK, OTH

  • Added various new content division markers.

Marker Revisions

• Finalized Study Bible Content markup.

• Reviewed and finalized Peripheral content markup (see “Marker Additions” above).

• Changed \rq …\rq* from paragraph to character level markup.

• Changed \ca …\ca* from paragraph to character level markup.

2.05

June 2006

Marker Additions

• Added \rq for marking inline quotation references.

2.04

October 2005

Marker Additions

• Added \toc3 for providing the standard abbreviation for a book.

2.03

August 2005

Marker Additions

• Added \toc1 and \toc2 for providing and marking long and short table of contents texts.

• Added \fl for marking footnote “label” text items.

• Added \fp for marking footnote additional paragraphs.

2.0

October 2004

The following sections outline changes in USFM from 1.53 to 2.0.

Marker Revisions

• Removed \pdi and \pde, and substitute with embedded text markup (under additions, below)

• Removed \wr ...\wr*. This was really a duplicate of \w …w* used for marking words in the scripture text which are included in the wordlist.

• Removed \ps. This is used in conjunction with \nb to indicate that the paragraph spans the chapter boundary. It should be sufficient to just start the new chapter with \nb and use the appropriate paragraph marker for the previous chapter (\p, \m etc.)

Marker Additions

• Add character style \em …\em* for “emphasis”.

• In Peripherals:

  • Add \intro section to Front Matter (in addition to Preface).

  • Add \maps (Maps Index) section to Back Matter.

  • Paratext will be adjusted to include predefined “standard” books for FRT, BAK, and OTH rather than using the book names XXA, XXB, and XXC for these materials.

• Add \sr for marking the text references range listed under a section heading \s.

• Add the following markers for “embedded text” (see example references – not all versions mark these items the same).

  • \pm - Embedded text paragraph

  • \pmo - Embedded text opening

  • \pmc - Embedded text closing

  • \pmr - Embedded text refrain

  • \qm# - Embedded text poetic line

• Add character style \pro …\pro* for indicating pronunciation (in CJK texts).

• Add character style \wj …\wj* for marking words of Jesus.