Extension:Variables

MediaWiki 拡張機能マニュアル

Variables リリースの状態: 安定
実装	パーサー関数
説明	ページ上の変数をさらに活用できるパーサー機能を提供します。
作者	Rob Adams, Tom Hempel, Xiloynaha, Daniel Werner, MGChecker
メンテナー	MGChecker
最新バージョン	2.5.1 (2019-07-11)
MediaWiki	1.29+
PHP	5.5+
データベースの変更	いいえ
ライセンス	ISC ライセンス
ダウンロード	拡張機能をダウンロード Git [?]: Git master をダウンロード リポジトリを参照 (Phabricator · GitHub) コミット履歴 リポジトリの貢献者 (GitHub) コード レビュー README RELEASE-NOTES
パラメーター $wgVariablesAreVolatile $wgVariablesDisabledFunctions
使用するフック ParserClearState ParserFirstCallInit
四半期ごとのダウンロード数	85 (Ranked 63rd)
使用中の公開ウィキ	1,808 (Ranked 201st)
translatewiki.net で翻訳を利用できる場合は、Variables 拡張機能の翻訳にご協力ください
Vagrant role	variables
問題点	未解決のタスク · バグを報告

警告:	この拡張機能は、Parsoid の使用によって意図されているように、構文解析を並列化する計画と互換性がありません。 従って、この拡張機能の将来は不確かであり、数年内には標準の MediaWiki パーサーと互換性がなくなると予想されています。 詳細情報は、タスク T250963 および 拡張機能タグを順次、順番に処理するためのサポートがありません を参照してください。

MediaWiki 1.35 - MediaWiki 1.38 の InternalParseBeforeSanitize フックについての廃止予定警告や、MediaWiki 1.39 + の #var_final パーサー関数の不足を回避するには、最新バージョン (現時点では master ブランチ) に更新してください。 詳細情報は タスク T276627 および タスク T250963 を参照してください。

Variables 拡張機能では、ページ上の変数を定義し、同じページ、あるいは参照読み込みされたテンプレートでその変数を使用することを可能にします。式によっては、古い値などを指定された値に変更することもできます。

たったそれだけの機能ですが、非常に軽量な拡張機能なのでウィキへの負荷も少なく、1つのページ上で多くの変数を扱うことができます。最良の結果を得るためには、ParserFunctions 拡張機能も揃えて使うといいでしょう。

Wikimedia Foundation (WMF)によって運営されているwikiはこの拡張機能を有効にしていません。 代替を見てください。

変数への値の代入

#vardefine

• {{#vardefine:変数名 | 指定した値 }}

(既存またはここに記入された) 変数名 の変数に 指定した値 の値が割り当てられます。

• 例: {{#vardefine:iconwidth|25}} で iconwidth = 25 にする

#vardefineecho

• {{#vardefineecho:変数名 | 指定した値 }}

#vardefine とほぼ同様に機能しますが、影響を受けた値が出力されます。

• 例: iconwidth = {{#vardefineecho:iconwidth|25}} にする

変数の値の取得

#var

変数 変数名 の値は以下のようにして取得できます

• {{#var:変数名}}

未定義の場合、結果は空の文字列になります。エラーメッセージは表示されません。

変数が未定義の場合や空 (void) の場合に使用される値は以下のようにして既定値を取得できます:

• {{#var:変数名 | 既定値 }}

これは以下と等価です:

• {{#if: {{#var:変数名 }} | {{#var:変数名 }} | 既定値 }}

これは最短のきれいな配列です。しかしバージョン2.0以前では、既定値が常時展開されるようになっています。バージョン2.0からは、実際に使用された場合のみに展開されます。

値はパーサー関数などで使用できます。

#varexists

• {{#varexists:変数名 }} 変数が既に定義されている場合は 1 を返します。変数が定義されていない場合は、戻り値が空 (void) となります。

これらの値を置換するため第 2 および第 3 パラメーターを使用できます。

• {{#varexists:変数名 | if-値 | else-値 }}

これは以下と等価です:

• {{#if: {{#varexists: 変数名 }} | if-値 | else-値 }}

ただし、この方が短く、整理されています。バージョン 2.5 未満では、両方が常に展開されていました。 バージョン 2.5 以降では、if および else の値は、その条件が実際に入力されたときにのみ展開されます。

#var_final

Variables 2.0で新しく導入された実験的な関数です。 この関数では、ページの表示が終了した時点での変数の値を、最終的に出力します。 パーサーがすべてのウィキマークアップを検証した上で値が挿入されるため、正確な値が示されるはずです。ただし、他の関数と併用することはできません。 例:

• {{#var_final:変数名 | 既定値 }}

最終的なページの表示段階で変数が存在しない場合、またはその値が空の文字列である場合に default の値が使用されます。 既定では、関数がどこで使用されていても展開するため、パラメーターはそれが必要としていなくとも展開されます。

例

#expr を使用するには ParserFunctions 拡張機能をインストールする必要があります。

x = 2*a + b を計算する:

• {{#vardefine:x|{{#expr:2*{{#var:a}}+{{#var:b}}}}}}

n に 1 を足す:

• {{#vardefine:n|{{#expr:{{#var:n}}+1}}}}

インストール

• ダウンロードして、ファイルをextensions/フォルダー内のVariablesという名前のディレクトリ内に配置します。
  開発者とコード寄稿者は、上記の代わりに以下を使用してGitからインストールします:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Variables
• 以下のコードを LocalSettings.php ファイルの末尾に追加します:

  wfLoadExtension( 'Variables' );
  

• 必要に応じて設定します
•  完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

設定

この拡張機能には 2 つの構成パラメーターがあります:

$egVariablesAreVolatile

Allows to disable the parser frame being marked as volatile by the extension, i.e. disable template caching.

既定値: true;

$egVariablesDisabledFunctions

Allows to disable specified parser functions provided by this extension.

既定値: [];

例: [ 'var_final', 'vardefineecho' ];

互換性

MediaWikiの最近のバージョンで推奨される、Variables拡張機能のバージョンは以下の通りです。古いバージョンの拡張機能も動作するかもしれませんが、新しいバージョンのMediaWikiでテストされている訳ではありません。

MediaWiki version	Variables version
1.19–1.22	2.1.x
1.23–1.28	2.2.x
1.29–1.34	2.5.x
1.35–1.39	2.5.x (deprecated)
1.40+	unsupported (WIP)

代替

As this extension will not be enabled for wikis run by the Wikimedia Foundation (WMF), here are some alternatives:

• If you use Variables as cache for expensive operations, you can transform the section where you need them into a template and pass the required information as template parameters instead. This will work until you reach the expansion depth limit, which can be increased if necessary.
• If you use Variables to do more complex template operations than possible with simple Extension:ParserFunctions , and if you have sufficient permissions on the server, you can use Scribunto's Lua functionality instead. You may not be able to install Scribunto on shared hosting. Note that this does not add support for global Variables. However, Extension:VariablesLua adds a Scribunto interface for the Variables store.
• Don't use variables, instead duplicate the information you need as a variable. If that information is acquired by an expensive template call, performance may suffer. This will work until you reach the node count limit.
• If you require variables just for autonumbering, you could look into Extension:NumerAlpha .

関連項目

• Extension:PhpTags
• Extension:MyVariables – Creates new variables in the MediaWiki sense
• Extension:Loops – Provides parser functions for performing loops
• Extension:Arrays – Create an array and provide array functions (such as search, split, and sort) and set operations (such as intersect, union and diff)
• Extension:HashTables – New parser functions for handling hash tables in MediaWiki