Template:Post-nominals/doc: Difference between revisions
meta>RexxS →Separator: update documentation to indicate that comma is only punctuation allowed between post-nominals |
meta>RexxS →Usage: expand documentation with more examples |
||
| Line 3: | Line 3: | ||
=== Usage === | === Usage === | ||
The default use provides post-nominals at 85% fontsize linked to the relevant article for the award. By default, the Canadian set of awards are used: | |||
<code><nowiki>{{post-nominals|PC|CC|OBE}}</nowiki></code>: {{post-nominals|PC|CC|OBE}} | |||
==== Suppress links with the postnoms parameter ==== | |||
The linking can be suppressed by using the {{para|post-noms}} parameter: | |||
<code><nowiki>{{post-nominals|post-noms=PC CC OBE}}</nowiki></code>: {{post-nominals|post-noms=PC CC OBE}} | |||
<nowiki>{{post-nominals|post- | ==== 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>{{post-nominals|post-nominals|PC|CC|OBE|size=100%}}</nowiki></code>: {{post-nominals|post-nominals|PC|CC|OBE|size=100%}} | |||
==== Separator ==== | ==== Separator ==== | ||
| Line 17: | Line 22: | ||
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. | 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==== | <code><nowiki>{{post-nominals|PC|CC|OBE|sep=,}}</nowiki></code>: {{post-nominals|PC|CC|OBE|sep=,}} | ||
==== Automatic linking to a country article ==== | |||
<nowiki>{{post-nominals|country=CAN|PC|CC|OBE}}</nowiki>: {{post-nominals|country=CAN|PC|CC|OBE}} | <code><nowiki>{{post-nominals|country=CAN|PC|CC|OBE}}</nowiki></code>: {{post-nominals|country=CAN|PC|CC|OBE}} | ||
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. | 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. | ||
<code><nowiki>{{post-nominals|country=GBR|PC|CC|OBE}}</nowiki></code>: {{post-nominals|country=GBR|PC|CC|OBE}} | |||
<code><nowiki>{{post-nominals|country=GBR|PC|CC|OBE|size=100%|sep=,}}</nowiki></code>: {{post-nominals|country=GBR|PC|CC|OBE||size=100%|sep=,}} | |||
Note that this is case-sensitive; "country=GBR" will invoke the British list, but "Country=GBR" will default to the Canadian list. | Note that this is case-sensitive; "country=GBR" will invoke the British list, but "Country=GBR" will default to the Canadian list. | ||
Revision as of 17:28, 20 January 2014
 | 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
The default use provides post-nominals at 85% fontsize linked to the relevant article for the award. By default, the Canadian set of awards are used:
{{post-nominals|PC|CC|OBE}}: PC CC OBE
Suppress links with the postnoms parameter
The linking can be suppressed by using the |post-noms= parameter:
{{post-nominals|post-noms=PC CC OBE}}: PC CC OBE
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%:
{{post-nominals|post-nominals|PC|CC|OBE|size=100%}}: PC CC OBE
Separator
To use a comma separator between post-nominals, use
|sep=,
Leave out the parameter completely or supply a blank value |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.
{{post-nominals|PC|CC|OBE|sep=,}}: PC, CC, OBE
Automatic linking to a country article
{{post-nominals|country=CAN|PC|CC|OBE}}: PC CC OBE
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.
{{post-nominals|country=GBR|PC|CC|OBE}}: PC CC OBE
{{post-nominals|country=GBR|PC|CC|OBE|size=100%|sep=,}}: PC, CC, OBE
Note that this is case-sensitive; "country=GBR" will invoke the British list, but "Country=GBR" will default to the Canadian list.
Exceptions
- OM in the Canada set defaults to the Order of Manitoba. The Order of Merit is specified with OMt:
- 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.
- 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.
- 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 templates for each supported country:
