Help:テンプレートの説明せつめい文ぶん

ウィキペディア日本語にほんご版ばんのヘルプページです。

---

テンプレートの説明せつめい文ぶんの記述きじゅつ方法ほうほうについて解説かいせつします。テンプレートは各かくページにて繰くり返かえし用もちいられる記述きじゅつを簡易かんい化かできるため、とても便利べんりな機能きのうですが、テンプレートの説明せつめい文ぶんが添そえられることが望のぞましいでしょう。複雑ふくざつなテンプレートも多おおく存在そんざいするためです。

テンプレートのページに書かく方法ほうほう

テンプレートを使つかったページに説明せつめい文ぶんが表示ひょうじされてしまわないよう <noinclude>...</noinclude> を使つかう必要ひつようがあります。「Help:テンプレート#一部いちぶを無視むしさせる」を参照さんしょう。

解説かいせつ用ようのサブページを用意よういしてそこで説明せつめいする

<noinclude>{{Documentation}}</noinclude>

{{Documentation}}を使つかった場合ばあい、解説かいせつ用ようのサブページを作つくるためのリンクが作成さくせいされますので、それに従したがって解説かいせつページを作成さくせいします。

別べつに分わけることで、テンプレートが更新こうしんされたのか、解説かいせつが更新こうしんされたのか、容易よういに区別くべつできるようになります。解説かいせつ文ぶんを変更へんこうしようとして間違まちがってテンプレートを編集へんしゅうしてしまう危険きけん性せいも防ふせげます。多おおくのページで使つかわれているテンプレートは編集へんしゅうできないよう保護ほごして、説明せつめい文書ぶんしょを編集へんしゅうできるように、分離ぶんりすることも可能かのうです。

直接ちょくせつテンプレートに書かく

この方法ほうほうは、簡単かんたんな説明せつめいで済すむ場合ばあいに適てきしています。

1. <noinclude>説明せつめい文ぶん</noinclude>
2. <noinclude>{{Documentation|content=説明せつめい文ぶん}}</noinclude>

{{Documentation}}の|content=引数ひきすうを使つかうことで、説明せつめい文ぶんが解説かいせつ用ようのテキストであることを明確めいかくにできます。

解説かいせつサブページを作成さくせいする方法ほうほう

前述ぜんじゅつのとおり、テンプレート本体ほんたいには、<noinclude>{{Documentation}}</noinclude> を記述きじゅつします。これで説明せつめい文ぶんとカテゴリはサブページに移行いこうすることができます。

注意ちゅうい: <noinclude> は改行かいぎょうせずにテンプレート本体ほんたいの最後さいごの文字もじと同おなじ行ぎょうに続つづけて配置はいちするようにして下ください。そうしないと、余分よぶんな改行かいぎょうがテンプレートを呼よび出だしたページに反映はんえいされてしまいます。

注意ちゅうい: 既存きそんの解説かいせつ文ぶんをサブページに移行いこうする場合ばあいは、ページの分割ぶんかつと統合とうごう#分割ぶんかつの手順てじゅんに従したがって履歴りれきの継承けいしょうを行おこなう必要ひつようがあります。

テンプレート本体ほんたい（Template:X）に貼はり付つけるコード

<!-- テンプレートの本体ほんたいコード --><noinclude>
{{Documentation}}
<!-- カテゴリはここではなく、/doc サブページに追加ついかしてください -->
</noinclude>

次つぎに右みぎ上じょうの[作成さくせい]のリンクをクリックすると、説明せつめい文ぶんの雛形ひながたが記述きじゅつされた Template:X/doc の編集へんしゅう画面がめんが開ひらくのでコメント文ぶんを参考さんこうに編集へんしゅうして、解説かいせつサブページの完成かんせいです。説明せつめい文ぶん、カテゴリ、{{複雑ふくざつなテンプレート}}や{{告知こくち}}のようなテンプレートも全すべてサブページに記述きじゅつします。

実例じつれい

• Template:Documentation - サブページを使つかった例れい
• Template:Documentation/doc - 解説かいせつサブページの例れい

関連かんれん項目こうもく

• Template:Documentation subpage - そのページが解説かいせつサブページだと表示ひょうじします。
• Wikipedia:テンプレートのサンドボックスとテストケース