{{{1}}}
 | This is the template sandbox page for Template:Ruby (diff). See also the companion subpage for test cases. |
 | Per Wikipedia:Manual of Style/Japan-related articles § Ruby, do not use this template in articles, except when they are about ruby characters themselves, or it is needed to accurately quote something that includes ruby characters. |
 | This template uses TemplateStyles: |
Usage
[edit]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.
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=yesenlarges 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
If you see , then your browser supports Ruby.
If you see Base (top), then your browser does not support Ruby.
See also
[edit]- {{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
- {{overset}} for oversetting characters for math and similar uses
TemplateData
[edit]TemplateData for Ruby
Shows a Chinese, Kanji or other phrase with Ruby text above it
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Base | 1 | Text in Kana or Chinese characters to be annotated
| Line | required |
| Annotation | 2 | Hiragana, romanization or other transcription; shown above the Base text
| Line | required |
| Large? | large | If 'yes', renders text large
| String | optional |
| CSS styling | style css | no description | String | optional |