模块:Tl/doc
外观
这是Module:Tl的文档页面
本模块用于模板链接:{{tl}}、模板链接:{{tlc}}、模板链接:{{tlx}}、模板链接:{{tls}}等模板。
函数说明
[编辑源代码]p._tlRaw
[编辑源代码]该函数传入两个参数:args和params。其中args是需要写入模板输出中的参数,包括模板名称、模板参数,而params是用于调整输出方式的参数。
p._tl
[编辑源代码]该函数同样也是传入两个参数:frameArgs和defaultParams,这两个都可以是框架项目(frame object)中的参数。这些参数会预先经过迭代重写处理,传入p._tlRaw中。
在特定情况下,frameArgs中的内容会转移到defaultParams的表中(实际上是迭代重写时的转移),frameArgs重写后的表不再有被转移的域。这里的“特定情况”包括:
- 键是特定的字段(详见#参数说明)。
- 值是字符串0或1。
请注意:重写时,不会对参数的值进行去除边界空白字符(mw.text.trim)处理,也不会忽略空白字符串值。解析器函数在调用时,命名参数的边界空白字符会被自动除去。
p.tl
[编辑源代码]这就是模板链接:{{#invoke:}}解析器函数需要直接调用的函数了。它会从调用此模板的页面中获得参数表(即frame:getParent().args)作为frameArgs,然后直接从调用模板链接:{{#invoke:}}时传入的参数表(frame.args)作为defaultParams,然后以此调用p._tl,这两个参数表被处理之后调用p._tlRaw。
参数说明
[编辑源代码]这些参数在传入p._tl函数时,其值为字符串1或0,因此无论是在模板链接:{{#invoke:}}中还是在调用模板时,调整输出方式的参数的值应该是0或1。而在p._tlRaw中,其值会转化为布尔值true和false。
| 参数名称 | 描述 |
|---|---|
| generateLinks | 若为true,则输出的内容中,模板名称会自动添加链接。链接不会应用于subst:等前缀。若模板名称以井号(#)开头,则一律不生成链接。
|
| isCode | 若为true,则输出的结果会加上<code>标签。 |
| isSubst | 若为true,则输出时模板名称前面自动添加“subst:”前缀。如设置了substPrefix,则substPrefix的值覆盖这一参数。 |
| substPrefix | 字符串,用于替换引用时的前缀,不含冒号。它通常是subst、safesubst或msgnw。如果设置了,则会连同冒号一起自动添加在模板名称前面(若添加了链接,则在链接至外),即使isSubst没有设置为true。 |