Help:テンプレート

複数のページに含めたい共通テキストがある場合は、MediaWiki のテンプレート機能が役立ちます。 拡張ファイルやメディアファイルとは異なり、テンプレートのための中央リポジトリはありません。テンプレートは、新たに書き込むか既存作業の繰り返しを節約したり、他のwikiたとえばウィキペディアからエクスポートしたり、そのあとターゲットのwikiにインポートしたりできます。

作成

テンプレートとは内容を他のページにトランスクルード（埋め込み）できるよう設計された標準wikiページです。テンプレート名は「Template:」ではじまる名前空間の命名規則に従います。また、ほかのwikiページのように作成することもできます。

テンプレートの最も簡単な使い方は以下のようになります。「Template:Welcome」いうページを作成して内容をつぎのようにします。

こんにちは！ウィキへようこそ。

はじめてのテンプレートが作成できました！つぎにコードを挿入します。

{{Welcome}}

他のページでは{{Welcome}}と表示する代わりに「こんにちは！ウィキへようこそ」というテキストが表示されます。テンプレートの内容が「トランスクルード」されてページに統合されます。

任意ページの任意の位置に歓迎文{{Welcome}}を挿入することもできます。100ページで使用されていると仮定します。テンプレートの内容を次のように変更した場合：

こんにちはみなさん！この素敵なウィキへようこそ。

そうするとテンプレートを使用していた100ページがすべて再検討されて、元のテキストの代わりに新しいテキストが表示されます。この方法では各ページにテンプレートをトランスクルードしているので100ページ分の内容を編集することなく一括変更することができます。

これが基本的な仕組みです。この仕組みを豊かにしたりテンプレートをとても便利にしたりする追加のトランスクルード機能があります。

使用法

テンプレートは、他のページ内で以下のように使用します。

• {{固有名}} — 上記のように、このテンプレートリンクを含むページを読み込んだときに、テンプレートリンクを[[Template:固有名]]の現時点の内容で動的に置き換えます。このリンクは読込ページのソースからは変更されません。
• {{subst:固有名}} — このテンプレートリンクを含むページがはじめて保存されたときの[[Template:固有名]] の内容で置き換えます。テンプレートリンクは[[Template:固有名]]の内容を編集可能なテキストとしてコピーします。インクルードしたページの内容を編集しても元のテンプレートには影響がありません。注意：テンプレートを修正したときにテンプレートを参照しているページも自動的に修正されてほしい場合は使用してはいけません。
• {{safesubst:固有名}} — これはトランスクルードを破壊しないsubst展開を導入します。w:en:Help:Substitution#The safesubst: modifierを参照してください。
• {{msgnw:固有名}} は、それを含むページが取得される際に、(<nowiki> のように) 生のウィキ構文として表示する形式でテンプレートを埋め込みます。

実際は単にページ名を含む名前空間を指定することで通常のwikiページをテンプレートとして使用することもできます。たとえば

• {{Template:ページ名}} は [[Template:ページ名]] を参照読み込みします
• {{Talk:ページ名}} は [[Talk:ページ名]] を参照読み込みします
• {{:ページ名}} は [[ページ名]] を参照読み込みします
  • {{subst::ページ名}} は [[ページ名]]の内容で置き換えます

その名前空間が存在しない場合はフルタイトルのテンプレートであると仮定されます。

• {{Foo:Bar}}は[[Template:Foo:Bar]]を参照読み込みします

パラメーター

MediaWikiは、参照読み込みの機能を豊富にするために、テンプレートを参照読み込みするときにパラメーターを渡します。パラメーターによって、テンプレートからさまざまな異なるコンテンツを生成したり、異なる挙動をさせる事ができます。

つぎのような、ちょっとした感謝の言葉を他の利用者のトークページに挿入したい場合

この感謝文には理由(この場合は「あなたの尽力に」)と署名(「私」)があります。目的はすべてのユーザーが理由にかかわらず他のユーザーに感謝できるようにする事です。

たとえばTemplate:Thankyouというテンプレートを定義して使うことで、どの場所でも同じ記述ができるようになります。しかし感謝する記述は同じでも具体的な内容(理由や署名)はユーザーによって違います。このため、それらをパラメータとして渡す必要があります。もしボックスの書式を設定するために残りの要素を無視して画像を配置する場合、テンプレートの主な内容は次のようになります:

'''感謝をこめて...'''
{{{1}}}。
{{{2}}}より。

{{{1}}}と{{{2}}}の使用には注意してください。これはテンプレートを使用したときに渡すパラメーターをテンプレート内で識別するための使用法です。テンプレート内では各パラメーターが3対のブラケット{{{ }}}に囲まれている、ということに注意してください。これは通常のテンプレート名の使用法とは異なります。

ページからテンプレートを呼び出すときは各パラメータ値を「パイプ」文字(|)で区切って記述します。MediaWikiはパラメーターを名前なし、番号付き、名前付きという3通りの方法でテンプレートに渡すことができます。

名前なしパラメーター

名前なしパラメーターを渡すには、パラメーターを順番にリスト化してください。

{{Thankyou|あなたの尽力に|私}}

この場合は{{Thankyou}}テンプレートが{{{1}}}=あなたの尽力にと{{{2}}}=私を受け取って次のように返します。

名前なしパラメーターを渡す順番が動作に影響します。パラメーターの順序を逆にしてみます。

{{Thankyou|私|あなたの尽力に}}

以下のように出力されます。

注：順番（{{{1}}}など）によるパラメータの識別機能は名前なしパラメータだけで動作します。ページが名前で識別した任意のパラメータは、以下に示すように、序数を使用してテンプレートにアクセスできなくなります。

Note: If an equal sign appears inside the argument to an anonymous template parameter, that parameter may be misinterpreted as a named parameter (which is explained below in this document) treating the text before the equal sign as the parameter name and the text after it as the argument value. これは、外部リンク、または属性を持つHTML要素を含める必要がある場合、共通の問題です（Task 16235を参照）。 この問題を回避するには、名前付きのパラメータを使用するか、次の節で説明するように番号付きのパラメータを使用します。

数値パラメーター

数値によるパラメーターの場合はパラメーター値によって識別されます。

{{Thankyou|2=私|1=あなたの友情に}}

このとき{{Thankyou}}テンプレートは{{{1}}}=あなたの友情にと{{{2}}}=私を受け取ります。ただしパラメーターは数値の降順で指定されてしまいます。つぎのように出力されます。

名前付きパラメーター

パラメータを渡す第3の方法として数字の代わりに名前を使用します。この場合はテンプレートの内容をこのように変更してください（注：名前付きパラメータは大文字と小文字を区別）。

'''感謝をこめて...'''
{{{reason}}}。
{{{signature}}}より

テンプレート内で各パラメータを識別するために、数字の代わりに{{{reason}}}と{{{signature}}}を使用しています。名前でパラメーターを渡すと、渡したときに各パラメーターが識別されます。

{{Thankyou|signature=私|reason=そのままのあなたに}}

この場合は{{Thankyou}}テンプレートが{{{reason}}}=そのままのあなたにと{{{signature}}}=私を受け取って、次のように返します。

テンプレートに名前付きパラメータを使用することの利点は、パラメーターを渡す順番が柔軟になることに加えて、大量のパラメーターをもつテンプレートコードをはるかに理解しやすくできるということです。

既定値

パラメーターを取るテンプレートにそのパラメーターの引数を指定せずにトランスクルードするには、以下のようにします:

{{Thankyou}}

数値パラメーターの例は次のようになります。

引数を渡さなかったため、テンプレートはパラメーターのそれぞれの値の代わりにパラメーター自身を提示します。この場合、パラメーターの既定値を定義する場合、つまり値を渡さなかった際に使用される値を定義する場合に、有用かもしれません。例えばテンプレートの内容を以下のように変更します:

'''感謝をこめて...'''
{{{reason|すべてに}}}。
{{{signature|私}}}より。

{{{reason|すべてに}}} は、パラメーター {{{reason}}} に引数を指定しなかった場合の値を定義しており、その値として すべてに が使用されます。同様に {{{signature|私}}} では、パラメーター {{{signature}}} の既定値が 私 になります。さて、任意の引数を渡さずに再びテンプレートをトランスクルードすると以下のようになります:

評価の順序

パラメーターはテンプレートへ渡される前に完全に評価されます。だから、もしあるパラメーターが別のテンプレートの呼び出しだったなら実際に渡されるものは展開されたパラメーターになります。

{{Thankyou|reason=ご訪問に({{Welcome}})|signature=私}}

つぎのようになります。

{{Thankyou|reason=ご訪問に(こんにちはみなさん！この素敵なウィキへようこそ！)|signature=私}}

そしてつぎのようになります。

In a few circumstances, this order of evaluation makes a difference from the alternative. (The alternative being to check the results of the template call to see if there are additional templates to be expanded.)

まずパラメーターと同様にテンプレート名を展開できます。

このようなものを

{{Thankyou in {{preferred language}}|signature=私}}

展開します。

{{Thankyou in french|signature=私}}

このようにThankyou in frenchを呼び出したテンプレートは(その言語が既定されていれば)優先言語で感謝を表示します。

第二に、呼び出されたテンプレートは後に呼び出されるものからテンプレートを作成することはできません。 もしstart of callが{{Thankyou| で end of call が signature=私}} のときは {{start of call}}{{end of call}}形式をとったテンプレートは動作しないでしょう。

第三に、渡したパラメーターはテンプレートの使用場所ごとに展開されるのではなく、1回だけ展開されます。これはMediaWikiサーバーにとってより効率的です。

最後に、呼出テンプレートは完全に展開されたパラメーターを停止することはできません。テンプレートがなんらかの状況でパラメータを使用するだけでも、呼び出し前にかならず展開されています。

テンプレートの再帰

テンプレート自身を呼び出すテンプレートがMediaWikiに永久の繰り返しを要求することはありません。 MediaWiki は名前が太字 (ボールド体) のテンプレートを再帰 (recursion) しません。 たとえば「Template:Aaaa」の内容が「{{Aaaa}}」だった場合は「Template:Aaaa」と表示します。

テンプレートの参照読み込みの制御

デフォルトではテンプレートの表示内容は直接表示したときと別のページからインクルードしたときのどちらでも完全に表示されます。ただし<noinclude> タグと <includeonly> タグを使用することでテンプレートの参照読み込みを管理できます。

<noinclude>と</noinclude>の間にあるものはページが直接閲覧されるときのみ表示され、インクルードされる場合は表示されません。これは、どこかのページで展開されることを望まないテンプレートにテクストやコードを含ませたい場合に有用です。実行できる応用例は次の通りです:

• テンプレート自身をカテゴリ化する際に使用するカテゴリ
• 他言語版の類似したテンプレートへの言語間リンク
• テンプレートの使用法についての説明文

逆は<includeonly>.です。<includeonly>と</includeonly>の間のテキストはページがインクルードされたときのみ処理され表示されます。明確な応用例は与えられたテンプレートを含むすべてのページをカテゴリに追加することです。

• テンプレートを含むページのカテゴリー割り当て。一つのテンプレート内部の複数のカテゴリを変更した場合、参照ページのカテゴリはこれらのページが編集されるまで更新されないことにご注意ください。ジョブ キューによって処理されるからです。特定のページのカテゴリを強制的に更新するには、ページを編集モードで開き、何も修正しないまま保存し直します。
• Ensuring that the template's code is not executed when viewing the template page itself. Typically this is because it expects parameters, and its execution without parameters has an undesired result.

<noinclude>たぐ<includeonly>タグの外側部分は（テンプレートページで直接閲覧していても、テンプレートが他ページで呼び出されていても）通常ページ同様に表示されます 重視すべきは、2つのタグの内側がどんな内容であるかという点です。

<onlyinclude>タグの外側部分は読み込み内容に入っていません。 Even sections tagged includeonly are discarded in the transclusion unless they are also tagged as onlyinclude. 要点は、このタグの外側がどんな内容かという点です。

これらのタグは入れ子にすることもできます。

以上3つのパーシャルトランスクルージョンタグは処理，レンダリングされる内容のあらゆる組み換えを可能にします。 Comments also fill a role.

テンプレートの整理

効率的にするためにユーザーがテンプレートを見つけて利用できることが必要です。

以下の方法で見つけられます:

1. 特別ページ > 全ページをクリック
2. 名前空間: 一覧で Template を選択して表示

使用方法の情報を示すためにテンプレートページにこのような例を含めます。

<noinclude>
== 使い方 ==
ユーザーを歓迎するには
{{Thankyou|reason=あなたの理由|signature=あなたの署名}}
</noinclude>

それから編集者は同じようなページを作成するために例をコピー＆ペーストします。

テンプレートへのリンク

テンプレートをインクルードする代わりにリンクを表示するには{{tl}}テンプレートを使用します。 編集者はリンクさせたいテンプレート名を仮想パイプのあとに続けます。 例: {{tl|navbar}}は{{navbar}}テンプレートへリンクします。

別のウィキへのコピー

テンプレートはCSSかその他テンプレートを要するため、ユーザーはウィキからウィキへのテンプレート複製にトラブルを抱えることになります。最もテンプレートのため、以下の手順を実行するとよいでしょう。

MediaWiki のコード

新しいウィキでインポート権限（特にimportupload）がある場合:

1. 元のウィキのSpecial:Exportに移動し、必要なすべてのテンプレートの完全な履歴を含む.xmlファイルを次のようにダウンロードします。
   • 大きなテキストボックスにテンプレートの名前を入力します（例:「Template:Welcome」）。大文字と特殊文字に特に注意してください。テンプレート名が正確でない場合、エクスポートは引き続き行われますが、.xmlファイルには予期されたデータが含まれません。
   • 「テンプレートを含める」にチェックを入れる。
   • 項目「完全な履歴は含めず、最新版のみを含める」のチェックを外す。
   • 「書き出し」をクリック。
2. 新しいウィキの Special:Import に移動して、.xml ファイルをアップロードします。

新しいウィキの取り込み権限を持ってない場合:

1. もととなるウィキから複製したいテンプレートに移動します。編集画面に移動し、ソース全体をコピーします。
2. 新たなウィキにて、コピーしたテンプレートと同じ名称のページへ移動します。作成，編集を押してコピーしたソースを貼り付けします。各テンプレートの編集要約欄では、帰属用に複製元のページへリンクさせてください。
3. 編集画面での複製元ウィキに戻り、編集欄下にある"このページで使われているテンプレート"の一覧をご確認ください。For each template listed follow these instructions.

リストのテンプレートのいずれかにより使われるテンプレートにも同じく行ってください。

This will copy the entire code necessary, and will suffice for some templates. If it doesn't work also check for red links listed under "Pages transcluded onto the current version of this page:", below the edit box. If there are any repeat the above steps for these as well.

After successfully importing the template and all its linked templates from the other wiki, edit it to change customisations to suit your wiki. For example to change a logo, remove redundant categories or red links.

拡張機能

An extension often used in templates is ParserFunctions. Visit page ParserFunctions and check if any of the functions listed there are used in the templates you've copied. If so, you have to install the ParserFunctions extension. To install it, you'll need system admin access to the server of your MediaWiki installation.

Another dependency that may be used in templates, especially those on Wikipedia, is Lua. Having {{#invoke: }} in template code is a good sign for it. In case it's used, you need to install the Scribunto extension and system admin access is required too. See that page for more instructions about installing and using the extension.

CSS および JavaScript のコード

Besides MediaWiki code, many templates make use of CSS and some rely on JavaScript to work fully. If the copied templates are not behaving as expected, this may be the cause. To copy the required CSS and JavaScript to your wiki you'll normally need to have admin privileges, because you'll be editing system messages in the "MediaWiki:" namespace.

1. Look for the use of CSS classes (text like class="foobar") in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy those classes to "MediaWiki:Common.css" on the new wiki and check if the template is now fine.
2. If the copied template is still not working as expected, check if there is code in "MediaWiki:Common.js" or "MediaWiki:Monobook.js" on the original wiki. If so, you can try copying it to "MediaWiki:Common.js" on the new wiki. Normally, it is a good idea to only copy code from trusted sources, and first browsing the code to identify and select the parts that are relevant. You may find comments that can serve as clues to identify the functionality of each part.

関連項目

• Help:テンプレートデータHelp:TemplateData
• Help:外部検索Help:External searches – 特殊なテンプレートの例
• Help:マジックワードHelp:Magic words – fancy stuff you may find in some templates
• Help:Extension:ParserFunctionsHelp:Extension:ParserFunctions - additional fancy control functions such as #if and #switch
• Help:テンプレート内でのパーサー関数Help:Parser functions in templates - guidance on using parser functions in templates
• m:Help:Template – contains a much more thorough manual on how exactly templates function
• m:Help:Advanced templates – describes even more advanced techniques such as dynamic template calls and variable variables
• m:Help:Embed page – embedding pages from namespaces other than Template:.
• Manual:Importing Wikipedia infoboxes tutorialManual:Importing Wikipedia infoboxes tutorial
• Help:ExpandTemplatesHelp:ExpandTemplates
• Extension:PageTemplates