Template:Ruby

From Wikisource
Jump to navigation Jump to search

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

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


Usage[edit]

Template:Nihongo 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|Base|top}}Base (top)

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ā}}

()

{{Ruby|large=yes|媽|mā}}

()

Browser support[edit]

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 Template:Overset, then your browser supports Ruby.

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

See also[edit]


TemplateData[edit]

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Ruby

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

[Edit template data]

Template parameters

ParameterDescriptionTypeStatus
Base1

Text in Kana or Chinese characters to be annotated

Example
Linerequired
Annotation2

Hiragana, romanization or other transcription; shown above the Base text

Example
すべ
Linerequired
Large?large

If 'yes', renders text large

Example
yes
Stringoptional
CSS stylingstyle css

no description

Stringoptional