ヘルプ:テンプレート
複雑なマークアップや記述を短く書くために呼び出されるページのことをテンプレートと呼びます。多くはテンプレート名前空間に置かれています。
記事の書式を定めたひな形もテンプレートと呼ばれますが、これらは全く別のものです。このページでは前者のテンプレートについて説明します。
テンプレートを使う
テンプレートを呼び出すときには{{テンプレート名}}と書きます。たとえば、Template:未確定を呼び出すときには{{未確定}}とします。
テンプレート名前空間にないものを呼び出すときは{{名前空間名:テンプレート名}}とすると呼び出せます。標準名前空間にあるものを呼び出すときには{{:記事名}}とすると呼び出せます。
引数を入力するときは「|」(パイプ記号)で区切ります。
{{テンプレート名|引数の名前1=引数1|引数の名前2=引数2}}
引数の名前が数字である場合は、引数の名前を省略することができます。ただし、数字と同じ順番で書く必要があります。
{{テンプレート名|引数1|引数2}}
テンプレートを展開して使う
{{subst:テンプレート名}}と記述すると 保存時にテンプレートのソースコードが展開されます。
なお、「subst」は大文字(Subst)でも問題なく動作します。
テンプレートを作る
テンプレートの編集方法は普通の記事を編集するときと基本的には同じです。入力した内容がそのまま呼び出したときに表示されます。<noinclude>呼出時表示したくない部分</noinclude>のようにするとその部分は呼び出したときには表示されません(テンプレートのカテゴリなど)。
逆に呼び出したときだけ表示したい部分は<includeonly>呼出時のみ表示する部分</includeonly>のように書きます。
また、一部分だけを呼び出し時に表示したい場合は<onlyinclude>呼出時表示する部分</onlyinclude>のようにします。
引数
引数 (ひきすう) を使用したい場合は{{{引数名}}}と、三重でくくります。このとき、引数に何も入力せず呼び出すと「{{{引数名}}}」がそのまま表示されてしまいますが、{{{引数名|省略時の値}}}とすることで、省略時の表示を変えられます。
{{{引数名|}}}とすると省略時に何も表示されません。これは以下で説明する#条件文を使用するときに便利です。
テンプレート風のマジックワード
マジックワードの中にはテンプレートと同じように二重中括弧で囲んで使用するものがあります。これらもsubstで展開することができます。数が多いのでここではよく使われるものに絞って説明します。省略してしまったものについてはWikipediaのヘルプを参考にしてください。
変数
システム変数と呼ばれているものです。使用時にはすべて大文字で綴る必要があります。
PAGENAME
ページ名を示します。名前空間名は含まれません。このページで使用するとテンプレートとなります。
用法としては、テンプレートの題にあたる部分で記事名を返したいときに使うほか(引数で変えられるようにすると便利です)、コピペで記事を作るときにSubst展開で使用するとよいでしょう(コピペで作る際は必ずSubst展開にしてください)。
なお、名前空間名を含めたいときにはFULLPAGENAMEを使用します。こちらはこのページで使用するとヘルプ:テンプレートとなります。
LOCALDAY
このWikiの場合は、表示された時の日付を表示します。使用すると15となります。
一桁の場合に0を付けるには,{{LOCALDAY2}}とします。
関数
{{関数名:引数1|引数2}}のかたちで使用します。1個目の引数はコロンのあとに入力することに注意してください。substで展開するときは{{subst:関数名:引数1|引数2}}のようにします。
条件文
拡張機能ParserFunctionsを導入したWikiでのみ使用できる関数です。このWikiでも使用できるので、一部紹介しておきます。Wikipediaのヘルプもご覧ください。
わかりにくければサンドボックスや利用者サブページなどを使用して実験するとよいでしょう。
関数名の先頭にはすべて「#」記号が入っています。
expr
{{#expr:数式}}
数式を計算します。
- 使用例
{{LOCALMONTH}}×{{LOCALDAY}}={{#expr:{{LOCALMONTH}}*{{LOCALDAY}}}}- 表示例
- 11×15=165
与えられた式に等号や不等号が入っているときは式の評価を返します。式が正しければ1を、正しくなければ0を返します。
if
{{#if:引数1|真のときの内容|偽のときの内容}}
引数1が空でないときは真のときの内容が、そうでなければ(つまり空のときは)偽のときの内容が表示されます。 「空」とは、スペースや改行などの、いわゆる空白文字しか入っていない状態を指します。
単に引数1が定義されていれば引数1をそのまま返したい場合は、前述のとおり{{{引数1|}}}でOKです。
ifeq
{{#ifeq:引数1|引数2|等しいときの内容|等しくないときの内容}}
引数1と引数2が等しいかを判定します。等しい候補を複数使用したい場合は後述のswitchを使用します。
ifexist
{{#ifexist:ページ名|存在するときの内容|存在しないときの内容}}
与えられたページがWiki内に存在するか判定します。
ifexpr
{{#ifexpr:数式|0のときの内容|0でないときの内容}}
数式を計算し、その結果または評価に基づいて内容を変更します。作業の残り数カウンターとして設置する際に、これを使用して0になったら「完了」と示すなどの工夫ができます。
switch
{{#switch:変数|候補1=内容1|候補2=内容2|候補3=内容3|どれにも当てはまらないときの内容}}
変数の値に応じて表示内容を切り替えます。上の例では候補3つと当てはまらなかったときを指定していますが、候補の数に特に制限はありません。
複数の値に同じ内容を設定する場合何度も同じものを書く必要はありません。イコールを設定しなければ、このように次以降で最初のイコールが設定されているものが返されます。
{{#switch:変数|候補1=内容1|候補2|候補3=内容2,3|候補4=内容4}}
どれにも当てはまらない場合の内容は引数リストの最後に入力します。別の場所に入力したい場合やどれにも当てはまらない場合の内容であることを明示したい場合は候補#defaultを使用できます。
{{#switch:変数|#default=当てはまらない内容|候補1=内容1}}
- 使用例
{{#switch:{{{世代}}}|1=第一世代|2=第二世代|3=第三世代|4=第四世代|5=第五世代|6=第六世代|世代不明}}
この場合、変数「世代」に1と入力すると「第一世代」と、2と入力すると「第二世代」と返されます。1、2、3、4、5、6以外の物を入れると「世代不明」と返されます。
time
{{#time:書式|日付|言語コード}}
表示された時の時間を表示します。場合によっては、マジックワードを使う方が良い場合があります。
書式には、指定されたコードを入力します。日付では、指定しなかった場合はUTCが使われます。日本時間を表示する場合は、+9 hoursを入れます。
コードは、Wikipediaのヘルプを参照してください。
HIRAGANASORTKEY
{{HIRAGANASORTKEY:ソート}}
このWikiとBulbapediaでのみ使用できる独自機能です。ひらがな、カタカナで入力された引数をソートキーにふさわしい形に変換します。
- 使用例
{{HIRAGANASORTKEY:ポケットモンスター ルビー・サファイア}}- 表示例
- ほけつともんすたあ るひい・さふあいあ
DEFAULTSORT
{{DEFALITSORT:ソートキー}}
ソートキーを一括指定します。
