<ruby> (Phonetic Guide)

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 (§2.3.3.26) and the guide text is stored in the <rt> element (§2.3.3.23).

example:

tō東kyō京

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]

Parent Elements

<r> (§7.1.2.87); <r> (§2.3.2.23)

Child Elements

Subclause

<rt> (Phonetic Guide Text)

§2.3.3.23

<rubyBase> (Phonetic Guide Base Text)

§2.3.3.26

<rubyPr> (Phonetic Guide Properties)

§2.3.3.27

The following XML Schema fragment defines the contents of this element:

<complexType name="CT_Ruby">
	<sequence>
	<element name="rubyPr" type="CT_RubyPr"/>
	<element name="rt" type="CT_RubyContent"/>
	<element name="rubyBase" type="CT_RubyContent"/>
	</sequence>
</complexType>