テンプレート: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」が存在する場合は、そちらも同時に表示されます。
- 注意：「|content=」で指定した部分に含まれているパイプ構文の表は正しく表示されません。「|content=」で指定する部分に表を作成する場合はパイプ構文ではなくHTMLタグを使用するようにしてください。（「/doc」等のこのテンプレートによって呼び出されたページにパイプ構文の表が含まれる場合は、正しく表示されます。）
ヘッドラインを変更する
次のように書き込めば、ヘッドラインを変更できます。
<noinclude>{{Documentation|heading=変更したヘッドライン}}</noinclude>
もし次のように heading 引数を空にすれば、ヘッドラインは表示されません。
<noinclude>{{Documentation|heading=}}</noinclude>
注意
これらのコードは<noinclude>の前に余分な空白をつけずに、テンプレートやその他の解説を呼び出したいページに付け加えてください。もし、解説・説明文書のページが<includeonly>や<noinclude>といったタグを解説の一部として含むならば「<」を「<」で置き換えてください。
特別な機能
プリロード
もし解説のページが存在しなければ、[編集]リンクは Template:Documentation/preload から解説の雛形ファイルをプリロードします。
プリロードするファイルは、preload 引数で変更できます。
サンドボックスとテストケースとの連携
このテンプレートはサンドボックスとテストケースの存在を確認し、存在していればそのことを存在していなくてもそのことを通知しサンドボックスとテストケースの使用に誘導します。
この機能は、sandbox-testcases引数に「show」以外を指定することによってキャンセルできます。
引数
| 引数 | 指定内容 | 既定値 | 説明 |
|---|---|---|---|
| 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 | 解説のページが存在しない場合にプレロードする雛形ファイル。 |
カテゴリ
このテンプレートが貼り付けられたページに適用するカテゴリはありません。
このテンプレートを使う理由
- このテンプレートを使うことによってテンプレートやその他のページが保護されていても、そのページのための解説、言語間リンク、カテゴリなどを変更することができます。
- テンプレートのページはテンプレートを表示するための空間に読み込まれますが、その空間の大きさはパフォーマンス上の理由により制限されています。解説をサブページにおけば、テンプレートのページ自体に書かれるコードを減らすことができます。