Module:Shortcut: Difference between revisions

From FAMEPedia, The free encyclopedia
h>Jonesey95
(attempt fix suggested in 2019 talk archive)
m (1 revision imported: h)
 
(One intermediate revision by one other user not shown)
Line 24: Line 24:
 
frame = frame or mw.getCurrentFrame()
 
frame = frame or mw.getCurrentFrame()
 
cfg = cfg or mw.loadData(CONFIG_MODULE)
 
cfg = cfg or mw.loadData(CONFIG_MODULE)
local templateMode = options.template and yesno(options.template)
+
local isCategorized = yesno(options.category) ~= false
local redirectMode = options.redirect and yesno(options.redirect)
 
local isCategorized = not options.category or yesno(options.category) ~= false
 
   
 
-- Validate shortcuts
 
-- Validate shortcuts
Line 39: Line 37:
 
local listItems = {}
 
local listItems = {}
 
for i, shortcut in ipairs(shortcuts) do
 
for i, shortcut in ipairs(shortcuts) do
 
listItems[i] = frame:expandTemplate{
local templatePath, prefix
 
 
title = 'No redirect',
if templateMode then
 
 
args = {shortcut}
-- Namespace detection
 
 
}
local titleObj = mw.title.new(shortcut, 10)
 
if titleObj.namespace == 10 then
 
templatePath = titleObj.fullText
 
else
 
templatePath = shortcut
 
end
 
prefix = options['pre' .. i] or options.pre or ''
 
end
 
if options.target and yesno(options.target) then
 
listItems[i] = templateMode
 
and string.format("{{%s[[%s|%s]]}}", prefix, templatePath, shortcut)
 
or string.format("[[%s]]", shortcut)
 
else
 
listItems[i] = frame:expandTemplate{
 
title = 'No redirect',
 
args = templateMode and {templatePath, shortcut} or {shortcut, shortcut}
 
}
 
if templateMode then
 
listItems[i] = string.format("{{%s%s}}", prefix, listItems[i])
 
end
 
end
 
 
end
 
end
 
table.insert(listItems, options.msg)
 
table.insert(listItems, options.msg)
   
-- Return an error if we have nothing to display
 
if #listItems < 1 then
 
local msg = cfg['no-content-error']
 
msg = string.format('<strong class="error">%s</strong>', msg)
 
if isCategorized and cfg['no-content-error-category'] then
 
msg = msg .. makeCategoryLink(cfg['no-content-error-category'])
 
end
 
return msg
 
end
 
   
 
local root = mw.html.create()
 
local root = mw.html.create()
Line 92: Line 61:
 
local nShortcuts = #shortcuts
 
local nShortcuts = #shortcuts
 
if nShortcuts > 0 then
 
if nShortcuts > 0 then
local headingMsg = options['shortcut-heading'] or
+
shortcutHeading = message(cfg['shortcut-heading'], nShortcuts)
redirectMode and cfg['redirect-heading'] or
 
cfg['shortcut-heading']
 
shortcutHeading = message(headingMsg, nShortcuts)
 
 
shortcutHeading = frame:preprocess(shortcutHeading)
 
shortcutHeading = frame:preprocess(shortcutHeading)
 
end
 
end
Line 105: Line 71:
 
:addClass('module-shortcutboxplain plainlist noprint')
 
:addClass('module-shortcutboxplain plainlist noprint')
 
:attr('role', 'note')
 
:attr('role', 'note')
if options.float and options.float:lower() == 'left' then
 
shortcutList:addClass('module-shortcutboxleft')
 
end
 
if options.clear and options.clear ~= '' then
 
shortcutList:css('clear', options.clear)
 
end
 
 
if shortcutHeading then
 
if shortcutHeading then
 
shortcutList
 
shortcutList
Line 125: Line 85:
   
 
function p.main(frame)
 
function p.main(frame)
local args = require('Module:Arguments').getArgs(frame)
+
local args = require('Module:Arguments').getArgs(frame, {
  +
wrappers = 'Template:Shortcut'
  +
})
   
 
-- Separate shortcuts from options
 
-- Separate shortcuts from options

Latest revision as of 23:43, 18 August 2021

Module documentation[create]
-- This module implements {{shortcut}}.

-- Set constants
local CONFIG_MODULE = 'Module:Shortcut/config'

-- Load required modules
local checkType = require('libraryUtil').checkType
local yesno = require('Module:Yesno')

local p = {}

local function message(msg, ...)
	return mw.message.newRawMessage(msg, ...):plain()
end

local function makeCategoryLink(cat)
	return string.format('[[%s:%s]]', mw.site.namespaces[14].name, cat)
end

function p._main(shortcuts, options, frame, cfg)
	checkType('_main', 1, shortcuts, 'table')
	checkType('_main', 2, options, 'table', true)
	options = options or {}
	frame = frame or mw.getCurrentFrame()
	cfg = cfg or mw.loadData(CONFIG_MODULE)
	local isCategorized = yesno(options.category) ~= false

	-- Validate shortcuts
	for i, shortcut in ipairs(shortcuts) do
		if type(shortcut) ~= 'string' or #shortcut < 1 then
			error(message(cfg['invalid-shortcut-error'], i), 2)
		end
	end

	-- Make the list items. These are the shortcuts plus any extra lines such
	-- as options.msg.
	local listItems = {}
	for i, shortcut in ipairs(shortcuts) do
		listItems[i] = frame:expandTemplate{
			title = 'No redirect',
			args = {shortcut}
		}
	end
	table.insert(listItems, options.msg)


	local root = mw.html.create()
	root:wikitext(frame:extensionTag{ name = 'templatestyles', args = { src = 'Shortcut/styles.css'} })
	-- Anchors
	local anchorDiv = root
		:tag('div')
			:addClass('module-shortcutanchordiv')
	for i, shortcut in ipairs(shortcuts) do
		local anchor = mw.uri.anchorEncode(shortcut)
		anchorDiv:tag('span'):attr('id', anchor)
	end

	-- Shortcut heading
	local shortcutHeading
	do
		local nShortcuts = #shortcuts
		if nShortcuts > 0 then
			shortcutHeading = message(cfg['shortcut-heading'], nShortcuts)
			shortcutHeading = frame:preprocess(shortcutHeading)
		end
	end

	-- Shortcut box
	local shortcutList = root
		:tag('div')
			:addClass('module-shortcutboxplain plainlist noprint')
			:attr('role', 'note')
	if shortcutHeading then
		shortcutList
			:tag('div')
				:addClass('module-shortcutlist')
				:wikitext(shortcutHeading)
	end
	local list = shortcutList:tag('ul')
	for i, item in ipairs(listItems) do
		list:tag('li'):wikitext(item)
	end
	return tostring(root)
end

function p.main(frame)
	local args = require('Module:Arguments').getArgs(frame, {
		wrappers = 'Template:Shortcut'
	})

	-- Separate shortcuts from options
	local shortcuts, options = {}, {}
	for k, v in pairs(args) do
		if type(k) == 'number' then
			shortcuts[k] = v
		else
			options[k] = v
		end
	end

	-- Compress the shortcut array, which may contain nils.
	local function compressArray(t)
		local nums, ret = {}, {}
		for k in pairs(t) do
			nums[#nums + 1] = k
		end
		table.sort(nums)
		for i, num in ipairs(nums) do
			ret[i] = t[num]
		end
		return ret
	end
	shortcuts = compressArray(shortcuts)

	return p._main(shortcuts, options, frame)
end

return p