Template:Ruby
{{{1}}}
Documentation for Ruby
Description
{{Ruby|<base>|<annotation>}}
Ruby annotation is a feature that allows small text (the "annotation") to be displayed above the base text.
Examples
- A basic annotation
{{Ruby|東京|とうきょう}}
generates: 東京
- Making it larger
{{Ruby|迷途城堡|Hassle Castle|large=yes}}
generates: 迷途城堡
- Adding custom CSS styling
{{Ruby|迷途城堡|Hassle Castle|style=color:red;}}
generates: 迷途城堡
- Adding custom CSS styling to the top
{{Ruby|迷途城堡|Hassle Castle|style2=color:red;}}
generates: 迷途城堡
- Using the lang parameters
{{Ruby|Hello|lang=en|こんにちは|lang2=ja}}
generates: Hello
Parameters
- unnamed parameter 1 (base)
- Text to be annotated. This is the content that you want to provide pronunciation or additional information for.
- unnamed parameter 2 (annotation)
- Text shown above the base text.
- lang (Optional)
- Sets the language of the base text. Defaults to page language (ja, zh-hant, zh-hans etc.).
- lang2 (Optional)
- Sets the language of the annotation. Defaults to page language (ja, zh-hant, zh-hans etc.).
- large (Optional)
- Makes the text larger.
- style / css (Optional)
- Additional CSS styling for the element (<ruby> tag).
- style2 / css2 (Optional)
- Additional CSS styling for the annotation (<rt> tag).