Fandom


ヘルプ

テンプレートに直接パラメータ(引数)を入力することによって、表示させる内容を変えたり、デザインを変えたりすることができます。このパラメータのことを、テンプレートパラメータ または テンプレート引数 ( - ひきすう) ということもあります。(テンプレート関数と呼ぶこともあります。)

注意:ビジュアルエディタでも、パラメータを指定したテンプレートを、ページに加えることができます。その場合、ウィキテキストを使う必要はありません。

シンプルなテンプレートパラメータを作ってみましょう 編集

  • あなたのwikiで、"Template:Box" というテンプレートページを作成します。
  • 以下のコードをコピーし、作成したページに貼り付けてください。
<div style="width:10em; height:5em; border:1px solid #999; background-color:#CDF; color:#000; text-align:center; padding-top:2em;">
{{{1}}}
</div>
  • ページを保存して、以下の内容と同じように表示されることを確認します。
{{{1}}}
  • 「テンプレートテスト」の記事を作成します。(サンドボックスのページがあれば、利用すると良いでしょう。)
  • 以下のコードをコピーし、テンプレートテスト記事の、テンプレートを挿入したい部分に貼り付けます。
{{Box|例文を表示します}}
  • ページを保存して、以下の内容と同じように表示されることを確認します。
例文を表示します

上のテンプレートパラメータについて 編集

もとのテンプレートの {{{1}}} (引数名1) の部分は、ページのテンプレートに書かれた "例文を表示します" (引数1といいます) を呼び出します。 テンプレートを挿入したページには、テンプレートの{{{1}}}の部分が 引数1 (例では "例文を表示します") に置き換えられて表示されます。

上のテンプレート例では、引数は1つですが、{{{2}}}, {{{3}}}, ……と引数を増やすこともできます。

ブレース3つ ( {{{ }}} ) に囲まれた数字は、引数の順番を表します。

{{box|引数1|引数2|引数3}}

ある引数を使いたくない場合は、あなたはその引数を空欄のままにすることができます。このとき、しかし、基本的には、縦線記号 ( | ) は書く必要があります。

例:

{{box|引数1||引数3}}

名前付きテンプレートパラメータとデフォルトパラメータ 編集

上記の代わりに、名前付きテンプレートパラメータ (名前付きパラメータ, Named parameter) を使うこともできます。 コードは多少、より複雑になりますが、テンプレートの表示結果に幅をもたせることができます。

  • 先ほどのテンプレートページ「テンプレート:Box」を編集して、内容を以下のコードと入れ替えてください:
<div style="width:10em; height:5em; border:1px solid #999; background-color:{{{bgcolor|#CDF}}}; color:{{{textcolor|#000}}}; text-align:center; padding-top:2em;">
{{{text}}}
</div>
{{{text}}} 名前付きパラメータ の概念を挿入しています。
{{{bgcolor|#CDF}}} 同様に デフォルトパラメータ (Default parameter) の概念を挿入しています。: 'bgcolor' が指定されていない場合、 '#CDF' が使用されます。
  • 「テンプレートテスト」の記事をを編集して、内容を以下のコードと置き換えてください。
{{box|bgcolor=navy|textcolor=white|text=A navy blue box}}
  • ページを保存して、以下の内容と同じように表示されることを確認します。
A navy blue box

上のテンプレートパラメータについて 編集

パラメータに名前がつけられている場合でも、任意の順序で引数を渡すことができます。そのため、結果として{{box|textcolor=white|text=A navy blue box|bgcolor=navy}}と、全く同じ囲みができます。

もし、次のように、デフォルトパラメータ bgcolor により 背景色 (background-color) が定義されなかった場合についても確認してみましょう。

{{box|textcolor=white|text=A navy blue box}}

この場合は、以下のようになります。

A navy blue box


名前付きパラメータは、読みやすくするために、しばしば行を分けて記述されます。 以下のような形で書かれることは、珍しくありません。

{{box
 |bgcolor   = navy
 |textcolor = white
 |text      = A navy blue box
}}


デフォルト・パラメータを空欄に指定し、任意の引数が指定されない場合はページ内容を変えないようにすることもできます。

例えば、{{{text}}} と書かれたテンプレートを使った場合、'text=' 引数を記事ページで指定しなくても、 "{{{text}}}" が表示されます。 しかし、テンプレートを{{{text|}}} としておけば、デフォルトパラメータはテキストを含まないことになります。つまり、引数を指定しない場合は、記事ページにテキストが表示されません。

関連情報 編集

その他のヘルプとフィードバック 編集

特に記載のない限り、コミュニティのコンテンツはCC-BY-SA ライセンスの下で利用可能です。