Help:Extension:ParserFunctions/zh

扩展提供11个額外的解析器函数以补充MediaWiki固有的“”. （有可能会配置到额外的解析器函数以支持运行；这些字符串函数已在记载. ） 此扩展提供的所有解析器函数均采用以下形式：

#expr
这个函数计算数学表达式并返回计算值. 在中可以通过 来使用此函数.



右表依优先级列出了支持的运算符，运算符的详细说明请见帮助:计算. 运算结果的精度和格式受运行wiki服务器操作系统和站点语言的数字格式影响可能存在差异.

使用布尔代数时，0表示 ，其他任何非0数值（无论正负）均表示 ：



空表达式返回空值，无效的表达式返回错误信息，使用 函数检查错误：



置于数字前或数字后的加减号是有意义的，会被视为正负号而不会报错：



注意：使用魔术字输出数值时，首先要将其格式化以去除逗号，获得纯数字. 例如： 输出，而期望的输出值是0，使用 便可以实现. 对于某些语言，格式化数字尤为重要. 例如孟加拉语中， 的输出结果是৩০,০৬১.



四舍五入
将左边的数字四舍五入为1/10的幂的倍数，指数等于右边给出的数字的截断值（truncated value）.

向上、向下取整分别使用 或.

字符串
表达式函数只用于仅含有数字和运算符号的表达式，而字母字符串和其它符号不在此列. 若需要比较字符串，可以用替代.



#if
这个函数判断一个字符串是否为空. 只包含空格的字符串被视为空字符串.





这个函数首先判断参数1是否为空. 如果参数1不为空，则输出参数2. 如果参数1为空或只包含空白内容（空格、换行等），则输出参数3.



字符串内容会被处理为纯文本，因此不会计算数学表达式：



最后一个参数（false）可以忽略：



该函数可嵌套. 为了做到这一点，嵌套内层的#if函数需要按规则完整填写所有参数以符合#if的参数形式. 一般至多可嵌套7层，该数也可能为wiki自身限制和内存限制而有变动.

你可以在#if条件句中以字符串变量代替测试字符串. 在这里，你需要在变量名的后面加上 (分隔符)以正确引用字符串. （因此如果参数没有值，则计算结果为一个空字符串而非" ". ）



参见以了解更多关于解释器函数中变量的相关例子.

#ifeq
这个函数判断两个輸入字符串是否相同，並根據結果輸出兩個字符串的其中一個. 如果需要更多的比較和輸出字符串，請考慮使用.



如果两个字符串均为数字，则函数会进行数值的比较：



否则，函数会进行文本的比较（大小写敏感）：


 * →  （对比上面没有引号的例子）
 * →  （对比上面带有 的例子，會先回傳一個有效的整數）
 * →  （对比上面没有引号的例子）
 * →  （对比上面带有 的例子，會先回傳一個有效的整數）

作为例子，考虑一个已存在的 ，该模板利用解析器来選擇兩個標準時間，short和long. 它以参数作为第一个输入来比较字符串“short”–这没有约定顺序，但是如果参数在第一个则更容易理解. 模板代码定义为:



会产生如下结果：


 * → 20
 * → 40
 * → 40

#iferror
这个函数接收一个输入字符串，返回两个结果中的一个. 如果输入字符串包含一个由其他解析器函数（比如 、 和 ）、模板错误（比如模板循环和模板递归）或其他解释器“软错误”生成的 的HTML对象，那么视为真.



待返回字符串参数可以省略. 若省略 （正确）字符串参数，则在 （测试字符串）不出错的情况下函数将返回被测字符串本身. 若省略 （错误）字符串参数，则函数将在被测字符串出错时返回空字符串：


 * → &zwnj;
 * → &zwnj;
 * → &zwnj;
 * → &zwnj;
 * → &zwnj;
 * → &zwnj;

#ifexpr
此函数会判断数学表达式并根据其布尔值结果返回对应的字符串：



这里 输入串将原封不动的作为上面 的参数进行调用，且表达式运算符是通用的，返回值也将作为布尔表达式进行处理.

输入表达式为空时将视为 ：



如上面所提，0将视为 ，非零值将视为 ，因此这个函数与下面的仅用 和 的表述等价：



除了下面这种情况：所输入表达式为空或者是一个错误表达式（空串会返回一条错误信息，而它不等于0，所以在后者我们会得到 ）.



相对的



两个返回值都可以省略，当合适的对应分支被省略时，函数不输出：



Boolean operators of equality or inequality operators are supported.



#ifexist
这个函数将一组字符串作为输入，并翻译成页面标题，然后根据在本地wiki上是否存在该页面而返回对应的值.



只要页面存在就会判定为 （真值），即便那个页面看上去是空白的（比如像是分类链接或者是解释页之类的却不包含任何可视内容的页面），或者是，或者它就是空白页. 当且仅当页面是红链时判定为 （假值），包括那些曾经存在却被删除的页面.



函数在对应模块被安装时认定为 ，对的判定则取决于本地软件自身.



如果一个页面使用了 来检查目标页面，则这个检查页面将出现在被检查页面的里. 所以如果本页面（）使用了代码 ，那么/Foo将列出.

若wiki有其在使用的对应的共享媒体库， 就可用于检查一个文件是否在媒体库中，而不仅仅只是在wiki本体上检查：



如果文件有一个已创建的对应的本地描述页面，上面的结果将全部是exists.

不会对跨wiki链接起作用.

ifexist 限制
被视为“高开销（expensive）解析器函数”，每个页面调用这类函数的次数（包括包含于嵌入式模板的函数）存在一个限制. 当达到该限制时，更多的 函数，无论其目标页面是否存在，只会自动返回错误值false，且该页面会被分类到Category:中. 可能因您的wiki内容的语言而异.

一些情况下，在css中使用选择器 （以选出链接到不存在的页面的链接）或者是 （以选出已存在页面的链接），是可以达到模仿ifexist的效果的. 另外，控制 可以调整对高开销解析器函数数量的限制，如果有需要，也可以增加页面LocalSettings.php中的限制值.

ifexisit和需要的页面
一个不存在的页面被#ifexist检测后会被计数在待创建页面中. 请参阅了解原因，并查看w:Template:Linkless exists以了解解决方法.

#rel2abs
这个函数将文件的相对路径转换为绝对路径.



在输入项 中，可以使用以下类型的句法：


 * → 本级路径
 * → 回到上一级
 * → 向下一级进入子目录/foo

若 没有指定，将默认的填入函数所在页面的绝对路径：



无效语法，如 或 ，将被忽略. 由于不允许超过两个连续的句号，因此可以使用诸如此类的序列来分隔连续的语句：



#switch
参见： w:Help:Switch parser function

该函数将一个输入值同若干个测试用例（test cases）做比较，如果找到匹配，返回有关联的字符串.

例如：



含有部分嵌入包含标记的 # switch会影响到能让不熟悉模板代码的编辑者查看和编辑可配置元素的配置文件.

默认
如果 不能与任何 匹配，则返回 ：



在这种语法中，默认返回值必须是函数的最后一个参数，而且不能包含原始等号（不帶 的等號）. 否则，就会解析为样例比较，无匹配的样例时不显示文本. 这是因为默认值没有定义（是空的）. 如果有样例匹配，则返回关联的字符串.



你也可以将 字符串设为'' 从而清楚地声明默认值.

这种方式声明的默认结果可以放在函数的任何地方：



如果 参数被省略，且没有找到匹配，则不返回结果：



分组结果
该函数允许有“跌落”值，多个 字符串返回相同的 字符串，从而减少重复.

在本例中，第二、三、四个分支都会返回 ，第六和第七个分支都会返回. 上述案例中，最后一个参数中的“ ”可以省略.

带有参数使用
该函数允许将参数用作测试字符串. 在本例中，不必将管道符放在参数名称后面，因为你不太可能需要选择字符串“ ”作为样例. (（如果没有管道符，且参数不存在或没有值，则参数就会显示为这样. ） 参见. )



上面的例子中，如果 等于 ，函数返回. 如果等于 ，函数返回. 如果参数是空的或者不存在，函数返回.

上面的这些中，也可以将样例组合起来以返回单个结果.



如果 等于 、 或 ，函数返回. 如果等于 ，函数返回. 如果参数是空的或者不存在，函数返回.

而且，如果你希望在测试参数不能匹配任何样例时不返回任何内容，可以省略默认结果.



在本例中，如果 存在且等于 或 ，则分别返回 或 ，否则不返回任何内容.

这样做相当于将默认值声明为空.



如果由于某些原因需要将样例设置为 ，则函数在参数不存在或没有值的情况下返回该样例的结果. 参数需要存在且拥有不同于字符串“ ”的值以返回函数的默认结果.


 * （若 不存在或者是空的）：
 * →  Foo 
 * （若 的值为 ）：
 * →  Bar 
 * （若 的值为“ ”）：
 * →  Foo 

在这样的例子中，你需要给参数添加管道符（ ）.

比较行为
如同 那样，若被比较字符串和测试用例字符串都是数字，那么按照数值进行比较；反之若存在一个非纯数字串，都会按照字符串比较规则进行：





字符串可以是空的：



只要找到一个匹配，后面的 都会忽略：



原始等号
“case”字符串不能包含原始等号. 如果需要在比较串中加入等号，可以使用仅包含一个等号的模板=来代替 ，或者是用HTML标识码 来代替.

例如：

替换#ifeq
可以用于减少扩展深度.

例如：



等效于



也就是线性的深度迭代判断：

另一方面，对于嵌套在两个分支中的if（以缩进形式呈现，两侧都缩进），替换成switch可能很复杂/不切实际，从而形成对称树：

#time
该解析器函数接收一个（公历的）日期或者时间，并根据给定的语法将其格式化. 可以指定日期/时间对象，默认则为魔术字Special:MyLanguage/Help:Magic words#Date and time的当前值——也就是说，页面最后被渲染为HTML时的时间.



右表列举了支持的格式化代码. 任何不被识别的格式化字符串都不会被修改，这同样适用于空白字符（系统不使用空白字符来解释代码）. 格式化字符串内有两种方法来转义字符： 此外， 会被解释为单个原始的x.
 * 1) 反斜杠后跟随一个格式化字符串会被解释为单个原始的字符
 * 2) 用英文双引号括起来的字符视为原始字符，引号将被移除.

由于格式化代码列表会持续发展（支持新日历，或支持以不同方式计算和格式化的新日期字段），您应该转义所有需要传入而保持不变的文字字符（不仅仅是格式化代码当前使用的ASCII字母）.

不幸的是，目前，ASCII单引号仍未被视为当前已经受支持的ASCII双引号（可标记文字文本）和反斜杠（在许多语言使用的字符串常量中也必须转义，包括JSON、C、C++、PHP、JavaScript、Lua）的简单替代方法（例如，双引号在其他用途​​中是强制性的，例如JSON、C、C++等语言中的字符串值的定界）. 因此，您仍然无法在不使用反斜杠转义的情况下嵌入任何文字双引号（或者也可以使用其他弯引号、角形引号或方引号）.



可以是任何PHP strtotime函数接受的格式. 绝对（例如 ）和相对（例如 ）时间都可接受.


 * &rarr; 
 * &rarr; 
 * &rarr; 
 * &rarr; 
 * &rarr; 
 * &rarr; 
 * &rarr; 

ISO 639-3（?）中的 允许字符串显示为指定语言.



参数指定date/time object是指本地时区还是UTC时间.

这是一个布尔参数，其值是通过转换（casting）参数值来确定的（有关如何将字符串转换为布尔值的详细信息，请参阅官方PHP文档）.

参考下面的详细示例：





如果你已经计算了Unix时间戳，你可以通过添加 符号前缀来在日期计算中使用.



可以指定完整的或部分绝对的日期；函数会使用“当前”值“填充”日期中未被指定的部分.



4位數字總是被解讀為年分，而不是小時和分鐘：



6位數字儘量被解讀為小時、分鐘、秒，不然會被解讀為錯誤（而不是年份和月份）：


 * →  輸入被視為時間而不是年+月代碼.
 * →  雖然19:60:09不是有效時間，但196009不被解讀為1960年9月.

該函數執行一定數量的日期算數：



調用的格式字符串的總長度限制為6000個字符.

时区问题

 * 1) time解析器函数有个bug（尤其是PHP DateTime），不允许传入非整数的相对时区偏移. 这个问题不适用于使用基于小时的时区，例如EDT. 例如：


 * &rarr;

但是，印度（India）是UTC +5.5个小时的时间偏移，因此使用时区不会正常地计算相对时区偏移. 因此：


 * &rarr;

要解决这个问题，可将时间简单转换为分钟或者秒，像这样：


 * &rarr;
 * &rarr;

（Tim Starling，该函数的开发者，提供了该解决方案的准确语法. ）

#timel
该函数等价于 ，其中 参数设置为 ，因此总是使用wiki的本地时间（中设置的）.

该函数的语法为：





例如，参考以下示例：





#titleparts
此函数将页面标题根据斜杠划分成多个分段，然后输出返回这些分段中的部分.



如果没有指定要返回的分段数量参数，则默认为“0”，会从要返回的第一个分段（包含）开始返回所有分段. 如果要返回的第一个分段参数没有指定或者为“0”，则默认为“1”.


 * →  See also.
 * →  See also.

两个值都接受负值. 要返回的分段数量参数的负值会从字符串的最后开始“剥离”分段. 要返回的第一个分段参数的负值解释为“从这一分段开始，从右边开始计数”：


 * →  从字符串的末尾剥离一段 参见.
 * →   从字符串的末尾剥离所有4段
 * →   从字符串的末尾剥离5段（多于已存在的）
 * →   返回最后一段. 参见.
 * →   从字符串的末尾剥离一段，然后返回第二段及以后的段
 * →   从倒数第二个元素开始复制；从字符串的末尾剥离一段

处理前，页面名称参数是HTML解码的：如果包含一些标准的HTML字符实体，将被转换为纯字符（内部使用UTF-8编码，也就是与使用解析器函数的MediaWiki源页面中的编码相同）.


 * 例如，页面名称中出现了 、 、 的地方，都会替换为.
 * 不会执行从HTML到纯文本的其他转换，因此即使HTML标签在页面标题中无效，在此初始步骤中也会保持不变.

解码后的页面名称会尽可能标准化为MediaWiki支持的标准页面名称：


 * 1) 所有下划线都自动替换为空格：
 * →  不是bah_boo，尽管原来的内容有下划线.
 * 1) 字符串最多分割25此；更多的斜杠都会忽略，第25个元素将会包含字符串的剩余内容. 字符串也限制在255个字符内，因为要被视为页面标题：
 * 如果出于某些原因确实要将此函数推到极限（尽管不太可能），可以通过嵌套函数调用来绕过只能分割25此的限制：
 * 1) 最后，第一个子字符串根据本地wiki的大小写设置进行大写（如果该子字符串也以本地命名空间名称开头，则该命名空间名称也被标准化）.
 * 1) 最后，第一个子字符串根据本地wiki的大小写设置进行大写（如果该子字符串也以本地命名空间名称开头，则该命名空间名称也被标准化）.
 * 1) 最后，第一个子字符串根据本地wiki的大小写设置进行大写（如果该子字符串也以本地命名空间名称开头，则该命名空间名称也被标准化）.

{{Warning|1= 一些字符在页面标题中是非法的，会导致#titleparts不解析字符串.


 * → {{#titleparts: {one/two} | 1 | 1 }}. 不产生预期的： {one
 * → {{#titleparts: page/123 | 1 | 2 }}. 不起作用，因为页面标题中的中括号是非法的，并且此解析器函数不处理嵌入在其输入的页面名称参数中的链接，即使使用了MediaWiki语法或任何其他HTML或MediaWiki标签.
 * → "{{#titleparts: red/#00FF00/blue| 1 | 3 }}". 不起作用，因为“#”在页面标题中是非法的.

}}

字符串函数
所有这些函数（, ,  ,  ,  ,  ）都融合在了StringFunctions扩展中，但是只有在管理员在 中启用了 的情况下才能使用.

所有这些函数都以O(n)的时间复杂度运行，使其能够抵御DoS攻击.

#len
语法为：
 * 1) len函数返回指定字符串的长度.

返回值始终是源string中的字符数量（扩展模板调用之后、转换为HTML之前的字符数量）. 如果未指定字符串，则返回值为零.

#pos
语法为：
 * 1) pos函数返回给定搜索词在字符串中的位置.

offset参数如果指定了，则会表明函数应该开始搜索的起始位置.

如果找到了搜索词，则返回的值是字符串string中的位置（从0开始数）.

如果没有找到搜索词，函数返回空字符串.

#rpos
语法为：
 * 1) rpos函数返回给定搜索词在字符串中的最后位置.

如果找到了搜索词，则返回的值是字符串string中的最后位置（从0开始数）.

如果没有找到搜索词，函数返回-1.

#sub
语法为：
 * 1) sub函数返回指定字符串中的子字符串（substring）.

start参数，如果为正（或者零），则会指定要返回的第一个字符的索引（从0开始数）.

例如： 返回.

返回.

如果start参数为负，则指定要返回从末尾开始的多少个字符.

例如： 返回.

length参数，如果存在且为正数，则会指定返回的字符串的最大长度.

例如： 返回.

如果length参数为负，则指定忽略从末尾开始的多少个字符.

例如： 返回.

如果start参数为负，则指定要返回从末尾开始的多少个字符. length参数，如果存在且为正数，则会指定返回的字符串从开始点开始的最大长度.

例如： 返回.

#count

 * 1) count函数返回指定子字符串在提供的文本中出现的次数.

#replace

 * 1) replace函数返回指定的字符串，并将所有搜索词出现的地方替换成替换词.

如果search term未指定或者为空，则搜索单个空格.

如果replacement term未指定或者为空，则所有search term都会从string中移除.

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. your_string_here ) For example, if you want to remove the word "Category:" from the string regardless of its case, you may type:
 * Case-insensitive replace :

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
The #explode function splits the given string into pieces and then returns one of the pieces. The syntax is:

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. Examples:


 * returns
 * returns
 * returns
 * returns

The return value is the position-th piece. If there are fewer pieces than the position specifies, an empty string is returned.

#urldecode
converts the escape characters from an 'URL encoded' string back to readable text. The syntax is:

Notes:
 * This function works by directly exposing PHP's urldecode function.
 * A character-code-reference can be found at www.w3schools.com.
 * The opposite,, has been integrated into MediaWiki as of version 1.18; for examples, see.
 * urldecode was merged from Stringfunctions in 2010, by commit 1b75afd18d3695bdb6ffbfccd0e4aec064785363

Limits
This module defines three global settings:


 * $wgStringFunctionsLimitSearch
 * $wgStringFunctionsLimitReplace
 * $wgStringFunctionsLimitPad

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.

替代
Parser functions can be substituted by prefixing the hash character with :


 * → the code   will be inserted in the wikitext since the page exists.

Substitution does not work within ; you can use &hellip;  for this purpose.

重定向
Especially   could be handy in  to pages including dates, but this does not work.

在表格中逸出的管道符
Parser functions will mangle syntax and pipe characters, treating all the raw pipe characters as parameter dividers. To avoid this, most wikis used a template    :! with its contents only a raw pipe character, since MW 1.24 a  replaced this kludge. This 'hides' the pipe from the MediaWiki parser, ensuring that it is not considered until after all the templates and variables on a page have been expanded. It will then be interpreted as a table row or column separator. Alternatively, raw HTML table syntax can be used, although this is less intuitive and more error-prone.

You can also escape the pipe character for display as a plain, uninterpreted character using an HTML entity:.

剥离空格
Whitespace, including newlines, tabs, and spaces, is stripped from the beginning and end of all the parameters of these parser functions. If this is not desirable, comparison of strings can be done after putting them in quotation marks.



To prevent the trimming of then and else parts, see m:Template:If. Some people achieve this by using &lt; &gt;  &lt; /nowiki &gt; instead of spaces.


 * → foofoo
 * → foofoo

However, this method can be used to render a single whitespace character only, since the parser squeezes multiple whitespace characters in a row into one.




 * || → || foofoo 
 * }

In this example, the  style is used to force the whitespace to be preserved by the browser, but even with it the spaces are not shown. This happens because the spaces are stripped by the software, before being sent to the browser.

It is possible to workaround this behavior replacing whitespaces with  (breakable space) or   (non-breakable space), since they are not modified by the software:


 * →  foofoo 
 * → foofoo

参见

 * m:幫助:計算
 * m:幫助:換行及空格
 * m:Help:Comparison between ParserFunctions syntax and TeX syntax
 * , an (incomplete) list of parser functions added by core and extensions.
 * Module:String已废弃的
 * Parser functions for Wikibase (the extensions that enables Wikidata): d:Special:MyLanguage/Wikidata:How to use data on Wikimedia projects
 * Module:String已废弃的
 * Parser functions for Wikibase (the extensions that enables Wikidata): d:Special:MyLanguage/Wikidata:How to use data on Wikimedia projects
 * Parser functions for Wikibase (the extensions that enables Wikidata): d:Special:MyLanguage/Wikidata:How to use data on Wikimedia projects