Documentation

テンプレートドキュメンテーション (上記に表示されるテンプレートは隠蔽／不可視になることがあります)

このドキュメンテーションはテンプレート:Documentation/docからトランスクルードされています。(編集 | 履歴)

解説

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

構文

テンプレートの終わりにに<noinclude>{{documentation}}</noinclude>と入力してください。

一般的な使用法

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

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

テンプレートによっては、(noincludeタグつきで)挿入した{{documentation}}の前をクリアにするか、table/dicタグを閉じる必要があることがあります。

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

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

;解説
:このテンプレートがやる何かに利用します。
;構文
:どこかで<code>{{t|テンプレート名}}</code>と入力してください。
;出力例
:<code><nowiki>{{テンプレート名|foo}}</nowiki></code> は次のようになります...
:{{テンプレート名|foo}}

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

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

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

このテキストを編集するにはTemplate:Documentation/docにアクセスしてください！ (これはどう機能する？)