模組:Shortcut/doc
这是Module:Shortcut的文档页面
 | 本模块使用以下模板样式： |
| 相关链接 |
|---|
本模組可以產出一個文字方塊，顯示可連結至某個頁面的捷徑。
用法
用於Wiki標記語法
如果要從Wiki標記語法引入，本模板應當從某個模板進行呼叫，通常使用的模板為{{shortcut}}（尚未啟用，其測試版位於{{shortcut/sandbox}}）。請參考該模板的文件說明。然而，您也可以用Wiki標記語法進行呼叫：{{#invoke:shortcut|main|捷徑}}
用於Lua
如果要從Lua使用本模組，首先請讀取本模板。
local mShortcut = require('Module:Shortcut')
然後您可以依據下列語法建立捷徑方塊：
mShortcut._main(shortcuts, options, frame, cfg)
- shortcuts為捷徑頁的名稱陣列（必填）。
- options為表格偏好設定，支援下列參數：
msg- 顯示捷徑列表之後的訊息。category- if set to false (or a value regarded as false by Module:Yesno, such as "no"), categories are suppressed.
- frame a frame object. This is optional, and only intended to be used internally.
- cfg a table of config values. This is optional, and is only intended for testing.
技術細節
本模組有一份組態檔案Module:Shortcut/config。該檔案可將本模板翻譯成不同的語言，或是改變分類名稱的細節。