Template:Post-nominals/doc: Difference between revisions
meta>Abraham, B.S. tweak to represent change in default size |
m 88 revisions imported |
||
(51 intermediate revisions by 20 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- PLEASE ADD CATEGORIES | <!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE --> | ||
{{Template redirect|Post-nominal|Post-nominal styles|Postnom|Postnominal|Postnominals|Post nominals}}<!--only redirects currently in use--> | |||
===Usage=== | ===Usage=== | ||
====Default==== | |||
The default use provides post-nominals linked to the relevant article for the award. By default, the Canadian set of awards is used: | 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}} | : <code><nowiki>{{post-nominals|PC|CC|OBE}}</nowiki></code> produces: {{post-nominals|PC|CC|OBE}} | ||
Line 12: | Line 14: | ||
====Font size==== | ====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 100% | 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%. As per [[MOS:FONTSIZE]], this must be added when the template is used in infoboxes (it should be set to <kbd>100%</kbd>), because infoboxes already use size-reduced text. It can be used elsewhere when there are few post-nominal letters. | ||
: <code><nowiki>{{post-nominals|size= | : <code><nowiki>Jane Smith {{post-nominals|size=100%|PC|CC|OBE}}</nowiki></code> produces: Jane Smith {{post-nominals|size=100%|PC|CC|OBE}} | ||
====Commas==== | ====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): | 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}} | : <code><nowiki>Jane Smith, {{post-nominals|size=100%|commas=on|PC|CC|OBE}}</nowiki></code> produces: Jane Smith, {{post-nominals|size=100|commas=on|PC|CC|OBE}} | ||
====Country==== | ====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| | By default, the template links to articles on the Canadian versions of the honours indicated by the post-nominals. Please add <code>|country=CAN</code> anyway when Canada is wanted. To specify another country, include {{para|country|<var>XXX</var>}} where {{var|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}} | : <code><nowiki>Jane Smith {{post-nominals|country=NZL|PC|OBE}}</nowiki></code> produces: Jane Smith {{post-nominals|country=NZL|PC|OBE}} | ||
Currently, the countries supported are Australia (AUS); Canada (CAN); New Zealand (NZL); the United Kingdom (GBR); and South Africa (ZAR). (See data links below.) | Currently, the countries supported are Australia (AUS); Canada (CAN); Hong Kong (HKG); New Zealand (NZL); Nigeria (NGA); the United Kingdom (GBR); and South Africa (ZAR). United States (USA) is functional but blank. (See data links below.) | ||
If <code>country</code> is missing and none of <code>unlinked</code>, <code>list</code>, <code>post-noms</code> are used then [[:Category:Pages using Template:Post-nominals with missing parameters]] is added to the page. | |||
=====Exceptions===== | =====Exceptions===== | ||
Line 29: | Line 33: | ||
* '''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]]. | * '''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: | * '''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|size=100%|sep=,|GNZM|GCB|GCMG|GBE}}" is produced by: | ||
:: <code><nowiki>Sir John Smith {{post-nominals|country=NZL|GNZM|GCB|GCMG|GBE}}</nowiki></code> | :: <code><nowiki>Sir John Smith, {{post-nominals|country=NZL|size=100%|sep=,|GNZM|GCB|GCMG|GBE}}</nowiki></code> | ||
: while "Dame Jane Jones {{post-nominals|country=NZL|GNZMf|GCBf|GCMGf|GBEf}}" is produced by: | : 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> | :: <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> | ||
Line 36: | Line 40: | ||
* '''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]]. | * '''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 | * '''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 | :: <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''': | * '''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''': | ||
Line 44: | Line 48: | ||
=====Data===== | =====Data===== | ||
Data templates for each supported country: | Data templates for each supported country: | ||
*[[Template:Post-nominals/AUS| | * Australia: [[Template:Post-nominals/AUS|AUS]] or [[Template:Post-nominals/AUS-cats|AUS-cats]] ({{Compare pages|Template:Post-nominals/AUS|Template:Post-nominals/AUS-cats|compare}}) | ||
*[[Template:Post-nominals/CAN| | * Brunei: [[Template:Post-nominals/BRN|BRN]] | ||
*[[Template:Post-nominals/ | * Canada: [[Template:Post-nominals/CAN|CAN]] or [[Template:Post-nominals/CAN-cats|CAN-cats]] ({{Compare pages|Template:Post-nominals/CAN|Template:Post-nominals/CAN-cats|compare}}) | ||
*[[Template:Post-nominals/ | * Hong Kong: [[Template:Post-nominals/HKG|HKG]] | ||
*[[Template:Post-nominals/ | * India: [[Template:Post-nominals/IND|IND]] | ||
* New Zealand: [[Template:Post-nominals/NZL|NZL]] | |||
* Nigeria: [[Template:Post-nominals/NGA|NGA]] | |||
* Pakistan: [[Template:Post-nominals/PAK|PAK]] | |||
* South Africa: [[Template:Post-nominals/ZAR|ZAR]] | |||
* Sri Lanka: [[Template:Post-nominals/SRI|SRI]] | |||
* Sweden: [[Template:Post-nominals/SWE|SWE]] | |||
* United Kingdom: [[Template:Post-nominals/GBR|GBR]] or [[Template:Post-nominals/GBR-cats|GBR-cats]] ({{Compare pages|Template:Post-nominals/GBR|Template:Post-nominals/GBR-cats|compare}}) | |||
* United States: [[Template:Post-nominals/USA-cats|USA-cats]] | |||
== 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> | |||
== See also == | |||
* {{tl|Pre-nominal styles}} | |||
* {{clc|Pages using Template:Post-nominals with missing parameters}} | |||
<includeonly>{{ | <includeonly>{{Sandbox other| | ||
| <!----CATEGORIES BELOW THIS LINE, PLEASE:----> | | <!----CATEGORIES BELOW THIS LINE, PLEASE:----> | ||
[[Category:Wikipedia formatting and function templates]] | [[Category:Wikipedia formatting and function templates]] | ||
[[Category:Templates that add a tracking category]] | |||
[[Category:Pre- and post-nominals templates]] | |||
}}</includeonly> | }}</includeonly> |
Latest revision as of 04:51, 3 September 2020
This is a documentation subpage for Template:Post-nominals. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
Default
The default use provides post-nominals linked to the relevant article for the award. By default, the Canadian set of awards is used:
Unlinked and/or custom-linked post-nominals
To list post-nominals without links and/or with customised linking, use |unlinked=
or |list=
(or |post-noms=
):
{{post-nominals|unlinked=PC CC OBE}}
produces: PC CC OBE{{post-nominals|list=[[Order of the British Empire|KBE]]}}
produces: KBE
Font size
The optional |size=
parameter allows for the size of the text, as a percentage, to be changed from the template's default of 85%. As per MOS:FONTSIZE, this must be added when the template is used in infoboxes (it should be set to 100%), because infoboxes already use size-reduced text. It can be used elsewhere when there are few post-nominal letters.
Commas
By default, a single space is placed between each linked post-nominal (see above). To include a comma, set |commas=
(or |sep=
) as "on", "true", "," etc. (without quotemarks):
Country
By default, the template links to articles on the Canadian versions of the honours indicated by the post-nominals. Please add |country=CAN
anyway when Canada is wanted. To specify another country, include |country=XXX
where XXX is the ISO 3166-1 alpha-3 code for that country:
Currently, the countries supported are Australia (AUS); Canada (CAN); Hong Kong (HKG); New Zealand (NZL); Nigeria (NGA); the United Kingdom (GBR); and South Africa (ZAR). United States (USA) is functional but blank. (See data links below.)
If country
is missing and none of unlinked
, list
, post-noms
are used then Category:Pages using Template:Post-nominals with missing parameters is added to the page.
Exceptions
- 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, GNZM, GCB, GCMG, GBE" is produced by:
Sir John Smith, {{post-nominals|country=NZL|size=100%|sep=,|GNZM|GCB|GCMG|GBE}}
- while "Dame Jane Jones GNZM GCB GCMG GBE" is produced by:
Dame Jane Jones {{post-nominals|country=NZL|GNZMf|GCBf|GCMGf|GBEf}}
- 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 PC OM CC QC", for instance, is produced by:
Joseph Jacques Jean Chrétien {{post-nominals|country=CAN|PC|OMt|CC|QC}}
- 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 QFSMd and QPMd:
Data
Data templates for each supported country:
- Australia: AUS or AUS-cats (compare)
- Brunei: BRN
- Canada: CAN or CAN-cats (compare)
- Hong Kong: HKG
- India: IND
- New Zealand: NZL
- Nigeria: NGA
- Pakistan: PAK
- South Africa: ZAR
- Sri Lanka: SRI
- Sweden: SWE
- United Kingdom: GBR or GBR-cats (compare)
- United States: USA-cats
TemplateData
TemplateData for Post-nominals
Show a person's post-nominals cleanly and with links to the relevant articles.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Country | country | Which set of awards to use, by ISO 3166-1 alpha-3 country code. By default, the Canadian set is used.
| String | suggested |
1st post-nominal | 1 | A post-nominal to show with a link to the relevant page.
| String | suggested |
2nd post-nominal | 2 | A post-nominal to show with a link to the relevant page.
| String | optional |
3rd post-nominal | 3 | A post-nominal to show with a link to the relevant page.
| String | optional |
4th post-nominal | 4 | A post-nominal to show with a link to the relevant page.
| String | optional |
5th post-nominal | 5 | A post-nominal to show with a link to the relevant page.
| String | optional |
6th post-nominal | 6 | A post-nominal to show with a link to the relevant page.
| String | optional |
7th post-nominal | 7 | A post-nominal to show with a link to the relevant page.
| String | optional |
8th post-nominal | 8 | A post-nominal to show with a link to the relevant page.
| String | optional |
9th post-nominal | 9 | A post-nominal to show with a link to the relevant page.
| String | optional |
10th post-nominal | 10 | A post-nominal to show with a link to the relevant page.
| String | optional |
11th post-nominal | 11 | A post-nominal to show with a link to the relevant page.
| String | optional |
12th post-nominal | 12 | A post-nominal to show with a link to the relevant page.
| String | optional |
13th post-nominal | 13 | A post-nominal to show with a link to the relevant page.
| String | optional |
14th post-nominal | 14 | A post-nominal to show with a link to the relevant page.
| String | optional |
15th post-nominal | 15 | A post-nominal to show with a link to the relevant page.
| String | optional |
16th post-nominal | 16 | A post-nominal to show with a link to the relevant page.
| String | optional |
17th post-nominal | 17 | A post-nominal to show with a link to the relevant page.
| String | optional |
18th post-nominal | 18 | A post-nominal to show with a link to the relevant page.
| String | optional |
19th post-nominal | 19 | A post-nominal to show with a link to the relevant page.
| String | optional |
20th post-nominal | 20 | A post-nominal to show with a link to the relevant page.
| String | optional |
Separator | sep commas | What separator to use. By default, this uses a space; you can use commas if you wish.
| String | optional |
Size | size | At what size to show the list; only over-ride if appropriate.
| String | optional |
Unformatted list | list unlinked post-noms | A list of post-nominals to display without links, or with customised linking.
| Unbalanced wikitext | optional |
See also