Template:Ruby

{{{1}}}({{{2}}})

Template documentation[view] [edit] [history] [purge]

Usage

Ruby characters (ルビ, Rubi) are small, annotative glosses that can be placed above or to the right of a Chinese character when writing languages with logographic characters such as Chinese or Japanese to show the pronunciation. Typically called just ruby or rubi, such annotations are used as pronunciation guides for characters that are likely to be unfamiliar to the reader.

• {{Ruby|人|rén}} → 人(rén)
• {{Ruby|人|じん}} → 人(じん)
• {{Ruby|人|인}} → 人(인)

The first parameter is the base (the lower part) and the second is the Ruby text (the smaller part on top or in parentheses).

• |large=yes enlarges the characters by 250% for use in examples

Examples:

Markup	Renders as
{{Ruby|全|すべ}}て	全(すべ)て
{{Ruby|媽|mā}}	媽(mā)
{{Ruby|large=yes|媽|mā}}	媽(mā)

Browser support

The manner in which the Ruby characters are displayed is dependent upon the browser. For browser support, see Ruby annotation at Can I use.

For example: Base(top)

If you see topBase, then your browser supports Ruby.

If you see Base (top), then your browser does not support Ruby.

See also

• {{ruby line}} for easier annotation of multiple series of characters
• {{ruby-zh-p}} for Hanyu Pinyin
• {{ruby-zh-b}} for Bopomofo
• {{ruby-ja}} for Japanese
• {{Linked Ruby}} for easier wikilinks to Ruby annotations
• {{overset}} for oversetting characters for math and similar uses

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Ruby in articles based on its TemplateData.

TemplateData for Ruby

Shows a Chinese, Kanji or other phrase with Ruby text above it

Template parameters[Edit template data]

Parameter		Description	Type	Status
Base	1	Text in Kana or Chinese characters to be annotated Example 全	Line	required
Annotation	2	Hiragana, romanization or other transcription; shown above the Base text Example すべ	Line	required
Large?	large	If 'yes', renders text large Example yes	String	optional
CSS styling	style css	no description	String	optional

The above documentation is transcluded from Template:Ruby/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
Add categories to the /doc subpage. Subpages of this template.