Help:テンプレート

---

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

作成

Templates are standard wiki pages whose content is designed to be transcluded (embedded) inside other pages. Templates follow a convention that the name is prefixed with "Template:", assigning it to that namespace; besides this, you can create them like any other wiki page.

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

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

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

{{Welcome}}

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

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

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

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

これが基本的なメカニズムです。このメカニズムを豊かにしてテンプレートをとても便利にするトランスクルード追加機能がいくつかあります。

使用法

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

• {{Name}} — as described above, this link will be dynamically replaced by the current content of [[Template:Name]] at the time the page with the template link is loaded. The link will remain unchanged in the page's source.
• {{subst:Name}}は、それを含むページが保存されるときにテンプレートの内容によって置き換えられます。これは、通常どおり編集可能なテキストで、これを編集しても元のテンプレートには影響はありません。注意：テンプレートを修正したとき、そのテンプレートを参照しているページが自動的に修正されることを期待しているなら、これを使ってはいけません。
• {{safesubst:Name}} — this was introduced to allow for substitution that doesn't break transclusion, see w:en:Help:Substitution#The safesubst: modifier.
• {{msgnw:Name}} は、それを含むページが取得される際に、(<nowiki> のように) 生のウィキ構文として表示する形式でテンプレートを埋め込みます。

In fact, an ordinary wiki page can also be used as a template, simply by specifying the namespace it resides in, so:

• {{Template:ページ名}} は [[Template:ページ名]] を参照読み込みします
• {{Foo:ページ名}} は [[Foo:ページ名]] を参照読み込みします
• {{:ページ名}} は [[ページ名]] を参照読み込みします
  • {{subst::Pagename}} replaces itself with the contents of [[Pagename]]

If no such namespace exists, the full title is assumed to be a template:

• {{Foo:Bar}} includes [[Template:Foo:Bar]]

パラメーター

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

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

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

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

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

Notice the use of {{{1}}} and {{{2}}}. This is the way to identify, within templates, the parameters that will be passed in when the template is used. Note that, within the template, each parameter is surrounded by three braces: {{{ }}}. This is different from normal template name usage.

When using the template on a page, you fill in the parameter values, separated by a "pipe" character (|). MediaWiki allows parameters to be passed to the template in three ways: Anonymously, Numbered, and Named.

名前なしパラメーター

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

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

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

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

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

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

Note: identifying parameters by order (with {{{1}}}, etc) works only with anonymous parameters. If your page identifies any parameter by number or name, as shown below, this method will no longer be available to the template which receives them.

Note: If an equal sign appears inside an anonymous template parameter, it may be interpreted as a named parameter, treating the text before the equal sign as the parameter name and the text after it as the value. This is a common problem when you need to include an external link, or an HTML element with attributes (see Task 16235) The workaround is to use named parameters instead, or even numbered parameters as explained in the following section.

数値パラメーター

数値によるパラメーターの場合は、パラメーター値により、識別されます:

{{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を呼び出したテンプレートは優先言語で感謝を表示します。(その言語が既定されていれば)

Secondly, the template being called can't construct a template from pieces to be called later. A template that took the form {{start of call}}{{end of call}} would not work if start of call was {{Thankyou| and end of call was signature=Me}}.

Thirdly, the parameter being passed is expanded only once, rather than every place the parameter is used in the template. This is more efficient on the mediawiki server.

Finally, the template being called can't stop the parameter from being expanded altogether. Even if a template only uses a parameter in some circumstances, it will always have been expanded before the call was made.

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

By default, a template's content is displayed in its entirety, both when viewed directly and when included in another page. However, you can control which parts of a template will be seen and included by the use of the <noinclude> and <includeonly> tags.

<noinclude>と</noinclude>の間にあるものはページが直接閲覧されるときのみ表示され、インクルードされる場合は表示されません。実行できる応用例は次の通りです:

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

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

• Categorizing pages which include the template. Note: when changing the categories applied by a template in this fashion, the categorization of the pages which include that template may not be updated until some time later: this is handled by the job queue. To force the re-categorization of a particular page, open that page for editing and save it without changes.
• 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.

Everything outside <noinclude> and <includeonly> is processed and displayed normally; that is, both when the template page is being viewed directly and when the template is included in another page. The focus is on what is inside these two tags.

Everything outside <onlyinclude> tags is discarded in the transclusion. Even sections tagged includeonly are discarded in the transclusion unless they are also tagged as onlyinclude. The focus is on what is outside this tag.

The three partial transclusion tags enable all possible combinations of what is processed and rendered. Comments also fill a role.

テンプレートの整理

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

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

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

To give usage information, include an example like this one on the template page:

<noinclude>
== Usage ==
Welcome users:
{{Thankyou|reason=your reason|signature=your signature}}
</noinclude>

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

Linking to a template

To link to a template instead of including it, use the {{tl}} template. The name of the template the editor wants to link to goes after the vertical pipe. 例: {{tl|navbar}} links to the {{navbar}} template.

別のウィキへのコピー

Templates often require CSS or other templates, so users frequently have trouble copying templates from one wiki to another. The steps below should work for most templates.

MediaWiki のコード

If you have import rights (Specifically importupload) on the new wiki:

1. Go to Special:Export on the original wiki, and download an .xml file with the complete history of all necessary templates, as follows:
   • Enter the name of the template in the big text box, e.g. "Template:Welcome". Pay special attention to capitalization and special characters — if the template name isn't exactly correct, the export may still occur but the .xml file will not have the expected data.
   • ボックス「テンプレートを含める」にチェックを入れる。
   • ボックス「完全な履歴は含めず、最新版のみを含める」のチェックを外す。
   • 「書き出し」をクリック。
2. 新しいウィキの Special:Import に移動して、.xml ファイルをアップロードします。

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

1. Go to the template you want to copy from the original wiki. Go to the edit page, and copy all the wikitext
2. On the new wiki, go to the page with the same name as the template you copied. Hit create/edit and paste the wikitext you copied. In the edit summary of each template, link to the original page for attribution.
3. Back in the original wiki at the edit window, below the edit box, look at the list of "Templates used on this page". For each template listed follow these instructions. Also do that for any template used by any of these templates, and so on.

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.

注記

An experiment shows that if you include a template in itself, it won't put MediaWiki into an infinite recursion. MediaWiki will find out, and stop with the template's name in bold. For example, if the content of "Template:Aaaa" is "{{Aaaa}}", it'll show as "Template:Aaaa".

関連項目

• Help:テンプレートデータHelp:TemplateData
• Help:外部検索Help:External searches – 特殊なテンプレートの例
• Help:マジックワードHelp:Magic words – fancy stuff you may find in some templates
• Help:テンプレート内でのパーサー関数Help: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