「テンプレート:Ruby/doc」を編集中

{{Documentation subpage}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
{{warning|Per {{section link|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.}}

{{TemplateStyles|Template:Ruby/styles.css}}
== Usage ==
{{nihongo|'''[[Ruby character]]s'''|ルビ|Rubi}} are small, annotative [[gloss (annotation)|gloss]]es that can be placed above or to the right of a [[Chinese character]] when writing languages with [[logogram|logographic]] characters such as [[Chinese language|Chinese]] or [[Japanese language|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.

* {{tlx|Ruby|人|rén}} → {{Ruby|人|rén}}
* {{tlx|Ruby|人|ひと}} → {{Ruby|人|ひと}}
* {{tlx|Ruby|人|인}} → {{Ruby|人|인}}

The first parameter is the base (the lower part) and the second is the Ruby text (the smaller part on top or in parentheses).

* {{para|large|yes}} enlarges the characters by 250% for use in examples

Examples:

{{markup
|<nowiki>{{Ruby|全|すべ}}て</nowiki>
|{{Ruby|全|すべ}}て

|<nowiki>{{Ruby|媽|mā}}</nowiki>
|{{Ruby|媽|mā}}

|<nowiki>{{Ruby|large=yes|媽|mā}}</nowiki>
|{{Ruby|large=yes|媽|mā}}
}}

== Browser support ==
The manner in which the Ruby characters are displayed is dependent upon the browser. For browser support, see [https://caniuse.com/ruby Ruby annotation] at ''Can I use''.

For example: {{Ruby|Base|top}}

If you see {{overset|top|Base}}, then your browser supports Ruby.

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

== See also ==
* {{tl|ruby line}} for easier annotation of multiple series of characters
* {{tl|ruby-zh-p}} for [[Hanyu Pinyin]]
* {{tl|ruby-zh-b}} for [[Bopomofo]]
* {{tl|ruby-ja}} for Japanese
* {{tl|Linked Ruby}} for easier wikilinks to Ruby annotations
* {{tl|overset}} for oversetting characters for math and similar uses

== TemplateData ==
{{TemplateDataHeader}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Base",
			"description": "Text in Kana or Chinese characters to be annotated",
			"example": "全",
			"type": "line",
			"required": true
		},
		"2": {
			"label": "Annotation",
			"description": "Hiragana, romanization or other transcription; shown above the Base text",
			"example": "すべ",
			"type": "line",
			"required": true
		},
		"large": {
			"label": "Large?",
			"description": "If 'yes', renders text large",
			"example": "yes",
			"type": "string"
		},
		"style": {
			"label": "CSS styling",
			"type": "string",
			"aliases": [
				"css"
			]
		}
	},
	"description": "Shows a Chinese, Kanji or other phrase with Ruby text above it"
}
</templatedata>
<includeonly>{{sandbox other||
<!-- Categories go here, and interwikis go in Wikidata -->
[[Category:Wikipedia XHTML tag-replacing templates]]
[[Category:Pronunciation templates]]
}}</includeonly>