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: |
Usage
[edit]Displays South African battle honours as a bordered table of embroidered honour images. Data come from Module:BattleHonour/data.
{{BattleHonour
|Title=Awarded to the Example Regiment
|caption=Battle Honours
|South_Africa_1879
|Delville_Wood
|El_Alamein
}}
Parameters
[edit]- Positional parameters (unlimited): underscore honour codes from the module data (e.g.
South_Africa_1879). list: optional comma-separated alternative to positional codes.Title: header cell text (default: Awarded).caption: table caption (default: Battle Honours).size: image size (default:x20px).float: extra table class (e.g.floatright).borderColor: top/bottom border colour (default:#CF9C65).unlinked: if set, output codes as plain text instead of the image table.
There is no 40-honour limit; codes are collected until positional parameters end (safety cap 500).
Honours are shown as a vertical list (one embroidered scroll per table row), not in a single horizontal row.
Module exports
[edit]{{#invoke:BattleHonour|BHTable}}— used by this template.{{#invoke:BattleHonour|catalogue}}— sortable overview table.{{#invoke:BattleHonour|honour|CODE}}— single honour section for list pages.{{#invoke:BattleHonour|honoursByPeriod}}— full chronological list by period.
Code naming
[edit]Use the underscore form matching Module:BattleHonour/data keys (e.g. Western_Desert_1941_43). Short aliases SWA15 and SWA14_15 remain valid. Unknown codes render an error message and add Category:Pages with unknown BattleHonour codes.