テンプレート:Hatnote/doc

**ハットノート** (Hatnote) とは、記事の冒頭に置かれる短い注です。読み手が探しているであろう別の記事へのリンクを提示する際に使われます。
ハットノートを使うことで、読み手が適切な情報を見つけだす手助けをすることができます。

必要なファイル
* Module:Hatnote
* Module:Hatnote/i18n (解説ページで使用)
* Module:I18n (解説ページで使用)
* Category:エラーのあるHatnoteテンプレート
* Category:異常な引数のあるHatnoteテンプレート

構文
基本的な使い方

```
{{hatnote|*テキスト*}}

```

全ての引数を使った場合

```

```

引数 (パラメーター)
このテンプレートでは、以下のパラメーターが使えます。

* `1` - ハットノートのテキスト (必須)
* `extraclasses` - 追加したいCSSのクラス
* `selfref` - "yes"、"y"、"true" または "1" を指定すると、"selfref" というCSSクラスを追加します。自己言及であることを示す際に使われます。
* `category` - "no"、"n"、"false" または "0" を指定すると、エラーによるメンテナンスカテゴリ (Category:エラーのあるHatnoteテンプレート) に属さないようにすることができます。先頭の引数 (ハットノートのテキスト) が省略された場合のみ有効です。

使用例
* `{{hatnote|ハットノートのテキストを入力した例}}` → ハットノートのテキストを入力した例

主なハットノート
{{Main}} と {{Further}} は似ているテンプレートですが、前者は話題の核になる情報を、後者は話題の詳細情報を案内するために使われます。２つのテンプレートではほとんど同じ引数が使用できます。

{{Main}}
記事が長くなると、その部分の話題を分割し、子記事を作成します。その際、元の記事では子記事の話題についての概要のみ記し、子記事へのリンクを示します。このテンプレートは、子記事についての概要を記した節 (セクション) で見出しに続けて使い、子記事にリンクするようにします。
{{Main|*<メインページ>*}} →
Main article: メインページ
{{Main|*<メインページ>*|*<メインページ>*}} →
Main articles: メインページ and メインページ

{{Further}}
その話題のより詳しい情報に関する記事へのリンクに使われます。
{{Further|*<メインページ>*}} →
Further information: メインページ
{{Further|*<メインページ>*|*<メインページ>*}} →
Further information: メインページ and メインページ

{{See also}}
その話題に関連する追加情報となる記事へのリンクに使われます。
{{See also|*<メインページ>*}} →
See also: メインページ
{{See also|*<メインページ>*|*<メインページ>*}} →
See also: メインページ and メインページ

* `1`, `2`, `3`, ... – リンクさせたいページを指定します。
	+ 指定がない場合、テンプレートが置かれたページの (名前空間名を除いた) ページ名が指定されます。
	+ カテゴリページやファイルページを指定すると、コロンの用法によりそれぞれのページにリンクされますが、冒頭のコロンは表示されません。
	+ 節 (セクション) へのリンクは、MediaWiki標準の *ページ#節* ではなく*ページ § 節* に変換して表示されます。
* `l1`, `l2`, `l3`, ... または `label 1`, `label 2`, `label 3`, ... – 各リンクのラベル (パイプ付きリンクで指定する、表示テキスト部分にあたります) を任意で追加できます。
	+ この引数には、(大文字の 'L' ではなく) 小文字の 'l' を使うことにご注意ください。(例: `L1` ではなく `l1`)
* `selfref` – "yes"、"y"、"true" または "1" を指定すると、"selfref" というCSSクラスを追加します。自己言及であることを示す際に使われます。

Disambiguation (曖昧さ回避)
曖昧さ回避の情報を載せる場合のうち、独立した曖昧さ回避ページまでは必要としないというときは、{{About}} や {{For}} といったテンプレートを使います。曖昧さ回避ページは、主に曖昧さ回避が必要な、平等な記事が4ページ以上ある場合や、分野名を付記した項目名の記事ページ (「項目名 (分野)」) に対して作られています。

{{About}}
同じ名前、あるいは概念についての記事を読者が求めることがあると考えられる場合に使うテンプレートです。以下のようなフォーマットでご利用ください。
{{About|*<Use1>*}} →
 For other uses, see Hatnote/doc (disambiguation).
{{About|*<Use1>*|*<>*|*<メインページ>*}} →
This page is about Use1. For other uses, see メインページ.
This page is about Use1. For other uses, see メインページ.
{{About|*<Use1>*|*<Use2>*|*<メインページ>*}} →
This page is about Use1. For Use2, see メインページ.
This page is about Use1. For Use2, see メインページ. For 及び, see メインページ.
This page is about Use1. For Use2, see メインページ. For その他の用法, see Hatnote/doc (disambiguation).

{{About}}テンプレートを節 (セクション) の最初で使う場合は、引数に `section=yes` を指定します。それによって、節用のメッセージが利用できます。

{{About|*<Use1>*|*<section=yes>*}} →
This section is about Use1. For other uses, see Hatnote/doc (disambiguation).
This section is about Use1. For other uses, see メインページ.
This section is about Use1. For Use2, see メインページ.
This section is about Use1. For Use2, see メインページ. For 及び, see メインページ.
This section is about Use1. For Use2, see メインページ. For その他の用法, see Hatnote/doc (disambiguation).

* これらのハットノートテンプレートは、以下のテンプレートメッセージでは不十分な場合のみ使うよう心がけてください。
* このテンプレートもselfref引数が使えます。

{{For}}
4ページまでの関連ページや、曖昧さ回避ページへのリンクに使用します。0〜5の引数を指定できます。
このテンプレートを、引数を指定せず「Foo」というページで使った場合、以下のようになります…
For その他の用法, see Foo (曖昧さ回避).

1つ目の引数を指定すると、ハットノートのメッセージ部分を変更できます。プレーンテキスト (文字のみ) で指定してください。
例えば、{{For|*<類語>*}} は以下のようになります…
For 類語, see Foo (曖昧さ回避).
2つ目の引数を指定すると、リンク先を変更できます。
例えば、{{For|*<類語>*|*<メインページ>*}} は以下のようになります…
For 類語, see メインページ.
3〜5つ目の引数を指定すると、リンク先を3つまで追加できます。
* For 類語, see メインページ and メインページ.

* For 類語, see メインページ, メインページ, and メインページ.

* For 類語, see メインページ, メインページ, メインページ, and メインページ.

最後の例は、以下のコードを入力したものです。
エラー
ハットノートのテキストが指定されていない場合、以下のようにエラーメッセージが表示されます。

* **Error: no text specified (help).**

エラーメッセージが表示される場合、以下の4つの原因が考えられます。

1. 引数が指定されていない場合。(テンプレートのコードが `{{hatnote}}` 。) `{{hatnote|*テキスト*}}` のように修正してください。
2. 一部の引数のみ指定され、ハットノートのテキストは指定されていない場合。例えば、テンプレートのコードが `{{hatnote|extraclasses=seealso}}` でもこのエラーになります。この例の場合、`{{hatnote|*テキスト*|extraclasses=seealso}}` のように修正してください。
3. ハットノートテキストに半角等号記号 ("=") が含まれている場合。テンプレートコード上では、半角等号は特別な役割をもっているため、名前付きの引数 (パラメータ) 以外でテキストとして使うことはできません。例えば、`{{hatnote|2+2=4}}` というテンプレートコードは、エラーを起こしてしまいます。正しく表示させるためには、ハットノートのテキストの前で引数名として (1つ目の引数であることを 表す) `1=` を指定してください。先ほどの例では、次のようになります。`{{hatnote|1=2+2=4}}`
4. `{{#invoke:hatnote|hatnote|*テキスト*}}`のコードを用いて、Module:Hatnoteを直接呼び出そうとした場合。このように `{{#invoke:}}`ステートメントを使った方法は、性能的な理由のため使用できません。`{{hatnote|*テキスト*}}` を利用してください。

このエラーのあるページには、自動的にCategory:エラーのあるHatnoteテンプレートというカテゴリが追加されます。

技術的な情報
このテンプレートはLua言語でプログラムされています。詳細はグローバルLuaモジュールのページ (英語)からご覧いただけます。
このテンプレートを使った場合のHTMLコードは、次のようになります…

* `<div role="note" class="hatnote">*ハットノートのテキスト*</div>`

関連項目
* Template:Hatnote
* Template:Main
* Template:Further
* Template:See also
* Template:About
* Template:For
* Template:Details
* Template:Format link

* w:c:ja.templates:Template:Hatnote/wikitext - ウィキテキストによるハットノートテンプレート

テンプレートWikiの記事
* w:c:ja.templates:テンプレート:Hatnote