テンプレートは、コンテンツの断片をナレッジベース記事内で再利用するためのものです。定型の手順を複数の記事に書く代わりに、テンプレートを 1 本作成して更新し、他のページから参照してください。テンプレートを使用すれば、そのテンプレートを更新するだけで、それを参照するすべてのページが自動的に更新されます。
テンプレートとは何か
テンプレートは、タイトルが「Template:」で始まる特別な Wiki ページです。テンプレートには Wiki ページの機能がすべて使えます。翻訳したり履歴を残したり、Wiki マークアップを記述することもできます。
テンプレートを作成するには
- 新しいナレッジベース記事を作成 します。あらかじめ、テスト用のサーバで新しい記事を作成 してみてください。
- タイトルは必ず「Template:」で始めてください。例: Template:aboutconfig
- カテゴリを「テンプレート」(Template) にセットしてください。
- 他のナレッジベース記事と同じようにテンプレートの内容を書いてください。
テンプレートを記事に含めるには
テンプレートを Wiki ページ内で使うには、そのページ内にテンプレートへの「リンク」を書くだけです。 例えば、次のように記述します:
[[Template:Some Template]]
または
[[T:Some Template]]
このように記述すると、リンクが作成される代わりに、Template:Some Template の内容が記事に挿入されます。テンプレート内の Wiki マークアップも解釈されます。
テンプレートと順序付きリスト
多くの場合、テンプレート内の順序付きリストは他のナレッジベースドキュメントと同じ方法で記述して動作します。しかし、例外があります。テンプレートが順序付きリストで、元記事の大きな順序付きリスト内で使用された場合、全体の順序が乱れます。
回避策:
テンプレート内の手順リストには、「#」を使用しないでください。代わりに、2 番目以降の手順項目を <li> </li> で次のように囲んでください:
これはリストの最初の手順です
<li>これは 2 番目の手順です</li>
<li>これは 3 番目の手順です</li>
次に、記事内にテンプレートを追加するときは、テンプレートの前に「#」を追加してください:
#[[T:List]]
#これはテンプレートに含まれないもう一つの手順です
上記は次のように展開されます:
- これはリストの最初の手順です
- これは 2 番目の手順です
- これは 3 番目の手順です
- これはテンプレートに含まれないもう一つの手順です
もう一つ重要なことがあります。これらのテンプレート内で、ブロックレベルの {for} を使うことはできません。例えば:
悪い例:
{for not fx10}
最初の手順 - Firefox 9 以前
{/for}
{for fx10}
最初の手順 - Firefox 10 以降
{/for}
<li>これは 2 番目の手順です</li>
良い例:
{for not fx10}最初の手順 - Firefox 9 以前{/for}{for fx10}
最初の手順 - Firefox 10 以降{/for}
<li>これは 2 番目の手順です</li>
テンプレートに引数を指定する
テンプレートには引数を渡すことができます。これは、ほとんど 同じ内容のものを再利用するためです。
例を挙げてみましょう。記事が Firefox 4 だけに適用されることをユーザに知らせるテンプレートがあり、もう一つのテンプレートは、Firefox 3.6 にだけ適用されることを知らせるものがあるとします。これらのテキストの内容はバージョン番号を除いて全く同じです。このような時はテンプレートを使いましょう！
Template:OnlyVersionX:
{note}このドキュメントまたはセクションは、'''Firefox {{{1}}}''' にのみ適用されます。{/note}
上記のテンプレートは、ある Wiki ページで次のように使用されます:
[[Template:OnlyVersionX|4]]
また別のページでは、次のように使用できます:
[[Template:OnlyVersionX|3.6]]
テンプレートには複数の引数を渡すこともできます。または、同じ引数を 2 回渡すこともできます。
Template:XLikesY:
# {{{2}}} likes {{{1}}}.
# {{{3}}} likes {{{2}}}.
# Class! Nobody likes {{{2}}}!
上記のテンプレートは次のように使用します:
[[Template:XLikesY|Lisa|Milhouse|Janey]]
これは、次のように展開されます:
- Milhouse likes Lisa.
- Janey likes Milhouse.
- Class! Nobody likes Milhouse!
複数の引数に数字を使うのは混乱することがあるため、テンプレートには 引数名 を使うこともできます:
Template:XPrecededY:
First comes {{{first}}}, then comes {{{second}}}.
上記のテンプレートは次のように使用します:
[[Template:XPrecededY|first=love|second=marriage]]
名前付きの引数では、テンプレートを使用する時に、その記述順を気にする必要はありません:
[[Template:XPrecededY|second=marriage|first=love]]
上記の Template:XPrecededY テンプレートの使用例は、どちらも同じ結果になります。
