テンプレート:Documentation

テンプレートのドキュメンテーション
注意: 上記のテンプレートは部分的または完全に非表示になることがあります。
このドキュメンテーションを編集するにはテンプレート:Documentation/docにアクセスしてください。(これはどう機能する？)

解説

このテンプレートはテンプレートに解説を挿入する目的で使用します。

構文

テンプレートページの最後に<noinclude>{{documentation}}</noinclude>を追記してください。

使用法

テンプレートページ上での利用

これは通常のフォーマットでの使用例です:

テンプレートコード<includeonly>テンプレートによって記事に挿入される任意のカテゴリ</includeonly><noinclude>
{{documentation}}</noinclude>

テンプレートによっては、( noinclude タグつきで) 挿入した{{documentation}}の前で table タグや div タグを閉じる必要がある場合があります。

{{documentation}} の直前の改行はドキュメンテーションテンプレートが前のコードに「衝突する」のを防ぐのにも役立ちます。

テンプレート名/doc ページ上での使用

通常は、ドキュメンテーションページには下記のようなことを書くとよいでしょう:

== 解説 ==
このテンプレートは何々で使用します。

== 構文 ==
何々で <code>{{t|テンプレート名}}</code> と入力してください。
== 例 ==

<code><nowiki>{{テンプレート名|入力}}</nowiki></code> 

は次のようになります...

{{テンプレート名|入力}}

<includeonly>テンプレート自信が所属する任意のカテゴリ</includeonly><noinclude>[[カテゴリ:テンプレートドキュメンテーション|{{PAGENAME}}]]</noinclude>

上記の解説／構文／例の出力セクションのいずれかまたはすべてを使用してください。「関連項目」や追加情報セクションを追加することもできます。

上記の例はテンプレート:Tとテンプレート:T/pieceテンプレートも使用していることに注意してください。