Template:Post-nominals/doc

From Zoophilia Wiki
Revision as of 12:22, 23 December 2018 by meta>SMcCandlish (plural)
Jump to navigationJump to search

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 comma-space is placed between each linked post-nominal (see above). Many post-nominals contain their own spaces ("OFM Cap FSA Scot FRHistS" looks like five post-nominals, but is only three). To include only a space, set |nocommas=y (or |nocommas=true, etc.):

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

This should probably only be done in cases where space is at a premium, such as in a tight table, and (not or) when all of a person's post-nominals are known with absolute certainty and zero of them contain spaces.

The old |comma= (AKA |sep=) is no longer needed, and can be removed from deployed instances of the template, since inclusion of the comma is the default.

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%|GNZM|GCB|GCMG|GBE}}
while "Dame Jane Jones GNZM GCB GCMG GBE" is produced by an f suffix on the parameter values:
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 this template in articles based on this 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
Separatornocommas nocomma

Change the default separator (comma-space) into just a space; should not be done any time confusion could result, such as with post-nominals that contain spaces themselves.

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