Template: BattleHonour/doc
| 40px | This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original template page. |
Usage
The default use provides Battle Honours linked to the relevant article for the award. By default, the South African set of awards is used:
{{BattleHonour|SWA15|SWA14-15}}produces:
| Awarded |
| South West Africa 1915 |
| South West Africa 1914–1915 |
Unlinked and/or custom-linked Battle Honours
To list Battle Honours without links and/or with customised linking, use |unlinked= or |list= (or |battlehonour=):
{{BattleHonour|unlinked=SWA15 SWA14-15}}produces:
| Awarded
SWA15 SWA14-15 |
{{BattleHonour|list=SWA15 SWA14-15}}produces:
| Awarded
SWA15 SWA14-15 |
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%:
Jane Smith, {{BattleHonour|size=100|SWA15|SWA14-15}}produces: Jane Smith,
| Awarded |
| South West Africa 1915 |
| South West Africa 1914–1915 |
Country
By default, the template links to articles on the South African versions of the honours indicated by the Battle Honours. To specify another country, include |country=XXX where XXX is the ISO 3166-1 alpha-3 code for that country:
{{Battle Honours|country=NZL|SWA|SWA14-15}}produces:
| Awarded |
| Template:BattleHonour/NZL |
| Template:BattleHonour/NZL |
Currently, the countries supported are South Africa (ZAR). (See data links below.)
Data
Data templates for each supported country:
TemplateData
<templatedata> { "params": { "1": { "label": "1st Battle Honour", "description": "A Battle Honour to show with a link to the relevant page.", "example": "SWA15", "type": "string", "suggested": true }, "2": { "inherits": "1", "label": "2nd Battle Honour",
"suggested": false
}, "3": { "inherits": "2", "label": "3rd Battle Honour" }, "4": { "inherits": "2", "label": "4th Battle Honour" }, "5": { "inherits": "2", "label": "5th Battle Honour" }, "6": { "inherits": "2", "label": "6th Battle Honour" }, "7": { "inherits": "2", "label": "7th Battle Honour" }, "8": { "inherits": "2", "label": "8th Battle Honour" }, "9": { "inherits": "2", "label": "9th Battle Honour" }, "10": { "inherits": "2", "label": "10th Battle Honour" }, "11": { "inherits": "2", "label": "11th Battle Honour" }, "12": { "inherits": "2", "label": "12th Battle Honour" }, "13": { "inherits": "2", "label": "13th Battle Honour" }, "14": { "inherits": "2", "label": "14th Battle Honour" }, "15": { "inherits": "2", "label": "15th Battle Honour" }, "16": { "inherits": "2", "label": "16th Battle Honour" }, "17": { "inherits": "2", "label": "17th Battle Honour" }, "18": { "inherits": "2", "label": "18th Battle Honour" }, "19": { "inherits": "2", "label": "19th Battle Honour" }, "20": { "inherits": "2", "label": "20th Battle Honour" }, "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", "battlehonours" ], "label": "Unformatted list", "description": "A list of Battle Honours to display without links, or with customised linking.", "example": "PC KBE", "type": "unbalanced-wikitext" }, "country": { "example": "ZAR", "label": "Country", "description": "Which set of Battle Honours to use, by ISO 3166-1 alpha-3 country code. By default, the South African (ZAR) set is used.", "type": "string", "default": "ZAR", "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 Unit's Battle Honours cleanly and with links to the relevant articles." } </templatedata>