テンプレート:読み/docのソースを表示

{{Documentation subpage|種類=[[Help:テンプレート|テンプレート]]}}
<includeonly>{{使用箇所の多いテンプレート|4,000以上}}</includeonly>音声出力環境での利用者のため、音声読み上げソフトに誤読される可能性が高い、難読の固有名詞などに読み仮名を振るテンプレートです。内部的に[[HyperText Markup Language|HTML]]のruby要素を使用していますが、[[Cascading Style Sheets|CSS]]の "ruby-position:inline" に相当する設定で出力しているため、ルビ（ふりがな）表示には対応していません。

== 使い方 ==
=== 通常の表示方法 ===
<pre>
{{読み仮名|漢字|よみがな}}
</pre>
と入力すると
<div style="padding-left: 1em; border:1px solid #999">
{{読み仮名|漢字|よみがな}}
</div>
のように、「漢字」とともに「よみがな」が括弧書きで表示されます。HTMLのruby要素に対応した音声ブラウザなどでは、「漢字」部分のテキストを読まずに「よみがな」部分のみを読み上げます。非対応の環境では通常のテキストどおり「漢字」と「よみがな」が重複して読み上げられます。

=== 備考を付記する表示方法 ===
<pre>
{{読み仮名|漢字|よみがな|備考}}
</pre>
と入力すると
<div style="padding-left: 1em; border:1px solid #999">
{{読み仮名|漢字|よみがな|備考}}
</div>
のように、「よみがな」と併せて「備考」を括弧内に付記できます。

=== 読み仮名を非表示にする方法 ===
<pre>
{{読み|漢字|よみがな}}
</pre>
と入力すると
<div style="padding-left: 1em; border:1px solid #999">
{{読み|漢字|よみがな}}
</div>
のように、ruby要素に対応した[[ウェブブラウザ]]などでは「よみがな」のテキストが非表示になり、音声でのみ出力されます。一般的な視覚ブラウザでは、「漢字」の文字上にカーソルを合わせると「よみがな」がポップアップ表示されます。ruby要素に非対応の環境では通常の表示と同様に「よみがな」が括弧書きで表示され、「漢字」と「よみがな」が重複して読み上げられます。
=== 読み仮名をルビとして表示する方法 ===
このテンプレートは内部的に[[HyperText Markup Language|HTML]]のruby要素を使用していますが、「[[Wikipedia:表記ガイド]]」の書式に準じて読み仮名を括弧書きで表示させているため（[[Cascading Style Sheets|CSS]]の "ruby-position:inline" に相当する仕様）、ルビ（振り仮名）表示は出力しません。ルビ形式で読み仮名を表示したい場合には、このテンプレートの代わりに{{tl|Ruby}}を使ってください。<code>{{tlp|Ruby|漢字|よみがな}}</code>と入力すると、「{{Ruby|漢字|よみがな}}」のように表示されます。

ただし、ルビの使用は表組みや囲みの引用文中に限り許容されています。詳しくは「[[Wikipedia:表記ガイド#読み仮名|Wikipedia:表記ガイド]]」を参照してください。

=== 使用上の注意事項 ===
特に誤読される可能性が高い難読の固有名詞などの場合、同一の単語に対してこのテンプレートを使用している箇所と使用していない箇所が混在すると音声での読み上げ結果がその都度まちまちになってしまい混乱するため、同じ記事内でどの単語にこのテンプレートを使用するかを統一してください。ひとつの文章中に同じ単語が繰り返し出てくる場合には読みやすさを損なわないよう、初出の箇所のみ「よみがな」を表示させ、2つめ以降は「よみがな」を非表示にすると良いでしょう。

== 引数 ==
{| class="wikitable" border="1"
|+ 引数の一覧
! 引数 !! 指定内容 !! 既定値 !! 説明
|-
! 1
| 読み仮名を振る単語 || なし || 難読の固有名詞など、読み仮名を振る対象となる単語を入力します。
|-
! 2
| 読み仮名 || なし || 単語の読みを入力します。
|-
! 3
| 備考 || なし || 人物の生没年や著作物の作者・発表年など、読み仮名と併せて括弧内に付記する文字列を指定します。読み仮名を表示する場合のみ使用できます。
|}

== ユーザースタイルシートの使用について ==
従来まで使用されていたTemplate:ルビでは、各自のユーザースタイルシートなどで[[Cascading Style Sheets|CSS]]のカスタマイズを行う利用者のために同テンプレート独自のclass名（ "ruby", "rb", "rp", "rt" ）が指定されていました。

現行の当テンプレートはHTMLのruby要素、rb要素、<!-- rp要素、-->rt要素を使用しており、従来同様にユーザースタイルシートなどを用いてこれら各要素の書式をカスタマイズすることもある程度は可能です。<!--下記はユーザースタイルシートの一例です。-->ただし個々のユーザーに対して希望どおりの出力を保証するものではありません。
<!--
[[MediaWiki:Common.css]]や[[MediaWiki:Common.js]]などのデフォルトCSSで定義されていない書式指定およびそれに付随する不具合などへの対処は各自の自己責任で実施してください。

<syntaxhighlight lang="css">
/* Template:ルビ */
ruby {
  border: none;
  display: inline-table;
  height: 1em;
  line-height: 1;
  margin: 0px;
  padding: 0px;
  text-align: center;
  text-indent: 0px;
  vertical-align: text-bottom;
  white-space: nowrap;
}

rb {
  border: none;
  display: table-row-group;
  line-height: 1;
  margin: 0px;
  padding: 0px;
  text-align: center;
  white-space: nowrap;
  speak: none
}

rt {
  border: none;
  display: table-header-group !important;
  font-size: 0.625em !important;
  line-height: 1.1;
  margin: 0px;
  padding: 0px;
  text-align: center;
  white-space: nowrap;
}

rp {
  display: none !important;
  speak: none
}
</syntaxhighlight>
-->

== カテゴリ ==
<!-- このテンプレートは、貼り付けられたページに次のカテゴリを適用します:
{| class="wikitable"
! カテゴリ !! ソートキー !! 説明
|-
! style="text-align:left;" | 
|  ||  
|}-->
''このテンプレートが貼り付けられたページに適用するカテゴリはありません''。
<!--
== 関連項目 ==
* 
* -->

== TemplateData ==
{{TemplateDataHeader}}
<templatedata>
{
	"params": {
		"1": {
			"label": "読み仮名を振る単語",
			"description": "難読の固有名詞など、読み仮名を振る対象となる単語を入力します。",
			"example": "太宰 治",
			"type": "line",
			"required": true
		},
		"2": {
			"label": "読み仮名",
			"description": "単語の読みを入力します。",
			"example": "だざい おさむ",
			"type": "line",
			"required": true
		},
		"3": {
			"label": "備考",
			"description": "人物の生没年、著作物の作者・発表年など、読み仮名と併せて括弧内に付記する文字列を指定します。",
			"example": "1909年6月19日–1948年6月13日",
			"type": "line"
		}
	},
	"description": "難読語（固有名詞など）の読みを指定します。視覚ブラウザでは「漢字（よみがな）」のように表示され、音声ブラウザでは「漢字」の部分のテキストは読まれずに「よみがな」の部分が読み上げられます。",
	"format": "inline"
}
</templatedata>


<includeonly>
<!-- カテゴリは以下に追加してください -->
[[Category:多言語支援テンプレート|よみ]]
</includeonly>