Module:Shortcut

CaelLab-import​(留言 | 贡献)2026年11月19日 (四) 16:23的版本 (huifu bei enwiki daoru dingti de banben (shangyiban 闲敲棋子落灯花))
(差异) ←上一版本 | 最后版本 (差异) | 下一版本→ (差异)

Template:Lua sidebar 本模組可以產出一個文字方塊,顯示可連結至某個頁面的捷徑。

用法

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



-- This module implements {{shortcut}}.

-- Load required modules
local checkType = require('libraryUtil').checkType
local yesno = require('Module:Yesno')
local tools = require 'Module:TableTools'
local compressArray = tools.compressArray
	
local function noRedirect(page)
	local isRedirect = require 'Module:Redirect'.luaIsRedirect(page)
	if isRedirect then
		return require 'Module:Fullurl'._fullurl2(page, {redirect='no'}, page)
	else
		return '[[:' .. page .. ']]'
	end
end
	
local p = {}

function p._main(args, frame, type)
	args = args or {}
	frame = frame or mw.getCurrentFrame()
	local isCategorized = not yesno(args.nocat)

	-- 验证快捷方式是否有效。
	for i, shortcut in tools.sparseIpairs(args) do
		if _G.type(shortcut) ~= 'string' or #shortcut < 1 then
			error('无效的快捷方式:“' .. tostring(shortcut) .. '”,请确保该参数必须是字符串且至少一个字符', 2)
		end
	end

	local root = mw.html.create()
	root:wikitext(frame:extensionTag{ name = 'templatestyles', args = {
		src = type == 'mbox' and 'Template:Mbox/shortcut.css' or 'Shortcut/styles.css'
	} })

	-- Shortcut heading
	local shortcutHeading = '[[Help:快捷方式|快捷方式]]'
	if yesno(args.policy) then
	    shortcutHeading = '[[Help:快捷方式|方针快捷方式]]'
	end

	-- Shortcut box
	local shortcutList = root
		:tag('div')
			:addClass('module-shortcutboxplain noprint')
			:addClass(type == 'Mbox' and 'module-mboxshortcutplain' or nil)
			:attr('role', 'note')
	if args.float == 'left' then
		shortcutList:addClass('module-shortcutboxplain-left')
	end
	if shortcutHeading then
		shortcutList
			:tag('div')
				:addClass('module-shortcutlist')
				:wikitext(shortcutHeading)
	end
	local list = shortcutList:tag('ul')
	for i, shortcut in ipairs(args) do
		list:tag('li'):wikitext(noRedirect(shortcut))
	end
	return tostring(root)
end

function p.main(frame)
	local args = require('Module:Arguments').getArgs(frame)

	return p._main(tools.shallowClone(args), frame)
end

function p._ombx(args, frame, type)
	error '请直接使用_main方法而非_ombox,并将type参数设为 "mbox"'
end

-- @deprecated
function p.ombox(frame)
	local args = require('Module:Arguments').getArgs(frame)

	return p._main(tools.shallowClone(args), frame, 'mbox')
end

p.mbox = p.ombox

function p._template(args, frame, type)
	error '请直接使_main(args, frame, type)而非_template'
end

function p.template(frame)
	local args = require('Module:Arguments').getArgs(frame)

	return p._main(tools.shallowClone(args), frame, 'template')
end

function p._ombx_template(args, frame, type)
	error '请直接使用_main(args, frame, "mbox")而非_ombox_template'
end

-- @deprecated
function p.ombox_template(frame)
	local args = require('Module:Arguments').getArgs(frame)

	return p._main(args, frame, 'mbox')
end

p.mbox_template = p.ombox_template

return p