Manual:Magic words/ja



マジックワードとは単一の関数のIDに対応するさまざまなウィキテキスト文字列を対応付けする技術で、変数 にもパーサ関数にも使われています. 特定のIDに対応付けされたさまざまなテキストは、関数の戻り値に置換されます. $wgExtensionMessagesFiles[]を使って読み込んだファイルの 変数には、IDに対応するすべての文字列を格納します.

既定のマジックワードはで実装されています.

マジックワードの動作の仕組み
MediaWikiでは二重の角括弧 に挟まれた文字列を検地すると、その中に含まれるXXXが変数もしくはパーサ関数あるいはテンプレートのどれに該当するか識別必要があります. そのためにいくつかの問いを解きます.


 * 1) 文字列にはマジックワードのIDが付帯するか? という文字列のマークアップ解決において最初にMediaWikiはXXXをマジックワードIDに変換できるかどうか検討します. 変換テーブルは$magicWordsによって定義されます.
 * 2) *付帯するマジックワードIDが見つからない場合、XXXはテンプレートだと判断されます.
 * 3) 関数ではないか? マジックワードIDが検出 される と、MediaWikiは次にパラメータがあるかどうか確認します.
 * 4) *パラメータを検出しなかった場合、MediaWikiはマジックワードIDが有効なIDかどうか確認します. 手順は を呼び出し、表示されるマジックワードのリストを取得します. この方法により、ハードコードされた変数ID（ヘルプ:関数を参照）とMagicWordwgVariableIDsフックに接続する関数をすべて提供するカスタム変数IDのリストから、変数IDのリストを取得します.
 * 5) **マジックIDが変数として分類されると、フックMediaWikiはイベント名'ParserGetVariableValueSwitch'に関連する関数を呼び出し続け、マジックワードを認識してその値を返すことができる変数を検出します.
 * 6) Is it a parser function? If there are any parameters or if the magic word ID is missing from the list of variable magic word IDs, then MediaWiki assumes that the magic word is a parser function or template. If the magic word ID is found in the list of parser functions declared via a call to , it is treated as a parser function and rendered using the function named  .  Otherwise, it is presumed to be a template.
 * 1) Is it a parser function? If there are any parameters or if the magic word ID is missing from the list of variable magic word IDs, then MediaWiki assumes that the magic word is a parser function or template. If the magic word ID is found in the list of parser functions declared via a call to , it is treated as a parser function and rendered using the function named  .  Otherwise, it is presumed to be a template.
 * 1) Is it a parser function? If there are any parameters or if the magic word ID is missing from the list of variable magic word IDs, then MediaWiki assumes that the magic word is a parser function or template. If the magic word ID is found in the list of parser functions declared via a call to , it is treated as a parser function and rendered using the function named  .  Otherwise, it is presumed to be a template.

マジックワードを定義する
For magic words to do their magic we must define two things:
 * a mapping between wiki text and a magic word ID
 * a mapping between a magic word ID and some php function that interprets the magic word.

ウィキテキストからマジックワード ID への対応付け
The variable $magicWords is used to associate each magic word ID with a language-dependent array that describes all the text strings that mapped to the magic word ID. Important: This only sets up the back end i18n mapping, you still have to write other code to make MediaWiki use the magic word for anything

The first element of this array is an integer flag indicating whether or not the magic word is case sensitive. The remaining elements are a list of text that should be associated with the magic word ID. If the case sensitive flag is 0, any case variant of the names in the array will match. If the case sensitive flag is 1, only exact case matches will be associated with the magic word ID. Thus the format is

This association is created by $magicWords in a file registered using $wgExtensionMessagesFiles[].

In the example below, a Spanish MediaWiki installation will associate the magic word ID 'MAG_CUSTOM' with "personalizado", "custom", "PERSONALIZADO", "CUSTOM" and all other case variants. In an English MediaWiki only "custom" in various case combinations will be mapped to 'MAG_CUSTOM':

ファイル :

拡張機能の初期化ファイル :

Note that "ExampleMagic" is a different to the key you would use for a plain internationalization file (normally just the title of the extension, i.e. "Example"). "Magic" has been appended deliberately so one does not overwrite the other.

マジックワード ID と PHP 関数の関連付け
The mechanism for associating magic word IDs with rendering functions depends on whether the magic word will be used as a parser function or a variable. For more information, please see:



マジックワードの登録
In MediaWiki 1.8 and beyond there is no explicit requirement to register magic word IDs. Registering the parser function or variables that use them is sufficient. For versions prior to 1.8, see below.

地域化

 * ''ヘルプは Help:Magic words#地域化 を参照してください.

You can read more on definition and usage of magic words for localisation at Localisation#PLURAL and GENDER support in JavaScript, Localisation#Localizing namespaces and special page aliases, Localisation#Switches in messages…; Localisation#Be aware of PLURAL use on all numbers, Localisation#Users have grammatical genders, Avoid  in messages.

1.8より前のバージョンのMediaWikiのマジックワード
1.8 より前のバージョンの MediaWiki では以下の点が異なります:

 Manual:Hooks/LanguageGetMagicは言語パラメータをわたしませんでした. このパラメータをシミュレートするには、1.7またはそれ以前にバックポートされた拡張機能単体で$wgContLangの言語抽出が可能で、通常どおりに処理したり/またはIDテキスト対応付けを選択するため言語非依存の処理を行います.  マジックワードを使う拡張機能はMagicWordMagicWordsフックを使って、明示的にマジックワードIDを登録する必要がありました. この方法では実装者にマジックワードIDの提供を単に依頼するのみでした.

 

挙動の切り替え(二重の下線で囲まれたマジックワード)
挙動スイッチとは特殊なマジックワードを指します. (二重の角括弧ではなく) 二重の下線（_）を使用するのが特徴で、 のようになります.

これらの特殊なマジックワードの出力は内容（コンテンツ）ではなくページの挙動の変更と/あるいはページの属性を決定する. 一覧は で取得でき、ヘルプ:マジックワード#挙動スイッチでも参照できる. 挙動スイッチの効果はそれぞれ に規定されている. 特に効果を規定していない場合、マジックワードは単にページ属性 (page_props) テーブルにページの属性を書き込む.

関連項目

 * ヘルプ:マジックワード - や  などの変数の一覧