Editing Module:Arbcom election banner/sandbox/doc

{{module rating|beta}}

This module generates banner templates for the annual [[WP:ACE|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 <code>guide''n''</code> parameters. Voting guides are displayed in a random order.

== Syntax ==

The basic syntax for the template is as follows:

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

The full syntax for the template is as follows:

<pre>
{{#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        = 
}}
</pre>

== Parameters ==

=== Important ===

These parameters may need to be set explicitly.

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

=== Other ===

These parameters' default values should be acceptable.

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