Module:Shortcut: Difference between revisions

1,230 bytes added ,  4 years ago
m
29 revisions imported from wikipedia:Module:Shortcut: see Topic:Vtixlm0q28eo6jtf
(calculate the number of list items based on a table of list items, rather than doing it ad hoc from the shortcuts plus whatever else we want to add)
m (29 revisions imported from wikipedia:Module:Shortcut: see Topic:Vtixlm0q28eo6jtf)
 
(22 intermediate revisions by 9 users not shown)
Line 6: Line 6:
-- Load required modules
-- Load required modules
local checkType = require('libraryUtil').checkType
local checkType = require('libraryUtil').checkType
local yesno = require('Module:Yesno')


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 15: 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 redirectMode = options.redirect and yesno(options.redirect)
local isCategorized = not options.category or 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 30: Line 39:
local listItems = {}
local listItems = {}
for i, shortcut in ipairs(shortcuts) do
for i, shortcut in ipairs(shortcuts) do
listItems[i] = string.format('[[%s]]', shortcut)
local templatePath, prefix
if templateMode then
-- 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("&#123;&#123;%s[[%s|%s]]&#125;&#125;", 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("&#123;&#123;%s%s&#125;&#125;", prefix, listItems[i])
end
end
end
end
table.insert(listItems, options.msg)
table.insert(listItems, options.msg)
local nListItems = #listItems


-- Exit if we have nothing to display
-- Return an error if we have nothing to display
if nListItems < 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
local shortcutHeading = mw.message.newRawMessage(
local shortcutHeading
cfg['shortcut-heading'],
do
nListItems
local nShortcuts = #shortcuts
):plain()
if nShortcuts > 0 then
shortcutHeading = frame:preprocess(shortcutHeading)
local headingMsg = options['shortcut-heading'] or
redirectMode and cfg['redirect-heading'] or
cfg['shortcut-heading']
shortcutHeading = message(headingMsg, nShortcuts)
shortcutHeading = frame:preprocess(shortcutHeading)
end
end


-- 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 options.float and options.float:lower() == 'left' then
:css('background', '#fff')
shortcutList:addClass('module-shortcutboxleft')
:css('margin', '.3em .3em .3em 1em')
end
:css('padding', '3px')
if options.clear and options.clear ~= '' then
:css('text-align', 'center')
shortcutList:css('clear', options.clear)
:tag('tr')
end
:tag('th')
if shortcutHeading then
:addClass('plainlist')
shortcutList
:css('border', 'none')
:tag('div')
:css('background', 'transparent')
:addClass('module-shortcutlist')
:tag('small')
:wikitext(shortcutHeading)
:wikitext(shortcutHeading)
end
:newline()
local list = shortcutList:tag('ul')
: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
end
-- Error category
if shortcuts[1] 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
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