Mattk4355: Created page with "{{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 "explan..."

2025-08-31T02:27:31Z

Created page with "{{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 "explan..."

New page

{{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}} — the beginning denotation of the "explanation" tag (defaults to an ''open parenthesis'')
* {{F|rpEnd}} — the ending denotation of the "explanation" tag (defaults to an ''close parenthesis'')
* {{F|large}} — 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}} — 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}}
<templatedata>
{
"params": {
"1": {
"label": "Base Text 1",
"type": "string",
"required": true
},
"2": {
"label": "Explanation Text 1",
"type": "string",
"suggested": true
},
"3": {
"label": "Base Text 2",
"type": "string"
},
"4": {
"label": "Explanation Text 1",
"type": "string"
},
"rpStart": {
"description": "the beginning denotation of the \"explanation\" tag (defaults to an open parenthesis)",
"type": "string",
"default": "("
},
"rpEnd": {
"description": "the ending denotation of the \"explanation\" tag (defaults to an close parenthesis)",
"type": "string",
"default": ")"
},
"large": {
"type": "boolean",
"description": "setting this value to any non-blank value will make the \"base\" text 250% bigger (fixed value), and the \"explanation\" text smaller (fixed value)"
},
"center": {
"type": "boolean",
"description": "setting this value to any non-blank value will make the center the ruby text instead of space it out along the base text"
}
},
"format": "inline",
"description": "This template is used to input ruby text, which helps form furigana in Japanese and Pinyin reading guide in Chinese. Please see the documentation page for a full explanation of the parameters.",
"paramOrder": [
"1",
"2",
"3",
"4",
"rpStart",
"rpEnd",
"large",
"center"
]
}
</templatedata>

Template:Rubi/doc - Revision history