TEI: Guidelines for Electronic Text Encoding and Interchange

P5 Version 4.10.2. Last updated on 4th September 2025, revision bcfa98f42

<ruby>

<ruby> (ruby container) contains a passage of base text along with its associated ruby gloss(es). [3.4.2 Ruby Annotations]

Module core — Elements Available in All TEI Documents

Attributes

att.global
- @xml:id
- @n
- @xml:lang
- @xml:base
- @xml:space
- att.global.analytic
  - @ana
- att.global.change
  - @change
- att.global.facs
  - @facs
- att.global.linking
  - @corresp
  - @synch
  - @sameAs
  - @copyOf
  - @next
  - @prev
  - @exclude
  - @select
- att.global.rendition
  - @rend
  - @style
  - @rendition
- att.global.responsibility
  - @cert
  - @resp
- att.global.source
  - @source
att.cmc
- @generatedBy
att.typed
- @type
- @subtype

Member of

Contained by

analysis: cl phr s

cmc: post

core: abbr add addrLine author biblScope citedRange corr date del distinct editor email emph expan foreign gloss head headItem headLabel hi item l label measure mentioned name note num orig p pubPlace publisher q quote rb ref reg rs rt said sic soCalled speaker stage street term textLang time title unclear unit

dictionaries: case colloc def dictScrap entryFree etym form gen gram gramGrp hyph iType lang lbl mood number orth per pos pron re sense stress subc syll tns usg xr

drama: actor camera caption castItem role roleDesc sound tech view

figures: cell

header: change distributor edition extent geoDecl handNote licence scriptNote

linking: ab seg

msdescription: accMat acquisition additions catchwords collation colophon condition custEvent decoNote explicit filiation finalRubric foliation heraldry incipit layout material musicNotation objectType origDate origPlace origin provenance rubric secFol signatures source stamp summary support surrogates typeNote watermark

namesdates: addName affiliation birth bloc country death district education eventName faith floruit forename genName gender geogFeat geogName nameLink nationality objectName occupation offset orgName persName persPronouns placeName region residence roleName settlement sex socecStatus surname

spoken: u writing

tagdocs: eg

textcrit: lem rdg wit witDetail

textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer

transcr: damage fw metamark mod restore retrace secl supplied surplus

verse: rhyme

May contain

core: rb rt

Example

The word 入学試験 nyūgakushiken (university entrance exam) is glossed with a hiragana phonation guide.

<p xml:lang="ja">

<ruby>
<rb>入学試験</rb>
<rt place="above">にゅうがくしけん</rt>
</ruby>

</p>

Show all ⚓︎

Example

This fictional example shows the initialism TEI glossed letter-by-letter with an IPA transcription.

<ruby>
<rb>T</rb>
<rt>ti:</rt>
</ruby>
<ruby>
<rb>E</rb>
<rt>i:</rt>
</ruby>
<ruby>
<rb>I</rb>
<rt>aɪ</rt>
</ruby>

Show all ⚓︎

Content model

<content>
 <sequence>
 <elementRef key="rb" minOccurs="1"
  maxOccurs="1"/>
 <elementRef key="rt" minOccurs="1"
  maxOccurs="unbounded"/>
 </sequence>
</content>

Schema Declaration

<rng:element name="ruby">
 <rng:ref name="att.global.attributes"/>
 <rng:ref name="att.global.analytic.attributes"/>
 <rng:ref name="att.global.change.attributes"/>
 <rng:ref name="att.global.facs.attributes"/>
 <rng:ref name="att.global.linking.attributes"/>
 <rng:ref name="att.global.rendition.attributes"/>
 <rng:ref name="att.global.responsibility.attributes"/>
 <rng:ref name="att.global.source.attributes"/>
 <rng:ref name="att.cmc.attributes"/>
 <rng:ref name="att.typed.attributes"/>
 <rng:group>
 <rng:ref name="rb"/>
 <rng:oneOrMore>
  <rng:ref name="rt"/>
 </rng:oneOrMore>
 </rng:group>
</rng:element>

element ruby
{
 att.global.attributes,
 att.global.analytic.attributes,
 att.global.change.attributes,
 att.global.facs.attributes,
 att.global.linking.attributes,
 att.global.rendition.attributes,
 att.global.responsibility.attributes,
 att.global.source.attributes,
 att.cmc.attributes,
 att.typed.attributes,
 ( rb, rt+ )
}

[English] [Deutsch] [Español] [Italiano] [Français] [日本語] [한국어] [中文]

TEI Guidelines P5 Version 4.10.2. Last updated on 4th September 2025, revision bcfa98f42. This page generated on 2025年09月04日T16:27:03Z.