Template:Post-nominals/doc: Difference between revisions

From The Goon Show Depository
m (1 revision imported)
No edit summary
 
Line 167: Line 167:
"label": "Unformatted list",
"label": "Unformatted list",
"description": "A list of post-nominals to display without links, or with customised linking.",
"description": "A list of post-nominals to display without links, or with customised linking.",
"example": "PC [[Order of the British Empire|KBE]]",
"example": "PC [[w:Order of the British Empire|KBE]]",
"type": "unbalanced-wikitext"
"type": "unbalanced-wikitext"
},
},

Latest revision as of 11:14, 22 August 2022

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); Ghana (GHA); 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. See a monthly parameter usage report for Template:Post-nominals in articles based on its TemplateData.

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 [[w:Order of the British Empire|KBE]]
Unbalanced wikitextoptional

See also