「テンプレート:Documentation」の版間の差分

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

使い方

基本

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

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

ページ指定

解説が保存されているページが「Template:any page/doc」である場合、次のコードを「Template:X」に付け足してください。

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

インライン・コンテンツ

解説を別のページに保存せず、次のように、「Template:X」に直接書き込むこともできます。

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

「Template:X/doc」が存在する場合は、そちらも同時に表示されます。

ヘッドラインを変更する

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

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

もし、次のように「heading」パラメータを空にすれば、ヘッドラインは表示されません。

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

注意

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

特別な機能

プレロード

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

プレロードするファイルは、preloadパラメータで変更できます。

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

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

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

パラメータ

カテゴリ

このテンプレートが貼り付けられたページに適用するカテゴリはありません。

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

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

関連項目

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