Help:テンプレートの説明文

出典: フリー百科事典『ウィキペディア(Wikipedia)』
移動: 案内検索
ようこそ - ガイドブック - チュートリアル - 早見表 - FAQ - ヘルプ - 用語集 - 利用案内 - 質問

このページはウィキペディア日本語版ヘルプページです。


編集の基本
ページの編集
新規ページの作成
記事名チェック
文書の体裁
セクションと目次
箇条書き   表の作り方
脚注 | ISBNのリンク
特殊文字
HTMLタグの使用
画像などの利用
画像の表示
ファイルページ
数式の書き方
リンクする
リンク | URL
パイプ付きリンク
言語間・ウィキ間リンク
ウィキデータ
カテゴリ
リダイレクトソフト
ページの位置づけ
名前空間
サブページ
ミスなどの修正
新規ページのパトロール
以前の版にページを戻す方法
ページの移動
作業の効率化
マジックワード
テンプレート早わかり
テンプレートの制限
条件文 | テンプレートの説明文
ナビゲーションボックス
コミュニケーション
要約欄
細部の編集
ノートページ | 過去ログ
ウィキラブ
ウィキメール | 感謝
その他
編集の競合
ページ名の働き
記事の定義
ページサイズ
音声・動画の作成と利用
棒グラフの書き方
サンドボックス
ウィキポータル
ヘルプの目次へ

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

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

最も簡単な方法は、テンプレートの使用方法を解説した部分を<noinclude>と</noinclude>のタグの間に挿んで提示するものです。 また、Template:Documentationを用いて<noinclude>{{Documentation|content=「解説文」}}</noinclude> とする方法もあります。このような解説文は、テンプレートの呼び出し先には表示されず、テンプレートページでのみ表示されるようになっています。簡単な説明の場合にはこれで十分ですが、テンプレート自体が複雑な内容の場合、解説文を変更しようとして間違ってテンプレートを編集してしまう危険性が常にあります。また、いくつかのテンプレートは、その編集が多くのページに与える多大な影響を考慮し、保護されています。この場合、解説文書の編集は管理者に依頼するよりほかありません。

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

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

ここでは、Template:X に解説サブページを作成するものとして解説します。

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

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

注意:既存の解説文をサブページに移行する場合は、Wikipedia:ページの分割と統合#分割の手順に従って履歴の継承を行う必要があります。

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

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

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

実例[編集]

関連項目[編集]