「テンプレート:Documentation/doc」を編集中

<noinclude>{{Documentation subpage}}</noinclude>
<includeonly>{{使用箇所の多いテンプレート|13,000以上}}{{Lua|モジュール:Documentation}}</includeonly>
このテンプレートは今ここに表示されているような[[Help:テンプレートの説明文|解説]]を、他のページから自動的に呼び出して表示します。このテンプレートは他のページに呼び出されるようなページに解説を加えることに使われ、おもにテンプレートでの使用を想定していますが名前空間によって制限されているわけではありません。

__TOC__
== 使い方 ==
=== 基本 ===
あなたがこのテンプレートを使用しようとしているページが「Template:テンプレート名例示用」だとすると「Template:テンプレート名例示用<u>/doc</u>」に解説を書いて保存し、「Template:テンプレート名例示用」に次のコードを付け足してください。
 &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}&#125;&#125;&lt;/noinclude&gt;

=== ページ指定 ===
解説が保存されているページが「Template:any page/doc」である場合、次のコードを「Template:テンプレート名例示用」に付け足してください。
 &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}|Template:any page/doc&#125;&#125;&lt;/noinclude&gt;

=== インライン・コンテンツ ===
解説を別のページに保存せず、次のように「Template:テンプレート名例示用」に直接書き込むこともできます。
 &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}|content=This is documentation.&#125;&#125;&lt;/noinclude&gt;
「Template:テンプレート名例示用/doc」が存在する場合は、そちらも同時に表示されます。
*'''注意'''：「|content=」で指定した部分に含まれている[[Help:表の作り方#パイプ構文|パイプ構文の表]]は'''正しく表示されません'''。「|content=」で指定する部分に表を作成する場合はパイプ構文ではなくHTMLタグを使用するようにしてください（「/doc」等のこのテンプレートによって呼び出されたページにパイプ構文の表が含まれる場合は、'''正しく表示されます'''）。

=== ヘッドラインを変更する ===
次のように書き込めば、ヘッドライン（冒頭表示）を変更できます。
 &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}|heading=変更したヘッドライン&#125;&#125;&lt;/noinclude&gt;

もし次のように heading 引数を空にすれば、ヘッドラインは表示されません。
 &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}|heading=&#125;&#125;&lt;/noinclude&gt;

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

== 特別な機能 ==
=== プリロード ===
もし解説のページが存在しなければ、[編集]リンクは[[Template:Documentation/preload]]から解説の雛形ファイルを[[mw:Manual:Creating pages with preloaded text/ja|プリロード]]します。

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

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

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

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

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

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

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

== このテンプレートを使う理由 ==
* このテンプレートを使うことによってテンプレートやその他のページが[[Wikipedia:保護の方針|保護]]されていても、そのページのための解説、言語間リンク、カテゴリなどを変更することができます。
* テンプレートのページはテンプレートを表示するための空間に読み込まれますが、その空間の大きさはパフォーマンス上の理由により[[Help:テンプレートの制限|制限されています]]。解説をサブページにおけば、テンプレートのページ自体に書かれるコードを減らすことができます。
== テンプレートデータ ==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "解説ページ名",
			"type": "wiki-page-name",
			"description": "解説として読み込むページが「/doc」サブページ以外にある際に、そのページ名を指定できます。",
			"example": "Template:ほげほげ/関連テンプレート共通doc",
			"default": "{{Documentation/docname}}"
		},
		"content": {
			"label": "インライン解説",
			"type": "unbalanced-wikitext",
			"description": "あえて直接、このテンプレート内に解説を書き込むこともできます。",
			"default": "{{{{{1}}}}}"
		},
		"heading": {
			"label": "解説見出し",
			"example": "関連テンプレート共通解説",
			"type": "string",
			"suggestedvalues": [
				"解説"
			],
			"description": "解説の見出しを変更したい場合に用います。なお、この見出しは目次に入りません。",
			"default": "解説"
		},
		"heading-style": {
			"label": "見出しCSS",
			"type": "line",
			"default": "font-size: 150%",
			"description": "見出しにCSSによるスタイルを施すことができます。",
			"deprecated": "可読性の維持などの消極的な理由を除き、CSSによる装飾は望ましいものではありません。"
		},
		"heading-padding": {
			"label": "見出しpadding",
			"description": "見出しにCSS paddingを設けることができます。",
			"type": "string",
			"default": "3px",
			"suggestedvalues": [
				"3px"
			],
			"deprecated": true
		},
		"heading-margin": {
			"label": "見出しmargin",
			"type": "string",
			"default": "1ex",
			"description": "見出しにCSS marginを設けることができます。",
			"suggestedvalues": [
				"1ex"
			],
			"deprecated": "可読性の維持などの消極的な理由を除き、CSSによる装飾は望ましいものではありません。"
		},
		"transcluded": {
			"label": "読み込み可否",
			"description": "あえて「show」以外を指定することで、読み込みを妨げることもできます。",
			"type": "boolean",
			"suggestedvalues": [
				"show"
			],
			"default": "show",
			"deprecated": "解説ページは、サブページから読み込んで表示することが望ましいです。"
		},
		"sandbox-testcases": {
			"label": "サンドボックスとテストケースの存否秘匿",
			"description": "あえて「show」以外を指定することで、サンドボックスとテストケースの存否を隠すこともできます。",
			"type": "boolean",
			"default": "show",
			"deprecated": "バックヤードであるテンプレート解説ページに於いて、あえて隠すことが望ましい状況か考えてから適用しましょう。"
		},
		"preload": {
			"label": "解説の雛形",
			"description": "解説の雛形を指定できます。",
			"type": "wiki-page-name",
			"default": "Template:Documentation/preload",
			"deprecated": "基本的な雛形は既に提供してあります。"
		}
	},
	"description": "テンプレートページなどに、解説サブページを参照読み込みするために用います。\n基本的に、パラメーターを追加する必要はありません。",
	"format": "inline"
}
</templatedata>
== 関連項目 ==
* [[Help:テンプレートの説明文]]
* [[Wikipedia:テンプレートのサンドボックスとテストケース]]
* {{Tl|Documentation subpage}}
* {{Tl|Template sandbox notice}}
* {{Tl|Template test cases notice}}
=== リダイレクト ===
* [[Template:ドキュメント]]
* [[Template:Doc]]
<includeonly>{{Sandbox other||
{{デフォルトソート:{{PAGENAME}}}}
[[Category:テンプレート文書| ]]
[[Category:テンプレート用テンプレート]]
}}</includeonly>