Template:Documentation

テンプレートの解説表示編集履歴キャッシュを破棄

このテンプレートは今ここに表示されているような解説を、他のページから自動的に呼び出して表示します。このテンプレートは他のページに呼び出されるようなページに解説を加えることに使われ、おもにテンプレートでの使用を想定していますが名前空間によって制限されているわけではありません。

使い方

基本

あなたがこのテンプレートを使用しようとしているページが「Template:テンプレート名例示用」だとすると「Template:テンプレート名例示用/doc」に解説を書いて保存し、「Template:テンプレート名例示用」に次のコードを付け足してください。

<noinclude>{{Documentation}}</noinclude>

ページ指定

解説が保存されているページが「Template:any page/doc」である場合、次のコードを「Template:テンプレート名例示用」に付け足してください。

<noinclude>{{Documentation|Template:any page/doc}}</noinclude>

インライン・コンテンツ

解説を別のページに保存せず、次のように「Template:テンプレート名例示用」に直接書き込むこともできます。

<noinclude>{{Documentation|Template:any page/doc}}</noinclude>

「Template:テンプレート名例示用/doc」が存在する場合は、そちらも同時に表示されます。

注意

表の作り方

|content=で指定した部分に含まれているパイプ構文の表は正しく表示されません。「|content=」で指定する部分に表を作成する場合はパイプ構文ではなくHTMLタグを使用するようにしてください（「/doc」等のこのテンプレートによって呼び出されたページにパイプ構文の表が含まれる場合は、正しく表示されます）。

追跡カテゴリ

|content=を使用すると「Category:((Documentation))の解説がインラインで書かれているテンプレート」に追加されます。

通常は{{Documentation}}は<noinclude>で囲むので問題になりませんが、{{Navbox documentation}}などのような事例では、その設置先まで追跡カテゴリに分類されてしまいます。この場合、|inline_content_category=に「disabled」「no」「n」のいずれかを指定するとオーバーライドできます。

ヘッドラインを変更する

次のように書き込めば、ヘッドライン（冒頭表示）を変更できます。

<noinclude>{{Documentation|heading=変更したヘッドライン}}</noinclude>

もし次のように heading 引数を空にすれば、ヘッドラインは表示されません。

<noinclude>{{Documentation|heading=}}</noinclude>

注意

これらのコードは<noinclude>の前に余分な空白をつけずに、テンプレートやその他の解説を呼び出したいページに付け加えてください。もし、解説・説明文書のページが<includeonly>や<noinclude>といったタグを解説の一部として含むならば「<」を「&lt;」で置き換えてください。

特別な機能

プリロード

もし解説のページが存在しなければ、[編集]リンクはTemplate:Documentation/preloadから解説の雛形ファイルをプリロードします。

プリロードするファイルは、preload 引数で変更できます。

サンドボックスとテストケースとの連携

このテンプレートはサンドボックスとテストケースの存在を確認し、存在していればそのことを���在していなくてもそのことを通知しサンドボックスとテストケースの使用に誘導します。

この機能は、sandbox-testcases引数に「show」以外を指定することによってキャンセルできます。

保護アイコンの表示 

このテンプレートを使用しているテンプレートが保護されていれば、そのテンプレートのページに{{pp-template}}に相当するインジケーターアイコンを表示し、さらにCategory:編集保護中のテンプレートやCategory:編集半保護中のテンプレートなどのカテゴリを付与します。

したがって本テンプレートを使用しているのであれば、テンプレートを保護しても手動で{{pp-template}}を追加する必要はありません。荒らし行為や編集合戦などを理由に一時的に保護する場合、テンプレートのページにおいて{{Documentation}}より後ろに{{pp-vandalism|small=yes}}のようなテンプレート呼び出しを挿入することで、インジケーターアイコンを上書きすることができます。

引数

引数の一覧

引数	指定内容	既定値	説明
1	ページ名	{{Documentation/docname}}	解説として読み込むページ名。
content	任意の文章	{{{{{1}}}}}	解説として表示する文章。
heading	任意の文字列	解説	ヘッドラインとして表示する文字列。
heading-style	CSS書式	font-size:150%	ヘッドラインのスタイル。
heading-padding	単位つき数値（CSS書式）	3px	ヘッドラインのパディング。
heading-margin	単位つき数値（CSS書式）	1ex	ヘッドラインのマージン。
transcluded	任意の文字列	show	「show」以外を指定すると、読込先を表示しない。
sandbox-testcases	任意の文字列	show	「show」以外を指定すると、サンドボックスとテストケースの存否を表示しない。
preload	ページ名	Template:Documentation/preload	解説のページが存在しない場合にプレロードする雛形ファイル。

カテゴリ

{{Pp-template}}

このテンプレートが使用されているページが保護されている場合はCategory:編集保護中のテンプレートやCategory:編集半保護中のテンプレートなどのカテゴリを付与します。

Category:((Documentation))の解説がインラインで書かれているテンプレート (1,358)

|content=引数に解説を記入している場合に有効です。|inline_content_category=に特定の値を指定するとオーバーライドできます。

このテンプレートを使う理由

• このテンプレートを使うことによってテンプレートやその他のページが保護されていても、そのページのための解説、言語間リンク、カテゴリなどを変更することができます。
• テンプレートのページはテンプレートを表示するための空間に読み込まれますが、その空間の大きさはパフォーマンス上の理由により制限されています。解説をサブページにおけば、テンプレートのページ自体に書かれるコードを減らすことができます。

テンプレートデータ

これはビジュアルエディターやテンプレートウィザードにより使用されるテンプレートのためのTemplateData文書です。

Documentation

テンプレートページなどに、解説サブページを参照読み込みするために用います。 基本的に、パラメーターを追加する必要はありません。

テンプレートパラメーター[テンプレートデータを編集]

このテンプレートは、パラメーターを1行で記述することが推奨されています。

パラメーター		説明	型	状態
解説ページ名	1	解説として読み込むページが「/doc」サブページ以外にある際に、そのページ名を指定できます。 既定 {{Documentation/docname}} 例 Template:ほげほげ/関連テンプレート共通doc	ページ名	省略可能
インライン解説	content	あえて直接、このテンプレート内に解説を書き込むこともできます。 既定 {{{{{1}}}}}	ウィキテキストの一部	非推奨
content引数追跡解除	inline_content_category	content引数内に解説を記入すると、専用の追跡カテゴリが付与されます。無効化するには、本引数に「disabled」「no」「n」のいずれかを指定してください。 値の候補 disabled no n	短いテキスト	省略可能
解説見出し	heading	解説の見出しを変更したい場合に用います。なお、この見出しは目次に入りません。 値の候補 解説 既定 解説 例 関連テンプレート共通解説	文字列	省略可能
見出しCSS	heading-style	見出しにCSSによるスタイルを施すことができます。 既定 font-size: 150%	短いテキスト	非推奨
見出しpadding	heading-padding	見出しにCSS paddingを設けることができます。 値の候補 3px 既定 3px	文字列	非推奨
見出しmargin	heading-margin	見出しにCSS marginを設けることができます。 値の候補 1ex 既定 1ex	文字列	非推奨
読み込み可否	transcluded	あえて「show」以外を指定することで、読み込みを妨げることもできます。 値の候補 show 既定 show	ブール値	非推奨
サンドボックスとテストケースの存否秘匿	sandbox-testcases	あえて「show」以外を指定することで、サンドボックスとテストケースの存否を隠すこともできます。 既定 show	ブール値	非推奨
解説の雛形	preload	解説の雛形を指定できます。 既定 Template:Documentation/preload	ページ名	非推奨

関連項目

• Help:テンプレートの説明文
• Wikipedia:テンプレートのサンドボックスとテストケース
• {{Documentation subpage}}
• {{Template sandbox notice}}
• {{Template test cases notice}}

リダイレクト

• Template:ドキュメント
• Template:Doc

この解説は、Template:Documentation/docから呼び出されています。 (編集 | 履歴)
編集者は、このテンプレートをサンドボックス (編集 | 差分)とテストケース (編集)で試すことができます。（解説）
/docのサブページにカテゴリを追加してください。 このテンプレートのサブページ一覧。