Ruby Domain

Provides markup based on the HTML 5 <ruby> elements for annotating ideographic characters as is done in Japanese-language documents.

The ruby domain provides a single top-level element, @@ruby, which then holds some combination of phrase-level content (the text to which the ruby applies), and some combination of <rb>, <rp>, and <rt> elements. These elements correspond directly to the HTML 5 and HTML 4 @@ruby markup (the main difference being that in HTML 5 the <rb> (ruby base) element is not used).

For example, Japanese content with a ruby would be marked up like so:

<p> 探険船シビリアコフ号の北氷洋航海中に撮影されたエピソード映画の中に、一頭の<ruby>
<rb>白熊</rb>
<rp>（</rp>
<rt>しろくま</rt>
<rp>）</rp>
</ruby>を射殺し、その子を生け捕る光景が記録されている。</p>

For HTML output the markup is output exactly as tagged in the DITA source and most browsers will render the ruby text above the base text. When that rendition is not provided, then the ruby text is given after the base text within parantheses.