Module:Shortcut: Difference between revisions

From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search

Module:Shortcut (view source)

Revision as of 18:11, January 24, 2022

563 bytes added ,  2 years ago
m
9 revisions imported: Originally imported from Wikipedia.
(create replacement for Template:Shortcut)
 
m (9 revisions imported: Originally imported from Wikipedia.)
 
(28 intermediate revisions by 9 users not shown)
Line 1:
-- This module implements {{shortcut}}.
 
-- Set constants
local cfg = {}
local CONFIG_MODULE = 'Module:Shortcut/config'
 
-- Load required modules
--------------------------------------------------------------------------------
local checkType = require('libraryUtil').checkType
-- Configuration
local yesno = require('Module:Yesno')
--------------------------------------------------------------------------------
 
-- 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
 
--------------------------------------------------------------------------------
-- Main functions
--------------------------------------------------------------------------------
 
local p = {}
 
local function p.mainmessage(framemsg, ...)
return mw.message.newRawMessage(msg, ...):plain()
local args = mArguments.getArgs(frame)
return p._main(args)
end
 
local function p._mainmakeCategoryLink(argscat)
return string.format('[[%s:%s]]', mw.site.namespaces[14].name, cat)
local shortcuts = p.getShortcuts(args)
local nShortcuts = #shortcuts
if nShortcuts < 1 then
-- Don't output anything if {{shortcut}} was called with no arguments.
return ''
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_main(argsshortcuts, options, frame, cfg)
checkType('_main', 1, shortcuts, 'table')
local shortcuts = mTableTools.compressSparseArray(args)
checkType('_main', 2, options, 'table', true)
return shortcuts
options = options or {}
end
frame = frame or mw.getCurrentFrame()
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
 
function -- Validate p.makeAnchorList(shortcuts)
local makeAnchor = p.makeAnchor
local anchors = {}
for i, shortcut in ipairs(shortcuts) do
anchors[#anchorsif + 1]type(shortcut) ~= makeAnchor('string' or #shortcut) < 1 then
error(message(cfg['invalid-shortcut-error'], i), 2)
end
end
return table.concat(anchors)
end
 
-- Make the list items. These are the shortcuts plus any extra lines such
function p.makeAnchor(s)
-- as options.msg.
s = anchorEncode(s)
local listItems = {}
local anchor = format('<span id="%s"></span>', s)
for i, shortcut in ipairs(shortcuts) do
return anchor
local templatePath, prefix
end
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
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()
function p.makeShortcutList(shortcuts)
root:wikitext(frame:extensionTag{ name = 'templatestyles', args = { src = 'Shortcut/styles.css'} })
local makeShortcutLink = p.makeShortcutLink
-- Anchors
local listArgs = {}
local anchorDiv = root
:tag('div')
:addClass('module-shortcutanchordiv')
for i, shortcut in ipairs(shortcuts) do
local linkanchor = makeShortcutLinkmw.uri.anchorEncode(shortcut)
anchorDiv:tag('span'):attr('id', anchor)
listArgs[#listArgs + 1] = link
end
return mList.makeList('bulleted', listArgs)
end
 
-- Shortcut heading
function p.makeShortcutLink(s)
local shortcutHeading
return format('[[%s]]', s)
do
end
local nShortcuts = #shortcuts
if nShortcuts > 0 then
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
function p.getErrorCategories(shortcuts)
local shortcut1shortcutList = shortcuts[1]root
:tag('div')
local title = mw.title.new(shortcut1)
:addClass('module-shortcutboxplain plainlist noprint')
if not title or not title.exists then
:attr('role', 'note')
local categoryNsName = mw.site.namespaces[14].name
if options.float and options.float:lower() == 'left' then
return format('[[%s:%s]]', categoryNsName, cfg.errorCategory)
shortcutList:addClass('module-shortcutboxleft')
else
return nil
end
if options.clear and options.clear ~= '' then
shortcutList:css('clear', options.clear)
end
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)
function p.export(anchors, nShortcuts, shortcutList, errorCategories)
local rootargs = mw.html.createrequire('Module:Arguments').getArgs(frame)
 
root:tag('div')
-- Separate shortcuts from options
:css{position = 'relative', top = '-3em'}
local shortcuts, options = {}, {}
:wikitext(anchors)
for k, v in pairs(args) do
:done()
if type(k) == 'number' then
:tag('table')
shortcuts[k] = v
:addClass('shortcutbox noprint')
:css{else
floatoptions[k] = 'right',v
end
border = '1px solid #aaa',
end
background = '#fff',
 
margin = '.3em .3em .3em 1em',
-- Compress the shortcut array, which may contain nils.
padding = '3px',
local function compressArray(t)
['text-align'] = 'center'
local nums, ret = {}, {}
}
for k in pairs(t) do
:tag('tr')
nums[#nums + 1] = k
:tag('th')
end
:addClass('plainlist')
table.sort(nums)
:css{border = 'none', background = 'transparent'}
for i, num in ipairs(nums) do
:tag('small')
ret[i] = t[num]
:wikitext(
end
nShortcuts <= 1
return ret
and cfg.shortcutHeaderSingular
end
or cfg.shortcutHeaderPlural
shortcuts = compressArray(shortcuts)
)
 
:newline()
return p._main(shortcuts, options, frame)
:wikitext(shortcutList)
root:wikitext(errorCategories)
return tostring(root)
end
 
Retrieved from "https://crocwiki.com/wiki/Special:MobileDiff/22200...22229"
Cookies help us deliver our services. By using our services, you agree to our use of cookies.
More information

Navigation menu