Help:Extension:ParserFunctions
ParserFunctions拡張機能は「マジックワード」を補完する MediaWiki に既存の13のパーサ関数を提供します。 (文字列処理のために追加のパーサー関数を提供するように設定できるかもしれません。ここでいう文字列関数の説明文書はこちらを参照してください。) この拡張機能が提供するすべてのパーサー関数は以下の形式です:
{{#関数名: 引数 1 | 引数 2 | 引数 3 ... }}
 |
注意: このページを編集すると、編集内容が CC0 のもとで公開されることに同意したと見なされます。詳細はパブリック・ドメインのヘルプ ページを参照してください。
|
|
#expr
| 種類 | 演算子 |
|---|---|
| グループ化 (括弧) | ( )
|
| 数値 | 1234.5 e (2.718) pi (3.142)
|
二項演算子 e 単項 +,-
| |
| 単項 | not ceil trunc floor abs exp ln sin cos tan acos asin atan
|
| 二項 | ^
|
* / div mod
| |
+ -
| |
| 四捨五入 | round
|
| 論理 | = != <> > < >= <=
|
and
| |
or
|
この関数は、数式を計算してその計算結果を返します。
この関数はmw.ext.ParserFunctions.expr 関数を介して Scribunto でも使えます。
{{#expr: 数式 }}
表の右欄は使用できる演算子で、上ほど優先順位が高いものです。各演算子の機能の詳細は計算のヘルプ ヘルプ:Calculation を参照してください。出力結果の精度と形式には幅があり、ウィキを実行するサーバーのOSバージョン、サイト表示言語の数値形式の影響を受けます。
ブール代数を使用して評価する際、値がゼロならfalse、非ゼロなら正の数でも負の数でもtrueと評価されます:
{{#expr: 1 and -1 }}→ 1{{#expr: 1 and 0 }}→ 0{{#expr: 1 or -1 }}→ 1{{#expr: -1 or 0 }}→ 1{{#expr: 0 or 0 }}→ 0
空の入力式は空の文字列を返します。無効な式はいくつかのエラー メッセージのうちのいずれかを返します。このエラーは #iferror 関数を使用して捕捉できます:
{{#expr: }}→{{#expr: 1+ }}→ Expression error: Missing operand for +.{{#expr: 1 = }}→ Expression error: Missing operand for =.{{#expr: 1 foo 2 }}→ Expression error: Unrecognized word "foo".
数値の前後の加算および減算オペランドの順序は意味があり、誤った入力を持つオペランドとしてではなく、正または負の値として扱われる場合があります。
{{#expr: +1 }}→ 1{{#expr: -1 }}→ -1{{#expr: + 1 }}→ 1{{#expr: - 1 }}→ -1
メモ:マジックワードの出力を使用する場合は、コンマを削除して数字を翻訳するために、それらをraw形式にする必要があることに注意してください。
たとえば、{{NUMBEROFUSERS}} は 17,786,519 になりますが、17786519 が必要です。これは {{formatnum:{{NUMBEROFUSERS}}|R}} を使用して取得できます。
これは、数字が翻訳される一部の言語では特に重要です。
たとえば、ベンガル語では、{{NUMBEROFUSERS}} は ৩০,০৬১ を生成します。
{{#expr:{{NUMBEROFUSERS}}+100}}→ Expression error: Unrecognized punctuation character ",".{{#expr:{{formatnum:{{NUMBEROFUSERS}}|R}}+100}}→ 17786619
 警告: | 演算子 mod は、第 2 引数の値によっては誤った結果を返す場合があります:
|
四捨五入機能
Rounds off the number on the left to a multiple of 1/10 raised to a power, with the exponent equal to the truncated value of the number given on the right.
切り上げや切り捨てを行うには、それぞれ単項のceilとfloorを使用してください。
| テスト ケース | 結果 | 四捨五入の手法 | ||
|---|---|---|---|---|
{{#expr: 1/3 round 5 }} |
0.33333 | 最終桁が 5 未満であるため、切り上げはされません (0.333333… → 0.33333) | ||
{{#expr: 1/6 round 5 }} |
0.16667 | 最終桁が 5 以上であるため、切り上げされます (0.166666… → 0.16667) | ||
{{#expr: 8.99999/9 round 5 }} |
1 | この場合も、結果は最後の桁で切り上げられ、追加の切り上げが行われます。 (0.999998… → 1.00000 → 1) | ||
{{#expr: 1234.5678 round -2 }} |
1200 | 負の値は小数点の左側に丸められるため、100に最も近い値に丸められます。 | ||
{{#expr: 1234.5678 round 2 }} |
1234.57 | 正の値は小数点の右側に丸められるため、最も近い100番目に丸められます | ||
{{#expr: 1234.5678 round 2.3 }} |
1234.57 | round の右の値の小数点以下は、丸めの結果には影響しません | ||
{{#expr: trunc 1234.5678 }} |
1234 | 小数点以下の切り捨て | ||
| 最も近い整数への丸め | ||||
{{#expr: 1/3 round 0 }} |
0 | 最も近い整数への切り捨てで 0 | ||
{{#expr: 1/2 round 0 }} |
1 | 最も近い整数への切り上げで 1 | ||
{{#expr: 3/4 round 0 }} |
1 | 最も近い整数への切り上げで 1 | ||
{{#expr: -1/3 round 0 }} |
-0 | 最も近い整数への切り上げで 0 | ||
{{#expr: -1/2 round 0 }} |
-1 | 最も近い整数への切り捨てで -1 | ||
{{#expr: -3/4 round 0 }} |
-1 | 最も近い整数への切り捨てで -1 | ||
| ceill や floor による切り上げや切り捨て | ||||
{{#expr: ceil(1/3) }} |
1 | 次に大きい整数まで | ||
{{#expr: floor(1/3) }} |
0 | 次の「小さい」整数、つまりゼロまで | ||
{{#expr: ceil(-1/3) }} |
-0 | 最も近い整数への切り上げで 0 | ||
{{#expr: floor(-1/3) }} |
-1 | 負の整数である次の小さい整数まで | ||
{{#expr: ceil 1/3 }} |
0.33333333333333 | 1が既に整数であるため、丸めは行なわれません
| ||
文字列
式は数値のような値でのみ機能し、文字列や文字を比較することはできません。代わりに#ifeqを使用できます。
{{#expr: "a" = "a" }}→ Expression error: Unrecognized punctuation character """.{{#expr: a = a }}→ Expression error: Unrecognized word "a".{{#ifeq: a | a | 1 | 0 }}→ 1
#if
この関数はテスト文字列を評価し、それが空であるかどうかを判定します。空白のみを含むテスト文字列は空であると見做されます。
{{#if: テスト文字列 | テスト文字列が空ではない場合の値 | テスト文字列が空 (または空白のみ) の場合の値 }}
{{#if: パラメーター 1 | パラメーター 2 | パラメーター 3 }}
この関数は、初めに最初の引数が空でないか確かめます。最初の引数が空でない場合、2 番目の引数を表示します。最初の引数が空または空白文字（空白、改行等）のみを含む場合、3 番目の引数を表示します。
{{#if: | yes | no}}→ no{{#if: string | yes | no}}→ yes{{#if: | yes | no}}→ no{{#if:→ no
| yes | no}}
テスト文字列は常に純粋なテキストとして評価されます。そのため数式は評価されません (#ifexpr を参照):
{{#if: 1==2 | yes | no }}→ yes{{#if: 0 | yes | no }}→ yes
最後の引数 (false) は省略可能です:
{{#if: foo | yes }}→ yes{{#if: | yes }}→{{#if: foo | | no}}→
関数はネストできます。これを行うには、囲んでいる #if 関数のパラメーターの代わりに、内部の #if 関数を完全な形式でネストします。ウィキやメモリ制限によって異なりますが、最大7レベルのネストが可能です。
{{#if: テスト文字列 | テスト文字列が空ではない場合の値 | {{#if: テスト文字列 | テスト文字列が空ではない場合の値 | テスト文字列が空 (または空白のみ) の場合の値 }} }}
#if 文において引数をテスト文字列として用いることも可能です。変数名の後には |（パイプ記号）を追加する必要があります。
(そのため、パラメーターに値がない場合は、文字列 "{{{1}}}"ではなく空の文字列に評価されます。)
{{#if:{{{1|}}}|変数1にテキストを入力しました|変数1にテキストがありません}}
このパーサー関数の他の例については Help:テンプレート内でのパーサー関数 を参照してください。
#ifeq
このパーサー関数は、2つの入力文字列を比較し、それらが同一であるかどうかを判断し、結果に基づいて2つの文字列のうちの1つを返します。
さらに比較と出力文字列が必要な場合は、#switchの使用を検討してください。
{{#ifeq: string 1 | string 2 | value if identical | value if different }}
両方の文字列が有効な数値である場合、文字列は数値的に比較されます。
{{#ifeq: 01 | 1 | equal | not equal}}→ equal{{#ifeq: 0 | -0 | equal | not equal}}→ equal{{#ifeq: 1e3 | 1000 | equal | not equal}}→ equal{{#ifeq: {{#expr:10^3}} | 1000 | equal | not equal}}→ equal
それ以外は文字列として比較します。その場合は大文字小文字を識別します。
{{#ifeq: foo | bar | equal | not equal}}→ not equal{{#ifeq: foo | Foo | equal | not equal}}→ not equal{{#ifeq: "01" | "1" | equal | not equal}}→ not equal (引用符なしで、上記の同様の例と比較してください){{#ifeq: 10^3 | 1000 | equal | not equal}}→ not equal (compare to similar example above, with#exprreturning a valid number first)
実用的な例として、既存のテンプレート テンプレート:Timerをパーサーを使用して、短い時間と長い時間の2つの標準時間から選択するとします。
文字列「short」と比較する最初の入力としてパラメータを取ります–順序の規則はありませんが、パラメーターが最初にある方が読みやすくなります。
テンプレートコードは次のように定義されています:
{{#ifeq: {{{1|}}} | short | 20 | 40 }}
次のようになります:
{{timer|short}}→ 20{{timer|20}}→ 40{{timer}}→ 40
| 警告: | パーサー関数内で使用する場合、パーサータグおよびその他のパーサー関数は一時的に一意のコードに置き換える必要があります。 これは比較に影響します:
|
| 警告: | PAGENAMEマジックワードとの文字通りの比較は、サイトの構成によっては失敗する場合があります。 たとえば、ウィキによっては、{{FULLPAGENAME}}が最初の文字を大文字にし、すべてのアンダースコアをスペースに置き換える場合があります。
これを回避するには、両方のパラメーターにマジックワードを適用します。
|
#iferror
この関数は入力文字列を取り、2つの結果から1つを返します。この関数は、 #expr や #time や #rel2abs のような他のパーサー関数、ループや再帰のようなテンプレートエラー、その他の「フェースソフト」なパーサーエラーによって作られた class="error" を含む HTML オブジェクトが入力文字列に含まれていた場合に true と評価します。
{{#iferror: test string | value if error | value if correct }}
返値の文字列の一方または両方が省略できます。もし correct の文字列が省略されていた場合、エラーがないのであれば test string が返されます。 error の文字列も省略されていた場合は、エラー時にから文字列が返されます。
{{#iferror: {{#expr: 1 + 2 }} | error | correct }}→ correct{{#iferror: {{#expr: 1 + X }} | error | correct }}→ error{{#iferror: {{#expr: 1 + 2 }} | error }}→ 3{{#iferror: {{#expr: 1 + X }} | error }}→ error{{#iferror: {{#expr: 1 + 2 }} }}→ 3{{#iferror: {{#expr: 1 + X }} }}→ {{#iferror: {{#expr: . }} | error | correct }}→ correct{{#iferror: <strong class="error">a</strong> | error | correct }}→ error
Some errors may cause a tracking category to be added, using {{#iferror:}} will not suppress the addition of the category.
#ifexpr
この関数は数式を評価し、結果の真偽値に応じて2つの文字列のいずれかを返します:
{{#ifexpr: expression | value if true | value if false }}
式入力は、上記の#exprとまったく同じように評価され、同じ演算子を使用できます。次に、出力は真偽値の式として評価されます。
空の入力式はfalseと評価されます:
{{#ifexpr: | yes | no}}→ no
上記のように、ゼロはfalseと評価され、ゼロ以外の値はtrueと評価されるため、この関数は#ifeqと#exprのみを使用する関数と同等です:
{{#ifeq: {{#expr: expression }} | 0 | value if false | value if true }}
空の入力式または間違った入力式を除きます(エラーメッセージは空の文字列として扱われます。ゼロに等しくないため、value if true を取得します)。
{{#ifexpr: = | yes | no }}→ Expression error: Unexpected = operator.
比較
{{#ifeq: {{#expr: = }} | 0 | no | yes }}→ yes
戻り値のいずれかまたは両方を省略できます。適切なブランチが空のままの場合、出力は提供されません。
{{#ifexpr: 1 > 0 | yes }}→ yes{{#ifexpr: 1 < 0 | yes }}→{{#ifexpr: 0 = 0 | yes }}→ yes{{#ifexpr: 1 > 0 | | no}}→{{#ifexpr: 1 < 0 | | no}}→ no{{#ifexpr: 1 > 0 }}→
Boolean operators of equality or inequality operators are supported.
{{#ifexpr: 0 = 0 or 1 = 0 | yes}}→ yes{{#ifexpr: 0 = 0 and 1 = 0 | | no}}→ no{{#ifexpr: 2 > 0 or 1 < 0 | yes}}→ yes{{#ifexpr: 2 > 0 and 1 > 0 | yes | no}}→ yes
| 警告: | #ifexprによる数値比較の結果は、#ifeqや#switchの結果と必ずしも一致しません。 これらの後者の2つは、#ifexprよりも正確であり、同等の結果を返しません。
変更された最後の桁とのこれらの比較を検討してください:
数字が異なると、equalの結果は実際には正しくありません。 #ifexprでのこの動作は、MediaWikiが式のリテラル数をfloat(フロート)型に変換するために発生します。これは、このような大きな整数の場合、丸めを伴います。 |
#ifexist
この関数は入力文字列を受け取り、それをページタイトルとして解釈し、そのページがローカルウィキに存在するかどうかに応じて、2つの値のいずれかを返します。
{{#ifexist: page title | value if exists | value if doesn't exist }}
ページが存在する場合、コンテンツが含まれているかどうかにかかわらず、関数はtrue(真)と評価されます(カテゴリリンクやマジックワードなどのメタデータが含まれていますが、表示されていません)。 コンテンツ、空白、またはリダイレクトです。存在していないページのみがfalse(偽)と評価されます。これには、ページが以前は存在していたが削除された場合も含まれます。
{{#ifexist: Help:Extension:ParserFunctions/ja | exists | doesn't exist }}→ exists{{#ifexist: XXHelp:Extension:ParserFunctions/jaXX | exists | doesn't exist }}→ doesn't exist
この関数は、カスタマイズされたシステムメッセージと、ソフトウェアによって定義された特別ページに対してtrue(真)と評価されます。
{{#ifexist: Special:Watchlist | exists | doesn't exist }}→ exists{{#ifexist: Special:CheckUser | exists | doesn't exist }}→ exists (Checkuser拡張機能がこのウィキにインストールされているため){{#ifexist: MediaWiki:Copyright | exists | doesn't exist }}→ exists (MediaWiki:Copyrightがカスタマイズされているため)
ページが#ifexist:を使用してターゲットをチェックする場合、そのページはターゲットページのSpecial:WhatLinksHereリストに表示されます。したがって、コード{{#ifexist:Foo }}がこのページ(Help:Extension:ParserFunctions/ja)にライブで含まれている場合、Special:WhatLinksHere/FooはHelp:Extension:ParserFunctions/jaをリストします。
共有メディアリポジトリを使用するWikiでは、#ifexist:を使用して、ファイルがリポジトリにアップロードされているかどうかを確認できますが、Wiki自体にはアップロードされていません。
{{#ifexist: File:Example.png | exists | doesn't exist }}→ doesn't exist{{#ifexist: Image:Example.png | exists | doesn't exist }}→ doesn't exist{{#ifexist: Media:Example.png | exists | doesn't exist }}→ exists
ファイルのローカル説明ページが作成されている場合、結果は上記のすべてに対して existsになります。
#ifexist:はインターウィキリンクでは機能しません。
ifexistの制限
#ifexist: は、「高負荷なパーサー関数」と見なされます。 1つのページに含めることができるのは限られた数だけです(参照読み込みされたテンプレート内の関数を含む)。
この制限を超えると、参照読み込み先ページが存在するかどうかに関係なく、それ以降の #ifexist: 関数は自動的にfalseを返し、ページは Category:Pages with too many expensive parser function calls に分類されます。
tracking category の名前は、ウィキのコンテンツ言語によって異なる場合があります。
使用事例によっては、a.new (存在しないページへのリンクを選択) またはa:not(.new) (存在するページへのリンクを選択) を使用して ifexist 効果を css で代用できます。
さらに、単一ページで使用するメモリ消耗の激しいパーサ関数の件数の上限は $wgExpensiveParserFunctionLimit で制御され、必要な場合は上限値を LocalSettings.php で変更できます。
存在し、必要なページ
存在せず、#ifexistを使っているかどうかテスト済みのページは、募集ページに分類されます。 See タスク T14019 for the reason, and w:Template:Linkless exists for a workaround.
#rel2abs
この関数は相対ファイル パスを絶対ファイル パスに変換します。
{{#rel2abs: path }}{{#rel2abs: path | base path }}
path 部分では、以下の構文を使用できます:
.→ 現在の階層..→ 1 つ上の階層に移動/foo→ 下位ディレクトリ /foo に 1 階層移動
base path を指定していない場合は、ページの完全なページ名が代わりに使用されます:
{{#rel2abs: /quok | Help:Foo/bar/baz }}→ Help:Foo/bar/baz/quok{{#rel2abs: ./quok | Help:Foo/bar/baz }}→ Help:Foo/bar/baz/quok{{#rel2abs: ../quok | Help:Foo/bar/baz }}→ Help:Foo/bar/quok{{#rel2abs: ../. | Help:Foo/bar/baz }}→ Help:Foo/bar
/. や /./ のような無効な構文は無視されます。
連続する終止符は2つまでしか許可されていないため、次のようなシーケンスを使用して、連続するステートメントを区切ることができます。
{{#rel2abs: ../quok/. | Help:Foo/bar/baz }}→ Help:Foo/bar/quok{{#rel2abs: ../../quok | Help:Foo/bar/baz }}→ Help:Foo/quok{{#rel2abs: ../../../quok | Help:Foo/bar/baz }}→ quok{{#rel2abs: ../../../../quok | Help:Foo/bar/baz }}→ Error: Invalid depth in path: "Help:Foo/bar/baz/../../../../quok" (tried to access a node above the root node).
For a similar group of functions see also Help:Magic words#URL data. Built-in parser functions include: 'localurl:', 'fullurl:', 'anchorencode:' etc.
#switch
関連項目: w:Help:Switch parser function
この関数は入力値1件を複数のテストケースと比較し、ヒットした場合は当該の文字列を返します。
{{#switch: comparison string
| case = result
| case = result
| ...
| case = result
| default result
}}
例:
{{#switch: baz | foo = Foo | baz = Baz | Bar }}→ Baz{{#switch: foo | foo = Foo | baz = Baz | Bar }}→ Foo{{#switch: zzz | foo = Foo | baz = Baz | Bar }}→ Bar
#switch with partial transclusion tags can affect a configuration file that enables an editor unfamiliar with template coding to view and edit configurable elements.
既定
case文字列に対応するcomparison stringがヒットしない場合、default resultを返します。
{{#switch: test | foo = Foo | baz = Baz | Bar }}→ Bar
この構文では、デフォルトの結果は最後のパラメーターである必要があり、生の等号({{}}のない等号)を含めることはできません。
一致する場合は、ケース比較として扱われ、一致するケースがない場合はテキストは表示されません。
これは、既定値が定義されていない (空である) ためです。
ただし、大文字と小文字が一致する場合は、関連する文字列が返されます。
{{#switch: test | Bar | foo = Foo | baz = Baz }}→{{#switch: test | foo = Foo | baz = Baz | B=ar }}→{{#switch: test | test = Foo | baz = Baz | B=ar }}→ Foo
代替方法として、既定の結果を "#default" のcase文字列で明示的に宣言することもできます。
{{#switch: comparison string
| case = result
| case = result
| ...
| case = result
| #default = default result
}}
この方法で宣言されたデフォルトの結果は、関数内のどこにでも配置できます。
{{#switch: test | foo = Foo | #default = Bar | baz = Baz }}→ Bar
defaultパラメータが省略され、一致が行われない場合、result(結果)は返されません。
{{#switch: test | foo = Foo | baz = Baz }}→
グループ化の結果
いくつかの case 文字列に同じ result 文字列を返す「フォールスルー」値を持たせることができます。これにより重複を最小限に抑えることができます。
{{#switch: comparison string
| case1 = result1
| case2
| case3
| case4 = result234
| case5 = result5
| case6
| case7 = result67
| #default = default result
}}
ここではケース2と3、4とも出力はresult234です。ケース6と7の出力は両方ともresult67です
上記の場合、最後のパラメータの「#default = 」は省略できます。
パラメータとともに使用
この関数は、テスト文字列としてパラメータとともに使用できます。
この場合、大文字と小文字を文字列 「{{{parameter name}}}」に設定する可能性は非常に低いため、パラメータ名の後にパイプを配置する必要はありません。
(これは、パイプが存在せず、パラメーターが存在しないか、値がある場合にパラメーターがデフォルトで設定する値です。
Help:テンプレート内でのパーサー関数 を参照してください。)
{{#switch: {{{1}}} | foo = Foo | baz = Baz | Bar }}
上記の場合、{{{1}}}がfooに等しい場合、関数はFooを返します。
bazに等しい場合、関数はBazを返します。
パラメータが空であるか存在しない場合、関数はBarを返します。
上記のセクションのように、ケースを組み合わせて単一の結果を得ることができます。
{{#switch: {{{1}}} | foo | zoo | roo = Foo | baz = Baz | Bar }}
ここで、{{{1}}}がfoo、zoo、またはrooに等しい場合、関数はFooを返します。
bazに等しい場合、関数はBazを返します。
パラメータが空であるか存在しない場合、関数はBarを返します。
さらに、テストパラメータ値がいずれの場合にも一致しない場合に何も返したくない場合は、デフォルトの結果を省略できます。
{{#switch: {{{1}}} | foo = Foo | bar = Bar }}
この場合、{{{1}}}が存在してfooまたはbarに等しい場合を除き、関数は空の文字列を返します。この場合、関数はそれぞれFooまたはBarを返します。
これは、デフォルトの結果を空として宣言するのと同じ効果があります。
{{#switch: {{{1}}} | foo | zoo | roo = Foo | baz = Baz | }}
何らかの理由でケースを「{{{parameter name}}}」に設定すると、パラメーターが存在しないか値がない場合に、関数はそのケースの結果を返します。
関数のデフォルトの結果を返すには、パラメーターが存在し、文字列「{{{parameter name}}}」以外の値を持っている必要があります。
- (
{{{1}}}が存在しないか、空の場合):{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }}→ Foo
- (
{{{1}}}の値が「test」の場合):{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }}→ Bar
- (
{{{1}}}の値が「{{{1}}}」の場合):{{#switch: {{{1}}} | {{{1}}} = Foo | baz = Baz | Bar }}→ Foo
この架空のケースでは、パイプをパラメーター({{{1|}}})に追加する必要があります。
比較の挙動
#ifeq 同様、比較は比較する文字列と対象の格文字列が数値である場合、数値として処理されます。あるいは大文字小文字を識別する文字列として処理されます。
{{#switch: 0 + 1 | 1 = one | 2 = two | three}}→ three{{#switch: {{#expr: 0 + 1}} | 1 = one | 2 = two | three}}→ one{{#switch: 02 | +1 = one | +2 = two | three}}→ two{{#switch: 100 | 1e1 = ten | 1e2 = hundred | other}}→ hundred
{{#switch: a | a = A | b = B | C}}→ A{{#switch: A | a = A | b = B | C}}→ C
case文字列は空白の場合があります。
{{#switch: | = Nothing | foo = Foo | Something }}→ Nothing
一致が見つかると、それ以降のcasesは無視されます。
{{#switch: b | f = Foo | b = Bar | b = Baz | }}→ Bar
| 警告: | #switchおよび#ifeqを使用した数値比較は、式の比較と同等ではありません(上記も参照)。
|
生の等号
"Case" 文字列には生の等号を含めることができません。これを回避するには、{{=}} マジックワードを使用して単一の等号記号 = を含むテンプレート {{=}} を作成するか、または等号記号を HTML コード = に置き換えます。
例:
| 入力 | 出力 |
|---|---|
{{#switch: 1=2
| 1=2 = raw
| 1<nowiki>=</nowiki>2 = nowiki
| 1{{=}}2 = template
| default
}}
|
template |
{{#switch: 1=2
| 1=2 = html
| default
}}
|
html |
#ifeqの置換
拡張深度を減らすには#switchを使用。
例えば:
{{#switch:{{{1}}} |condition1=branch1 |condition2=branch2 |condition3=branch3 |branch4}}
は、以下と同等です
{{#ifeq:{{{1}}}|condition1 |branch1 |{{#ifeq:{{{1}}}|condition2 |branch2 |{{#ifeq:{{{1}}}|condition3 |branch3 |branch4}}}}}}
つまり、深い入れ子、線形:
{{#ifeq:{{{1}}}|condition1
|<!--then-->branch1
|<!--else-->{{#ifeq:{{{1}}}|condition2
|<!--then-->branch2
|<!--else-->{{#ifeq:{{{1}}}|condition3
|<!--then-->branch3
|<!--else-->branch4}}}}}}
一方、switchの交換は、両方のブランチにネストされたIF(インデントの代替で示され、両側にインデントされている)の場合、複雑/非実用的であり、完全に対称的なツリーになります。
{{#ifeq:{{{1}}}|condition1
|<!--then-->branch1t{{
#ifeq:{{{1}}}|condition2
|<!--then-->branch1t2t{{#ifeq:{{{1}}}|condition4|<!--then-->branch1t2t4t|<!--else-->branch1t2t4e}}
|<!--else-->branch1t2e{{#ifeq:{{{1}}}|condition5|<!--then-->branch1t2e5t|<!--else-->branch1t2e5e}}
}}
|<!--else-->branch1e{{#ifeq:{{{1}}}|condition3
|<!--then-->branch1e3t{{#ifeq:{{{1}}}|condition6|branch1e3t6t|branch1e3t6e}}
|<!--else-->branch1e3e{{
#ifeq:{{{1}}}|condition7
|branch1e3e7t
|branch1e3e7t
}}
}}
}}
#time
| コード | 説明 | 現在の出力 (更新するにはこのページのキャッシュを破棄してください) |
|---|---|---|
| 年 | ||
Y
|
4 桁の年 | 2023 |
y
|
2 桁の年 | 23 |
L
|
閏年の場合 1、平年の場合 0 | 0 |
o[note 1] |
指定した週の ISO-8601 年[note 2] | 2023[note 3] |
| 月 | ||
n
|
月番号、ゼロ補完なし | 6 |
m
|
月番号、ゼロ補完あり | 06 |
M
|
サイトの言語での月名の省略形 | 6月 |
F
|
サイトの言語での完全な月名 | 6月 |
xg
|
属格と主格を区別する表示言語では、月の名前の表記を属格形式で出力。このオプションはスラヴ語派のポーランド語やロシア語、ベラルーシ語やチェコ語、スロバキア語やスロベニア語、ウクライナ語などに使える。 | ポーランド語の例:{{#time:F Y|June 2010|pl}} → czerwiec 2010(主格) {{#time:d xg Y|20 June 2010|pl}} → 20 czerwca 2010(所有格) |
| 月または年の通算日 | ||
j
|
日、ゼロ補完なし | 9 |
d
|
日、ゼロ補完あり | 09 |
z
|
日 (1月 1 = 0). 注: ISO 日付を得るには 1 を加算する。
|
159 |
| 週および曜日 | ||
W
|
ISO 8601 週番号、ゼロ補完あり | 23 |
N
|
ISO 8601 曜日番号 (月曜日 = 1、日曜日 = 7) | 5 |
w
|
曜日番号 (日曜日 = 0、土曜日 = 6) | 5 |
D
|
曜日の略号。翻訳されない場合が多い。 | 金 |
l
|
曜日の省略しない表記。翻訳されない場合が多い。 | 金曜日 |
| 時 | ||
a
|
午前 (00:00:00 ～ 11:59:59) の場合「am」、午後 (12:00:00 ～ 23:59:59) の場合「pm」 | am |
A
|
上の a の大文字版
|
AM |
g
|
時、12 時間制、ゼロ補完なし | 6 |
h
|
時、12 時間制、ゼロ補完あり | 06 |
G
|
時、24 時間制、ゼロ補完なし | 6 |
H
|
時、24 時間制、ゼロ補完あり | 06 |
| 分と秒 | ||
i
|
分、ゼロ補完あり | 09 |
s
|
秒、ゼロ補完あり | 57 |
U
|
Unix 日時。 1970年1月1日 00:00:00 GMT からの経過秒数 | 1686290997 |
| タイムゾーン (1.22wmf2 時点) | ||
e
|
タイムゾーン識別子 | UTC |
I
|
日時がサマータイムかどうか | 0 |
O
|
グリニッジ標準時 (GMT) との差 | +0000 |
P
|
グリニッジ標準時 (GMT) との差、コロン付き | +00:00 |
T
|
タイムゾーンの省略形 | UTC |
Z
|
タイムゾーンのオフセット (秒) | 0 |
| その他 | ||
t
|
日 | 30 |
c
|
ISO 8601 形式の日付、Y-m-d"T"H:i:s+00:00 と同等
|
2023-06-09T06:09:57+00:00 |
r
|
RFC 5322 形式の日時、D, j M Y H:i:s +0000 と同等。曜日と月名は国際化されない。
|
Fri, 09 Jun 2023 06:09:57 +0000 |
| グレゴリオ暦以外 | ||
| イスラム暦 | ||
xmj
|
日 | 20 |
xmF
|
完全な月名 | ズー＝ル＝カアダ |
xmn
|
月番号 | 11 |
xmY
|
完全な年 | 1444 |
| イラン暦 (Jalaly) | ||
xit
|
月間の日数 | 31 |
xiz
|
日 | 80 |
xij
|
日 | 19 |
xiF
|
完全な月名 | ホルダード |
xin
|
月番号 | 3 |
xiY
|
完全な年 | 1402 |
xiy
|
2 桁の年 | 02 |
| ユダヤ暦 | ||
xjj
|
日 | 20 |
xjF
|
完全な月名 | シバン |
xjt
|
月の日数 | 30 |
xjx
|
月名の所有格 | シバン |
xjn
|
月番号 | 9 |
xjY
|
完全な年 | 5783 |
| タイ太陽暦 | ||
xkY
|
タイ太陽暦の完全な年。 注: 1941 年より前の 1 月から 3 月の範囲は、適切には計算できません。
|
2566 |
| 民国紀元/主体暦 | ||
xoY
|
完全な年 | 112 |
| 日本の年号 | ||
xtY
|
完全な年 | 令和5 |
| フラグ | ||
xn
|
後続の数値をそのまま半角英数字に整形する。 | ヒンディー語では、{{#time:H, xnH}} は ०६, 06 を返す。
|
xN
|
xn と同様ですが、トグル フラグとして文字列の終端または文字列に次の xN が出現するまで保持されます。
| |
xr
|
後続の数値をローマ数字に整形する。10,000 までの数値で動作する。 (MediaWiki 1.20 以前は上限 3,000) |
{{#time:xrY}} → MMXXIII
|
xh
|
後続の数値をヘブライ数字に整形する。 | {{#time:xhY}} → ב'כ"ג
|
このパーサ関数は日付あるいは時間 (グレゴリア暦) を取って指定の文法どおりにフォーマットします。日・時間のオブジェクトを特定する方法; 既定値は マジックワード {{CURRENTTIMESTAMP}} – つまりページが最近 HTML 形式で表示された日時。
{{#time: format string }}{{#time: format string | date/time object }}{{#time: format string | date/time object | language code }}{{#time: format string | date/time object | language code | local }}
右の図には利用できる書式コードをまとめてあります。もし書式文字列内にこれら以外の文字がふくまれると、未処理で出力します。空白スペースも扱いは同様です (コードの解析に不要なため)。また書式文字列内の文字をエスケープする方法が2つあります。
- バックスラッシュに続けて書式指定文字列を記述すると、ひとまとまりのリテラル文字として解釈。
- 文字列を二重引用符で囲むと、リテラル文字として扱い引用符を除去。
またさらに、有向グラフxxの場合、ひとまとまりのリテラル文字"x"と解釈します。
Any character in the formatting string that is not recognized is passed through unaltered; this applies also to blank spaces (the system does not need them for interpreting the codes).
There are also two ways to escape characters within the formatting string:
- A backslash followed by a formatting character is interpreted as a single literal character
- Characters enclosed in double quotes are considered literal characters, and the quotes are removed.
In addition, the digraph xx is interpreted as a single literal "x".
As the list of formatting codes continues to evolve (with the support of new calendars, or of new date fields computed and formatted differently), you should escape all literal characters (not just ASCII letters currently used by formatting codes) that need to be passed through unaltered.
Unfortunately, for now, the ASCII single quote is still not recognized as a simple alternative for marking literal text to the currently supported ASCII double quotes (for example, double quotes are mandatory for in other uses like the delimitation of string values in JSON, C, C++...) and backslashes (which have to be escaped as well in string constants used by many languages, including JSON, C, C++, PHP, JavaScript, Lua). So you still cannot embed any literal double quote without escaping it with a backslash (or you can use other curly, angular or square quotation marks instead).
{{#time: Y-m-d }}→ 2023-06-09{{#time: [[Y]] m d }}→ 2023 06 09{{#time: [[Y (year)]] }}→ 2023 (23UTCamFri, 09 Jun 2023 06:09:57 +0000){{#time: [[Y "(year)"]] }}→ 2023 (year){{#time: i's" }}→ 09'57"
PHPはdate/time objectを受け取ると、どの書式でも strtotime() 関数で処理します (訳注：英文形式の日付を Unix タイムスタンプに変換)。
Absolute (e.g. 20 December 2000), relative (e.g. +20 hours), and combined times (e.g. 30 July +1 year) are accepted.
{{#time: r|now}}→ Fri, 09 Jun 2023 06:09:57 +0000{{#time: r|+2 hours}}→ Fri, 09 Jun 2023 08:09:57 +0000{{#time: r|now + 2 hours}}→ Fri, 09 Jun 2023 08:09:57 +0000{{#time: r|20 December 2000}}→ Wed, 20 Dec 2000 00:00:00 +0000{{#time: r|December 20, 2000}}→ Wed, 20 Dec 2000 00:00:00 +0000{{#time: r|2000-12-20}}→ Wed, 20 Dec 2000 00:00:00 +0000{{#time: r|2000 December 20}}→ Error: Invalid time.
ISO 639-3 (?) の言語コードにより、文字列を選択した言語で表示します。
{{#time:d F Y|1988-02-28|nl}}→ 28 februari 1988{{#time:l|now|uk}}→ п'ятниця{{#time:d xg Y|20 June 2010|pl}}→ 20 czerwca 2010
localパラメーターは、「日付/時刻オブジェクト」がローカルタイムゾーンを参照するかUTCを参照するかを指定します。
これは真偽値のパラメーターです。その値は、引数の値をキャストすることによって決定されます(文字列を真偽値にキャストする方法の詳細については、公式PHPドキュメントを参照してください)。
$wgLocaltimezoneがUTCに設定されている場合、localがtrueまたはfalseに設定されていても、出力に違いはないことに注意してください。詳細については、次の例を参照してください:
{{#time: Y F d H:i:s|now|it|0}}→ 2023 giugno 09 06:09:57{{#time: Y F d H:i:s|now|it|1}}→ 2023 giugno 09 06:09:57{{#time: Y F d H:i:s|+2 hours||0}}→ 2023 6月 09 08:09:57{{#time: Y F d H:i:s|+2 hours||1}}→ 2023 6月 09 08:09:57
{{#time:c|2019-05-16T17:05:43+02:00|it}}→ 2019-05-16T15:05:43+00:00{{#time:c|2019-05-16T17:05:43+02:00|it|0}}→ 2019-05-16T15:05:43+00:00{{#time:c|2019-05-16T17:05:43+02:00|it|true}}→ 2019-05-16T15:05:43+00:00
Unix タイムスタンプを計算する場合は、文字列の先頭に@記号を付けると日付計算に使えます。
{{#time: U | now }}→ 1686290997{{#time: r | @1686290997 }}→ Fri, 09 Jun 2023 06:09:57 +0000
| 警告: | もしタイムスタンプの数値の先頭に@を付けないと、ほぼ毎回、エラーか想定外の値を返します。
|
| 警告: | 許容できる入力値は「1 January 0111 → 31 December 9999」の範囲です。年は100から110までが不定形です。Y (年) とうるう年はその 100-110 と同様に不定形、r (RFC 5322 形式)、D (曜日略号)、l (曜日)、U (Unix日時) を記述すると年を 2000-2010 の範囲として解釈します。
先頭に 0 を付けて 4 桁の書式にした場合を除いて、年の値 0-99 は 2000-2069 年および 1970-1999 年と解釈されます:
|
完全または部分的な絶対日付を指定できます。この関数は current 値を使用して、指定されていない日付の部分を「補完」します。
{{#time: Y | January 1 }}→ 2023
| 警告: | 補完の関数は不定形です。特定の部分は現在の値で補完され、別の部分はエラーになります。
満員の日の例外ケースがあります:
|
4桁の数字は常に年として解釈され、時間や分としては解釈されません。[1]
{{#time: Y m d H:i:s | 1959 }}→ 1959 06 09 00:00:00
6桁の数字は時間と解釈、できるかぎり分と秒まで出力しようとしますが、それ以外の場合はエラーになります (たとえば年月日とは解釈しません)。
{{#time: Y m d H:i:s | 195909 }}→ 2023 06 09 19:59:09 記述したコードは年とゼロ補完の月と日を要求したのに、出力は時間として解釈。{{#time: Y m d H:i:s | 196009 }}→ Error: Invalid time. 19:60:09 は有効な時刻ではないにもかかわらず、196009 は1960年9月とは解釈されません。
関数は日付計算をこなそうとします。（訳注：Fは「サイトの言語での完全な月名」、dはゼロ補完の日を求め、入力値の不備で出力結果が不定形。）
{{#time: d F Y | January 0 2008 }}→ 31 12月 2007{{#time: d F | January 32 }}→ Error: Invalid time.{{#time: d F | February 29 2008 }}→ 29 2月{{#time: d F | February 29 2007 }}→ 01 3月{{#time:Y-F|now -1 months}}→ 2023-5月
#timeに対する書式文字列の文字数上限は半角で6000文字です[2]。
タイムゾーンの問題点
この#timeパーサ関数(より具体的にはPHP DateTime )には相対的なタイムゾーンオフセットとして整数以外 は渡せないというバグがあります。EDT (東部夏時間) など時間通りのタイムゾーンを使用する場合、この問題は発生しません。例をあげます。：
{{#time:g:i A | -4 hours }}→ 2:09 AM
ところがインドは UTC (協定世界時) との時差が +5.5 時間のため、タイムゾーンを適用すると通常なら正しいオフセットの計算に失敗するはずです。実例はこちら:
{{#time:g:i A | +5.5 hours }}→ 6:09 AM
そこで回避策として、単純に時間を分か秒 (minutes か seconds) に換算して、次の例のように与えます。
{{#time:g:i A | +330 minutes }}→ 11:39 AM{{#time:g:i A | +19800 seconds }}→ 11:39 AM
(関数の開発者 Tim Starling がこれを解決する構文を書いてくれました。)
#timel
この関数は {{#time: ... }} と同一ですが、local パラメーターに true を設定した場合に、常にウィキのローカルの時間を使用する点が異なります (タイムゾーンの設定は $wgLocaltimezone に従う)。
関数の構文は次のとおりです:
{{#timel: format string }}{{#timel: format string | date/time object }}{{#timel: format string | date/time object | language code }}
$wgLocaltimezoneがUTCに設定されている場合、localがtrueまたはfalseに設定されていても、出力に違いはないことに注意してください。
例えば、以下の例を参照してください:
{{#time:c|now|it}}→ 2023-06-09T06:09:57+00:00{{#time:c|now|it|0}}→ 2023-06-09T06:09:57+00:00{{#time:c|now|it|1}}→ 2023-06-09T06:09:57+00:00{{#timel:c|now|it}}→ 2023-06-09T06:09:57+00:00
| 警告: | UTC(旧称GMT)とは異なるタイムゾーンのウィキペディアでは、1970-01-01 00:00:00 UTC以降、時間と時間の両方のUが同じ秒数を返すことに注意してください。
|
#titleparts
この関数は、ページのタイトルをスラッシュに基づいてセグメントに分離し、それらのセグメントの一部を出力します。
{{#titleparts: ページ名 | 返すセグメント数 | 最初に返すセグメント }}
「返されるセグメントの数」パラメータが指定されていない場合、デフォルトで「0」になり、「最初に返されるセグメント」(含まれている)からすべてのセグメントが返されます。 「最初に返すセグメント」パラメータが指定されていないか「0」の場合、デフォルトで「1」になります。
{{#titleparts: Talk:Foo/bar/baz/quok }}→ Talk:Foo/bar/baz/quok{{#titleparts: Talk:Foo/bar/baz/quok | 1 }}→ Talk:Foo See also {{ROOTPAGENAME}}.{{#titleparts: Talk:Foo/bar/baz/quok | 2 }}→ Talk:Foo/bar{{#titleparts: Talk:Foo/bar/baz/quok | 2 | 2 }}→ bar/baz{{#titleparts: Talk:Foo/bar/baz/quok | | 2 }}→ bar/baz/quok{{#titleparts: Talk:Foo/bar/baz/quok | | 5 }}→
両方の値に負の値が受け入れられます。返されるセグメントの数パラメータの負の値は、文字列の末尾からセグメントを効果的に「ストリップ」します。 「最初に返されるセグメント」の負の値は、「このセグメントを右から数えて開始する」という意味になります。
{{#titleparts: Talk:Foo/bar/baz/quok | -1 }}→ Talk:Foo/bar/baz 文字列の最後から数えてはじめのセグメントを削除します。 {{BASEPAGENAME}} も参照してください。{{#titleparts: Talk:Foo/bar/baz/quok | -4 }}→ 文字列の末尾から4つのセグメントすべてを削除します{{#titleparts: Talk:Foo/bar/baz/quok | -5 }}→ 文字列の末尾から5つのセグメントを削除します(存在する以上){{#titleparts: Talk:Foo/bar/baz/quok | | -1 }}→ quok 最後のセグメントを返します。 {{SUBPAGENAME}} も参照してください。{{#titleparts: Talk:Foo/bar/baz/quok | -1 | 2 }}→ bar/baz 文字列の末尾から1つのセグメントを削除してから、2番目以降のセグメントを返します{{#titleparts: Talk:Foo/bar/baz/quok | -1 | -2 }}→ baz 最後から2番目の要素からコピーを開始します。文字列の末尾から1つのセグメントを削除します
処理する前に、「pagename」パラメータはHTMLでデコードされます。標準のHTML文字エンティティが含まれている場合、それらはプレーン文字に変換されます(UTF-8で内部的にエンコードされます。つまり、MediaWikiソースページで使用するのと同じエンコードです。このパーサー関数)。
- たとえば、pagenameに
"、"、または"が含まれている場合は、"に置き換えられます。 - HTMLからプレーンテキストへの他の変換は実行されないため、HTMLタグは、ページタイトルで無効であっても、この最初のステップではそのまま残ります。
Some magic keywords or parser functions of MediaWiki (such as {{PAGENAME}} and similar) are known to return strings that are needlessly HTML-encoded, even if their own input parameter was not HTML-encoded:
The titleparts parser function can then be used as a workaround, to convert these returned strings so that they can be processed correctly by some other parser functions also taking a page name in parameter (such as {{PAGESINCAT:}} but which are still not working properly with HTML-encoded input strings.
For example, if the current page is Category:Côte-d'Or, then:
{{#ifeq: {{FULLPAGENAME}} | Category:Côte-d'Or | 1 | 0 }}, and{{#ifeq: {{FULLPAGENAME}} | Category:Côte-d'Or | 1 | 0 }}are both returning1; (the #ifeq parser function does perform the HTML-decoding of its input parameters).{{#switch: {{FULLPAGENAME}} | Category:Côte-d'Or = 1 | #default = 0 }}, and{{#switch: {{FULLPAGENAME}} | Category:Côte-d'Or = 1 | #default = 0 }}are both returning1; (the #switch parser function does perform the HTML-decoding of its input parameters).{{#ifexist: {{FULLPAGENAME}} | 1 | 0 }},{{#ifexist: Category:Côte-d'Or | 1 | 0 }}, or even{{#ifexist: Category:Côte-d'Or | 1 | 0 }}will all return1if that category page exists (the #ifexist parser function does perform the HTML-decoding of its input parameters);{{PAGESINCAT: Côte-d'Or }}will return a non-zero number, if that category contains pages or subcategories, but:{{PAGESINCAT: {{CURRENTPAGENAME}} }}, may still unconditionally return 0, just like:{{PAGESINCAT: {{PAGENAME:Category:Côte-d'Or}} }}{{PAGESINCAT: {{PAGENAME:Category:Côte-d'Or}} }}
The reason of this unexpected behavior is that, with the current versions of MediaWiki, there are two caveats:
{{FULLPAGENAME}}, or even{{FULLPAGENAME:Côte-d'Or}}may return the actually HTML-encoded stringCategory:Côte-d'Orand not the expectedCategory:Côte-d'Or, and that:{{PAGESINCAT: Côte-d'Or }}unconditionally returns 0 (the PAGESINCAT magic keyword does not perform any HTML-decoding of its input parameter).
The simple workaround using titleparts (which will continue to work if the two caveats are fixed in a later version of MediaWiki) is:
{{PAGESINCAT: {{#titleparts: {{CURRENTPAGENAME}} }} }}{{PAGESINCAT: {{#titleparts: {{PAGENAME:Category:Côte-d'Or}} }} }}{{PAGESINCAT: {{#titleparts: {{PAGENAME:Category:Côte-d'Or}} }} }}, that all return the actual number of pages in the same category.
Then the decoded pagename is canonicalized into a standard page title supported by MediaWiki, as much as possible:
- All underscores are automatically replaced with spaces:
{{#titleparts: Talk:Foo/bah_boo|1|2}}→ bah boo Not bah_boo, despite the underscore in the original.
- The string is split a maximum of 25 times; further slashes are ignored and the 25th element will contain the rest of the string. The string is also limited to 255 characters, as it is treated as a page title:
{{#titleparts: a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y/z/aa/bb/cc/dd/ee | 1 | 25 }}→ y/z/aa/bb/cc/dd/ee- If for whatever reason you needed to push this function to its limit, although very unlikely, it is possible to bypass the 25 split limit by nesting function calls:
{{#titleparts: {{#titleparts: a/b/c/d/e/f/g/h/i/j/k/l/m/n/o/p/q/r/s/t/u/v/w/x/y/z/aa/bb/cc/dd/ee| 1 | 25 }} | 1 | 2}}→ z
- Finally the first substring is capitalized according to the capitalization settings of the local wiki (if that substring also starts by a local namespace name, that namespace name is also normalized).
{{#titleparts: talk:a/b/c }}→ Talk:A/b/c
| 警告: | You can use #titleparts as a small "string parser and converter", but consider that it returns the first substring capitalized:
小文字を求めるには lc: 関数を使い出力をコントロールします。
You can prepend a 'dummy' slash at the beginning of the string to get the correct first substring capitalization (uppercase or lowercase). Use
|
| 警告: | Certain characters that are illegal in a page title will cause #titleparts to not parse the string:
|
| 警告: | If any part of the title is just "
|
| 警告: | This function does not degrade gracefully if the input exceeds 255 bytes in UTF-8. If the input string is 256 bytes or more, the whole string is returned. |
StringFunctions
All of these functions (len, pos, rpos, sub, replace, explode) are integrated from the StringFunctions extension, but are only available if an administrator sets $wgPFEnableStringFunctions = true; in LocalSettings.php.
- Some parameters of these functions are limited through global settings to prevent abuse.
- For functions that are case sensitive, you may use the magic word
{{lc:string}}as a workaround in some cases.
- To determine whether a MediaWiki server enables these functions, check the list of supported Extended parser functions in Special:Version.
- String length is limited by
$wgPFStringLengthLimitvariable, default to 1000.
#len
#len parser function was merged from the StringFunctions extension as of version 1.2.0.The #len function returns the length of the given string. 構文は以下の通りです:
{{#len:string}}
The return value is always a number of characters in the source string (after expansions of template invocations, but before conversion to HTML). If no string is specified, the return value is zero.
- This function is safe with UTF-8 multibyte characters.
{{#len:Žmržlina}}→8
- Leading and trailing spaces or newlines are not counted, but intermediate spaces and newlines are taken into account.
{{#len:Icecream }}→8{{#len: a b }}→5- 3 spaces between 2 characters
- Characters given by reference are not converted, but counted according to their source form.
{{#len: }}→6- named characters references{{#len: }}→5- numeric characters references, not ignored despite it designates a space here.
- Tags such as
<nowiki>and other tag extensions will always have a length of zero, since their content is hidden from the parser.
{{#len:<nowiki>This is a </nowiki>test}}→4
#pos
#pos parser function was merged from the StringFunctions extension as of version 1.2.0.The #pos function returns the position of a given search term within the string. 構文は以下の通りです:
{{#pos:string|search term|offset}}
The offset parameter, if specified, tells a starting position where this function should begin searching.
If the search term is found, the return value is a zero-based integer of the first position within the string.
If the search term is not found, the function returns an empty string.
- This function is case sensitive.
- The maximum allowed length of the search term is limited through the $wgStringFunctionsLimitSearch global setting.
- この関数は UTF-8 の2バイト超の文字体系を使っても安全です。 例:
{{#pos:Žmržlina|žlina}}は 3 を返します。
- As with #len,
<nowiki>and other tag extensions are treated as having a length of 1 for the purposes of character position.
{{#pos:<nowiki>This is a </nowiki>test|test}} は 1 を返します。#rpos
#rpos parser function was merged from the StringFunctions extension as of version 1.2.0.The #rpos function returns the last position of a given search term within the string. 構文は以下の通りです:
{{#rpos:string|search term}}
If the search term is found, the return value is a zero-based integer of its last position within the string.
If the search term is not found, the function returns -1.
- This function is case sensitive.
- The maximum allowed length of the search term is limited through the $wgStringFunctionsLimitSearch global setting.
- This function is safe with UTF-8 multibyte characters.
{{#rpos:Žmržlina|lina}} は 4 を返します。
- As with #len,
<nowiki>and other tag extensions are treated as having a length of 1 for the purposes of character position.
{{#rpos:<nowiki>This is a </nowiki>test|test}} は 1 を返します。#sub
#sub parser function was merged from the StringFunctions extension as of version 1.2.0.The #sub function returns a substring from the given string. 構文は以下の通りです:
{{#sub:string|start|length}}
The start parameter, if positive (or zero), specifies a zero-based index of the first character to be returned.
例:
{{#sub:Icecream|3}} は cream を返します。
{{#sub:Icecream|0|3}} は Ice を返します。
If the start parameter is negative, it specifies how many characters from the end should be returned.
例:
{{#sub:Icecream|-3}} は eam を返します。
The length parameter, if present and positive, specifies the maximum length of the returned string.
例:
{{#sub:Icecream|3|3}} は cre を返します。
If the length parameter is negative, it specifies how many characters will be omitted from the end of the string.
例:
{{#sub:Icecream|3|-3}} は cr を返します。
If the start parameter is negative, it specifies how many characters from the end should be returned. The length parameter, if present and positive, specifies the maximum length of the returned string from the starting point.
例:
{{#sub:Icecream|-3|2}} は ea を返します。
- If the length parameter is zero, it is not used for truncation at all.
- 例:
{{#sub:Icecream|3|0}}はcreamを返します。{{#sub:Icecream|0|3}}はIceを返します。
- 例:
- If start denotes a position beyond the truncation from the end by negative length parameter, an empty string will be returned.
- 例:
{{#sub:Icecream|3|-6}}は空の文字列を返します。
- 例:
- This function is safe with UTF-8 multibyte characters.
{{#sub:Žmržlina|3}} は žlina を返します。
- As with #len,
<nowiki>and other tag extensions are treated as having a length of 1 for the purposes of character position.
{{#sub:<nowiki>This is a </nowiki>test|1}} は test を返します。#count
#count parser function was added to the StringFunctions extension as of version 1.2.0.The #count function returns the number of times a given substring appears within the provided text.
{{#count:string|substring}}
#replace
#replace parser function was merged from the StringFunctions extension as of version 1.2.0.The #replace function returns the given string with all occurrences of a search term replaced with a replacement term.
{{#replace:string|search term|replacement term}}
If the search term is unspecified or empty, a single space will be searched for.
If the replacement term is unspecified or empty, all occurrences of the search term will be removed from the string.
- This function is case-sensitive.
- The maximum allowed length of the search term is limited through the $wgStringFunctionsLimitSearch global setting.
- The maximum allowed length of the replacement term is limited through the $wgStringFunctionsLimitReplace global setting.
- Even if the replacement term is a space, an empty string is used.
- 例:
{{#replace:My_little_home_page|_|<nowiki> </nowiki>}}はMy little home pageを返します。
- 例:
- If this doesn't work, try
{{#replace:My_little_home_page|_|<nowiki/> <nowiki/>}}with two self-closing tags.
- If this doesn't work, try
- Note that this is the only acceptable use of nowiki in the replacement term, as otherwise nowiki could be used to bypass $wgStringFunctionsLimitReplace, injecting an arbitrarily large number of characters into the output.
<nowiki> or any other tag extension within the replacement term are replaced with spaces.
- This function is safe with UTF-8 multibyte characters.
{{#replace:Žmržlina|ž|z}} は Žmrzlina を返します。
- If multiple items in a single text string need to be replaced, one could also consider Extension:ReplaceSet.
- Case-insensitive replace
Currently the syntax doesn't provide a switch to toggle case-sensitivity setting.
But you may make use of magic words of formatting as a workaround.
(e.g. {{lc:your_string_here}})
For example, if you want to remove the word "Category:" from the string regardless of its case, you may type:
{{#replace:{{lc:{{{1}}}}}|category:|}}
But the disadvantage is that the output will become all lower-case. If you want to keep the casing after replacement, you have to use multiple nesting levels (i.e. multiple replace calls) to achieve the same thing.
#explode
#explode parser function was merged from the StringFunctions extension as of version 1.2.0.The #explode function splits the given string into pieces and then returns one of the pieces. The syntax is:
{{#explode:string|delimiter|position|limit}}
The delimiter parameter specifies a string to be used to divide the string into pieces. This delimiter string is then not part of any piece, and when two delimiter strings are next to each other, they create an empty piece between them. If this parameter is not specified, a single space is used. The limit parameter is available in ParserFunctions only, not the standalone StringFunctions version, and allows you to limit the number of parts returned, with all remaining text included in the final part.
The position parameter specifies which piece is to be returned. Pieces are counted from 0. If this parameter is not specified, the first piece is used (piece with number 0). When a negative value is used as position, the pieces are counted from the end. In this case, piece number -1 means the last piece. 例:
{{#explode:And if you tolerate this| |2}}returnsyou{{#explode:String/Functions/Code|/|-1}}returnsCode{{#explode:Split%By%Percentage%Signs|%|2}}returnsPercentage{{#explode:And if you tolerate this thing and expect no more| |2|3}}returnsyou tolerate this thing and expect no more
The return value is the position-th piece. If there are fewer pieces than the position specifies, an empty string is returned.
- This function is case sensitive.
- The maximum allowed length of the delimiter is limited through $wgStringFunctionsLimitSearch global setting.
- This function is safe with UTF-8 multibyte characters. Example:
{{#explode:Žmržlina|ž|1}}returnslina.
#urldecode
#urldecode converts the escape characters from an 'URL encoded' string back to readable text. The syntax is:
{{#urldecode:値}}
Notes:
- This function works by directly exposing PHP's urldecode() function.
- A character-code-reference can be found at www.w3schools.com.
- The opposite,
urlencode, has been integrated into MediaWiki as of version 1.18; for examples, see Help:Magic Words. - urldecode was merged from Stringfunctions in 2010, by commit 1b75afd18d3695bdb6ffbfccd0e4aec064785363
制限
This module defines three global settings:
These are used to limit some parameters of some functions to ensure the functions operate in O(n) time complexity, and are therefore safe against DoS attacks.
$wgStringFunctionsLimitSearch
This setting is used by #pos, #rpos, #replace, and #explode. All these functions search for a substring in a larger string while they operate, which can run in O(n*m) and therefore make the software more vulnerable to DoS attacks. By setting this value to a specific small number, the time complexity is decreased to O(n).
This setting limits the maximum allowed length of the string being searched for.
The default value is 30 multibyte characters.
$wgStringFunctionsLimitReplace
This setting is used by #replace. This function replaces all occurrences of one string for another, which can be used to quickly generate very large amounts of data, and therefore makes the software more vulnerable to DoS attacks. This setting limits the maximum allowed length of the replacing string.
The default value is 30 multibyte characters.
全般的な情報
subst展開
パーサー関数の subst展開は、ハッシュ記号の前にsubst:を足します。
{{subst:#ifexist: Help:Extension:ParserFunctions/ja | [[Help:Extension:ParserFunctions/ja]] | Help:Extension:ParserFunctions/ja }}→[[Help:Extension:ParserFunctions/ja]]というページが存在するため、コード Help:Extension:ParserFunctions/ja がウィキテキストに挿入されます。
| 警告: | The results of substituted parser functions are undefined if the expressions contain unsubstituted volatile code such as variables or other parser functions. For consistent results, all the volatile code in the expression to be evaluated must be substituted. See Help:Substitution. |
Subst展開は <ref>…</ref>; では機能しないので、予測する結果を得るには{{subst:#tag:ref|…}} を使ってください。
リダイレクト
中でも{{#time:…|now-…}} は文中に日付を含むページのリダイレクトで特に利便性が高そうに見えても、実用上は機能しません。
表内でのパイプ記号のエスケープ
パーサー関数はウィキ記述の表 wikitable の構文を断ち切りパイプ記号 (|) に与える役目を変質させ、生のパイプ記号は単に変数の区切り子として扱います。
回避策として過去にはほとんどのウィキで Template:! テンプレートを使い生のパイプ記号 (|) 単体のみ記していたところ、MW 1.24 以降はこの苦しい方法に代わって {{!}} マジックワードが使えます。
これは見た目にパイプ記号を MediaWiki 関数に対して〈不可視化〉することで、特定のページ内のテンプレート類や変数がすべて展開するまで、処理の対象として保留されます。
そして表の列や行の区切り子として解釈されます。
代案として生の HTML 形式の関数の表を使う方法もあり、ただし直感的に記述しにくくエラー発生の確率も高めです。
パイプ記号は、平文 (解釈されない) 文字としてエスケープすることもできます。これには HTML エンティティ | を使用します。
| 説明 | 入力内容 | 結果 |
|---|---|---|
| パイプ記号を表の行/列区切りとしてエスケープ | {{!}}
|
| |
| パイプ記号をプレーンな文字としてエスケープ | | |
| |
空白類の除去
空白 (改行、タブ、空白アキ) はパーサ関数の全パラメータの開始から終了まで除去します。これを回避するには、引用符で囲んでから文字列を比較します。
{{#ifeq: foo | foo | equal | not equal }}→ equal{{#ifeq: "foo " | " foo" | equal | not equal }}→ not equal
then 部分および else 部分での空白の除去を回避する方法は m:Template:If を参照してください。空白の代わりに <nowiki> </nowiki> を使用することもできます。
foo{{#if:|| bar }}foo→ foobarfoofoo{{#if:||<nowiki /> bar <nowiki />}}foo→ foo bar foo
ただし連続する複数の空白文字はパーサにより1文字に圧縮されるため、この方法により処理できるのは1文字の空白文字に限定されます。
<span style="white-space: pre;">foo{{#if:||<nowiki/> bar <nowiki/>}}foo</span>
→ foo bar foo
このサンプルでは white-space: pre 書式を採用してブラウザ上で非表示でも、空白スペースが保持されるように強制します。ソフトウェアにより、ブラウザに渡す前に空白文字が除去されるため発生します。
この挙動を回避するには、ソフトウェアによって置換されないように空白スペースを  (breakable space) もしくは (non-breakable space) に置換します。
<span style="white-space: pre;">foo{{#if:||   bar   }}foo</span>→ foo bar foofoo{{#if:|| bar }}foo→ foo bar foo
Beware that not all parameters are created equal. In ParserFunctions, whitespace at the beginning and end is always stripped. In templates, whitespace at the beginning and end is stripped for named parameters and named unnamed parameters but not from unnamed parameters:
foo{{1x|content= bar}}foo→ foobarfoofoo{{1x|1= bar}}foo→ foobarfoofoo{{1x| bar }}foo→ foo bar foo
関連項目
- Help:テンプレート内でのパーサー関数
- m:Help:計算
- m:Help:改行と空白アキ
- m:Help:ParserFunctions 構文と TeX 構文の比較対照
- Help:マジックワード
- Parser function hooks, an (incomplete) list of parser functions added by core and extensions.
- Module:String は Extension:StringFunctions を廃止
- Extension:PhpTags
- Parser functions for Wikibase (the extensions that enables Wikidata): d:Special:MyLanguage/Wikidata:How to use data on Wikimedia projects#Parser_function
脚注
- ↑ 2011年のr86805以前とは扱いが変わりました。
- ↑ phabricator.wikimedia.orgのExtParserFunctions.php を参照してください。