Module:Team appearances list

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

This module implements {{Team appearances list}}. Check there for usage documentation.

Modules

• Module:Team appearances list • Module:Team appearances list/sandbox • different (diff)
• Module:Team appearances list/data • Module:Team appearances list/data/sandbox • different (diff)
• Module:Team appearances list/show • Module:Team appearances list/show/sandbox • same content

Module:Team appearances list is invoked by {{Team appearances list}} to display a horizontal list showing the years a specified team participated in a specified competition. Each year of attendance is wikilinked to a corresponding article, while years the team did not compete (absences) are shown as disabled.

The names of the competition and team must be specified. Optionally, information for a competition can be defined in Module:Team appearances list/data, and team information can be included:

• begin_year – The first year to be shown.
• end_year – The last year to be shown.
• Years the team did not attend the competition.

If begin_year or end_year are defined for a team, they set default values that can be overridden with parameters in the template.

If a team is defined for a particular competition, any absent years in the templace call are ignored (instead, the absences defined in the data module are used).

Module:Team appearances list/show is used for testing. It shows the results for all competition/team pairs defined in the data module. The results are displayed at Module talk:Team appearances list/show.

Changes should be performed in the sandbox modules, using the following for testing:

• {{Team appearances list/sandbox}} – Uses the sandbox main and data modules.
• Module talk:Team appearances list/show – Results for all competition/team pairs defined in the sandbox data module.

Errors

Parameters provided by the template are validated using the following rules.

Always:
    competition   required : non-empty string
    team          required : non-empty string

If competition is defined in data module:
    begin_year    optional : number from 1800 to 2100 inclusive
    end_year      optional : as above (and end_year >= begin_year)
else:
    begin_year    required : as above
    end_year      optional : as above
    interval      required : number from 1 to 30 inclusive

An invalid parameter causes an error to be displayed and places the page in the hidden category Category:Pages with script errors.

The above documentation is transcluded from Module:Team appearances list/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Subpages of this module.

-- This module produces a horizontal list of team appearances at a specified
-- sports competition; each item is in the format:
-- [[<team> at the <year> <competition>|<year]]. The module requires the
-- following parameters: begin_year, interval, team and competition. end_year
-- may be optionally defined if the sports competition is now defunct.

local p = {}
local hlist = require('Module:List').horizontal

function p.main(frame)
	local args = require('Module:Arguments').getArgs(frame)
	return p._main(args)
end
 
function p._main(args)
	local appearances = {}
	for i = args.begin_year, (args.end_year or os.date('%Y')+args.interval), 
			args.interval do
		table.insert(appearances, mw.ustring.format('[[%s at the %s %s|%s]]',
			args.team, i, args.competition, i))
	end
	return hlist(appearances)
end

return p