Ruby annotations (add char@style rb)

Updated: January 2018

In the course of implementing support for ruby editing in one application (Paratext), the specification and markup needs were clarified and refined. Note the following updated proposal. The original proposal has been retained at the end of this description.

Proposal

Add rb to the supported @style attributes list for <char> for ruby "base text" - the text being annotated with ruby character(s).
Extend <char style="rb"> with the following attributes:

Attributes

gloss - ruby glosses
- Use of a colon : to separate multiple pieces within a phrase gloss.

<char style="rb" gloss="gg:gg">BB</char>

Supporting a null gloss: Allow parts of the gloss to be empty

In order to preserve the whole phrase unit (rather than breaking off just the characters that have glosses), USX needs some way to specify a null gloss piece. Since the separator character (colon :) is visible, a visible character for null gloss is not strictly needed.

Allow any slot in the gloss attribute string to be empty.
- If the publication decision is to gloss by character, then skip the corresponding base character when aligning glosses above base characters (or gloss it using whitespace).

Examples of omission:

Second and fourth base characters are unglossed:

<char style="rb" gloss="g1::g3:">BBBB</char>

Second base character is unglossed:

<char style="rb" gloss="つく::ぬし">神の子</char>

This is the USX companion to USFM 3.0 proposal "Ruby annotations (CJK texts) (add \rb ...\rb; add \rt ...\rt)". See: ubsicap/usfm#31 for detail.

OUTDATED Proposal

Add rb to the supported @style attributes list for for ruby "base text" - the text being annotated with ruby character(s).
Add rt to the supported @style attributes list for for "ruby text"

ubsicap / usx