◇◆
<rb> Ruby Base Text
Usage/Remarks
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 parenthesis after the characters they modify, or to the right of vertically
set text.
In BITS, as in NISO JATS, Ruby annotations are not used within any of the metadata elements such as
<book-meta>, <book-part-meta>, and
<sec-meta>.
Models and Context
May be contained in
Description
Any combination of:
- Text, numbers, or special characters
- Linking Elements
- Related Material Elements
- <hr> Horizontal Rule
- Emphasis Elements
- <bold> Bold
- <fixed-case> Fixed Case
- <italic> Italic
- <monospace> Monospace Text (Typewriter Text)
- <overline> Overline
- <overline-start> Overline Start
- <overline-end> Overline End
- <roman> Roman
- <sans-serif> Sans Serif
- <sc> Small Caps
- <serif> Serif
- <strike> Strike Through
- <underline> Underline
- <underline-start> Underline Start
- <underline-end> Underline End
- <ruby> Ruby Annotation Wrapper
- <alternatives> Alternatives For Processing
- Inline Display Elements
- Inline Math Elements
- Math Elements
- Other Inline Elements
- Internal Linking Elements
- <sub> Subscript
- <sup> Superscript
- <x> X - Generated Text and Punctuation
Content Model
<!ELEMENT rb (#PCDATA %rb-elements;)* >
Expanded Content Model
(#PCDATA | email | ext-link | uri | inline-supplementary-material | related-article | related-object | hr | bold | fixed-case | italic | monospace | overline | overline-start | overline-end | roman | sans-serif | sc | serif | strike | underline | underline-start | underline-end | ruby | alternatives | inline-graphic | inline-media | private-char | chem-struct | inline-formula | tex-math | mml:math | abbrev | index-term | index-term-range-end | milestone-end | milestone-start | named-content | styled-content | fn | target | xref | sub | sup | x)*
Tagged Samples
Multiple Ruby annotations
Formatted
Tagged
... <p>... 畿内や西日本一帯では <ruby><rb>麦</rb><rt>むぎ</rt></ruby>を <ruby><rb>裏</rb><rt>うら</rt></ruby> <ruby><rb>作</rb><rt>さく</rt></ruby>とする二毛作が普及していった。 ...</p> ...
Translation notes in English and Japanese
Formatted
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> ...