Template:Year by category/doc

これはTemplate:Year by categoryの解説サブページです。
使用方法、カテゴリ、およびその他テンプレートページ自体に含まれない情報を収容しています。

このテンプレートはカテゴリを「Category:mcdy年のカテゴリ名」という形式で年別に分類するために使うテンプレートである。

構文

{{Year by category
| m = 
| c = 
| d = 
| y = 
| cat = 
| in = 
| parent = 
| subcat = 
| sortkey = 
}}

引数

以下の5つの引数は年別に分類するために用いる。 ●m = 先頭から1桁目の数字︵1234年なら"1"︶ ●c = 先頭から2桁目の数字︵1234年なら"2"︶ ●d = 先頭から3桁目の数字︵1234年なら"3"︶ ●y = 先頭から4桁目の数字︵1234年なら"4"︶ ●cat = カテゴリ名 カテゴリ名のうち、﹁mcdy年の﹂以降の部分。
隣の引数を用いると、テンプレートを使用しているカテゴリの名称で記事が作成されているときに、その記事へのリンクを追加することができる。 ●in = 関連記事名 省略可能: ﹁mcdy年の﹂で始まる年別形式の関連記事へのリンクを追加する。記事名のうち﹁mcdy年の﹂以降の部分。Template:See alsoを使用。
その他の部分はカテゴリの分類先を決める。 ●parent = テンプレートを使用しているカテゴリの親カテゴリ名 省略可能: "Category:"以外の全文を記載。﹁各年の項目名﹂と記入。"parent" で指定した親カテゴリ内では年順にソートされる。 ●subcat = その他のカテゴリ名 省略可能: 上記以外の親カテゴリに分類したい場合に、"Category:"以外の全文を記載。﹁mcdy年の関連項目名﹂と記入。省略すると﹁mcdy年﹂のカテゴリに分類される。 ●sortkey = カテゴリのソートキー カテゴリのソートキー。"subcat" を指定し "sortkey" を省略すると、"subcat" で指定した親カテゴリ内ではソートキーが未入力の状態でソートされる。 "parent" と "subcat" はテンプレートを使用しているカテゴリの﹁親カテゴリ﹂を指定する引数である。

使用例

Category:2006年の日本で引数をすべて指定した場合、以下のようになる。

{{Year by category
| m = 2
| c = 0
| d = 0
| y = 6
| cat = 日本
| in = 日本
| parent = 各年の日本
| subcat = 2006年の各国
| sortkey = にほん
}}

「2006年の日本」も参照

この時、テンプレートにより最低でもカテゴリには[[Category:各年の日本|2006ねん]]（引数 "parent"、"m"、"c"、"d"、"y" による）、[[Category:2006年の各国|にほん]]（引数 "subcat"、"sortkey" による）が指定される。