模块:Shortcut/doc

这是Module:Shortcut的文档页面

本模块可以产出一个文本框,显示可链接至某个页面的快捷方式。

用法

用于Wiki标记语法

如果要从Wiki标记语法引入,本模板应当从某个模板进行调用,通常使用的模板为{{shortcut}}。请参考该模板的文件说明。然而,您也可以用Wiki标记语法进行调用:{{#invoke:shortcut|main|快捷方式}}

用于Lua

如果要从Lua使用本模块,首先请读取本模板。

local mShortcut = require('Module:Shortcut')

然后您可以依据下列语法创建快捷方式方块:

mShortcut._main(shortcuts, options, frame, cfg)
  • shortcuts为快捷方式页的名称数组(必填)。
  • options为表格偏好设置,支持下列参数:
    • msg - 显示快捷方式列表之后的消息。
    • category - 如果设为no,则隐藏分类,不建议使用。(调用Module:Yesno
  • frame a frame object. This is optional, and only intended to be used internally.
  • cfg - 表格格式测试,正常情况下请不要使用,该参数应仅供测试

技术细节

本模块有一份配置文件案Module:Shortcut/config。该文件可将本模板翻译成不同的语言,或是改变分类名称的细节。