Fandom


ヘルプ

Fandomにおける基本的なテンプレートのレイアウトを説明します。

はじめに

テンプレートページには、テンプレートのコードを記述します。/docサブページには、そのテンプレートの解説と、テンプレートのカテゴリを記述します。このサブページは、テンプレート解説ページ (または、テンプレートドキュメンテーション) と呼ばれています。

このように構成することで、解説を更新した場合には、テンプレートを使用しているたくさんのページにそれを反映させる負荷がかからなくなります。また、(解説ページを保護することなく)テンプレートページのみを保護することもできます。

解説
このテンプレートはテンプレートに解説を挿入する目的で使用します。
構文
テンプレートページの最後に<noinclude>{{documentation}}</noinclude>を追記してください。

テンプレートの記述例

テンプレート解説ページを使用する場合

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

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

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

テンプレート解説ページ (/doc サブページ)
;解説
:このテンプレートは……に使用します。

;必要なファイル <!-- 空の場合はなし -->
<!-- このテンプレートが使用しているモジュール、CSS、JS、画像、他のテンプレートについて -->
:* 

;構文
:……に <code>{{t|テンプレート名|引数1 <!-- 空の場合はなし -->}}</code> と入力してください。

;使用例
:<code>{{テンプレート名|入力1 <!-- 空の場合はなし -->|入力2= <!-- 空の場合はなし -->}}</code> は次のようになります...
:{{テンプレート名|入力1 <!-- 空の場合はなし -->|入力2= <!-- 空の場合はなし -->}}

;関連項目 <!-- 空の場合はなし -->
:* [[テンプレート:<!-- 関連するテンプレート -->]] <!-- 空の場合はなし -->
:* [[<!-- その他の関連情報 -->]] <!-- 空の場合はなし -->

<includeonly>
{{DEFAULTSORT:テンプレート名が日本語の場合はソートキー}}
<!-- テンプレートのカテゴリ・言語間リンク -->
</includeonly><noinclude>
{{DEFAULTSORT:テンプレート名が日本語の場合はソートキー}}[[カテゴリ:テンプレート文書]]
<!-- テンプレート解説ページの言語間リンク -->
</noinclude>

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

上記の例はテンプレート:T(および、Template Wikiの新しいテンプレート:Tを導入していない場合はテンプレート:T/piece)テンプレートも使用していることに注意してください。

テンプレート解説ページを使用しない場合

テンプレートページ
;解説
:このテンプレートは……に使用します。

;構文
:……に <code>{{t|テンプレート名|引数1 <!-- 空の場合はなし -->}}</code> と入力してください。

;使用例
:<code>{{テンプレート名|入力1 <!-- 空の場合はなし -->|入力2= <!-- 空の場合はなし -->}}</code> は次のようになります...
:{{テンプレート名|入力1 <!-- 空の場合はなし -->|入力2= <!-- 空の場合はなし -->}}
----
;テンプレート
<onlyinclude><!-- テンプレートコード --><includeonly><!-- テンプレートによって記事に挿入される任意のカテゴリ --></includeonly></onlyinclude>
<!-- 任意で -->{{documentation}}
{{DEFAULTSORT:テンプレート名が日本語の場合はソートキー}}
<!-- テンプレートのカテゴリ・言語間リンク -->

ぜひテンプレート解説ページを使ってください

冒頭でテンプレート解説ページ (テンプレート:テンプレート名/doc) についてご紹介したとおり、ぜひテンプレートページとは別に解説ページを作成してください。特に、解説が詳しくなったり、たくさんの例を載せていたりする場合、解説ページを作成することは有効です。

/doc サブページを使用して解説ページを作成する場合、{{Documentation}} テンプレートをテンプレートページに含めることになり、そのテンプレートはサブページと依存関係になります。また、/doc サブページにテンプレートのカテゴリを記述する方法は、慣れるまでは難しく感じるでしょう。そのため、簡単な解説のみの、単純なテンプレートであれば、テンプレートページの中に解説を含めるほうが、テンプレートページ単体で済み、手軽だとする考え方もあります。

この方法でレイアウトする場合に使用するテンプレート

このページで紹介したコードを正しく機能させるため、以下のテンプレートが必要です。

関連情報

その他のヘルプとフィードバック

特に記載のない限り、コミュニティのコンテンツはCC-BY-SA ライセンスの下で利用可能です。