テンプレート:Documentation/doc

提供: SOS団Miraheze支部
ナビゲーションに移動 検索に移動

概要

テンプレートページに説明文を記載するために使うテンプレート。

構文

テンプレートページの終わりに、<noinclude>{{documentation}}</noinclude>と追加する。

使用法

テンプレートページ上で

標準的な用法は次の通り。

テンプレート本体のソースコード<includeonly>記事のみに入れるべきカテゴリなど</includeonly><noinclude>
{{documentation}}</noinclude>

テンプレートが、閉じていないdivタグやWikitableで構成されている場合、{{documentation}}<noinclude>の間にタグを入れて閉じることで、表示崩れを防げる。また、場合によっては、{{documentation}}の前に改行を挟むことで、表示崩れや専攻のソースコードの反映を防ぐことができる。

テンプレート/docページ上で

標準的には、以下のような構成によって、テンプレートの使用法を説明する。但し、全てのテンプレートでここまでフォーマルに説明が記載されているとは限らないので注意。

== 概要 ==
テンプレートの用途。

== 構文 ==
<code>{{t|テンプレート名|引数があれば引数等}}</code>と入力する。

== 入出力例 ==
<code><nowiki>{{テンプレート名|引数}}</nowiki></code> 

と入力すると、以下のような出力を得る。

{{テンプレート名|引数}}

<includeonly>テンプレートページにのみ入れたいカテゴリ</includeonly><noinclude>{{DEFAULTSORT:平仮名濁点・半濁点・小文字抜きの表記}}[[Category:説明用テンプレート]]</noinclude>

必要に応じて、「関連項目」節を付けたり、一部説明を省略したりできる。

関連項目