Difference between revisions of "Module:Shortcut"

From blackwiki
Jump to navigation Jump to search
blackwiki>Mr. Stradivarius
(use the number of shortcuts to generate the plural for the shortcut heading, rather than the number of list items; also, don't output the heading if we don't have any shortcuts to display)
m (26 revisions imported)
 
(17 intermediate revisions by 7 users not shown)
Line 5: Line 5:
  
 
-- Load required modules
 
-- Load required modules
 +
local checkType = require('libraryUtil').checkType
 
local yesno = require('Module:Yesno')
 
local yesno = require('Module:Yesno')
local checkType = require('libraryUtil').checkType
 
  
 
local p = {}
 
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)
 
function p._main(shortcuts, options, frame, cfg)
Line 16: 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 isCategorized = yesno(options.category) ~= false
  
 
-- Validate shortcuts
 
-- Validate shortcuts
 
for i, shortcut in ipairs(shortcuts) do
 
for i, shortcut in ipairs(shortcuts) do
 
if type(shortcut) ~= 'string' or #shortcut < 1 then
 
if type(shortcut) ~= 'string' or #shortcut < 1 then
error(string.format(
+
error(message(cfg['invalid-shortcut-error'], i), 2)
'shortcut #%d was invalid (shortcuts must be strings of ' ..
 
'at least one character in length)'
 
), 2)
 
 
end
 
end
 
end
 
end
Line 31: Line 37:
 
local listItems = {}
 
local listItems = {}
 
for i, shortcut in ipairs(shortcuts) do
 
for i, shortcut in ipairs(shortcuts) do
listItems[i] = string.format('[[%s]]', shortcut)
+
if yesno(options['target']) then
 +
listItems[i] = string.format("[[%s]]",shortcut)
 +
else
 +
listItems[i] = frame:expandTemplate{
 +
title = 'No redirect',
 +
args = {shortcut}
 +
}
 +
end
 
end
 
end
 
table.insert(listItems, options.msg)
 
table.insert(listItems, options.msg)
  
-- Exit if we have nothing to display
+
-- Return an error if we have nothing to display
 
if #listItems < 1 then
 
if #listItems < 1 then
return nil
+
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
 
end
  
 
local root = mw.html.create()
 
local root = mw.html.create()
 
+
root:wikitext(frame:extensionTag{ name = 'templatestyles', args = { src = 'Shortcut/styles.css'} })
 
-- Anchors
 
-- Anchors
 
local anchorDiv = root
 
local anchorDiv = root
 
:tag('div')
 
:tag('div')
:css('position', 'relative')
+
:addClass('module-shortcutanchordiv')
:css('top', '-3em')
 
 
for i, shortcut in ipairs(shortcuts) do
 
for i, shortcut in ipairs(shortcuts) do
 
local anchor = mw.uri.anchorEncode(shortcut)
 
local anchor = mw.uri.anchorEncode(shortcut)
 
anchorDiv:tag('span'):attr('id', anchor)
 
anchorDiv:tag('span'):attr('id', anchor)
 
end
 
end
 
root:newline() -- To match the old [[Template:Shortcut]]
 
  
 
-- Shortcut heading
 
-- Shortcut heading
Line 59: Line 74:
 
local nShortcuts = #shortcuts
 
local nShortcuts = #shortcuts
 
if nShortcuts > 0 then
 
if nShortcuts > 0 then
shortcutHeading = mw.message.newRawMessage(
+
local headingMsg = options['shortcut-heading'] or cfg['shortcut-heading']
cfg['shortcut-heading'],
+
shortcutHeading = message(headingMsg, nShortcuts)
nShortcuts
 
):plain()
 
 
shortcutHeading = frame:preprocess(shortcutHeading)
 
shortcutHeading = frame:preprocess(shortcutHeading)
shortcutHeading = shortcutHeading .. '\n'
 
 
end
 
end
 
end
 
end
Line 70: Line 82:
 
-- Shortcut box
 
-- Shortcut box
 
local shortcutList = root
 
local shortcutList = root
:tag('table')
+
:tag('div')
:addClass('shortcutbox noprint')
+
:addClass('module-shortcutboxplain plainlist noprint')
:css('float', 'right')
+
:attr('role', 'note')
:css('border', '1px solid #aaa')
+
if shortcutHeading then
:css('background', '#fff')
+
shortcutList
:css('margin', '.3em .3em .3em 1em')
+
:tag('div')
:css('padding', '3px')
+
:addClass('module-shortcutlist')
:css('text-align', 'center')
+
:wikitext(shortcutHeading)
:tag('tr')
+
end
:tag('th')
+
local list = shortcutList:tag('ul')
:addClass('plainlist')
 
:css('border', 'none')
 
:css('background', 'transparent')
 
:tag('small')
 
:wikitext(shortcutHeading)
 
:tag('ul')
 
 
for i, item in ipairs(listItems) do
 
for i, item in ipairs(listItems) do
shortcutList:tag('li'):wikitext(item)
+
list:tag('li'):wikitext(item)
end
 
 
 
-- Error category
 
if shortcuts[1] and not yesno(options.nocat) then
 
local title = mw.title.new(shortcuts[1])
 
if not title or not title.exists then
 
root:wikitext(string.format(
 
'[[%s:%s]]',
 
mw.site.namespaces[14].name,
 
cfg['first-parameter-error-category']
 
))
 
end
 
 
end
 
end
 
 
return tostring(root)
 
return tostring(root)
 
end
 
end
  
 
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 07:17, 28 September 2020

Script error: No such module "Uses TemplateStyles".

This module makes a box showing the shortcut links to a page.

Usage

From wikitext

From wikitext, this module should be called from a template, usually {{shortcut}}. Please see the template page for documentation. However, it can also be called using the syntax {{#invoke:shortcut|main|arguments}}.

From Lua

To use this module from Lua, first load it.

local mShortcut = require('Module:Shortcut')

Then you can create shortcut boxes with the following syntax:

mShortcut._main(shortcuts, options, frame, cfg)
  • shortcuts is an array of shortcut page names. (required)
  • options is a table of options. The following keys are supported:
    • msg - a message to leave after the list of shortcuts.
    • 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.

Technical details

This module has a configuration file at Module:Shortcut/config. It can be used to translate this module into different languages or to change details like category names.



-- 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
		if yesno(options['target']) then
			listItems[i] = string.format("[[%s]]",shortcut)
		else
			listItems[i] = frame:expandTemplate{
				title = 'No redirect',
				args = {shortcut}
			}
		end
	end
	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()
	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
			local headingMsg = options['shortcut-heading'] or cfg['shortcut-heading']
			shortcutHeading = message(headingMsg, 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)

	-- 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