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

{{Documentation subpage|種類=[[Help:テンプレート|テンプレート]]}}
{{Uses TemplateStyles|Template:Ruby/styles.css}}
{{注意|このテンプレートを[[Help:記事とは何か|記事]]の本文で使うことは、原則として禁止されています。例外的に使用が認められるケースについては[[WP:NORUBY]]をご覧ください。}} 
ruby要素を使って[[ルビ]]（[[読み仮名]]など）付きの文字を表示させるテンプレートです。

'''原則的に、記事本文内での使用は禁止です'''（[[WP:NORUBY]]）。表、Infobox、引用文内の使用のみ許容されています。

__TOC__
== 使い方 ==
<dl>
<dt>ウィキテキスト</dt>
<dd><span style="font-family:monospace"><nowiki>{{ruby|ruby|ルビ|style=color:red}}{{ruby|要素|ようそ|rtc=エレメント|rtcstyle=color:blue}}を{{ruby|使|つか}}ってルビ{{ruby|付|つ}}きの{{ruby|文字|もじ}}を{{ruby|表示|ひょうじ}}させるテンプレートです。</nowiki></span></dd>
<dt>あなたのブラウザの表示</dt>
<dd>{{ruby|ruby|ルビ|style=color:red}}{{ruby|要素|ようそ|rtc=エレメント|rtcstyle=color:blue}}を{{ruby|使|つか}}ってルビ{{ruby|付|つ}}きの{{ruby|文字|もじ}}を{{ruby|表示|ひょうじ}}させるテンプレートです。</dd>
<dt>ruby要素に対応しているブラウザの表示イメージ</dt>
<dd>
{|
|- style="font-size:50%;text-align:center;line-height:50%;"
| <span style="color:red">ルビ</span> || ようそ ||   || つか  ||   ||  つ  ||  || もじ ||  || ひょうじ  || 
|-
| <span style="color:red">ruby</span> || 要素 || を || 使 || ってルビ || 付 || きの || 文字 || を || 表示 || させるテンプレートです。
|- style="font-size:50%;text-align:center:line-height:50%;"
|
| style="color:blue" | エレメント ||   ||   ||   ||    ||  ||  ||  ||   || 
|}
</dd>
<dt>ruby要素に対応していないブラウザの表示イメージ</dt>
<dd>ruby(ルビ)要素(ようそ、エレメント)を使(つか)ってルビ付(つ)きの文字(もじ)を表示(ひょうじ)させるテンプレートです。</dd>
</dl>
== 引数 ==
{| class="wikitable" border="1"
|+ 引数の一覧
! 引数 !! 指定内容 !! 既定値 !! 説明
|-
! <code>1</code>
| ルビベース || 空 || ルビが振られる対象文字列を記入します。
|-
! <code>2</code>
| ルビ文字列 || 空 || ルビとなる文字列を記入します。
|-
! <code>style</code><code>css</code>
| スタイリング || 空 || CSSを使ったスタイリングをする際はここを使います。
|-
! <code>rtc</code>
| 両側ルビ文字列 || 空 || 両側ルビとなる文字列を記入します。
|-
! <code>rtcstyle</code><code>rtccss</code>
| スタイリング || 空 || CSSを使ったスタイリングをする際はここを使います。
|}

== カテゴリ ==
''このテンプレートが貼り付けられたページに適用するカテゴリはありません''。

== TemplateData ==
{{TemplateDataHeader}}
<templatedata>
{
	"description": "ルビ付きの文字を出力します。",
	"params": {
		"1": {
			"label": "ルビベース",
			"description": "ルビが振られる対象文字列を記入します。",
			"type": "string",
			"required": true,
			"example": "慶喜"
		},
		"2": {
			"label": "ルビ文字列",
			"description": "ルビとなる文字列を記入します。",
			"type": "string",
			"required": true,
			"example": "よしのぶ"
		},
		"style": {
			"label": "スタイリング",
			"description": "CSSを使ったスタイリングをする際はここを使います。",
			"type": "string",
			"required": false,
			"example": "color:red",
			"aliases": [
				"css"
			]
		},
		"rtc": {
			"label": "両側ルビ文字列",
			"description": "両側ルビとなる文字列を記入します。",
			"type": "string",
			"required": false,
			"example": "けいき"
		},
		"rtcstyle": {
			"label": "スタイリング",
			"description": "CSSを使ったスタイリングをする際はここを使います。",
			"type": "string",
			"required": false,
			"example": "color:blue",
			"aliases": [
				"rtccss"
			]
		}
	}
}
</templatedata>

== 関連項目 ==
* {{tl|読み}} - [[音声読み上げソフト]]（[[スクリーンリーダー]]）のために難読な固有名詞の読み仮名を、非表示で埋め込むテンプレート
* {{tl|読み仮名}} - 音声読み上げソフトのために難読な固有名詞の読み仮名を、ruby要素を使って、読み仮名を「空気（くうき）」の形式で表示するテンプレート

<includeonly>
[[Category:HTML入力支援テンプレート]]
[[Category:多言語支援テンプレート]]
[[Category:アクセシビリティ・テンプレート]]
</includeonly>