模組: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。該檔案可將本模板翻譯成不同的語言,或是改變分類名稱的細節。