Template:索引のルールの告知/doc

このテンプレートは、Wikipedia:索引に項目を掲載する時の記述方法、掲載位置（排列）などに関するルールが追加・変更された時や、既にあるルールに従っていない項目が多数ある時、索引を編集するユーザにルールの存在を告知し修正を促すとともに、未対処・未確認のページを管理するために用います。

このテンプレートを索引以外のページに使用しないで下さい。

使用法

本テンプレートはなるべく単独では使わず、一部のパラメータを設定済みにした別のテンプレートを作成して使って下さい。本テンプレートのサブページとして作ることを推奨します。

サブページの作り方

たとえば、Template:索引のルールの告知/「ヴ」の読み仮名と排列 という名前で以下の内容のサブページを作成します。

<includeonly>{{索引のルールの告知
   |date={{{date|}}}
   |detail_link=Wikipedia:索引#凡例
   |rule1=記事名に「ヴ」を含む項目の読み仮名は、ひらがなの「ゔ」を使う
   |rule2=索引の並び順を決める時、「ゔ」は「う」の濁音として扱う
   |category=ルール準拠が未確認の索引/「ヴ」の読み仮名と排列
   |keep_until={{{keep_until|}}}
   |{{{1|}}}
 }}</includeonly>

上の例では、4つのパラメータ detail_link、rule1、rule2、category を既定しており、2つのパラメータ date、keep_until とパラメータ名を特定しない1番目のパラメータは Template:索引のルールの告知/「ヴ」の読み仮名と排列 を使う時に指定できるようにしています。「パラメータ名を特定しない1番目のパラメータ」は、doneを使用できるようにするためのものです。

また、テンプレート全体を <includeonly>〜</includeonly> で囲んでいるのは、対処管理用のカテゴリがテンプレート自体に付与されることを避けるためです。

索引へTemplateを挿入する方法

サブページを作ったら、それを索引の各ページの冒頭に挿入して下さい。Wikipedia:Bot作業依頼を利用することを想定しています。

{{索引のルールの告知/「ヴ」の読み仮名と排列|date=2024年10月|keep_until=2025年10月}}

（以下、索引の本文）

上記のようにテンプレートを挿入すると、ページの先頭に以下のように表示されます。また、Category:ルール準拠が未確認の索引/「ヴ」の読み仮名と排列 が付与されます。

未対処管理用のカテゴリとdoneパラメータ

このテンプレートを挿入した索引ページは、categoryパラメータで指定したカテゴリが自動的に付与されます。ルールに従う修正が行われた後は、テンプレートを除去するか、以下の例のようにパラメータ done をテンプレートに追加すると、そのページがカテゴリから除去されます。このカテゴリによって、未対処のページを把握することができます。

{{索引のルールの告知/「ヴ」の読み仮名と排列|date=2024年10月|keep_until=2025年10月|done}}

doneを追加したテンプレートは、以下のように表示されます。また、Category:ルール準拠が未確認の索引/「ヴ」の読み仮名と排列 が付与されなくなり、代わりにCategory:ルール準拠が未確認の索引/「ヴ」の読み仮名と排列/done が付与されます。

対処後すぐにテンプレートを除去して良い場合

修正が行われた時（または修正済みであることが確認された時）、周知のためにテンプレートを残す必要がなく、すぐにテンプレートを除去して良い場合は、keep_untilパラメータを指定しないで下さい。

{{索引のルールの告知/「ヴ」の読み仮名と排列|date=2024年10月}}

keep_untilを指定しないテンプレートは、以下のように表示されます。また、Category:ルール準拠が未確認の索引/「ヴ」の読み仮名と排列 が付与されます。

なお、keep_untilが指定されない場合は、対処後にdoneを追加するのではなくテンプレートを除去することになりますので、もしdoneを追加しても表示は変わりません。

既にあるルールを告知する場合

ルールの追加・改訂に伴う告知ではなく、既にあるルールが守られていない場合に周知・修正を促すためこのテンプレートを使う場合は、dateパラメータを指定しないで下さい。

{{索引のルールの告知/「ヴ」の読み仮名と排列|keep_until=2025年10月}}

dateを指定しないテンプレートは、以下のように表示されます。また、Category:ルール準拠が未確認の索引/「ヴ」の読み仮名と排列 が付与されます。

引数

引数の一覧

引数	指定内容	既定値	説明
date	ルール追加・改訂の年月	（なし）	告知するルールが追加・改訂された年月を「2024年10月」という形式で記載して下さい。追加・改訂ではなく既にあるルールを告知する場合は指定しないで下さい。
detail_link	ルールへのリンク	（なし）	告知するルールが掲載されているページへのアンカーを 「Wikipedia:索引#凡例」という形式で記載して下さい。[[ と ]]は不要です。
rule1	ルール1	（なし）	必須項目。告知するルールの内容を1行程度で説明して下さい。
rule2	ルール2	（なし）	告知するルールが複数ある場合、5つまでまとめて掲載することができます。ただし、関連性の薄いルールをひとつのテンプレートで同時に告知しないで下さい。categoryによる管理が困難になります。
rule3	ルール3	（なし）
rule4	ルール4	（なし）
rule5	ルール5	（なし）
keep_until	掲載期限の年月	（なし）	ルールに従って索引が修正された後も、引き続きルールを告知するためこのテンプレートを削除せず掲載し続けたい場合、その期限の年月を「2025年10月」という形式で記載して下さい。修正が完了したらすぐテンプレートを除去して良い場合は指定しないで下さい。
category	未対処・未確認の時に付与されるカテゴリ	（なし）	ルールに従った修正が完了するまでページに付与するカテゴリを、「ルール準拠が未確認の索引/「ヴ」の読み仮名と排列」というような形式で記載して下さい。[[Category: と ]]は不要です。
done	対処済みフラグ	（なし）	索引に従った修正が行われていることを確認した時、テンプレートに追加するべきパラメータです。指定されていると、categoryで指定したカテゴリは付与されず、代わりに「categoryで指定した名称/done」というカテゴリが付与されます。なおkeep_untilが指定されていない場合は、doneを追加するのではなくテンプレートを除去すれば良いため、doneは無視されます。

カテゴリ

このテンプレートは、貼り付けられたページに category パラメータで指定されたカテゴリを適用します。ただし doneパラメータが指定されている場合は適用しません。

関連項目

• Wikipedia:索引
• Wikipedia‐ノート:索引