Module:Football squad/sandbox

Module documentation[view] [edit] [history] [purge]

Implements Template:Football squad. Can be invoked directly using {{#invoke:Football squad|navbox}}

Usage

{{Football squad}} is designed to be used within squad list templates (typically placed at the bottom of a player page) in order to make editing and standardisation easier. If you want to use this template first set up a new template for your squad, typically called something like Template:(team name) squad.

Templates useful for formatting the list are:

• {{football squad2 player}} - takes parameters "no" (number) and "name" (player name).

• {{football squad manager}} - takes the parameter "name" (manager name) and the optional parameter "title" (defaults to Manager, other commonly assigned values are Coach and Head Coach).

Options

teamdisplay: Use this parameter when you want the name displayed on the top line of the box to be different than the full title of the article about the team; for example, where the article title is qualified to disambiguate between two similarly-named teams. See {{Olimpija Ljubljana squad}} for an example of usage.

{{football squad
| name = {{subst:PAGENAME}}
| teamname = Norwich City F.C.
| bgcolor = yellow
| textcolor = green
| bordercolor = green
| list = 
{{football squad2 player|no=1|name=[[Tim Krul|Krul]]}}
{{football squad2 player|no=2|name=[[Max Aarons|Aarons]]}}
{{football squad2 player|no=3|name=[[Sam Byram|Byram]]}}
{{football squad2 player|no=4|name=[[Ben Godfrey|Godfrey]]}}
{{football squad2 player|no=5|name=[[Grant Hanley|Hanley]]}} ([[Captain (association football)|c]])
{{football squad2 player|no=6|name=[[Christoph Zimmermann|Zimmermann]]}}
{{football squad2 player|no=7|name=[[Lukas Rupp|Rupp]]}}
{{football squad2 player|no=8|name=[[Mario Vrančić|Vrančić]]}}
{{football squad manager|name=[[Daniel Farke|Farke]]|title=Head coach}}
}}

produces:

Players and managers can also be specified using the |no##=, |manager##=, and |manager_type##= parameters, which reduces the post-expand include size of the template.

Microformat

The HTML mark-up produced by this template includes an hCard microformat that makes an organization's details readily parsable by computer programs. This aids tasks such as the cataloguing of articles and maintenance of databases. For more information about the use of microformats on Wikipedia, please visit the Microformat WikiProject.

Subtemplates

• Use {{Start date and age}} for the date on which an organisation was "established", "founded", "opened" or otherwise started, unless that date is before 1583 CE.
• Use {{URL}} for an organisation's URL.

Please do not remove instances of these subtemplates.

Classes used

The HTML classes of this microformat include:

• adr
• agent
• category
• country-name
• extended-address
• fn
• geo
• label
• latitude
• locality
• longitude
• nickname
• note
• org
• region
• street-address
• url
• vcard

Please do not rename or remove these classes
nor collapse nested elements which use them.

See also

• {{National squad}}

The above documentation is transcluded from Module:Football squad/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this module.

-- This implements Template:Football squad
local p = {}

local getArgs = require('Module:Arguments').getArgs
local Navbox = require('Module:Navbox')

local function notblank(v)
	return mw.ustring.match((v or ''),'%S') ~= nil
end

local function makeError(msg)
	return mw.text.tag('strong', {['class']='error'}, msg)
end

local function listDecode(json, listType)
	local list = {}
	if notblank(json) then
		local status, plist = pcall(mw.text.jsonDecode, json)
		if not status then
			return makeError('Error decoding ' .. listType .. ' list: ' .. plist)
		end
		
		for k, v in pairs (plist) do
			if not v.name then
				return makeError('Error: Missing name on line ' .. k .. ' of ' .. listType .. ' list.')
			end
			
			local prefix
			if listType == 'manager' then
				prefix = (notblank(v.title) and v.title or 'Manager') .. ": "
			else
				prefix = (notblank(v.no) and (v.no .. ' ') or '')
			end
			
			table.insert(list,mw.ustring.format( '* <span class="nowrap agent vcard">%s<span class="fn">%s</span></span>', prefix, v.name))
		end
	end
	return table.concat(list, "\n")
end

local function buildPlayerList(args)
	local list = {}
	for k, v in pairs(args) do
		if type(k) ~= 'number' and notblank(v) and k:sub(1,2) == 'no' and tonumber(k:sub(3)) then
			local row =  mw.ustring.format( '* <span id="fbsquad_%s" class="nowrap agent vcard">%s <span class="fn">%s</span></span>', k, k:sub(3), v)
			table.insert(list, row)
		end
	end
	table.sort(list, function (x, y) return tonumber(string.match(x, 'fbsquad_no(%d*)"')) < tonumber(string.match(y, 'fbsquad_no(%d*)"')) end )
	return table.concat(list, "\n")
end

local function buildManagerList(args)
	local list = {}
	for k, v in pairs(args) do
		local n = k:sub(8)
		if type(k) ~= 'number' and notblank(v) and k:sub(1,7) == 'manager' and (tonumber(n) or n == '') then
			if n == '' then n = 1 end
			local title=args['title' .. k:sub(8)] or "Manager"
			local row =  mw.ustring.format( '* <span id="fbsquad_manager%s" class="nowrap agent vcard">%s: <span class="fn">%s</span></span>', n, title, v)
			table.insert(list, row)
		end
	end
	table.sort(list, function (x, y) return tonumber(string.match(x, 'fbsquad_manager(%d*)"')) < tonumber(string.match(y, 'fbsquad_manager(%d*)"')) end )
	return table.concat(list, "\n")
end
		
function p.navbox(frame)
	local args = getArgs(frame)
	
	args.name = args.name or "{{{name}}}"
	args.state = args.state or "autocollapse"
	args.teamname = args.teamname or "{{{teamname}}}"
	args.bgcolor = args.bgcolor or "#ccf"
	args.textcolor = args.textcolor or "#000"
	args.bordercolor = args.bordercolor or ""
	args.players = listDecode(args.players, "player") .. buildPlayerList(args)
	args.managers = listDecode(args.managers, "manager") .. buildManagerList(args)
	
	args.list1 = args.players .. (args.list1 or args.list or '') .. args.managers
	if args.list1 == '' then args.list1 = '{{{list}}}' end

	args.titlestyle = args.titlestyle or ("background:" .. args.bgcolor .. 
		"; color:" .. args.textcolor .. 
		"; box-shadow: inset 1px 1px 0 " .. args.bordercolor .. ", inset -1px -1px 0 " .. args.bordercolor .. 
		"; width:87%;")
	args.title = args.title or args.teamdisplay or args.teamname
	args.title = "[[" .. args.teamname .. "|<span style=\"color:" .. args.textcolor .. ";\">" .. args.title .. "</span>]] <span style=\"color:" .. args.textcolor .. ";\"> &ndash; current squad</span>"
	
	return Navbox._navbox({
		name       = args.name,
		state      = args.state,
		bodystyle  = nil,
		bodyclass  = "vcard",
		titleclass = "fn org",
		listclass  = "hlist",
		titlestyle = args.titlestyle,
		title      = args.title,
		list1      = args.list1
	})
end

return p