「ヘルプ:テンプレートの説明文」の版間の差分

2019年4月2日 (火) 22:15時点における最新版

テンプレートはとても便利な機能ですが、各テンプレートをどのように使えばよいのか、どのように編集すればよいのかがわかりにくい、複雑なテンプレートも多く存在します。これらのテンプレートには、テンプレートの説明文が副えられることが望ましいでしょう。ここでは、テンプレートの説明文の記述方法について解説します。

テンプレートのページに書く方法[編集]

最も簡単な方法は、テンプレートの使用方法を解説した部分を<noinclude>と</noinclude>のタグの間に挿んで提示するものです。 また、Template:Documentationを用いて<noinclude>{{Documentation|content=「解説文」}}</noinclude>とする方法もあります。このような解説文は、テンプレートの呼びだし先には表示されず、テンプレートページでのみ表示されるようになっています。簡単な説明の場合にはこれで十分ですが、この方式には欠点があります。

• <noinclude>...</noinclude>に囲まれたテキストは「展開前のサイズ pre-expand include size」に計上されてしまい、これには上限があります（詳しくはHelp:テンプレートの制限を参照してください）。
• いくつかのテンプレートは、その編集が多くのページに与える多大な影響を考慮し、保護されています。この場合、解説文書の編集は管理者に依頼するよりほかありません。

このため、サブページを使って、テンプレート本体から解説文書を別ページとして安全に切り離すための方法も整備されています。これにより解説文書は保護せずに、テンプレート本体を完全に保護することが可能となり、複雑なテンプレートが破壊される恐れなしに、解説文書を誰でも編集できるようになります。

解説サブページを作成する方法[編集]

ここでは、Template:Xに解説サブページを作成するものとして解説します。ただし、この方法は名前空間によって制限されるものではないことに注意してください。

まず、Template:Xの最後の行にTemplate:Documentationを<noinclude>タグで囲んで貼り付け、編集を完了します。これでテンプレート本体には、本体コードとTemplate:Documentationのみを記述して、説明文、言語間リンク、カテゴリはサブページに移行することができます。

注意: <noinclude> は改行せずにテンプレート本体の最後の文字と同じ行に続けて配置するようにして下さい。そうしないと、余分な改行がテンプレートを呼び出したページに反映されてしまいます。

テンプレート本体（Template:X）に貼り付けるコード

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

次に右上の[編集]のリンクをクリックすると、説明文の雛形が記述されたTemplate:X/docの編集画面が開くのでコメント文を参考に編集して、解説サブページの完成です。説明文、言語間リンク、カテゴリ、{{複雑なテンプレート}}や{{告知}}のようなテンプレートも全てサブページに記述します。

実例[編集]

• Template:Commons - サブページを使わないでタグを使った例
• Template:郵便局 - サブページを使わないでテンプレートを使った例
• Template:国際化 - サブページを使った例

関連項目[編集]

• Template:Documentation
• Template:Documentation subpage
• Yourpedia:テンプレートのサンドボックスとテストケース
• Help:テンプレート#一部を無視させる - <noinclude>と<includeonly>の解説

このページはウィキペディア日本語版のコンテンツ・ヘルプ:テンプレートの説明文を利用して作成されています。変更履歴はこちらです。