Module:Arbcom election banner/sandbox

This module generates banner templates for the annual Arbitration Committee elections. To make a banner template for an Arbcom election, add the links to that year's Arbcom election pages as described below, and set the four date parameters. After that, editors can add voting guides using the guiden parameters. Voting guides are displayed in a random order.

Syntax

The basic syntax for the template is as follows:

{{#invoke:Arbcom election banner|main
| year          = 
| nomstart      = 
| nomend        = 
| votestart     = 
| voteend       = 
| beforenomlink = 
| votepage      = 
| votelog       = 
<!-- Add candidate guides here. -->
| guide1        = 
| guide2        = 
| guide3        = 
| guide4        = 
| guide5        = 
}}

The full syntax for the template is as follows:

{{#invoke:Arbcom election banner|main
| year          = 
| name          = 
| root          = 
| electionpage  = 
| nomstart      = 
| nomend        = 
| votestart     = 
| voteend       = 
| beforenomlink = 
| nomlink       = 
| votepage      = 
| votelog       = 
| contact       = 
| discuss       = 
| cguide        = 
| cstatements   = 
| cquestions    = 
| cdiscuss      = 
<!-- Add candidate guides here. -->
| guide1        = 
| guide2        = 
| guide3        = 
| guide4        = 
| guide5        = 
}}

Parameters

Important

These parameters may need to be set explicitly.

• year - The year in which the elections are held. Either year or name must be given. If year is not given, name must end in a number, which will be taken as year. In this documentation, the value of year is denoted by YYYY.
• name - The name of the template. This is needed to make the navbar work properly. Defaults to ACEYYYY.
• nomstart - The date that nominations start. This must be in a format accepted by the #time parser function, e.g. November 11. Template:Red.
• nomend - The deadline for nominations, e.g. November 18. Template:Red.
• votestart - The date that voting begins, e.g. November 23. Template:Red.
• voteend - The date that voting ends, e.g. December 5. Template:Red.
• votepage - The link to the SecurePoll voting page. Defaults to pointing to Special:SecurePoll.
• votelog - The link to the voting log. Defaults to [[Wikipedia:ROOT/Log|Voter log]].
• beforenomlink - Text to be displayed before the nomination period begins. Defaults to [[Wikipedia:Requests for comment/ROOT|YYYY ArbCom pre-election RFC]].
  • This might at times be set to [[Wikipedia:Requests for comment/Arbitration Committee Elections December YYYY/Electoral Commission|Electoral Commission RFC]]. As of September 2021, the last time such a value was used was in 2016.
• guide1, guide2, guide3, ... - links to voting guides. These will be displayed in random order.

Other

These parameters' default values should be acceptable.

• rootpagename - The ROOTPAGENAME of the various election pages. Defaults to Arbitration Committee Elections December YYYY. In this documentation, the value of rootpagename is denoted by ROOT.
• electionpage - The main page for the year's Arbcom elections. Defaults to [[Wikipedia:ROOT|YYYY Arbitration Committee Elections]].
• nomlink - Text to be displayed while nominations are underway. Defaults to [[Wikipedia:ROOT/Candidates|Nominate]].
• votelink - A link to display during the voting period. Defaults to the voting page and the voting log, and can safely be left blank.
• contact - Link to the coordinator contact page. Defaults to [[Wikipedia talk:ROOT/Coordination|Contact the coordinators]].
• discuss - Link to the election discussion page. Defaults to [[Wikipedia talk:ROOT|Discuss the elections]].
• cguide - Link to the candidate guide. Defaults to [[Wikipedia:ROOT/Candidates/Guide|Candidate guide]].
• cstatements - Link to the candidate statements page. Defaults to [[Wikipedia:ROOT/Candidates|Candidate statements]].
• cquestions - Link to the candidate questions page. Defaults to [[Wikipedia:ROOT/Questions|Questions for the candidates]].
• cdiscuss - Link to the candidate discussion page. Defaults to [[Wikipedia:ROOT/Candidates/Discussion|Discuss the candidates]].

---

local messageBox = require('Module:Message box')
local navbarModule = require('Module:Navbar')

local p = {}

-- Get constants.
local lang = mw.language.getContentLanguage()
local currentUnixDate = lang:formatDate('U')
currentUnixDate = tonumber(currentUnixDate)

local function err(msg)
	return mw.ustring.format('<b class="error">%s</b>', msg)
end

local function getUnixDate(date)
	local success, unixDate = pcall(lang.formatDate, lang, 'U', date)
	if success then
		return tonumber(unixDate)
	end
end

local function unixDateError(date)
	return err(tostring(date) .. ' is not a valid date.')
end

local function makeOmbox(oargs)
	return messageBox.main('ombox', oargs)
end

local function makeNavbar(name)
	return navbarModule.navbar{name, mini = '1'}
end

local function randomizeArray(t)
	-- Iterate through the array backwards, each time swapping the entry "i" with a random entry.
	-- Courtesy of Xinhuan at http://forums.wowace.com/showthread.php?p=279756
	math.randomseed(mw.site.stats.edits)
	for i = #t, 2, -1 do
		local r = math.random(i)
		t[i], t[r] = t[r], t[i]
	end
	return t
end

local function getArgNums(args, prefix)
	-- Returns a table containing the numbers of the arguments that exist for the specified prefix. For example, if the prefix
	-- was 'data', and 'data1', 'data2', and 'data5' exist, it would return {1, 2, 5}.
	local nums = {}
	for k, v in pairs(args) do
		k = tostring(k)
		local num = mw.ustring.match(k, '^' .. prefix .. '([1-9]%d*)$')
		if num then
			table.insert(nums, tonumber(num))
		end
	end
	table.sort(nums)
	return nums
end

local function showBeforeDate(datePairs)
	-- Shows a value if it is before a given date.
	for i, datePair in ipairs(datePairs) do
		local date = datePair.date
		local val = datePair.val
		if not date then -- No date specified, so assume we have no more dates to process.
			return val
		end
		local unixDate = getUnixDate(date)
		if not unixDate then return unixDateError(date) end
		if currentUnixDate < unixDate then -- The specified date is in the future.
			return val
		end
	end
end

local function countdown(date, event)
	if type(event) ~= 'string' then return err('No event name provided.') end
	-- Get the current date unix timestamp.
	local unixDate = getUnixDate(date)
	if not unixDate then return unixDateError(date) end
	unixDate = tonumber(unixDate)
	-- Subtract the timestamp from the current unix timestamp to find the time left, and output that in a readable way.
	local secondsLeft = unixDate - currentUnixDate
	if secondsLeft <= 0 then return end
	local timeLeft = lang:formatDuration(secondsLeft, {'weeks', 'days', 'hours'})
	-- Find whether we are plural or not.
	local isOrAre
	if mw.ustring.match(timeLeft, '^%d+') == '1' then
		isOrAre = 'is'
	else
		isOrAre = 'are'
	end
	-- Make the numbers red and bold, because that's what {{countdown}} does and it makes them look important.
	local timeLeft = mw.ustring.gsub(timeLeft, '(%d+)', '<span style="color: #F00; font-weight: bold;">%1</span>')
	-- Make the refresh link, and join it all together.
	local refreshLink = mw.title.getCurrentTitle():fullUrl{action = 'purge'}
	refreshLink = mw.ustring.format('<small><span class="plainlinks">([%s refresh])</span></small>', refreshLink)
	return mw.ustring.format('There %s %s until %s. %s', isOrAre, timeLeft, event, refreshLink)
end

local function guides(args)
	local guideNums = getArgNums(args, 'guide')
	local guides_list = mw.html.create('ul')
	for _, num in ipairs(guideNums) do
		local guide = mw.html.create('li')
		guide:wikitext(args['guide' .. tostring(num)])
		guides_list:addNode(guide)
	end
	guides = randomizeArray(guides)
	
	local cbox = mw.html.create('div')
	cbox:addClass('mw-collapsible mw-collapsed')
		:css('border', '1px solid silver')
		:css('margin-top', '0.2em')
		:tag('div')
			:css('text-align', 'center')
			:wikitext('Voter guides')
			:done()
		:tag('div')
			:addClass('mw-collapsible-content hlist')
			:css('border', '1px solid silver')
			:css('padding', '0.5em')
			:css('background-color', 'white')
			:wikitext('These [[:Category:Wikipedia Arbitration Committee Elections 2021 voter guides|guides]] represent the thoughts of their authors. All individually written voter guides are eligible for inclusion. Guides to other guides are ineligible.')
			:addNode(guides_list)
		:allDone()
	
	return tostring(cbox)
	
end

function p._main(args)
	-- Get data for the box, plus the box title.
	local year = lang:formatDate('Y')
	local name = args.name or 'ACE' .. year
	local navbar = makeNavbar(name)
	local electionpage = args.electionpage or mw.ustring.format(
		'[[Wikipedia:Arbitration Committee Elections December %s|%s Arbitration Committee Elections]]',
		year, year
	)
	-- Get nomination or voting link, depending on the date.
	local beforenomlink = args.beforenomlink or mw.ustring.format('[[Wikipedia:Requests for comment/Arbitration Committee Elections December %s/Electoral Commission|Electoral Commission RFC]]', year)
	local nomstart = args.nomstart or error('No nomstart date supplied')
	local nomlink = args.nomlink or mw.ustring.format('[[Wikipedia:Arbitration Committee Elections December %s/Candidates|Nominate]]', year)
	local nomend = args.nomend or error('No nomend date supplied')
	local votestart = args.votestart or error('No votestart date supplied')
	local votepage = args.votepage or '[[Special:SecurePoll|Cast your vote]]'
	local votelog = args.votelog or mw.ustring.format('[[Wikipedia:Arbitration Committee Elections December %s/Log|Voter log]]', year)
	local votelink = args.votelink or mw.ustring.format("'''%s'''\n* %s", votepage, votelog)
	local voteend = args.voteend or error('No voteend date supplied')
	local voteendlink = args.voteendlink or votelog
	local scheduleText = showBeforeDate{
		{val = beforenomlink, date = nomstart},
		{val = nomlink, date = nomend},
		{val = countdown(votestart, 'voting begins'), date = votestart},
		{val = votelink, date = voteend},
		{val = voteendlink}
	}
	-- Get other links.
	local contact = args.contact or mw.ustring.format('[[WT:COORD%s|Contact the coordinators]]', mw.ustring.sub(year, 3, 4))
	local discuss = args.discuss or mw.ustring.format('[[WT:ACE%s|Discuss the elections]]', year)
	local cguide = args.cguide or mw.ustring.format('[[Wikipedia:Arbitration Committee Elections December %s/Candidates/Guide|Candidate guide]]', year)
	local cstatements = args.cstatements or mw.ustring.format('[[Wikipedia:Arbitration Committee Elections December %s/Candidates|Candidate statements]]', year)
	local cquestions = args.cquestions or mw.ustring.format('[[Wikipedia:Arbitration Committee Elections December %s/Questions|Questions for the candidates]]', year)
	local cdiscuss = args.cdiscuss or mw.ustring.format('[[Wikipedia:Arbitration Committee Elections December %s/Candidates/Discussion|Discuss the candidates]]', year)
	local guides = guides(args)
	-- Get the text field of ombox.
	local text = [=[
<div style="float: right">%s</div><div class="hlist">
* '''%s'''
* %s
* %s
* %s
* [[Wikipedia:5-minute guide to ArbCom elections|Quick guide]]</div>
----
<div class="hlist">
; Candidates
: %s
: %s
: %s
: %s</div>
%s]=]
	text = mw.ustring.format(
		text,
		navbar,
		electionpage,
		scheduleText,
		contact,
		discuss,
		cguide,
		cstatements,
		cquestions,
		cdiscuss,
		guides
	)
	-- Build the ombox args
	local oargs = {}
	oargs.image = args.image or '[[File:Judges cupola.svg|50px|ArbCom|link=]]'
	oargs.style = args.style or 'background-color: #e0f8e2'
	oargs.text = text
	return makeOmbox(oargs)		
end
 
function p.main(frame)
    -- If called via #invoke, use the args passed into the invoking template, or the args passed to #invoke if any exist.
    -- Otherwise assume args are being passed directly in from the debug console or from another Lua module.
    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
    -- Trim whitespace and remove blank arguments.
    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