<ruby> Ruby Annotation Wrapper

An inline wrapper element that surrounds some of the document narrative text in the same way a bold or italic emphasis would. The <ruby> element contains some of the document narrative text (inside a Ruby Base <rb> element) and applies/associates a Ruby Textual Annotation (inside an <rt> element to that base text.

Usage/Remarks

In JATS, the <ruby> element is an inline wrapper element that contains some of the document narrative text (inside a Ruby Base <rb> element) and associates that base text with a Ruby Textual Annotation (inside an <rt> element).
What is Ruby
A Ruby textual annotation is an annotation, typically short, applied to a letter, word, phrase, or name that appears in narrative text. Ruby annotations can indicate, for example, pronunciation advice, notes for translation, semantic annotations, etc. Ruby is used with Japanese, for example, in Furigana, which typically uses Hiragana annotations on Kanji base text. Ruby is also used in Chinese Pīnyīn (a phonetic system for transcribing the sound of Chinese characters into Latin script) as well as for some Korean names. In display or print, the characters of a Ruby annotation are frequently placed above the characters they modify, in parentheses after the characters they modify, or to the right of vertically set text.
Attributes

Base Attributes

Models and Context
May be contained in
<abbrev>, <abbrev-journal-title>, <addr-line>, <aff>, <alt-title>, <anonymous>, <article-title>, <attrib>, <award-id>, <bold>, <chapter-title>, <chem-struct>, <code>, <collab>, <comment>, <compound-kwd-part>, <compound-subject-part>, <conf-acronym>, <conf-loc>, <conf-name>, <conf-num>, <conf-sponsor>, <conf-theme>, <copyright-statement>, <corresp>, <data-title>, <date-in-citation>, <def-head>, <degrees>, <disp-formula>, <edition>, <element-citation>, <email>, <etal>, <ext-link>, <fax>, <fixed-case>, <funding-source>, <funding-statement>, <given-names>, <gov>, <history>, <inline-formula>, <inline-media>, <inline-supplementary-material>, <institution>, <issue>, <issue-part>, <issue-sponsor>, <issue-subtitle>, <issue-title>, <italic>, <journal-subtitle>, <journal-title>, <kwd>, <label>, <license-p>, <meta-name>, <meta-value>, <mixed-citation>, <monospace>, <named-content>, <on-behalf-of>, <overline>, <p>, <part-title>, <patent>, <phone>, <prefix>, <preformat>, <price>, <product>, <publisher-loc>, <publisher-name>, <rb>, <related-article>, <related-object>, <role>, <roman>, <sans-serif>, <sc>, <see>, <see-also>, <self-uri>, <series>, <series-text>, <series-title>, <sig>, <sig-block>, <source>, <speaker>, <std>, <std-organization>, <strike>, <string-conf>, <string-date>, <string-name>, <styled-content>, <sub>, <subject>, <subtitle>, <suffix>, <sup>, <supplement>, <support-source>, <surname>, <target>, <td>, <term>, <term-head>, <textual-form>, <th>, <title>, <trans-source>, <trans-subtitle>, <trans-title>, <underline>, <unstructured-kwd-group>, <uri>, <verse-line>, <version>, <volume>, <volume-id>, <volume-series>, <x>, <xref>
Description
Content Model
<!ELEMENT  ruby         %ruby-model;                                 >
Expanded Content Model

(rb, (rt | (rp, rt, rp)))

Tagged Samples
Multiple annotations
Formatted
../graphics/ruby2.png
Tagged
...
<p>... 畿内や西日本一帯では
 <ruby><rb>麦</rb><rt>むぎ</rt></ruby><ruby><rb>裏</rb><rt>うら</rt></ruby>
 <ruby><rb>作</rb><rt>さく</rt></ruby>とする二毛作が普及していった。
 ...</p>
...
Including English and Japanese translation notes
Formatted
../graphics/ruby-scotland-yard.png
Tagged
...
<p>... あの
 <ruby><rb>ロンドン警視庁</rb><rt xml:lang="en">Scotland Yard</rt></ruby>
 は霧の中に隠れていた。or あの
 <ruby><rb>ロンドン警視庁</rb><rt xml:lang="ja">ろんどんけいしちょう</rt>
 </ruby>は霧の中に隠れていた。 ...</p>
...
Ruby in English text
...
<p>In the midst of the document text, we find:
 <ruby><rb>多武峰</rb><rt>とうのみね</rt></ruby>, 
 and yet another example:
 <ruby><rb>汉</rb><rt>hàn</rt></ruby>
 <ruby><rb>字</rb><rt>zì</rt></ruby>.</p>
...
Related Resources