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

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

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


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

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

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

テンプレートを使ったページに説明文が表示されてしまわないよう <noinclude>...</noinclude> を使う必要があります。Help:テンプレート#一部を無視させるです。

解説用のサブページを用意してそこで説明する
<noinclude>{{Documentation}}</noinclude>
{{Documentation}}を使った場合、解説用のサブページを作るためのリンクが作成されますので、それに従って解説ページを作成します。
別に分けることで、テンプレートが更新されたのか、解説が更新されたのか、容易に区別できるようになります。解説文を変更しようとして間違ってテンプレートを編集してしまう危険性も防げます。多くのページで使われているテンプレートは編集できないよう保護して、説明文書を編集できるように、分離することも可能です。
直接テンプレートに書く
この方法は、簡単な説明で済む場合に適しています。
  1. <noinclude>説明文</noinclude>
  2. <noinclude>{{Documentation|content=説明文}}</noinclude>
{{Documentation}}|content=引数を使うことで、説明文が解説用のテキストであることを明確にできます。

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

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

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

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

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

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

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

実例[編集]

関連項目[編集]