Module:Toolbar
Appearance
| This Lua module is used in system messages, and on approximately 1,450,000 pages, or roughly 2% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
| This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing. |
| This module is currently protected from editing. See the protection policy and protection log for more details. Please discuss any changes on the talk page; you may submit an edit request to ask an administrator to make an edit if it is uncontroversial or supported by consensus. You may also request that this page be unprotected. |
| This module depends on the following other modules: |
This module implements {{toolbar}}. Please see the template page for documentation.
See also
- {{toolbar}}, {{toolbar/sandbox}}, /testcases
local p = {}
local function getArgNums(args)
-- Get the keys of the numerical arguments that are present.
local nums = {}
local tinsert = table.insert
for k, v in pairs(args) do
if type(k) == 'number' then
tinsert(nums, k)
end
end
table.sort(nums)
return nums
end
local function makeToolbarItems(args)
local nums = getArgNums(args)
local sep = (args.separator or 'pipe') .. '-separator'
sep = mw.message.new(sep):plain()
local ret = {}
local tinsert = table.insert
for i, v in ipairs(nums) do
tinsert(ret, args[v])
end
if #ret > 0 then
return table.concat(ret, sep)
end
end
function p._main(args)
local toolbarItems = makeToolbarItems(args)
if not toolbarItems then return '' end -- Return the blank string if no arguments were specified, rather than returning empty brackets
return mw.ustring.format(
'<span class="plainlinks%s"%s>(%s)</span>',
type(args.class) == 'string' and ' ' .. args.class or '',
type(args.style) == 'string' and mw.ustring.format(' style="%s"', args.style) or '',
toolbarItems
)
end
function p.main(frame)
-- If called via #invoke, use the args passed into the invoking template.
-- Otherwise, for testing purposes, assume args are being passed directly in.
local origArgs
if frame == mw.getCurrentFrame() then
origArgs = frame:getParent().args
for k, v in pairs(frame.args) do
origArgs = frame.args
break
end
else
origArgs = frame
end
-- Strip whitespace and remove nil values
local args = {}
for k, v in pairs(origArgs) do
if type(v) == 'string' then
v = mw.text.trim(v)
end
if v ~= '' then
args[k] = v
end
end
return p._main(args)
end
return p