Help:テンプレートの説明文
出典: Wikia
テンプレートはとても便利な機能ですが、各テンプレートをどのように使えばよいのか、どのように編集すればよいのかがわかりにくい、複雑なテンプレートも多く存在します。これらのテンプレートには、テンプレートの説明文が副えられることが望ましいでしょう。
多くのテンプレートページでは、テンプレートの使用方法を解説した部分を、<noinclude>と</noinclude>のタグの間に挿んで提示しています（例:template:cite news）。 このような解説文は、テンプレートの呼びだし先には表示されず、テンプレートページでのみ表示されるようになっています。しかし、この方式には欠点があります。
- <noinclude>...</noinclude>に囲まれたテキストは「展開前のサイズ pre-expand include size」に計上されてしまい、これには上限があります（参照：en:Wikipedia:Template limits）。
- いくつかのテンプレートは、その編集が多くのページに与える多大な影響を考慮し、保護されています。この場合、解説文書の編集は管理者に依頼するよりほかありません。
このため、サブページを使って、テンプレート本体から解説文書を別ページとして安全に切り離すための方法も整備されています。これにより解説文書は保護せずに、テンプレート本体を完全に保護することが可能となり、複雑なテンプレートが破壊される恐れなしに、解説文書を誰でも編集できるようになります。
[編集] サブページを使う方法
テンプレートの解説文をサブページにおく場合、Template:X という名前のテンプレートに対して、 Template:X/doc というサブページを作成し、以下をコピーします。
テンプレートの解説ページ（Template:X/doc）に貼り付けるコード
<includeonly>{{テンプレート文書呼出}}</includeonly><noinclude>{{テンプレート文書直接表示}}</noinclude>
<!-- 以下でテンプレートの解説を編集してください -->
<includeonly>
<!-- カテゴリは以下に追加してください -->
<!-- 言語間リンクは以下に追加してください -->
</includeonly>
解説文書、カテゴリ、言語間リンクはそれぞれの位置を示したコメント行以下に挿入することが推奨されます（上記を参照）。
Template:X のページでは、テンプレート本体の後に以下を追加します。
テンプレート本体（Template:X）に貼り付けるコード
<noinclude>
{{{{FULLPAGENAME}}/doc}}
<!-- カテゴリと言語間リンクはここではなく、/doc サブページに追加してください -->
</noinclude>
注意: <noinclude> は改行せずにテンプレート本体の最後の文字と同じ行に続けて配置するようにして下さい。そうしないと、余分な改行がテンプレートを呼び出したページに反映されてしまいます。また、サブページのタイトルは必ず"/doc"としてください。
この方法を導入することによって、テンプレートの解説文書（Template:X/doc）は誰でも自由に編集できる状態でありながら、テンプレート本体（Template:X）には保護をかけることが可能になります。
[編集] 関連項目
| このページの内容は、ウィキペディアから取られています。オリジナルの記事は、テンプレートの説明文にあります。この記事の著作権者のリストは、ページの履歴を御覧ください。Wikiaと同じく、ウィキペディアのテキストは、GNU Free Documentation Licenseで提供されています。 |