解説[]
このテンプレートはテンプレートに解説を挿入するために使用します。
構文[]
テンプレートページの最後に<noinclude>{{documentation}}</noinclude>
を追記してください。
使用法[]
テンプレートページ上での利用[]
これは使用するときの通常のフォーマットです:
テンプレートコード<includeonly>テンプレートによって記事に挿入される任意のカテゴリ</includeonly><noinclude> {{documentation}}</noinclude>
テンプレートによっては、( noinclude タグつきで) 挿入した{{documentation}}
の前で table タグや div タグを閉じる必要があることがあります。
{{documentation}}
の直前の改行はドキュメンテーションテンプレートが前のコードに「衝突する」のを防ぐのにも役立ちます。
テンプレート名/doc ページ上での使用[]
通常は、ドキュメンテーションページには下記のようなことを書くでしょう:
== 解説 == このテンプレートは何々で使用します。 == 構文 == 何々で <code>{{t|テンプレート名}}</code> と入力してください。 == 例 == <code><nowiki>{{テンプレート名|入力}}</nowiki></code> は次のようになります... {{テンプレート名|入力}} <includeonly>テンプレート自信が所属する任意のカテゴリ</includeonly><noinclude>[[Category:テンプレートドキュメンテーション|{{PAGENAME}}]]</noinclude>
上記の解説/構文/例の出力セクションのいずれかまたはすべてを使用してください。「関連項目」や追加情報セクションを追加することもできます。
上記の例はTemplate:TとTemplate:T/pieceテンプレートも使用していることに注意してください。