Module:Shortcut: Difference between revisions

    From Nonbinary Wiki
    (create replacement for Template:Shortcut)
     
    m (29 revisions imported from wikipedia:Module:Shortcut: see Topic:Vtixlm0q28eo6jtf)
     
    (28 intermediate revisions by 9 users not shown)
    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
    --------------------------------------------------------------------------------
    local yesno = require('Module:Yesno')


    -- Name for the error category produced if the first shortcut is not an existing
    local p = {}
    -- page on the wiki.
    cfg.errorCategory = 'Wikipedia shortcut box first parameter needs fixing'


    -- The header text for the list of shortcuts.
    local function message(msg, ...)
    -- cfg.shortcutHeaderSingular will be displayed if there is one shortcut, and
    return mw.message.newRawMessage(msg, ...):plain()
    -- cfg.shortcutHeaderPlural will be displayed if there are multiple shortcuts.
    end
    cfg.shortcutHeaderSingular = '[[Wikipedia:Shortcut|Shortcut]]:'
    cfg.shortcutHeaderPlural = '[[Wikipedia:Shortcut|Shortcuts]]:'


    --------------------------------------------------------------------------------
    local function makeCategoryLink(cat)
    -- Load external modules and define often-used functions
    return string.format('[[%s:%s]]', mw.site.namespaces[14].name, cat)
    --------------------------------------------------------------------------------
    end


    -- Load external modules
    function p._main(shortcuts, options, frame, cfg)
    local mArguments = require('Module:Arguments')
    checkType('_main', 1, shortcuts, 'table')
    local mTableTools = require('Module:TableTools')
    checkType('_main', 2, options, 'table', true)
    local mList = require('Module:List')
    options = options or {}
    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


    -- Define often-used functions
    -- Validate shortcuts
    local anchorEncode = mw.uri.anchorEncode
    for i, shortcut in ipairs(shortcuts) do
    local format = string.format
    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
    -- Main functions
    -- as options.msg.
    --------------------------------------------------------------------------------
    local listItems = {}
    for i, shortcut in ipairs(shortcuts) do
    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
    table.insert(listItems, options.msg)


    local p = {}
    -- 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


    function p.main(frame)
    local root = mw.html.create()
    local args = mArguments.getArgs(frame)
    root:wikitext(frame:extensionTag{ name = 'templatestyles', args = { src = 'Shortcut/styles.css'} })
    return p._main(args)
    -- Anchors
    end
    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


    function p._main(args)
    -- Shortcut heading
    local shortcuts = p.getShortcuts(args)
    local shortcutHeading
    local nShortcuts = #shortcuts
    do
    if nShortcuts < 1 then
    local nShortcuts = #shortcuts
    -- Don't output anything if {{shortcut}} was called with no arguments.
    if nShortcuts > 0 then
    return ''
    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
    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)
    -- Shortcut box
    local shortcuts = mTableTools.compressSparseArray(args)
    local shortcutList = root
    return shortcuts
    :tag('div')
    end
    :addClass('module-shortcutboxplain plainlist noprint')
     
    :attr('role', 'note')
    function p.makeAnchorList(shortcuts)
    if options.float and options.float:lower() == 'left' then
    local makeAnchor = p.makeAnchor
    shortcutList:addClass('module-shortcutboxleft')
    local anchors = {}
    end
    for i, shortcut in ipairs(shortcuts) do
    if options.clear and options.clear ~= '' then
    anchors[#anchors + 1] = makeAnchor(shortcut)
    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
    end
    return table.concat(anchors)
    return tostring(root)
    end
    end


    function p.makeAnchor(s)
    function p.main(frame)
    s = anchorEncode(s)
    local args = require('Module:Arguments').getArgs(frame)
    local anchor = format('<span id="%s"></span>', s)
    return anchor
    end


    function p.makeShortcutList(shortcuts)
    -- Separate shortcuts from options
    local makeShortcutLink = p.makeShortcutLink
    local shortcuts, options = {}, {}
    local listArgs = {}
    for k, v in pairs(args) do
    for i, shortcut in ipairs(shortcuts) do
    if type(k) == 'number' then
    local link = makeShortcutLink(shortcut)
    shortcuts[k] = v
    listArgs[#listArgs + 1] = link
    else
    options[k] = v
    end
    end
    end
    return mList.makeList('bulleted', listArgs)
    end


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

    Latest revision as of 11:43, 21 May 2021

    Documentation for this module may be created at Module:Shortcut/doc

    -- 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 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
    	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
    		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
    	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
    				redirectMode and cfg['redirect-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 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
    		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