Module:Arbcom election banner/sandbox/doc

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       =

| 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      =

| 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. {{red|This parameter is required}}.
nomend - The deadline for nominations, e.g. November 18. {{red|This parameter is required}}.
votestart - The date that voting begins, e.g. November 23. {{red|This parameter is required}}.
voteend - The date that voting ends, e.g. December 5. {{red|This parameter is required}}.
votepage - The link to the SecurePoll voting page. Defaults to pointing to Special:SecurePoll.
votelog - The link to the voting log. Defaults to Voter log.
beforenomlink - Text to be displayed before the nomination period begins. Defaults to YYYY ArbCom pre-election RFC.
This might at times be set to Electoral Commission RFC. {{As of|2021|9}}, 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 YYYY Arbitration Committee Elections.
nomlink - Text to be displayed while nominations are underway. Defaults to 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 Contact the coordinators.
discuss - Link to the election discussion page. Defaults to Discuss the elections.
cguide - Link to the candidate guide. Defaults to Candidate guide.
cstatements - Link to the candidate statements page. Defaults to Candidate statements.
cquestions - Link to the candidate questions page. Defaults to Questions for the candidates.
cdiscuss - Link to the candidate discussion page. Defaults to Discuss the candidates.