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

<noinclude>{{Documentation subpage|種類=[[Help:テンプレート|テンプレート]]}}</noinclude><includeonly>{{使用箇所の多いテンプレート|800,000以上}}</includeonly>
<!-- 以下でテンプレートの解説を編集してください -->
[[Help:脚注|脚注]]に参照文献リストを載せるためのテンプレートです。[[Help:脚注#脚注の作成方法|<code><nowiki><references /></nowiki></code>]]の代用として<code><nowiki>{{Reflist}}</nowiki></code>を使用することができます。

本文と脚注のスタイルを変えて、全体を読みやすくするために用いられます。

== 使用法 ==
=== 複数の列 ===
{{CSS3 multiple column layout}}
<code>&#123;&#123;{{BASEPAGENAME}}|30em&#125;&#125;</code>などのように、[[em (単位)|em]]などの相対単位や[[ピクセル|px]]などの絶対単位で幅を指定すると、その列幅以上になるように、脚注の列幅を指定できます。この際、数字と単位の間にはスペースを入れないでください。<code>&#123;&#123;{{BASEPAGENAME}}|colwidth=30em&#125;&#125;</code>のように、列幅の前に「colwidth=」と入れても同じ表示を得ることができます。

<code>&#123;&#123;{{BASEPAGENAME}}|2&#125;&#125;</code>とすると脚注が2列のリストに、<code>&#123;&#123;{{BASEPAGENAME}}|3&#125;&#125;</code>とすると3列のリストになります。

一般にはem単位指定および列数指定が用いられています。

'''注意'''：2019年時点で、対応するブラウザは表のとおり。

==== 発生し得る問題 ====
; 脚注の分裂
[[ファイル:Exofrefwith4cols2.png|thumb|脚注が途中で改列されてしまった例（{{oldid|61887478|section=脚注|和田アキ子}}）。なお、この画像では列幅も小さくなっているが、現在は解消されている。]]
複数の列を使用することで、列の一番下に表示された脚注が次の列の頭に分かれて表示されてしまうことがあります。[[MediaWiki:Common.css]]には表示が2列にわたって表示されないようにする[[Cascading Style Sheets|CSS]]ルールが含まれています。しかし、少なくない環境下において、1つの脚注であるにもかかわらず複数列表示の設定がされている場合や、スマートフォンで表示した場合などの特定の条件下では、1つの脚注が2列以上に分裂して表示されてしまうこともあります。

{{markup
|<nowiki>2列以上に組まれると<ref>このように脚注が表示されます。このように脚注が表示されます。</ref>、場合によっては1つの脚注が2列以上に分かれてしまいます。
この動作は、ウィンドウ幅やブラウザの種類によって表示が変化します。

== 脚注 ==
{{Reflist|10em}}</nowiki>
|2列以上に組まれると<ref>このように脚注が表示されます。このように脚注が表示されます。</ref>、場合によっては1つの脚注が2列以上に分かれてしまいます。
この動作は、ウィンドウ幅やブラウザの種類によって表示が変化します。
{{fake heading|sub=3|脚注}}
{{Reflist|10em}}
}}

このテンプレートで複数列設定を行った場合に、あなたのブラウザではそれぞれの脚注が1列に表示されていても、他の環境（ブラウザやウィンドウ幅など）によっては別の挙動を示すことがあります。

;列幅が極端に狭くなる
脚注の列数を極端に大きく設定すると、列の幅が非常に短くなり、見にくくなる恐れがあります。そのため、列数指定に対しては、列幅がある一定の値（20em）未満にならないようになっています。

また、列幅が狭すぎると脚注自体が表示されなくなります。

{{markup
|<nowiki>このように、列数を多く設定した場合には、実際に表示される列数は、その列数よりも少なくなります<ref>このような表示になります。</ref><ref>このような表示になります。</ref><ref>このような表示になります。</ref>。

== 脚注 ==
{{Reflist|6}}</nowiki>
|このように、列数を多く設定した場合には、実際に表示される列数は、その列数よりも少なくなります<ref>このような表示になります。</ref><ref>このような表示になります。</ref><ref>このような表示になります。</ref>。
{{fake heading|sub=3|脚注}}
{{Reflist|6}}
}}

==== 使用法 ====
使用する列幅の指定や列数指定は編集者にゆだねられていますが、以下に一般的な指定を挙げます。
* 指定なしもしくは1列指定（既定）: 脚注が少ないときに用いられます。
* 30emもしくは2列以上指定: 多数の脚注を直接書いている場合に用いられます。
* 20em: {{Tl|sfn}} が使用されている場合によく用いられます。

==== 例 ====
{{markup|title=15em幅指定の場合
|<nowiki>Lorem ipsum.<ref>出典名、アクセス日時など</ref>
Lorem ipsum dolor sit amet.<ref>出典名、アクセス日時など</ref>
Lorem ipsum dolor sit amet.<ref>出典名、アクセス日時など</ref>
Lorem ipsum dolor sit amet.<ref>出典名、アクセス日時など</ref>
Lorem ipsum dolor sit amet.<ref>出典名、アクセス日時など</ref>

== 脚注 ==
{{Reflist|15em}}</nowiki>
|Lorem ipsum.<ref>出典名、アクセス日時など</ref>
Lorem ipsum dolor sit amet.<ref>出典名、アクセス日時など</ref>
Lorem ipsum dolor sit amet.<ref>出典名、アクセス日時など</ref>
Lorem ipsum dolor sit amet.<ref>出典名、アクセス日時など</ref>
Lorem ipsum dolor sit amet.<ref>出典名、アクセス日時など</ref>

{{fake heading|sub=3|脚注}}
{{Reflist|15em}}<!--15emを使用しているのは、30emは一般的なディスプレイでは「描画」部での表示がなされないためです。-->
}}

=== group引数 ===
同一記事内に複数の脚注を設置する場合（[[Help:脚注#注釈リストと出典リストを分離したいとき|<nowiki><ref group=>, <references group=></nowiki>]]を使用する場合）は、group引数を用いる事で対応できます。

表示例
* 脚注1では<code><nowiki>{{Reflist}}</nowiki></code>と書き、脚注は<code><nowiki><ref>〜</ref></nowiki></code>で括っています。<ref>1111111111</ref><ref>2222222222</ref><ref>3333333333</ref>
* 脚注2では<code><nowiki>{{Reflist|group=※}}</nowiki></code>と書き、脚注は<code><nowiki><ref group="※">〜</ref></nowiki></code>で括っています。<ref group="※">aaaaaaaaaa</ref><ref group="※">bbbbbbbbbb</ref><ref group="※">cccccccccc</ref>

==== 脚注1 ====
{{Reflist}}

==== 脚注2 ====
{{Reflist|group=※}}

=== refs引数 ===
<nowiki><ref name="hoge">ほげほげ</ref></nowiki> のような、内容とname属性をもつ脚注タグをrefs引数として列挙しておくと、ページ中でそのname属性を使うことができます。

{| class="wikitable" style="margin-left:4em; font-size:small"
|-
!使<br />用<br />例
|<nowiki>これは本文です<ref group="†" name="hoge" />。ここでは説明ページの都合でgroup引数と併用していますが、もちろんgroup引数なしでも使えます<ref group="†" name="piyo" />。</nowiki>

<nowiki>{{Reflist|group="†"|refs=<ref group="†" name="hoge">これは脚注の内容です。</ref><ref group="†" name="piyo">これは本文中の脚注タグ内ではなく、refs引数の中に書いてあります。</ref>}}</nowiki>
|-
!実<br />際<br />の<br />表<br />示
|これは本文です<ref group="†" name="hoge" />。ここでは説明ページの都合でgroup引数と併用していますが、もちろんgroup引数なしでも使えます<ref group="†" name="piyo" />。

{{Reflist|group="†"|refs=<ref group="†" name="hoge">これは脚注の内容です。</ref><ref group="†" name="piyo">これは本文中の脚注タグ内ではなく、refs引数の中に書いてあります。</ref>}}
|}

通常――この機能を使わない場合は、name属性はページ中のどこかの脚注で定義しておく必要がありますが、それが消されると、name属性だけで記述している脚注でエラーとなってしまいます（実際、そのような編集はしばしば見られます）。このrefs引数で脚注のname属性を定義しておけば、このような事故を防ぐことができますし、ソースの可読性も向上します。

ただし欠点もあり、ここで定義された脚注が本文中で一度も使われなかった場合には、エラーが発生します。後で置換されたり除去されることが予想される脚注ではこの機能を使わず、普通に本文中の脚注タグで記述したほうが、後の編集者には親切かもしれません。

また、現在のところ、ここで入れ子脚注（[[H:REFNEST]]参照）を正常に利用することはできません。詳細は[[Template:Refnest#リスト定義時のエラー]]を参照してください。

=== liststyle引数 ===
既定では、脚注は番号付けされて表示されます。liststyle引数を用いることで、脚注を番号付けさせないようにしたり、他の記号やローマ数字などで番号付けできるようになります。list-style-typeとして定義されたCSS文字列ならば使用することができます。
使用可能なスタイルは以下の表を参照してください。
{{CSS list-style-type values}}

=== scroll引数（廃止） ===
'''注意'''：2009年5月の[[Help‐ノート:脚注/過去ログ2#脚注スクロール廃止の提案|Help‐ノート:脚注]]における合意により、脚注をスクロール表示にしたい場合は各自[[MediaWiki:Gadget-ScrolledReflist|Scrolled Reflist]]という[[Wikipedia:ガジェット|ガジェット]]を利用し、Template:Reflistのscrollパラメータは使用しないことになりました。なお、{{tl|Reflist}}を使っている項目の脚注部分にはclass名として「reflist」が指定されていますので、ウェブブラウザのユーザスタイルシートに[[MediaWiki:Gadget-ScrolledReflist.css]]の内容を転記すればIP利用者でも同等の効果を得ることができます。

== 追跡カテゴリ ==
*[[:Category:Reflistで3列を指定しているページ]] - 第1引数に「3」を指定しているページを収集します。
*[[:Category:Reflistで4列以上を指定しているページ]] - 第1引数に「4」もしくはそれ以上の列数を指定しているページを収集します。

== テンプレートデータ ==
{{TemplateData header}}
<templatedata>
{
	"description": "このテンプレートは、記事の最後に脚注の一覧を表示し、追加の書式設定および整理のオプションを提供します。\"Apply changes\"（変更の適用）をクリックしてビジュアル編集（VE）表示モードに戻った後は、参照リストは表示されません。\"Save page\"（ページの保存）を押して通常の表示モードに戻すと、変更を適用した参考文献一覧が再び表示されます。Phabricator:T53146 を参照してください。",
	"params": {
		"1": {
			"label": "Columns / Column width",
			"type": "string",
			"required": false,
			"description": "モード2件をサポートしています。第1モード：参考文献一覧は整数の固定列にレンダリング。2番目のモード：印刷用の 'em' などの測定単位で、参考文献一覧の列幅を指定（例：'33em'）。 「33&nbsp;em」のように空白を挟むと認識しません",
			"default": "1",
			"aliases": [
				"colwidth"
			]
		},
		"liststyle": {
			"label": "Liststyle",
			"type": "string",
			"required": false,
			"description": "参考文献一覧を列挙するときに使用する書式を設定。有効な CSS 値を list-style-type に定義できます",
			"default": "decimal"
		},
		"group": {
			"label": "Group",
			"type": "string",
			"required": false,
			"description": " group とは、表示する脚注を制限するパラメータ（識別子）です。このテンプレートに group パラメータを指定しないと、このパラメータのない脚注のみ表示します。指定すると group パラメータと一致する脚注に絞り込んで処理します。それ以外は処理されません。"
		},
		"refs": {
			"label": "List of references",
			"type": "string",
			"required": false,
			"description": "記事内でどんな名前付き脚注を使うか、定義する場所を提供します。脚注をこの場所で定義すると、記事のどこかで1回も使用しないものは、一覧に表示されません。"
		}
	}
}
</templatedata>

== 関連項目 ==
* {{Tl|脚注ヘルプ}}
* {{tl|Reflist-talk}} - ノートページ用。
* [[Help:脚注部分をスクロール化する]]

<div style="display:none; speak:none;">
<references />
</div>
<includeonly>{{sandbox other||
<!-- カテゴリは以下に追加してください -->
[[Category:脚注テンプレート]]
[[Category:段組みテンプレート]]}}
</includeonly>