Module:Shortcut
This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
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 yesno = require('Module:Yesno') local checkType = require('libraryUtil').checkType local p = {} 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) -- Validate shortcuts 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 ' .. 'at least one character in length)' ), 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 listItems[i] = string.format('[[%s]]', shortcut) end table.insert(listItems, options.msg) -- Return an error if we have nothing to display if #listItems < 1 then return '<strong class="error">Error: no shortcuts were specified ' .. 'and the ' .. mw.text.nowiki('|msg=') .. ' parameter was not ' .. 'set.</strong>' end local root = mw.html.create() -- Anchors local anchorDiv = root :tag('div') :css('position', 'relative') :css('top', '-3em') for i, shortcut in ipairs(shortcuts) do local anchor = mw.uri.anchorEncode(shortcut) anchorDiv:tag('span'):attr('id', anchor) end root:newline() -- To match the old [[Template:Shortcut]] -- Shortcut heading local shortcutHeading do local nShortcuts = #shortcuts if nShortcuts > 0 then shortcutHeading = mw.message.newRawMessage( cfg['shortcut-heading'], nShortcuts ):plain() shortcutHeading = frame:preprocess(shortcutHeading) shortcutHeading = shortcutHeading .. '\n' end end -- Shortcut box local shortcutList = root :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) :tag('ul') for i, item in ipairs(listItems) do shortcutList: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 return tostring(root) end function p.main(frame) local args = require('Module:Arguments').getArgs(frame, { wrappers = 'Template:Shortcut' }) -- 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