View source for Template:Election box candidate with party link/doc

{{Documentation subpage}}
{{High-use}}
{{Lua|Module:Political party}}

== Usage ==

===Party links===
A more sophisticated effect can be achieved using [[Template:Election box candidate with party link]].  This adds a link to the candidate's party and also adds a color tab to the left of the candidate.  For example:

For example:
 <nowiki>
 {{Election box begin | title=[[United Kingdom general election, 2005|General Election 2005]]: Strangford}}
 {{Election box candidate with party link
   |party      = Labour Party (UK)
   |candidate  = Tony Blair
   |votes      = 9,999
   |percentage = 50.0
   |change     = +10.0
 }}
 {{Election box candidate with party link
   |party      = Conservative Party (UK)
   |candidate  = Michael Howard
   |votes      = 9,999
   |percentage = 50.0
   |change     = +10.0
 }}
 {{Election box end}}
</nowiki>

Will create this:
{{Election box begin | title=[[United Kingdom general election, 2005|General Election 2005]]: Strangford}}
{{Election box candidate with party link
  |party      = Labour Party (UK)
  |candidate  = Tony Blair
  |votes      = 9,999
  |percentage = 50.0
  |change     = +10.0
}}
{{Election box candidate with party link
  |party      = Conservative Party (UK)
  |candidate  = Michael Howard
  |votes      = 9,999
  |percentage = 50.0
  |change     = +10.0
}}
{{Election box end}}

However, this does rely on some additional setup for each party.  See below for more details.

{{TemplateData header}}
<templatedata>
{
	"params": {
		"party": {
			"label": "Party",
			"description": "The article name of the relevant party",
			"example": "Labour Party (UK)",
			"type": "wiki-page-name",
			"required": true
		},
		"candidate": {
			"label": "Candidate name",
			"type": "string",
			"required": true
		},
		"votes": {
			"label": "Number of  votes",
			"example": "9,999",
			"type": "number",
			"required": true
		},
		"percentage": {
			"label": "% vote share",
			"example": "50.0",
			"type": "number",
			"required": true
		},
		"change": {
			"label": "Vote share change",
			"description": "Number of percentage points more/less than the previous election.",
			"example": "+10.0",
			"type": "string",
			"required": true
		}
	},
	"description": "A more sophisticated effect in election results tables can be achieved using this template. This adds a link to the candidate's party and also adds a color tab to the left of the candidate. See Election box begin and Election box end. See this template's page for a new party.",
	"paramOrder": [
		"party",
		"candidate",
		"votes",
		"percentage",
		"change"
	],
	"format": "inline"
}
</templatedata>

==Party set up==

It is necessary to do some a little bit of setup for each party in the election.  This involves creating an entry in [[Module:Political party]]. See [[Module:Political_party#Updating_the_module|the documentation]] for [[Module:Political party]] for details.

== Microformat ==
{{UF-hcard-person}}

== See also ==

{{List of Election Box Templates}}

<includeonly>{{Sandbox other||
<!-- CATEGORIES HERE, THANKS -->

[[Category:Election and referendum infobox templates]]
}}</includeonly>