Template:BattleHonour/doc
This is a documentation subpage for Template:BattleHonour. It may contain usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
TAKE NOTE: The template has changed and all the Battle Honour codes must have
- All spaces replace with underscores ( -> _)
- All dashes replaced with underscores (- -> _)
- All slashes replaced with underscores (/ -> _ )
Usage
[edit]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|XX|YY}}
produces:
Awarded |
---|
Unknown: YY Please see the Template:BattleHonour for help |
Unlinked and/or custom-linked Battle Honours
[edit]To list Battle Honours without links and/or with customised linking, use |unlinked=
or |list=
(or |battlehonour=
):
{{BattleHonour|unlinked=SWA15 SWA14_15}}
produces:
{{BattleHonour|list=SWA15, SWA14_15}}
produces:
Awarded |
---|
Image size
[edit]The optional |size=
parameter allows for changing the size of the image:
{{BattleHonour|size=x12px|SWA15|SWA14_15}}
Awarded |
---|
Data
[edit]All data is now stored in Module-space
Available Battle Honours
[edit]
TemplateData
[edit]Show a Unit's Battle Honours cleanly and with links to the relevant articles. The limit at the moment is forty.
Parameter | Description | Type | Status | |
---|---|---|---|---|
1st Battle Honour | 1 | A Battle Honour to show with a link to the relevant page.
| String | suggested |
2nd Battle Honour | 2 | A Battle Honour to show with a link to the relevant page.
| String | optional |
3rd Battle Honour | 3 | A Battle Honour to show with a link to the relevant page.
| String | optional |
4th Battle Honour | 4 | A Battle Honour to show with a link to the relevant page.
| String | optional |
5th Battle Honour | 5 | A Battle Honour to show with a link to the relevant page.
| String | optional |
6th Battle Honour | 6 | A Battle Honour to show with a link to the relevant page.
| String | optional |
7th Battle Honour | 7 | A Battle Honour to show with a link to the relevant page.
| String | optional |
8th Battle Honour | 8 | A Battle Honour to show with a link to the relevant page.
| String | optional |
9th Battle Honour | 9 | A Battle Honour to show with a link to the relevant page.
| String | optional |
10th Battle Honour | 10 | A Battle Honour to show with a link to the relevant page.
| String | optional |
11th Battle Honour | 11 | A Battle Honour to show with a link to the relevant page.
| String | optional |
12th Battle Honour | 12 | A Battle Honour to show with a link to the relevant page.
| String | optional |
13th Battle Honour | 13 | A Battle Honour to show with a link to the relevant page.
| String | optional |
14th Battle Honour | 14 | A Battle Honour to show with a link to the relevant page.
| String | optional |
15th Battle Honour | 15 | A Battle Honour to show with a link to the relevant page.
| String | optional |
16th Battle Honour | 16 | A Battle Honour to show with a link to the relevant page.
| String | optional |
17th Battle Honour | 17 | A Battle Honour to show with a link to the relevant page.
| String | optional |
18th Battle Honour | 18 | A Battle Honour to show with a link to the relevant page.
| String | optional |
19th Battle Honour | 19 | A Battle Honour to show with a link to the relevant page.
| String | optional |
20th Battle Honour | 20 | A Battle Honour to show with a link to the relevant page.
| String | optional |
Size | size | At what size to show the images in the list. Useful for InfoBox usage
| String | optional |