Template:Documentation/doc

これはTemplate:Documentationの解説かいせつサブページです。
使用しよう方法ほうほう、カテゴリ、およびその他たテンプレートページ自体じたいに含ふくまれない情報じょうほうを収容しゅうようしています。

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

使つかい方かた[編集へんしゅう]

基本きほん[編集へんしゅう]

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

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

ページ指定してい[編集へんしゅう]

解説かいせつが保存ほぞんされているページが「Template:any page/doc」である場合ばあい、次つぎのコードを「Template:テンプレート名めい例示れいじ用よう」に付つけ足たしてください。

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

インライン・コンテンツ[編集へんしゅう]

解説かいせつを別べつのページに保存ほぞんせず、次つぎのように「Template:テンプレート名めい例示れいじ用よう」に直接ちょくせつ書かき込こむこともできます。

<noinclude>{{Documentation|content=This is documentation.}}</noinclude>

「Template:テンプレート名めい例示れいじ用よう/doc」が存在そんざいする場合ばあいは、そちらも同時どうじに表示ひょうじされます。

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

ヘッドラインを変更へんこうする[編集へんしゅう]

次つぎのように書かき込こめば、ヘッドライン（冒頭ぼうとう表示ひょうじ）を変更へんこうできます。

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

もし次つぎのように heading 引数ひきすうを空そらにすれば、ヘッドラインは表示ひょうじされません。

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

注意ちゅうい[編集へんしゅう]

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

特別とくべつな機能きのう[編集へんしゅう]

プリロード[編集へんしゅう]

もし解説かいせつのページが存在そんざいしなければ、[編集へんしゅう]リンクは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	解説かいせつのページが存在そんざいしない場合ばあいにプレロードする雛形ひながたファイル。

カテゴリ[編集へんしゅう]

このテンプレートが使用しようされているページが保護ほごされている場合ばあいはCategory:編集へんしゅう保護ほご中ちゅうのテンプレートやCategory:編集へんしゅう半はん保護ほご中ちゅうのテンプレートなどのカテゴリを付与ふよします。

このテンプレートを使つかう理由りゆう[編集へんしゅう]

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