Template:Post-nominals/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
← Older edit
VisualWikitext
meta>RexxS
→‎Separator: update documentation to indicate that comma is only punctuation allowed between post-nominals
Ookami (talk | contribs)
1,664 edits
m 88 revisions imported
 
(60 intermediate revisions by 25 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
<!-- 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:
: <code><nowiki>{{post-nominals|PC|CC|OBE}}</nowiki></code> produces: {{post-nominals|PC|CC|OBE}}


====postnoms field====
====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]]}}


<nowiki>{{post-nominals|post-noms=PC CC OBE}}</nowiki>: {{post-nominals|post-noms=PC CC OBE}}
====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%. 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>Jane Smith {{post-nominals|size=100%|PC|CC|OBE}}</nowiki></code> produces: Jane Smith {{post-nominals|size=100%|PC|CC|OBE}}


The optional "size" field allows for the size of the text, as a percentage, to be changed from the template's default of 85%.
====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>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}}


<nowiki>{{post-nominals|post-noms=PC CC OBE|size=100%}}</nowiki>: {{post-nominals|post-noms=PC CC OBE|size=100%}}
====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>Jane Smith {{post-nominals|country=NZL|PC|OBE}}</nowiki></code> produces: Jane Smith {{post-nominals|country=NZL|PC|OBE}}


==== Separator ====
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.)
To use a comma separator between post-nominals, use
{{para|sep|,}}
Leave out the parameter completely or supply a blank value {{para|sep}} to have just non-breaking spaces between the post-nominals. Only a comma is supported as punctuation in this case and anything else supplied as a value will default to using a comma in the rendered text.


====Automatic linking====
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.


<nowiki>{{post-nominals|country=CAN|PC|CC|OBE}}</nowiki>: {{post-nominals|country=CAN|PC|CC|OBE}}
=====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|size=100%|sep=,|GNZM|GCB|GCMG|GBE}}" is produced by:
:: <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:
:: <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>


Countries are specified using [[ISO 3166-1 alpha-3]] codes. The only countries currently supported are Australia (AUS), Canada (CAN), New Zealand (NZL), and the United Kingdom (GBR). If a country is not specified, the Canadian list will be used, as it duplicates most of the British list.
* '''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]].


Note that this is case-sensitive; "country=GBR" will invoke the British list, but "Country=GBR" will default to the Canadian list.
* '''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>


=====Exceptions=====
* '''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}}


*'''OM''' in the Canada set defaults to the [[Order of Manitoba]]. The [[Order of Merit]] is specified with '''OMt''':
::<nowiki>'''Joseph Jacques Jean Chrétien''', {{Post-nominals|country=CAN|PC|OMt|CC|QC}}</nowiki> returns '''Joseph Jacques Jean Chrétien''', {{Post-nominals|country=CAN|PC|OMt|CC|QC}}
*'''GNZM GCB GCMG GBE''' Designates both a Knight Grand Cross/Companion and a Dame Grand Cross/Companion however different parameters  are used to link to a Dame Grand Cross or Companion.
** Sir John Smith {{post-nominals|country=NZL|GNZM|GCB|GCMG|GBE}}
** Dame Jane Jones {{post-nominals|country=NZL|GNZMf|GCBf|GCMGf|GBEf}} use <nowiki>{{post-nominals|country=NZL|GNZM</nowiki>'''f'''<nowiki>|GCB</nowiki>'''f'''<nowiki>|GCMG</nowiki>'''f'''<nowiki>|GBE</nowiki>'''f'''<nowiki>}}</nowiki>
*'''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'''.
::<nowiki>'''John Smith''' {{post-nominals|country=NZL|QFSM|QPM|QPSMd|QPMd}}</nowiki> returns '''John Smith''' {{post-nominals|country=NZL|QFSM|QPM|QFSMd|QPMd}}
*'''AM''' is ambiguous in the British list: use '''AMl''' ''(lower case 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]].
*In the British list, distinguish '''Kt''' for a [[Knight Bachelor]] ''(nb: the post-nominal is used only for knights bachelor who hold other knighthoods, baronetcies and/or peerages)'' from '''KT''' for a [[Knight of the Thistle]].
=====Data=====
=====Data=====
Data templates for each supported country:
Data templates for each supported country:
*[[Template:Post-nominals/AUS|Australia]]
* 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|Canada]]
* Brunei: [[Template:Post-nominals/BRN|BRN]]
*[[Template:Post-nominals/NZL|New Zealand]] and [[Template:Post-nominals/NZL-cats|NZ with Categories]]
* 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/GBR|United Kingdom]] and [[Template:Post-nominals/GBR-cats|UK with Categories]]
* Hong Kong: [[Template:Post-nominals/HKG|HKG]]
* 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><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
<includeonly>{{Sandbox other|
| <!----CATEGORIES BELOW THIS LINE, PLEASE:---->
[[Category:Wikipedia formatting and function templates]]
[[Category:Wikipedia formatting and function templates]]
</includeonly>
[[Category:Templates that add a tracking category]]
[[Category:Pre- and post-nominals templates]]
}}</includeonly>

Latest revision as of 04:51, 3 September 2020

Redirects

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:

{{post-nominals|PC|CC|OBE}} produces: PC CC OBE

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.

Jane Smith {{post-nominals|size=100%|PC|CC|OBE}} produces: Jane Smith PC CC OBE

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):

Jane Smith, {{post-nominals|size=100%|commas=on|PC|CC|OBE}} produces: Jane Smith, PC, CC, OBE

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:

Jane Smith {{post-nominals|country=NZL|PC|OBE}} produces: Jane Smith PC OBE

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
  • 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}}
Joseph Jacques Jean Chrétien {{post-nominals|country=CAN|PC|OMt|CC|QC}}
John Smith {{post-nominals|country=NZL|QFSM|QPM|QPSMd|QPMd}} produces: John Smith QFSM QPM QFSM QPM
Data

Data templates for each supported country:

TemplateData

This is the TemplateData for this template, used by TemplateWizard, VisualEditor and other tools.
TemplateData for Post-nominals

Show a person's post-nominals cleanly and with links to the relevant articles.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Countrycountry

Which set of awards to use, by ISO 3166-1 alpha-3 country code. By default, the Canadian set is used.

Default
CAN
Example
GBR
Stringsuggested
1st post-nominal1

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringsuggested
2nd post-nominal2

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
3rd post-nominal3

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
4th post-nominal4

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
5th post-nominal5

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
6th post-nominal6

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
7th post-nominal7

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
8th post-nominal8

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
9th post-nominal9

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
10th post-nominal10

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
11th post-nominal11

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
12th post-nominal12

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
13th post-nominal13

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
14th post-nominal14

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
15th post-nominal15

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
16th post-nominal16

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
17th post-nominal17

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
18th post-nominal18

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
19th post-nominal19

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
20th post-nominal20

A post-nominal to show with a link to the relevant page.

Example
GCB
Stringoptional
Separatorsep commas

What separator to use. By default, this uses a space; you can use commas if you wish.

Default
Stringoptional
Sizesize

At what size to show the list; only over-ride if appropriate.

Default
85%
Example
100%
Stringoptional
Unformatted listlist unlinked post-noms

A list of post-nominals to display without links, or with customised linking.

Example
PC [[Order of the British Empire|KBE]]
Unbalanced wikitextoptional

See also


Retrieved from "https://zoophilia.wiki/index.php?title=Template:Post-nominals/doc&oldid=71408"