模组:Hatnote list/doc
这是Module:Hatnote list的文档页面
此模块文档被引用于约88,000个页面。 为了避免造成大规模的影响,所有对此模块文档的编辑应先于沙盒或测试样例上测试。 测试后无误的版本可以一次性地加入此模块文档中,但是修改前请务必于讨论页发起讨论。 模板引用数量会自动更新。 |
此模块使用Lua语言: |
从维基文本中的使用
编辑虽然forSee
接受一个初始的frame
参数,并且可能可以从维基文本中使用,但这个模块并不是直接设计用于维基文本的,例如:
{{hatnote|PREFIX {{#invoke:Hatnote list|forSee|{{tl|For}}|Module:For|{{tl|About}}|Module:About}} POSTFIX}}
→
从 Lua 中的使用
编辑要调用该模块,请使用
local mHatList = require('Module:Hatnote list')
或类似的方式,然后通过 mHatList
变量(或其他使用的变量)访问其方法。
andList(和列表)
编辑andList
接受一个表格形式的列表,返回一个字符串,其中列表以“和”以及适当的逗号分隔。
orList(或列表)
编辑orList
接受一个表格形式的列表,返回一个字符串,其中列表以“或”以及适当的逗号分隔。
forSee(参见)
编辑_forSee
接受三个参数:一个修剪过且去除空白的参数表,一个从哪个索引开始的“from”数字,以及一个选项表,并返回一个字符串,其中包含一系列 "For X, see [[Y]]
" 句子。链接使用 Module:Hatnote 中的方法格式化。
为方便起见,forSee
方法(去掉前面的底线)接受相同的参数,除了使用框架而不是参数表,使用 Module:Arguments 中的 getArgs()
预处理参数。