模组:Shortcut/doc

本模组可以产出一个文字方块，显示可连结至某个页面的捷径。

用法

用于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。该档案可将本模板翻译成不同的语言，或是改变分类名称的细节。