Markups

  • USFM
  • USX
  • News

May 14, 2018 By Markups Admin

USFM 3.0 Release Notes

  • Full Git Changelog (2.5 > 3.0.0)
  • Issues closed for 3.0.0

These notes combine the 3.0 RC1 and the final 3.0 updates. The USFM documentation contains a separated list of notes for these milestones – acknowledging the significant time period between the published release candidate (RC1) and the final 3.0 specification.

Marker Additions

  • USFM version identifier: \usfm
  • Alternate language table of contents texts: \toca#
  • Letter opening: \po
  • List header and footer elements: \lh and \lf
  • Embedded list: \lim#
  • Hebrew note: \qd
  • Semantic division: \sd#
  • Structured list items: \lik …\lik* and \liv# …\liv#*
  • List item total: \litl …\litl*
  • Geographic proper name (Chinese texts): \png …\png*
  • Ruby annotations (CJK texts): \rb …\rb*
  • Superscript: \sup …\sup*
  • Aramaic wordlist entry: \wa …\wa*
  • List of witnesses in footnotes (for crtical editions): \fw …\fw*
  • Target references “added” text: \xta …\xta*
  • Published cross reference origin text: \xop …\xop*
  • Link text: \jmp …\jmp*
  • Common peripheral identifiers.

Marker Revisions

  • Support citation form for wordlist / glossary text (update \w …\w*).
  • Support for explicit table cell column spanning.
  • Revise syntax for figures / illustrations applying descriptive attributes: \fig …\fig*
  • Deprecated cross reference and footnote DC content markers: \xdc …\xdc* and \fdc …\fdc*
  • Deprecate 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.
  • Restored \pr for use as “text refrain”.

Syntax and Features

  • Syntax for assigning word-level descriptive attributes.
    • Descriptive attributes lemma, strong, srcloc for \w …\w*
    • Descriptive attributes alt, src, size, loc, copy, ref for \fig …\fig*
    • Descriptive attributes gloss for ruby \rb …\rb*
    • Document best practice for attributes containing multiple values, or multiple parts
  • Syntax for assigning word-level linking attributes.
    • Added default link-href linking attribute for \xt …\xt*
  • Syntax for milestones.
    • Quotation start / end milestones: \qt#-s\* and \qt#-e\*.
    • Translator’s section milestones: \ts-s\* and \ts-e\*
  • Syntax for peripheral (\periph) identifiers.

Standard Reference

  • Clarify and document specification regarding whitespace and new lines.

Filed Under: USFM, USFM Release Notes Tagged With: 3.0, releasenotes, usfm

May 14, 2018 By Markups Admin

USX 3.0 Release Notes

  • Full Git Changelog (2.5 > 3.0.0)
  • Issues closed for 3.0.0

Element / Attribute Additions

  • Letter opening: <para> @style po
  • List header and footer elements: <para> @style lh and lf
  • Embedded list: <para> @style lim#
  • Hebrew note: <para> @style qd
  • Semantic division: <para> @style sd#
  • Aramaic wordlist entry: <char> @style wa
  • Geographic proper name (Chinese texts): <char> @style png
  • Target references “added” text: <char> @style xta
  • Published cross reference origin text: <char> @style xop
  • Structured list items: <char> @style lik and liv#
  • List item total: <char> @style litl
  • Link text: <char> @style jmp
  • Ruby glosses (CJK texts): <char> @style rb
  • Milestone element: <ms>
    • Milestone @style types for quotations: qt#-s and qt#-e
      • Add attribute who for qt#-s and qt#-e
    • Milestone @style types for translators sections: ts-s and ts-e
  • <char> @style types providing additional attributes
    • <char> @style w (lemma, strong, scrloc)
    • <char> @style rb (gloss)
  • Verse start sid and end eid identifier attributes for <verse>.
  • Verse identifier vid attribute for <para>.
  • Strategy for applying USX markup to project peripheral contents.
  • Standard peripheral identifiers.

Element / Attribute Revisions

  • Require a <verse> milestone at start and end of verse text.
    • Verse start sid and end eid identifier attributes for <verse>.
  • Require a verse identifier vid attribute for <para> to re-identify the current verse whenever the previous para or table closed prior the end of the current verse text.
  • Support citation form for wordlist / glossary text (update <char> @style lik).
  • Support for explicit table cell column spanning (add attribute colspan to cell).
  • Deprecated cross reference and footnote DC content <char> @style types: xdc and fdc
  • Deprecated numbered running header <para> @style types: h#
  • Deprecated pronunciation info <char> @style pro in favour of ruby glosses <char> @style rb.

Syntax and Features

  • Strategy for applying USX markup to project peripheral contents.
  • Standard peripheral identifiers.

Filed Under: USX, USX Release Notes Tagged With: 3.0, releasenotes, usx

Bible Translation

Development Partners

  • United Bible Societies
  • SIL International
  • Every Tribe Every Nation

Scripture Ecosystem

  • Paratext Registry
  • Scripture Markup (USFM/USX)
  • Publishing Assistant
  • The Digital Bible Library

Copyright © 2018, United Bible Societies, All Rights Reserved.