Module:Toolbar

From Wikisource
Jump to navigation Jump to search
Documentation icon Module documentation[view] [edit] [history] [purge]


This template is used to create 'toolbars' of links that are laid out in the same way as those produced by the core MediaWiki software.

Usage[edit]

  • {{toolbar| [[User:Example|user]] | [[User talk:Example|talk]] | [[Special:BlockIP/Example|block]] }}(user | talk | block)

There is a "separator" parameter:

  • {{toolbar| [[User:Example|user]] | [[User talk:Example|talk]] | [[Special:BlockIP/Example|block]] | separator=dot }}(user · talk · block)

Available separators include:

  • comma , comma
  • dot  · dot
  • tpt-languages  • tpt-languages
  • pipe | default

Also, there are "class" and "style" parameters.

See also[edit]

-- This module implements {{toolbar}}.

local mArguments -- Lazily initialise [[Module:Arguments]]
local mTableTools = require('Module:TableTools')
local yesno = require('Module:Yesno')

local p = {}

function p.main(frame)
	mArguments = require('Module:Arguments')
	local args = mArguments.getArgs(frame)
	return p._main(args)
end

function p._main(args)
	local toolbarItems = p.makeToolbarItems(args)
	if not toolbarItems then
		-- Return the blank string if no arguments were specified, rather than
		-- returning empty brackets.
		return ''
	elseif yesno(args.span) == false then
		return string.format(
			'(%s)',
			toolbarItems
		)
	else
		return string.format(
			'<span class="plainlinks%s"%s>(%s)</span>',
			type(args.class) == 'string' and ' ' .. args.class or '',
			type(args.style) == 'string' and string.format(' style="%s"', args.style) or '',
			toolbarItems
		)
	end
end

function p.makeToolbarItems(args)
	local nums = mTableTools.numKeys(args)
	local sep = (args.separator or 'pipe') .. '-separator'
	sep = mw.message.new(sep):plain()
	local ret = {}
	for i, v in ipairs(nums) do
		ret[#ret + 1] = args[v]
	end
	if #ret > 0 then
		return table.concat(ret, sep)
	else
		return nil
	end
end

return p