17.3.3.25 ruby

This element specifies the presence of a phonetic guide at the current location in the document. A phonetic guide (often called ruby text) is a run of content with base text which appears at the normal baseline location for text in this run, with phonetic guide text displayed above it in the document. The resulting construct is called a phonetic guide as it is typically used to map words in one language to another phonetically.

The base text is stored in the rubyBase element (17.3.3.27) and the guide text is stored in the rt element (17.3.3.24).

[Example: Consider the following two runs, each containing a phonetic guide:

The first run would be specified using the following WordprocessingML:

<w:r>
  <w:ruby>
    <w:rubyPr>
      …
    </w:rubyPr>
    <w:rt>
      …
      <w:r>
          <w:t>tō</w:t>
      </w:r>
    </w:rt>
    <w:rubyBase>
      …
      <w:r>
          <w:t>東/<w:t>
      </w:r>
    </w:rubyBase>
  </w:ruby>
</w:r>

The base text is contained in a run within the rubyBase element, and the guide text is contained in a run within the rt element. end example]

[Note: The W3C XML Schema definition of this element’s content model (CT_Ruby) is located in A.1. end note]