This page is In Progress

Notice: The WebPlatform project, supported by various stewards between 2012 and 2015, has been discontinued. This site is now available on github.

ruby

Summary

The ruby element allows one or more spans of phrasing content to be marked with ruby annotations. Ruby annotations are short runs of text presented alongside base text, primarily used in East Asian typography as a guide for pronunciation or to include other annotations.

Overview Table

DOM Interface
HTMLElement

Ruby annotations are short runs of text presented alongside base text, primarily used in East Asian typography as a guide for pronunciation or to include other annotations.

In Japanese, this form of typography is also known as furigana.

Examples

This example uses the RUBY element to specify the first string of text as the base, and the RT element to specify the second string of text as the ruby.


<ruby>
  <rb>Base Text</rb>
  <rt>Ruby Text</rt>
</ruby>

View live example

In this example, each ideograph in the Japanese text 漢字 is annotated with its reading in hiragana.


<p lang="ja">...<ruby><rt>かん</rt><rt></rt></ruby>...</p>

Notes

Remarks

A ruby is an annotation or pronunciation guide for a string of text. The string of text annotated with a ruby is referred to as the base. The only valid object within the RUBY element is the RT element. Text not contained within the ruby text object, RT, is assumed to be a part of the base. This element is available in HTML and script as of Microsoft Internet Explorer 5.

Related specifications

HTML 5.1
W3C Working Draft
HTML 5
W3C Recommendation

See also

Related articles

Ruby

External resources

Related pages

  • rt

Attributions