View source for Template:Post-nominals/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

===Usage===
The default use provides post-nominals linked to the relevant article for the award. By default, the Canadian set of awards is used:
: <code><nowiki>{{post-nominals|PC|CC|OBE}}</nowiki></code> produces: {{post-nominals|PC|CC|OBE}}

====Unlinked and/or custom-linked post-nominals====
To list post-nominals without links and/or with customised linking, use {{para|unlinked}} or {{para|list}} (or {{para|post-noms}}):
: <code><nowiki>{{post-nominals|unlinked=PC CC OBE}}</nowiki></code> produces: {{post-nominals|unlinked=PC CC OBE}}
: <code><nowiki>{{post-nominals|list=[[Order of the British Empire|KBE]]}}</nowiki></code> produces: {{post-nominals|list=[[Order of the British Empire|KBE]]}}

====Font size====
The optional {{para|size}} parameter allows for the size of the text, as a percentage, to be changed from the template's default of 85%:
: <code><nowiki>Jane Smith, {{post-nominals|size=100|PC|CC|OBE}}</nowiki></code> produces: Jane Smith, {{post-nominals|size=100%|PC|CC|OBE}}

====Commas====
By default, a single space is placed between each linked post-nominal (see above). To include a comma, set {{para|commas}} (or {{para|sep}}) as "on", "true", "," etc. (without quotemarks):
: <code><nowiki>{{post-nominals|commas=on|PC|CC|OBE}}</nowiki></code> produces: {{post-nominals|commas=on|PC|CC|OBE}}

====Country====
By default, the template links to articles on the Canadian versions of the honours indicated by the post-nominals. To specify another country, include {{para|country|''XXX''}} where ''XXX'' is the [[ISO 3166-1 alpha-3]] code for that country:
: <code><nowiki>{{post-nominals|country=NZL|PC|OBE}}</nowiki></code> produces: {{post-nominals|country=NZL|PC|OBE}}

Currently, the countries supported are Australia (AUS); Canada (CAN); Hong Kong (HKG); New Zealand (NZL); Nigeria (NG); the United Kingdom (GBR); and South Africa (ZAR). (See data links below.)

=====Exceptions=====
<!--(Alphabetical:)-->
* '''AM''' is ambiguous in British honours. Use '''AMl''' ("AM" followed by a lowercase "L") for a member of the [[London Assembly]]; '''AMw''' for a member of the [[National Assembly for Wales]]; and '''AMh''' for an honorary [[Member of the Order of Australia]].

* '''GNZM GCB GCMG GBE''' designates both a Knight Grand Cross/Companion and a Dame Grand Cross/Companion. In order to link correctly, however, more specific abbreviations are needed to differentiate between the Knight and Dame. For instance, "Sir John Smith, {{post-nominals|country=NZL|GNZM|GCB|GCMG|GBE}}" is produced by:
:: <code><nowiki>Sir John Smith, {{post-nominals|country=NZL|GNZM|GCB|GCMG|GBE}}</nowiki></code>
: while "Dame Jane Jones, {{post-nominals|country=NZL|GNZMf|GCBf|GCMGf|GBEf}}" is produced by:
:: <code><nowiki>Dame Jane Jones, {{post-nominals|country=NZL|GNZM</nowiki>'''f'''<nowiki>|GCB</nowiki>'''f'''<nowiki>|GCMG</nowiki>'''f'''<nowiki>|GBE</nowiki>'''f'''<nowiki>}}</nowiki></code>

* '''Kt''', in the British set of honours, indicates a [[Knight Bachelor]] who also holds other knighthoods, baronetcies and/or peerages; '''KT''' indicates a [[Knight of the Thistle]].

* '''OM''' in the Canadian set defaults to the [[Order of Manitoba]], while the [[Order of Merit]] is specified by '''OMt'''. "Joseph Jacques Jean Chrétien, {{post-nominals|country=CAN|PC|OMt|CC|QC}}", for instance, is produced by:
:: <code><nowiki>Joseph Jacques Jean Chrétien, {{post-nominals|country=CAN|PC|OMt|CC|QC}}</nowiki><code>

* '''QFSM''', in New Zealand, designates both the [[Queen's Fire Service Medal for Gallantry]] and [[Queen's Fire Service Medal for Distinguished Service]]. '''QPM''' designates both [[Queen's Police Medal for Gallantry]] and [[Queen's Police Medal for Distinguished Service]]. In both instances, the Medal for Distinguished Service is specified with QFSM'''d''' and QPM'''d''':
:: <code><nowiki>John Smith, {{post-nominals|country=NZL|QFSM|QPM|QPSMd|QPMd}}</nowiki></code> produces: John Smith, {{post-nominals|country=NZL|QFSM|QPM|QFSMd|QPMd}}

=====Data=====
Data templates for each supported country:
*[[Template:Post-nominals/AUS|Australia]]
*[[Template:Post-nominals/CAN|Canada]]
*[[Template:Post-nominals/HKG|Hong Kong]]
*[[Template:Post-nominals/NZL|New Zealand]] and [[Template:Post-nominals/NZL-cats|NZ with Categories]]
*[[Template:Post-nominals/NG|Nigeria]]
*[[Template:Post-nominals/GBR|United Kingdom]] and [[Template:Post-nominals/GBR-cats|UK with Categories]]
*[[Template:Post-nominals/ZAR|South Africa]]

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "1st post-nominal",
			"description": "A post-nominal to show with a link to the relevant page.",
			"example": "GCB",
			"type": "string",
			"suggested": true
		},
		"2": {
			"inherits": "1",
			"label": "2nd post-nominal",
 			"suggested": false
	   },
		"3": {
			"inherits": "2",
			"label": "3rd post-nominal"
	   },
		"4": {
			"inherits": "2",
			"label": "4th post-nominal"
	   },
		"5": {
			"inherits": "2",
			"label": "5th post-nominal"
	   },
		"6": {
			"inherits": "2",
			"label": "6th post-nominal"
	   },
		"7": {
			"inherits": "2",
			"label": "7th post-nominal"
	   },
		"8": {
			"inherits": "2",
			"label": "8th post-nominal"
	   },
		"9": {
			"inherits": "2",
			"label": "9th post-nominal"
	   },
		"10": {
			"inherits": "2",
			"label": "10th post-nominal"
	   },
		"11": {
			"inherits": "2",
			"label": "11th post-nominal"
	   },
		"12": {
			"inherits": "2",
			"label": "12th post-nominal"
	   },
		"13": {
			"inherits": "2",
			"label": "13th post-nominal"
	   },
		"14": {
			"inherits": "2",
			"label": "14th post-nominal"
	   },
		"15": {
			"inherits": "2",
			"label": "15th post-nominal"
	   },
		"16": {
			"inherits": "2",
			"label": "16th post-nominal"
	   },
		"17": {
			"inherits": "2",
			"label": "17th post-nominal"
	   },
		"18": {
			"inherits": "2",
			"label": "18th post-nominal"
	   },
		"19": {
			"inherits": "2",
			"label": "19th post-nominal"
	   },
		"20": {
			"inherits": "2",
			"label": "20th post-nominal"
	   },
		"size": {
			"label": "Size",
			"description": "At what size to show the list; only over-ride if appropriate.",
			"example": "100%",
			"type": "string",
			"default": "85%"
		},
		"list": {
			"aliases": [
				"unlinked",
			"post-noms"
			],
			"label": "Unformatted list",
			"description": "A list of post-nominals to display without links, or with customised linking.",
			"example": "PC [[Order of the British Empire|KBE]]",
			"type": "unbalanced-wikitext"
		},
		"country": {
			"example": "GBR",
			"label": "Country",
			"description": "Which set of awards to use, by ISO 3166-1 alpha-3 country code. By default, the Canadian set is used.",
			"type": "string",
			"default": "CAN",
			"suggested": true
		},
		"sep": {
			"aliases": [
				"commas"
			],
			"label": "Separator",
			"description": "What separator to use. By default, this uses a space; you can use commas if you wish.",
			"type": "string",
			"default": " "
		}
	},
	"paramOrder": [
		"country",
		"1",
		"2",
		"3",
		"4",
		"5",
		"6",
		"7",
		"8",
		"9",
		"10",
		"11",
		"12",
		"13",
		"14",
		"15",
		"16",
		"17",
		"18",
		"19",
		"20",
		"sep",
		"size",
		"list"
	],
	"format": "inline",
	"description": "Show a person's post-nominals cleanly and with links to the relevant articles."
}
</templatedata>

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| <!----CATEGORIES BELOW THIS LINE, PLEASE:---->
[[Category:Wikipedia formatting and function templates]]
}}</includeonly>