View source for Template:Rubi/doc

{{Documentation/Header}}
{{Lua}}
{{CSS}}
This template is used to input [https://www.w3schools.com/tags/tag_ruby.asp ruby] text, which helps form '''furigana''' ({{ja|{{Rubi|振|ふり|仮名|がな}}}}) in Japanese and '''Pinyin reading guide''' {{Rubi|{{zh|米哈游}}|mǐ hā yóu}} in Chinese.

More information can be found [https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-ruby-element here].

==Syntax==
Pairs of text will form a "base" and "explanation" set. If there is an odd pair left out, it will be displayed as "base" text (without an "explanation" tag).

There are three named Parameters:
* {{F|rpStart}} &mdash; the beginning denotation of the "explanation" tag (defaults to an ''open parenthesis'')
* {{F|rpEnd}} &mdash; the ending denotation of the "explanation" tag (defaults to an ''close parenthesis'')
* {{F|large}} &mdash; setting this value to any non-blank value will make the "base" text 250% bigger (fixed value), and the "explanation" text smaller (fixed value)
* {{F|center}} &mdash; setting this value to any non-blank value will make the center the ruby text instead of space it out along the base text.

==Syntax==
{{T|Rubi|日本語|にほんご|_Ybr_=1}}<br />
{{T|Rubi|米哈游|mǐ hā yóu|_Ybr_=1}}<br />
{{T|Rubi|HT|HyperText|M|Markup|L|Language|large=1|_Ybr_=1}}<br />
{{T|Rubi|Very long base text that goes on and on|Short ruby|center=1|_Ybr_=1}}

<noinclude>
[[fr:Modèle:Rubi/doc]]
[[id:Templat:Rubi/doc]]
[[pt-br:Predefinição:Rubi/doc]]
[[vi:Bản mẫu:Rubi/doc]]
</noinclude>