Help:Templates/ja

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

作成
テンプレートとは内容を他のページに参照読み込み (トランスクルード) できるよう設計された標準ウィキページです. 命名規則により、テンプレート名は接頭辞「 」で始まり名前空間に紐付けされます. その他、他のウィキページのように作成することもできます.

テンプレートの最も簡単な使い方は以下のようになります. 例として「Template:Welcome」という名前のページを作成する場合を想定しています.

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

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

他のページでは と表示する代わりに「こんにちは！ウィキへようこそ」という文が表示されます. テンプレートの内容が他のページに「埋め込み」、つまり表示先のページに統合されます.

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

こんにちは、皆さん！ この素敵なウィキへようこそ.

その後、このテンプレートを使用した前出の100ページのどれかを開いて確認すると、元の文ではなく新しい文を表示します. 各ページにテンプレートが埋め込まれているため、この方法だと100ページ分の内容を編集することなく、一括で変更できます.

これが基本的な仕組みです. 埋め込みにはこの他、テンプレートを拡充したり他のテンプレートをとても便利にしたりする機能があります.

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


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

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


 * は  を参照読み込みします
 * は  を参照読み込みします
 * は  を参照読み込みします
 * は の内容で置き換えます

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


 * は を参照読み込みします

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

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

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

ノートがどこで使用されても同様に見えるようにするために、例えば というテンプレートを定義することができます. 利用者が他の利用者に感謝するときには、ノートは同様に見えるはずですが、その特定の内容（すなわち、理由と署名）は異なります. そのため、パラメータとして渡す必要があります. 残りの要素を無視してボックスをフォーマットして画像を配置すると、テンプレートのコアコンテンツは次のようになります.

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

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

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

この場合は テンプレートが と というパラメータを受け取って、次のように返します.

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

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

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

今回、テンプレート は、パラメータ と を逆順で受け取り、生成している.


 * 例:

出力

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

に 感謝をこめて.... ありがとうございます. より

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

この場合は テンプレートが と というパラメータを受け取って、次のように返します.

名前付きパラメーターの名前の大文字・小文字は区別されないため:

出力結果:

テンプレートに名前付きパラメータを使う利点は、パラメータを渡す順番が柔軟になることに加え、多数のパラメータを組み合わせてもテンプレートのコード読解がとても容易になることです.

既定値
パラメータを取るテンプレートなのに、そのパラメータの引数を指定せずに参照読み込みするには、以下のようにします:

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

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

は、パラメータ  に引数を指定しなかった場合の値を定義しており、その値として   が使用されます. 同様に  では、パラメータ   の既定値が   になります. さて、任意の引数を渡さずに再びテンプレートを参照読み込みすると、以下のようになります:

多くの場合、パラメーターの代替名を指定するために、既定値が使用されます. 例えば  の場合、テンプレートはまず「a」という名前のパラメーターを探します. それが設定されていない場合、「b」という名前のパラメーターを使用します. 「a」も「b」も設定されていない場合、何も出力されません.

評価
一般に、テンプレート パラメーターはトークン化された後、そのままテンプレートに代入されます. それらのパラメーターは、使用するまで評価されません.

This has a few consequences. First of all, if you have a  containing , and a   containing  , and put   on a page, mytemplate isn't transcluded, because tokens like "|" cannot be added by a template and keep their special meaning in templates. You can still use templates to control the name of a parameter or template, but you cannot split a template call amongst multiple templates.

The second consequence of this is dead-code elimination. If you make a template call like, and Template:Foo does not contain  , then the displaytitle is not used, since it is only evaluated when needed, and it there is no parameter to substitute it into, so it is never evaluated. This usually comes into play when using Extension:ParserFunctions, and can be especially noticed when used in combination with the  magic word that varies by user language.

Template calls starting with the magic word  or   are evaluated in a separate first pass that only happens at save time, along with ~ and links using the pipe trick. If they cannot be evaluated during the first pass, subst: calls are ignored, and safesubst: are treated as if a normal template.

Many but not all parser functions, parser tags and trancluded special pages are not directly included like templates but instead are replaced by a "strip marker". This means you cannot manipulate the results with parser functions like padleft: or similar functions from extensions, as they see the strip marker instead of the result of the parser function.

テンプレートの再帰
テンプレート自体を呼び出すテンプレートはMediaWikiに永久の繰り返しを要求したりしません. MediaWiki は名前が太字 (ボールド体) のテンプレートを再帰 (recursion) しません. 例えば、Template:Aaaaの内容が であれば、"a a Template loop detected: Template:Aaaa z z "と表示されます.

Forbidden idiom
This safeguard precludes a potentially useful template idiom where a template self-normalizes its own calling arguments. In this forbidden example  can either be called   or. If called in the first manner, it recurses into itself with the second argument structure (obtained using string parser functions), which then follows a unified processing path.



If  is modified to recurse into   and   is an identical manual copy of   this idiom works fine as the self-recursion safeguard operates dynamically and not statically.

A feasible way for the MediaWiki software to loosen the self-recursion rule would be to require that each recursive call have a distinct argument count from all previous active calls, at most once recursing with the argument count non-decreasing. That would provide a strong guarantee against infinite self-recursion while enabling useful idioms such as the one described here in a flexible manner.

If the processing path is of low complexity, a simple solution using only one template is to handle each calling convention on a separate if/else branch, duplicating the logic of the processing path within each case. If the processing path is more complex, each call-structure case can delegate to an implementation template with a unified call structure which provides the final template behaviour.

Tables in parameters
Since the syntax for wikitables involves pipes in single braces ({ }) and using the pipe trick will not work in transclusion parameters, one will have to create a table as a separate page and transclude it from there.

テンプレートの参照読み込みの制御
既定では、テンプレートの内容は直接表示したときも別のページから呼び出したときも完全に表示されます. ただし、、のタグを使用することでテンプレートのどの部分を表示し読み込むか管理できます.

との間にあるものはすべてページが直接閲覧されるときのみ表示され、呼び込みされる場合は表示されません. これは、すべてのページで展開されることを望まないテンプレートに文やコードを含ませたい場合に有用です. 実行できる応用例は次の通りです:


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

逆はです. との間のテキストは、テンプレートのページを直接開いて閲覧しても処理されず、ページがインクルードされたときのみ処理され表示されます. 明確な応用例は下記を含みます.


 * テンプレートを含むページのカテゴリ割り当て. 注:この方法で一つのテンプレートが割り当てる複数のカテゴリを変更した場合でも、参照ページのカテゴリはすぐには更新されないことにご注意ください. によって処理されるからです. 特定のページのカテゴリを強制的に更新するには、ページを編集モードで開き、何も修正しないまま保存し直します.
 * テンプレートのページ自体を閲覧しても、コードが処理されないようにします. パラメータを与えないとコードが処理されない仕組みのため、パラメータを与えられないままテンプレートが作動すると望ましくない結果をもたらします.

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

タグの外側部分は読み込み内容に入っていません. includeonlyのタグが付いた節でも、参照読み込みのときに処理の対象から外されるため、改めてonlyincludeのタグをつける必要があります. 要点は、このタグで挟んでいない、外側の部分がどんな内容かという点です.

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

以上、3種の部分埋め込みタグは処理、レンダリングされる内容のあらゆる組み換えを可能にします. コメントも役割を与えられています.

テンプレートの整理
テンプレートが有効に使われるには、ユーザーにとってテンプレートが見つけやすく、利用法が理解できる必要があります.

以下の方法で見つけられます:
 * 1) ' > 'をクリックし、
 * 2) ' 一覧で Template を選択して'をクリック.

使用法の情報を示すには、テンプレートページにこのような例を含めてください.

使い方
利用者を歓迎する記述:

その後、ほかの編集者はこの例をコピー＆ペーストして、テンプレートを使えるようにします.

テンプレートへのリンク
テンプレートページはほかのウィキページ同様、リンクすることができます. 一例としてTemplate:Navbarというリンクを作成するには、ウィキコードの  を使います.

多くのウィキでTemplate:Tlを使うと、「波カッコ」付きのウィキコード（参照読み込み形式）を明示するフォーマットにまとめたテンプレートを、実際に読み込まずにリンクを張ることができます. 例えば  というコードを使うと、Navbar というリンクが生成できます.

この構造はテンプレートの説明文書、ヘルプページまたはトークページでテンプレートについて述べるとき、よく使用されます. 同じ効果を得るのに、 も使用できますが、tl のほうが入力する文字数は少なくてすみます. Tlテンプレートが用意されている場合、どんなウィキでも上記に示したように文を「code」の要素としてレンダリングするとは限りません. うまく作動しない場合は、似た名称のテンプレートが有効かもしれません. 例えば英語版ウィキペディアでは en:Template:Tl の記事の「関連項目」節に列挙したものがいい例です.

別のウィキへのコピー
テンプレートはCSSかその他テンプレートを要するため、利用者はウィキからウィキへのテンプレート複製にトラブルを抱えることになります. 以下の手順はほとんどのテンプレートで有効とされています.

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


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

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


 * 1) もととなるウィキから複製したいテンプレートに移動します. 編集画面に移動し、ソース全体をコピーします.
 * 2) 新たなウィキにて、コピーしたテンプレートと同じ名称のページへ移動します. 作成、編集を押してコピーしたソースを貼り付けします. 各テンプレートの編集要約欄では、帰属用に複製元のページへリンクさせてください.
 * 3) 編集画面での複製元ウィキに戻り、編集欄の下にある「このページで使われているテンプレート」の一覧をご確認ください. そこに列挙されたテンプレート1件ごとに、上記の処理を繰り返します. また、一覧のテンプレートから呼び出されるテンプレートにも、それぞれ同じ処理が必要です.

上記で必要なコードすべての複写ができ、テンプレートの種類によってはこれで十分です. Note that only page elements parsed in rendering the page get exported, so, for example, documentation subpages are not exported as part of this process. うまく動作しない場合は、編集ボックスの下にある「Pages transcluded onto the current version of this page:」の下に赤いリンクが表示されていないか確認してください. いずれかの場合には、上記の手順を繰り返しモジュール内のコードをコピーします.

他のウィキからテンプレートおよびそれにリンクするテンプレート群のインポートに成功したら、ご利用のウィキに適合するように、カスタマイズする部分を編集します. 例えばロゴの変更、廃止したカテゴリあるいは赤字リンクの削除などが必要かもしれません.

拡張機能
テンプレートで多用される拡張機能には ParserFunctions があります. のページを開き、一覧にある機能のうち、先ほど複写したテンプレート内で使用しているものがないか確かめましょう. もし見つかったら 拡張機能をインストールする必要があります. インストールの処理は、MediaWiki インストレーションのサーバーでシステム管理者権限が必要です.

テンプレート、特にウィキペディアのテンプレートで使用される可能性のあるもう一つの依存関係は、Luaです. テンプレートコードに   が含まれていれば、その良い兆候であるといえるでしょう. このコードを見つけたら 拡張機能をインストールするのですが、これには管理者権限が必要です. インストールと使い方は、拡張機能のリンクを開いてページを参照してください (訳注: Luaも参照).

CSS および JavaScript のコード
MediaWikiコードの他にも、テンプレートの多くでCSSを使い、JavaScriptに依拠して完全に機能するものもあります. もし複写したテンプレートが予想通りに機能しない場合には、原因はそこにあるのかもしれません. 必要なCSSやJavaScriptをご利用のウィキに複写するには、通常、管理者権限が求められます. 「MediaWiki:」名前空間のシステムメッセージを編集する必要があるからです.


 * 1) テンプレートの文内にCSSクラスが使われているかどうか確認（例:  ）. 元のウィキの「MediaWiki:Common.css」ないしは「MediaWiki:Monobook.css」の中にCSSクラスがある場合は、これらを複写先のウィキの「MediaWiki:Common.css」に複写、テンプレートが予想通りに作動するかどうか確認をお願いします.
 * 2) それでも複写したテンプレートが予想通りに作動しない場合には、元のウィキの「MediaWiki:Common.js」もしくは「MediaWiki:Monobook.js」にコードがないかどうか確かめます. コードが見つかったら、それらをテンプレートの複写先のウィキの「MediaWiki:Common.js」に複写することもできます. 通常、信頼できる情報源からのみコードを複写することが良識的で、まず関連のある部分を特定するためにコードをウェブで検索してみましょう. コメントから、コードの各部分の機能を見極めるヒントが見つかるかもしれません.

関連項目

 * w:Help:Table - the easiest instructions to use.
 * – 特殊なテンプレートの例
 * – ある種のテンプレートに備わった上級者向け機能
 * – #ifや#switchなど、その他の上級者向け機能
 * – テンプレートのパラメーターにパーサー関数を適用する方法
 * m:Help:Template – テンプレートがどう機能するか、より詳しく具体的に示した説明文書
 * m:Help:Advanced templates – さらに高度な技術. 動的テンプレート呼び出しや可変パラメーター名など（訳注: テンプレート内にテンプレートやパラメータを組み込む等）
 * m:Help:Embed page – を使わず、名前空間からページ内に別のページを埋め込む方法.
 * – Using templates as the starting text of a page
 * – Using templates as the starting text of a page
 * – Using templates as the starting text of a page
 * – Using templates as the starting text of a page
 * – Using templates as the starting text of a page

外部リンク

 * ミラヘーズテンプレートリポジトリ - MediaWiki のテンプレートは一般的な使用を目的としています.