Nonbinary Wiki

Module:Shortcut: Difference between revisions

Module Discussion

Module:Shortcut (edit)

Revision as of 07:30, 15 December 2014

922 bytes removed ,  9 years ago
rewrite this without so many dependencies and with it hopefully easier to read
(use redirect=no)
(rewrite this without so many dependencies and with it hopefully easier to read)
Line 1: Line 1:
-- This module implements {{shortcut}}.
-- This module implements {{shortcut}}.


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


--------------------------------------------------------------------------------
-- Load required modules
-- Configuration
local checkType = require('libraryUtil').checkType
--------------------------------------------------------------------------------
 
-- Name for the error category produced if the first shortcut is not an existing
-- page on the wiki.
cfg.errorCategory = 'Wikipedia shortcut box first parameter needs fixing'
 
-- The header text for the list of shortcuts.
-- cfg.shortcutHeaderSingular will be displayed if there is one shortcut, and
-- cfg.shortcutHeaderPlural will be displayed if there are multiple shortcuts.
cfg.shortcutHeaderSingular = '[[Wikipedia:Shortcut|Shortcut]]:'
cfg.shortcutHeaderPlural = '[[Wikipedia:Shortcut|Shortcuts]]:'
 
--------------------------------------------------------------------------------
-- Load external modules and define often-used functions
--------------------------------------------------------------------------------
 
-- Load external modules
local mArguments = require('Module:Arguments')
local mTableTools = require('Module:TableTools')
local mList = require('Module:List')
 
-- Define often-used functions
local anchorEncode = mw.uri.anchorEncode
local format = string.format
local fullUrl = mw.uri.fullUrl
 
--------------------------------------------------------------------------------
-- Main functions
--------------------------------------------------------------------------------


local p = {}
local p = {}


function p.main(frame)
function p._main(shortcuts, options, frame, cfg)
local args = mArguments.getArgs(frame)
checkType('_main', 1, shortcuts, 'table')
return p._main(args)
checkType('_main', 2, options, 'table', true)
end
options = options or {}
frame = frame or mw.getCurrentFrame()
cfg = cfg or mw.loadData(CONFIG_MODULE)
local nShortcuts = #shortcuts


function p._main(args)
-- Validate shortcuts
local shortcuts = p.getShortcuts(args)
local nShortcuts = #shortcuts
if nShortcuts < 1 then
if nShortcuts < 1 then
-- Don't output anything if {{shortcut}} was called with no arguments.
return nil
return ''
else
for i, shortcut in ipairs(shortcuts) do
if type(shortcut) ~= 'string' or #shortcut < 1 then
error(string.format(
'shortcut #%d was invalid (shortcuts must be strings of ' ..
'least one character in length)'
), 2)
end
end
end
end
local anchors = p.makeAnchorList(shortcuts)
local shortcutList = p.makeShortcutList(shortcuts)
local errorCategories = p.getErrorCategories(shortcuts)
return p.export(anchors, nShortcuts, shortcutList, errorCategories)
end


function p.getShortcuts(args)
local root = mw.html.create()
local shortcuts = mTableTools.compressSparseArray(args)
return shortcuts
end


function p.makeAnchorList(shortcuts)
-- Anchors
local makeAnchor = p.makeAnchor
local anchorDiv = root
local anchors = {}
:tag('div')
:css('position', 'relative')
:css('top', '-3em')
for i, shortcut in ipairs(shortcuts) do
for i, shortcut in ipairs(shortcuts) do
anchors[#anchors + 1] = makeAnchor(shortcut)
local anchor = mw.uri.anchorEncode(shortcut)
anchorDiv:tag('span'):attr('id', anchor)
end
end
return table.concat(anchors)
end


function p.makeAnchor(s)
root:newline() -- To match the old [[Template:Shortcut]]
s = anchorEncode(s)
 
local anchor = format('<span id="%s"></span>', s)
-- Shortcut heading
return anchor
local shortcutHeading = mw.message.newRawMessage(
end
cfg['shortcut-heading'],
nShortcuts
):plain()
shortcutHeading = frame:preprocess(shortcutHeading)


function p.makeShortcutList(shortcuts)
-- Shortcut box
local makeShortcutLink = p.makeShortcutLink
local shortcutList = root
local listArgs = {}
:tag('table')
:addClass('shortcutbox noprint')
:css('float', 'right')
:css('border', '1px solid #aaa')
:css('background', '#fff')
:css('margin', '.3em .3em .3em 1em')
:css('padding', '3px')
:css('text-align', 'center')
:tag('tr')
:tag('th')
:addClass('plainlist')
:css('border', 'none')
:css('background', 'transparent')
:tag('small')
:wikitext(shortcutHeading)
:newline()
:tag('ul')
for i, shortcut in ipairs(shortcuts) do
for i, shortcut in ipairs(shortcuts) do
local link = makeShortcutLink(shortcut)
local url = mw.uri.fullUrl(shortcut, {redirect = 'no'})
listArgs[#listArgs + 1] = link
url = tostring(url)
local link = string.format('[%s %s]', url, shortcut)
shortcutList:tag('li'):wikitext(link)
end
end
listArgs.class = 'plainlinks'
if options.msg then
return mList.makeList('bulleted', listArgs)
shortcutList:tag('li'):wikitext(options.msg)
end
 
-- Error category
do
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)
end
end


function p.makeShortcutLink(s)
function p.main(frame)
local uriObj = fullUrl(s, {redirect = 'no'})
local args = require('Module:Arguments').getArgs(frame, {
local url = tostring(uriObj)
wrappers = 'Template:Shortcut'
return format('[%s %s]', url, s)
})
end
 
-- 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


function p.getErrorCategories(shortcuts)
-- Compress the shortcut array, which may contain nils.
local shortcut1 = shortcuts[1]
local function compressArray(t)
local title = mw.title.new(shortcut1)
local nums, ret = {}, {}
if not title or not title.exists then
for k in pairs(t) do
local categoryNsName = mw.site.namespaces[14].name
nums[#nums + 1] = k
return format('[[%s:%s]]', categoryNsName, cfg.errorCategory)
end
else
table.sort(nums)
return nil
for i, num in ipairs(nums) do
ret[i] = t[num]
end
return ret
end
end
end
shortcuts = compressArray(shortcuts)


function p.export(anchors, nShortcuts, shortcutList, errorCategories)
return p._main(shortcuts, options, frame)
local root = mw.html.create('')
root
:tag('div')
:css{position = 'relative', top = '-3em'}
:wikitext(anchors)
root
:tag('table')
:addClass('shortcutbox noprint')
:css{
float = 'right',
border = '1px solid #aaa',
background = '#fff',
margin = '.3em .3em .3em 1em',
padding = '3px',
['text-align'] = 'center'
}
:tag('tr')
:tag('th')
:addClass('plainlist')
:css{border = 'none', background = 'transparent'}
:tag('small')
:wikitext(
nShortcuts <= 1
and cfg.shortcutHeaderSingular
or cfg.shortcutHeaderPlural
)
:newline()
:wikitext(shortcutList)
root:wikitext(errorCategories)
return tostring(root)
end
end


return p
return p
Retrieved from "https://nonbinary.wiki/wiki/Special:MobileDiff/30883"