Help:解析器函数

来自滚动的天空Wiki

解析器函数(parser function)是由MediaWiki的扩展:解析器函数等扩展提供的额外功能。这些解析器函数的语法如下:

{{#函数名:参数1|参数2|参数3|…}}

大多数解析器函数调用需要加上#,以与模板嵌入等语法相区分。只有少部分不带#,如{{int:}}。所有可用的解析器函数可以在Special:版本#mw-version-parser-function-hook查看。

基础解析器函数[编辑源代码]

#expr[编辑源代码]

{{#expr:}}用来计算数学表达式并返回计算值。在Scibunto中可以通过mw.ext.ParserFunctions.expr来使用此函数。其语法为:

{{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

运算结果的精度和格式受运行wiki服务器操作系统和站点语言的数字格式影响可能存在差异。

使用布尔代数时,0表示false,其他任何非0数值(无论正负)均表示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+ }}表达式错误:缺少+的操作数。
  • {{#expr: 1 =}}表达式错误:缺少=的操作数。
  • {{#expr: 1 foo 2 }}表达式错误:无法识别的词语“foo”。

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

  • {{#expr: +1 }}1
  • {{#expr: -1 }}-1
  • {{#expr: + 1 }}1
  • {{#expr: - 1 }}-1

注意:使用魔术字输出数值时,首先要将其格式化以去除逗号,获得纯数字。例如:{{NUMBEROFEDITS}}输出24,333,而期望的输出值是24333,使用{{formatnum:{{NUMBEROFEDITS}}|R}}便可以实现。对于某些语言,格式化数字尤为重要。例如孟加拉语中,{{NUMBEROFEDITS}}的输出结果是৩০,০৬১。

  • {{#expr:{{NUMBEROFEDITS}}+100}} 表达式错误:无法识别的符号“,”。
  • {{#expr:{{formatnum:{{NUMBEROFEDITS}}|R}}+100}}24433

四舍五入[编辑源代码]

将左边的数字四舍五入为1/10的幂的倍数,指数等于右边给出的数字的截断值(truncated value)。

向上、向下取整分别使用ceilfloor

  • {{#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
    • 同理,最后一位数因后一位而加1,进而引起了前面的进位 (0.999998… → 1.00000 → 1)
  • {{#expr: 1234.5678 round -2 }}1200
    • 舍入至最近的整百数,负值在小数点左边。
  • {{#expr: 1234.5678 round 2 }}1234.57
    • 舍入至最近的整1/100数,因为正值会舍入至小数点右边。
  • {{#expr: 1234.5678 round 2.3 }}1234.57
    • 舍入指数的小数点在舍入结果中不起作用
  • {{#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)
使用ceil和floor向上或向下取整
  • {{#expr: ceil(1/3) }}1(向上取整至1)
  • {{#expr: floor(1/3) }}0(向下取整至0)
  • {{#expr: ceil(-1/3) }}-0(向上取整至0)
  • {{#expr: floor(-1/3) }}-1(向下取整至-1)
  • {{#expr: ceil 1/3 }}0.33333333333333
    • 没有取整,因为1本来就是整数,注意会被解析为(ceil 1)/3,而不是你想象中的ceil(1/3)

字符串[编辑源代码]

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

  • {{#expr: "a" = "a"}}表达式错误:无法识别的符号“"”。
  • {{#expr: a = a}}表达式错误:无法识别的词语“a”。
  • {{#ifeq: a | a | 1 | 0 }}1

#if[编辑源代码]

这个函数判断一个字符串是否为空。只包含空格的字符串被视为空字符串。其语法为:

{{#if: 测试字符串 | 非空时的值 | 空时的值 }}

这个函数首先判断测试字符串是否为空。如果测试字符串不为空,则输出非空时的值。如果测试字符串为空或只包含空白内容(空格、换行等),则输出空时的值

  • {{#if: | 是 | 否}}
  • {{#if: 字符串 | 是 | 否}}
  • {{#if:      | 是 | 否}}
  • {{#if:


    | 是 | 否}}

字符串内容会被处理为纯文本,因此不会计算数学表达式(参见#ifexpr):

  • {{ 是 | 否 |#if: 1==2}}
  • {{#if: 0 | 是 | 否 }}

最后一个参数(false)可以忽略:

  • {{#if: foo | 是 }}
  • {{#if: | 是 }}
  • {{#if: foo | | 否}}

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

你可以在#if条件句中以字符串变量代替测试字符串。在这里,你需要在变量名的后面加上|(管道符)以正确引用字符串,因此如果参数没有值,则计算结果为一个空字符串而非“{{{1}}}”。

#ifeq[编辑源代码]

这个函数判断两个字符串是否相同,並根據結果輸出兩個字符串的其中一個。如果需要更多的比較和輸出字符串,請考慮使用#switch。该函数的语法为:

{{#ifeq: 字符串1 | 字符串2 | 相同时的值 | 不相同时的值 }}

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

  • {{#ifeq: 01 | 1 | 相等 | 不相等}}相等
  • {{#ifeq: 0 | -0 | 相等 | 不相等}}相等
  • {{#ifeq: 1e3 | 1000 | 相等 | 不相等}}相等
  • {{#ifeq: {{#expr:10^3}} | 1000 | 相等 | 不相等}}相等

否则,函数会直接比较文本(区分大小写):

  • {{#ifeq: foo | bar | 相等 | 不相等}}不相等
  • {{#ifeq: foo | Foo | 相等 | 不相等}}不相等
  • {{#ifeq: "01" | "1" | 相等 | 不相等}}不相等(对比上面没有引号的例子)
  • {{#ifeq: 10^3 | 1000 | 相等 | 不相等}}不相等(对比上面带有#expr的例子,會先回傳一個有效的整數)

#iferror[编辑源代码]

这个函数接收一个输入字符串,返回两个结果中的一个。如果输入字符串包含一个由其他解析器函数(比如#expr#time#rel2abs)、模板错误(比如模板循环和模板递归)或其他解析器“软错误”生成的class="error"的HTML对象,那么视为真。

{{#iferror: 测试字符串 | 错误时的值 | 正确时的值 }}

待返回字符串参数可以省略。若省略正确时的值字符串参数,则在测试字符串不出错的情况下函数将返回测试字符串本身。若省略错误时的值字符串参数,则函数将在测试字符串本出错时返回空字符串:

  • {{#iferror: {{#expr: 1 + 2 }} | 错误 | 正确 }}正确
  • {{#iferror: {{#expr: 1 + X }} | 错误 | 正确 }}错误
  • {{#iferror: {{#expr: 1 + 2 }} | 错误 }}3
  • {{#iferror: {{#expr: 1 + X }} | 错误 }}错误
  • {{#iferror: {{#expr: 1 + 2 }} }}3
  • {{#iferror: {{#expr: 1 + X }} }}
  • {{#iferror: {{#expr: . }} | 错误 | 正确 }}正确
  • {{#iferror: <strong class="error">a</strong> | 错误 | 正确 }}错误

#ifexpr[编辑源代码]

此函数会判断数学表达式并根据其布尔值结果返回对应的字符串,语法为:

{{#ifexpr: 表达式 | true时的值 | false时的值 }}

这里表达式字符串参数将直接用作前文提到的#expr的参数,且表达式运算符是通用的,返回值也将作为布尔表达式进行处理。

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

  • {{#ifexpr: | 是|否}}

如上面所提,0将视为false,非零值将视为true,因此这个函数与下面的仅用#ifeq#expr的表述等价:

  • {{#ifeq: {{#expr: 表达式 }} | 0 | false时的值 | true时的值 }}

但下面一种情况除外:所输入的表达式为空或者是一个错误表达式(空串会返回一条错误信息,而它不等于0,所以在后者我们会得到true时的值)。

  • {{#ifexpr: = | 是 | 否 }} 表达式错误:未预料的=操作符。

相对应地:

  • {{#ifeq: {{#expr: = }} | 0 | 否 | 是 }}

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

  • {{#ifexpr: 1 > 0 | 是 }}
  • {{#ifexpr: 1 < 0 | 是 }}
  • {{#ifexpr: 0 = 0 | 是 }}
  • {{#ifexpr: 1 > 0 | | 否}}
  • {{#ifexpr: 1 < 0 | | 否}}
  • {{#ifexpr: 1 > 0 }}

支持对相等或不相等操作符的布尔运算:

  • {{#ifexpr: 0 = 0 or 1 = 0 | 是 }}
  • {{#ifexpr: 0 = 0 and 1 = 0 | | 否 }}

#ifexist[编辑源代码]

这个函数用于检测页面是否存在。其语法如下:

{{#ifexist: 页面标题 | 存在时的值 | 不存在时的值 }}

只要页面存在就会判定为true,即便那个页面看上去是空白的(比如像是分类链接或者是魔术字解释页之类的却不包含任何可视内容的页面),或者是重定向页,或者它就是空白页。当且仅当页面是红链时判定为false,包括那些曾经存在却被删除的页面。

  • {{#ifexist: Help:解析器函数 | 存在 | 不存在 }}存在
  • {{#ifexist: XXHelp:解析器函数XX | 存在 | 不存在}}不存在

对于系统消息,该系统消息在本地被自定义时返回true,对特殊页面的判定则取决于本地软件自身。

  • {{#ifexist: Special:监视列表 | 存在 | 不存在 }}存在
  • {{#ifexist: Special:用户查核 | 存在 | 不存在 }}存在 (因为Checkuser扩展已经安装于此wiki)
  • {{#ifexist: MediaWiki:Copyright | 存在 | 不存在 }}不存在 (因为MediaWiki:Copyright未自定义)

如果一个页面使用了#ifexist:来检查目标页面,则这个检查页面将出现在被检查页面的Special:链入页面里。所以如果本页面(Help:解析器函数)使用了代码 {{#ifexist:Foo}},那么Special:链入页面/Foo将列出Help:解析器函数。

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

  • {{#ifexist: File:Example.png | 存在 | 不存在 }}不存在
  • {{#ifexist: Image:Example.png | 存在 | 不存在 }}不存在
  • {{#ifexist: Media:Example.png | 存在 | 不存在 }}不存在

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

#ifexist:不会对跨wiki链接起作用。

ifexist限制[编辑源代码]

#ifexist:被视为“高开销(expensive)解析器函数”,每个页面调用这类函数的次数(包括包含于嵌入式模板的函数)存在一个限制,当达到该限制时,更多的#ifexist:函数,无论其目标页面是否存在,只会自动返回错误值false,且该页面会被分类到Category:有过多高开销解析器函数调用的页面中。

一些情况下,在css中使用选择器a.new(以选出链接到不存在的页面的链接)或者是a:not(.new)(以选出已存在页面的链接),是可以达到模仿ifexist的效果的。

ifexisit和需要的页面[编辑源代码]

一个不存在的页面被#ifexist检测后会被计数在待创建页面中。

#rel2abs[编辑源代码]

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

{{#rel2abs: 路径 }}
{{#rel2abs: 路径 | 基础路径 }}

在输入项path中,可以使用以下类型的句法:

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

基础路径没有指定,将默认的填入函数所在页面的绝对路径:

{{#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

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

{{#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 }}错误:无效路径深度:“Help:Foo/bar/baz/../../../../quok”(尝试访问根节点以上节点)

#switch[编辑源代码]

该函数将一个被测试的字符串同多个可能的匹配值做比较,如果找到匹配,返回对应的结果。其语法为:

{{#switch: 测试字符串
| 匹配1 = 结果1
| 匹配2 = 结果2
| 匹配3 = 结果3
| …
| 默认结果
}}

例如:

  • {{#switch: 天空 | 天空 = Sky | 山丘 = Massif | Other }} Sky
  • {{#switch: 山丘 | 天空 = Sky | 山丘 = Massif | Other }} Massif
  • {{#switch: 火山 | 天空 = Sky | 山丘 = Massif | Other }} Other

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

默认值[编辑源代码]

如果测试字符串不能与任何匹配字符串相等,则返回默认结果

  • {{#switch: 测试 | 天空 = Sky | 山丘 = Massif | 默认值 }} 默认值

在这种语法中,默认返回值必须是函数的最后一个参数,而且不能包含等号。否则,就会解析为对匹配值的比较,找不到对应的匹配值时不显示文本,这是因为默认值没有定义(是空的)。如果有对应的匹配值,则返回对应的结果。

你也可以将匹配字符串设为#default从而清楚地声明默认值。

{{#switch: 测试字符串
| 匹配1 = 结果1
| 匹配2 = 结果2
| 匹配3 = 结果3
| …
| #default = 默认结果
}}

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

  • {{#switch: 火山 | 天空 = Sky | #default = Other | 山丘 = Massif }} Other

如果默认结果参数被省略,且没有找到相等的匹配值,则不返回结果:

  • {{#switch: 火山 | 天空 = Sky | 山丘 = Massif }}

分组结果[编辑源代码]

该函数允许多个匹配字符串返回相同的结果字符串,从而减少重复。

{{#switch: 测试字符串
| 匹配1 = 结果1
| 匹配2 | 匹配3 | 匹配4 = 结果234
| 匹配5 | 匹配6 = 结果56
| …
| #default = 默认结果
}}

在本例中,第二、三、四个分支都会返回结果234,第5和第6个分支都会返回结果56。上述案例中,最后一个参数中的“#default = ”可以省略。例如:

  • {{#switch: 山丘 | 山丘 | 火山 | 森林 | 沙漠 = 滚动的天空 | 钢琴 | 地球 = 跳舞的线 | 其他 }}滚动的天空
  • {{#switch: 森林 | 山丘 | 火山 | 森林 | 沙漠 = 滚动的天空 | 钢琴 | 地球 = 跳舞的线 | 其他 }}滚动的天空
  • {{#switch: 钢琴 | 山丘 | 火山 | 森林 | 沙漠 = 滚动的天空 | 钢琴 | 地球 = 跳舞的线 | 其他 }}跳舞的线
  • {{#switch: 和平 | 山丘 | 火山 | 森林 | 沙漠 = 滚动的天空 | 钢琴 | 地球 = 跳舞的线 | 其他 }}其他

带有参数使用[编辑源代码]

该函数允许将参数用作测试字符串。在本例中,不必将管道符放在参数名称后面,因为你不太可能需要选择字符串“{{{参数名称}}}”作为测试。

{{#switch: {{{1}}} | foo = Foo | baz = Baz | Bar }}

上面的例子中,如果{{{1}}}等于foo,函数返回Foo。如果等于baz,函数返回Baz。如果参数是空的或者不存在,函数返回Bar

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

{{#switch: {{{1}}} | foo | zoo | roo = Foo | baz = Baz | Bar }}

如果{{{1}}}等于foozooroo,函数返回Foo。如果等于baz,函数返回Baz。如果参数是空的或者不存在,函数返回Bar

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

{{#switch: {{{1}}} | foo = Foo | bar = Bar }}

在本例中,如果{{{1}}}存在且等于foobar,则分别返回FooBar,否则不返回任何内容。

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

{{#switch: {{{1}}} | foo | zoo | roo = Foo | baz = Baz | }}

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

(若{{{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: 1 | 1 = one | 2 = two | three}}one
  • {{#switch: a | a = A | b = B | C}}A
  • {{#switch: A | a = A | b = B | C}}C

匹配字符串可以是空的:

  • {{#switch: | = Empty | 山丘 = Masisf | Other }}Empty

只要找到一个匹配,后面的匹配都会忽略:

  • {{#switch: 天空 | 山丘 = Massif | 天空 = Sky | 天空 = Heaven | }}Sky

原始等号[编辑源代码]

匹配字符串不能包含原始等号。如果需要在比较串中加入等号,可以用HTML标识码&#61;来代替。

例如:

您输入的 您输出的
{{#switch: 1=2
 | 1=2 = raw
 | 1<nowiki>=</nowiki>2 = nowiki
 | 1{{=}}2 = template
 | default
}}
template
{{#switch: 1=2
 | 1&#61;2 = html
 | default
}}
html

替换#ifeq[编辑源代码]

#switch可以用于减少扩展深度。

例如:

  • {{#switch:{{{1}}} |条件1=分支1 |条件2=分支2 |条件3=分支3 |分支4}}

等效于

  • {{#ifeq:{{{1}}}|条件1 |分支1 |{{#ifeq:{{{1}}}|条件2 |分支2 |{{#ifeq:{{{1}}}|条件3 |分支3 |分支4}}}}}}

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

{{#ifeq:{{{1}}}|条件1
  |<!--then-->分支1
  |<!--else-->{{#ifeq:{{{1}}}|条件2
                |<!--then-->分支2
                |<!--else-->{{#ifeq:{{{1}}}|条件3
                              |<!--then-->分支3
                              |<!--else-->分支4}}}}}}

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

{{#ifeq:{{{1}}}|条件1
 |<!--then-->分支1t{{
  #ifeq:{{{1}}}|条件2
   |<!--then-->分支1t2t{{#ifeq:{{{1}}}|条件4|<!--then-->分支1t2t4t|<!--else-->分支1t2t4e}}
   |<!--else-->分支1t2e{{#ifeq:{{{1}}}|条件5|<!--then-->分支1t2e5t|<!--else-->分支1t2e5e}}
  }}
 |<!--else-->分支1e{{#ifeq:{{{1}}}|条件3
   |<!--then-->分支1e3t{{#ifeq:{{{1}}}|条件6|分支1e3t6t|分支1e3t6e}}
   |<!--else-->分支1e3e{{
    #ifeq:{{{1}}}|条件7
     |分支1e3e7t
     |分支1e3e7t
    }}
  }}
}}

#time[编辑源代码]

该解析器函数接收一个(公历的)日期或者时间,并根据给定的语法将其格式化。可以指定日期/时间对象,默认则为当前值——也就是说,页面最后被渲染为HTML时的时间。

{{#time: 格式字符串 }}
{{#time: 格式字符串 | 日期/时间对象 }}
{{#time: 格式字符串 | 日期/时间对象 | 语言代码 }}
{{#time: 格式字符串 | 日期/时间对象 | 语言代码 | 是否本地 }}

格式字符串[编辑源代码]

任何不被识别的格式化字符都不会被修改,这同样适用于空白字符(系统不使用空白字符来解释代码)。格式化字符串内有两种方法来转义字符:

  1. 反斜杠后跟随一个格式化字符串会被解释为单个原始的字符
  2. 用英文双引号括起来的字符视为原始字符,引号将被移除。

此外,xx会被解释为单个原始的x。

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

不幸的是,目前,ASCII单引号仍未被视为当前已经受支持的ASCII双引号和反斜杠的简单替代方法。因此,您仍然无法在不使用反斜杠转义的情况下嵌入任何文字双引号(或者也可以使用其他弯引号、角形引号或方引号)。

日期/时间对象[编辑源代码]

日期/时间对象可以是任何PHPstrtotime()函数接受的格式。绝对(如20 December 2000)、相对(如+20 hours)和混合时间(如30 July +1 year)格式均是可以的。

  • {{#time: r|now}}Wed, 01 Feb 2023 15:40:09 +0000
  • {{#time: r|+2 hours}}Wed, 01 Feb 2023 17:40:09 +0000
  • {{#time: r|now + 2 hours}}Wed, 01 Feb 2023 17:40:09 +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}}错误:无效时间。

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

本地时区[编辑源代码]

是否本地参数指定日期/时间对象是指本地时区还是UTC时间。

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

参考下面的详细示例:

  • {{#time: Y F d H:i:s|now|it|0}}2023 febbraio 01 15:40:09
  • {{#time: Y F d H:i:s|now|it|1}}2023 febbraio 01 23:40:09
  • {{#time: Y F d H:i:s|+2 hours||0}}2023 2月 01 17:40:09
  • {{#time: Y F d H:i:s|+2 hours||1}}2023 2月 02 01:40:09
  • {{#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-16T23:05:43+08:00

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

  • {{#time: U | now }}1675266009
  • {{#time: r | @1675266009 }}Wed, 01 Feb 2023 15:40:09 +0000

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

  • {{#time: Y | January 1 }}2023

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

  • {{#time: Y m d H:i:s | 1959 }}1959 02 01 00:00:00

6位數字儘量被解讀為小時、分鐘、秒,不然會被解讀為錯誤(而不是年份和月份):

  • {{#time: Y m d H:i:s | 195909 }}2023 02 01 19:59:09 輸入被視為時間而不是年+月代碼。
  • {{#time: Y m d H:i:s | 196009 }}错误:无效时间。 雖然19:60:09不是有效時間,但196009不被解讀為1960年9月。

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

  • {{#time: d F Y | January 0 2008 }}31 12月 2007
  • {{#time: d F | January 32 }}错误:无效时间。
  • {{#time: d F | February 29 2008 }}29 2月
  • {{#time: d F | February 29 2007 }}01 3月
  • {{#time:Y-F|now -1 months}}2023-1月

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

非整数时区[编辑源代码]

#time解析器函数有个bug(尤其是PHP DateTime),不允许传入非整数的相对时区偏移。这个问题不适用于使用基于小时的时区,例如EDT。例如:

  • {{#time:g:i A | -4 hours }} → 11:40 AM

但是,印度(India)是UTC +5.5个小时的时间偏移,因此使用时区不会正常地计算相对时区偏移。因此:

  • {{#time:g:i A | +5.5 hours }} → 3:40 PM

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

  • {{#time:g:i A | +330 minutes }} → 9:10 PM
  • {{#time:g:i A | +19800 seconds }} → 9:10 PM

#timel[编辑源代码]

该函数等价于{{#time: ... }},其中是否本地参数设置为true,因此总是使用wiki的本地时间。

该函数的语法为:

  • {{#timel: 格式字符串 }}
  • {{#timel: 格式字符串 | 日期/时间对象 }}
  • {{#timel: 格式字符串 | 日期/时间对象 | 语言代码 }}

例如,参考以下示例:

  • {{#time:c|now|it}}2023-02-01T15:40:09+00:00
  • {{#time:c|now|it|0}}2023-02-01T15:40:09+00:00
  • {{#time:c|now|it|1}}2023-02-01T23:40:09+08:00
  • {{#timel:c|now|it}}2023-02-01T23:40:09+08:00

#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 参见{{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 从字符串的末尾剥离一段,然后返回第二段及以后的段
  • {{#titleparts: Talk:Foo/bar/baz/quok | -1 | -2 }} baz 从倒数第二个元素开始复制;从字符串的末尾剥离一段

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

例如,页面名称中出现了&quot;&#34;&#x22;的地方,都会替换为"。不会执行从HTML到纯文本的其他转换,因此即使HTML标签在页面标题中无效,在此初始步骤中也会保持不变。

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

  1. 所有下划线都自动替换为空格:
    {{#titleparts: Talk:Foo/bah_boo|1|2}}bah boo 不是bah_boo,尽管原来的内容有下划线。
  2. 字符串最多分割25次;更多的斜杠都会忽略,第25个元素将会包含字符串的剩余内容。 字符串也限制在255个字符内,因为要被视为页面标题:
    {{#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
    如果出于某些原因确实要将此函数推到极限(尽管不太可能),可以通过嵌套函数调用来绕过只能分割25此的限制:
    {{#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
  3. 最后,第一个子字符串根据本地wiki的大小写设置进行大写(如果该子字符串也以本地命名空间名称开头,则该命名空间名称也被标准化)。
    {{#titleparts: talk:a/b/c }}Talk:A/b/c

字符串函数[编辑源代码]

字符串函数只有当管理员在LocalSettings.php中启用了$wgPFEnableStringFunctions = true;的时才能使用。所有这些函数都以O(n)的时间复杂度运行,使其能够抵御DoS攻击。

#len[编辑源代码]

返回指定字符串的长度。语法为:

{{#len:字符串}}

返回值始终是源字符串中的字符数量(扩展模板调用之后、转换为HTML之前的字符数量)。如果未指定字符串,则返回值为零。例如:

  • {{#len:滚动的天空}}5
  • {{#len:Rolling Sky}}11
  • {{#len:<span style="color:green">滚动的天空</span>}}38
  • {{#len:{{FULLPAGENAME}}}}10

#pos[编辑源代码]

返回给定的搜索词在字符串中的位置。语法为:

{{#pos:字符串|搜索词|偏移}}

例如:

  • {{#pos:滚动的天空|动}}1
  • {{#pos:滚动的天空|空}}4

如果指定了偏移参数,则表明函数应该开始搜索的起始位置:

  • {{#pos:滚动的天空和跳舞的线|的}}2
  • {{#pos:滚动的天空和跳舞的线|的|4}}8

如果找到了搜索词,则返回的值是字符串字符串中的位置(从0开始数):

  • {{#pos:滚动的天空|滚动}}0

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

  • {{#pos:滚动的天空|线}}

#rpos[编辑源代码]

返回给定搜索词在字符串中的最后位置。语法为:

{{#rpos:字符串|搜索词}}

如果找到了搜索词,则返回的值是字符串字符串中的最后位置(从0开始数):

  • {{#rpos:滚动的天空|天}}3

如果没有找到搜索词,函数返回-1。

  • {{#rpos:滚动的天空|线}}-1

#sub[编辑源代码]

返回指定字符串中的子字符串(substring)。语法为:

{{#sub:字符串|开始|长度}}

开始参数,如果为正(或者零),则会指定要返回的第一个字符的索引(从0开始数)。

例如:

  • {{#sub:予独爱莲之出淤泥而不染|7}}返回泥而不染
  • {{#sub:予独爱莲之出淤泥而不染|5|3}}返回出淤泥

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

  • {{#sub:予独爱莲之出淤泥而不染|-4}}返回泥而不染

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

  • {{#sub:予独爱莲之出淤泥而不染|4|3}}返回之出淤

如果长度参数为负,则指定忽略从末尾开始的多少个字符。

  • {{#sub:予独爱莲之出淤泥而不染|3|-3}}返回莲之出淤泥

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

  • {{#sub:予独爱莲之出淤泥而不染|-5|2}}返回淤泥

#count[编辑源代码]

返回指定子字符串在提供的文本中出现的次数。语法为:

{{#count:字符串|子字符串}}

例如:

  • {{#count:道可道,非常道。名可名,非常名。|道}}3
  • {{#count:道可道,非常道。名可名,非常名。|可}}2
  • {{#count:道可道,非常道。名可名,非常名。|也}}0

#replace[编辑源代码]

返回指定的字符串,并将所有搜索词出现的地方替换成替换词。语法为:

{{#replace:字符串|搜索词|替换词}}

例如:

  • {{#replace:滚动的天空|天空|地板}}滚动的地板
  • {{#replace:滚动的天空|球|线}}滚动的天空

如果搜索词未指定或者为空,则搜索单个空格。

  • {{#replace:Suzhou Xinqu Railway Station||-}}Suzhou-Xinqu-Railway-Station

如果替换词未指定或者为空,则所有搜索词都会从字符串中移除。

  • {{#replace:Suzhou-Xinqu-Railway-Station|-}}SuzhouXinquRailwayStation
  • {{#replace:Suzhou-Xinqu-Railway-Station|-|}}SuzhouXinquRailwayStation

#explode[编辑源代码]

将指定的字符串分成多个片段,返回其中一段。语法为:

{{#explode:字符串|分隔符|位置|限制}}

分隔符参数指定一个用来将字符串划分成段的字符串。这个分隔符字符串不是任何片段的一部分,如果有两个分隔符彼此相邻,会在二者之间创建一个空片段。如果该参数未指定,则使用单个空格。

限制参数允许你限制返回的部分的数量,所有剩余文本都包含在最终部分中。

位置参数指定了返回哪一个片段。片段是从0开始数的。如果参数未指定,则使用第一个片段(数字0的片段)。如果位置使用负值,则片段会从最后开始数。这种情况下,第-1个片段表示最后一段。例如:

  • {{#explode:And if you tolerate this| |2}} you
  • {{#explode:字符串/函数/代码|/|-1}} 代码
  • {{#explode:使用%百分号%来%划分|%|2}}
  • {{#explode:And if you tolerate this thing| |2|3}}返回 you tolerate this thing

返回的值是第位置个片段。如果片段数量少于位置指定的值,则返回空字符串:

  • {{#explode:使用%百分号%来%划分|%|2017}}

#urldecode[编辑源代码]

将URL编码的转义字符转换回原来的可读字符。语法为:

{{#urlencode:}}

注意:

  • 该函数是通过直接暴露PHP的urldecode()函数来运作的。
  • 字符代码参考可参见www.w3schools.com
  • 与此相反的urlencode,已经融合在了MediaWiki的1.18版本中,具体示例可参见Help:魔术字

一般帮助[编辑源代码]

替换引用[编辑源代码]

在开花括号后添加subst:可以将字符串函数替换引用

{{subst:#ifexist: Help:解析器函数 | [[Help:解析器函数]] | Help:解析器函数 }} → 将在文本中插入代码[[Help:解析器函数]],因为Help:解析器函数存在。

<ref>...</ref>内的替换引用不起作用,如要使用,可以使用{{#tag:ref|...}}

重定向[编辑源代码]

特别地,{{#time:…|now-…}}可以方便地重定向到包含日期的页面,但这不起作用。

在表格中转义管道符[编辑源代码]

解析器函数会破坏表格语法和管道字符(|),将所有的原始管道字符视为参数分隔符。

为了避免这种情况,MediaWiki有{{!}}魔术字以将其取代。这会从MediaWiki解析器中“隐藏”管道符号,确保在展开页面上的所有模板和变量之前不考虑它。然后将被解释为表格的行、列分隔符(||||-)或内部链接([[目标页面|显示文字]])的分隔符。用这种方法会产生大量{{!}}。你也可以使用原始的HTML表格语法,尽管这并不直观而且容易出错。你也可以使用{{Table}},但建议最好还是不要在模板参数中添加表格。

对于需要显示的管道字符,可以使用HTML实体进行转义,显示为纯粹的、未被解释的字符:&#124;

除去空白字符[编辑源代码]

空白字符(whitespace),包括换行符、制表符和空格,在这些解析器函数的所有参数的开头和结尾处,都会被除去。如果不希望这样,可以将字符串放在引号中后进行比较。

  • {{#ifeq: 球           |           球 | 相等 | 不相等 }}相等
  • {{#ifeq: "球          " | "          球" | 相等 | 不相等 }}不相等

一些人为达到目的,会使用<nowiki>...</nowiki>而非空格。

  • 滚动{{#if:|| 的 }}天空滚动的天空
  • 滚动{{#if:||<nowiki /><nowiki />}}天空滚动 的 天空

然而,这种方法只能用于渲染单个空白字符,因为解析器函数会将一行中的多个空白字符挤压成一个。

  • <span style="white-space: pre-wrap;">滚动{{#if:||<nowiki/><nowiki/>}}天空</span>滚动 的 天空

在本例中,white-space: pre-wrap样式用来强制浏览器保留空白字符,但即使使用它,也不会显示空格,这是因为这些空格在发送到浏览器之前,就已经被软件除去了。

要解决此问题,可以将空白字符替换为&#32;可折行空格)或者&nbsp;不可折行空格),因为这些字符不会被软件修改:

  • <span style="white-space: pre-wrap;">滚动{{#if:||&#32;&#32;&#32;&#32;&#32;&#32;}}天空</span>滚动 的 天空
  • 滚动{{#if:||&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}}天空滚动   的   天空

注意并非所有参数都是以相同方式运作的,在解析器函数中,开头和结尾处的空白字符总是会被除去。在Help:模板中,只有命名参数中的开头和结尾空白字符会被除去,对于匿名参数的不会。

  • {{tlx|test|content=跳舞的线 }}{{test|content=跳舞的线}}
  • {{tlx|1= 跳舞的线 }}{{跳舞的线}}
  • {{tlx| 跳舞的线 }}{{ 跳舞的线 }}