Template:MilAward Desc/doc

This is a documentation subpage for Template:MilAward Desc.
It may contain usage information, categories and other content that is not part of the original template page.

This template uses Lua:

Module:MilAward

Usage edit

This template displays the Ribbon and description of awards.

This template accepts two main parameters:

{{MilAward Desc|PP}} for example gives us Pro Patria Medal . This is using the default size. To specify the size, we have to specify the second parameter.
{{MilAward Desc|code=PMM|size=x12px}} works just as well: Pro Merito Medal (1975) (PMM)

Additional Parameters edit

Country edit

You can specify the name of the holder's country and any other country will be added to the description. for example, {{MilAward Desc|OBE|country=ZAR}} will display

Country specified: Order of the British Empire (OBE) (Great Britain)
No Country specified: Order of the British Empire (OBE)

You can use as a shortcut country=yes to add the country irrespective.

No Ribbon edit

If you want to suppress the display of the ribbon, add the parameter : "norib=yes"

Normal: Order of the British Empire (OBE)
Suppressed: Order of the British Empire (OBE)

Org edit

If you want the "Org" field (Supposed to be Organisation) then specificy the parameter "org=yes"

Normal: Pro Patria Medal (South Africa) (with Cunene Clasp) ^[a]
Org: Pro Patria Medal (South Africa) (with Cunene Clasp) ^[b] (SADF)

Combining parameter edit

You can combine any of the parameters. Here is the country and no ribbon combined

Pro Patria Medal (South Africa) (with Cunene Clasp) ^[c] (South Africa) (SADF)

No Category edit

The default behaviour of the module is that if a "Recipient" category has been specified, then the page where this template is used will have that category added. This is subject to the category existing and not being a redirect. If you want to stop the addition of the recipient category completely then specify the parameter nocat=yes

See Also edit

Display ribbon along with a description of the award linked to the page about it

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
code	`1`	This is the code of the Award you want to display Example PP	String	required
size	`size`	This is the size of the image of the Ribbon to display Suggested values `x25px` `x12px` Default x25px Example x25px Auto value `x25px`	String	suggested
country	`country`	This is to make the data from the "country" field display after the description. You have two choices, one is to make it "yes" then the country will always be display or use the country of the recipient and only if it does NOT match will the country be displayed Suggested values `yes` `ZAR` `Brazil` Example yes	String	optional
norib	`norib`	This will suppress the display of the ribbon Suggested values `yes` Example yes	String	optional
nocat	`nocat`	This will suppress the addition of Recipient Categories to the page Suggested values `yes` Example norib=yes	String	optional

Notes edit

^ Only the Cunene clasp was awarded, to members who served in Angola during Operation Savannah in 1975 and 1976. Recipients of the clasp wear a button, with the letter C encircled by a wreath, on the ribbon bar.
^ Only the Cunene clasp was awarded, to members who served in Angola during Operation Savannah in 1975 and 1976. Recipients of the clasp wear a button, with the letter C encircled by a wreath, on the ribbon bar.
^ Only the Cunene clasp was awarded, to members who served in Angola during Operation Savannah in 1975 and 1976. Recipients of the clasp wear a button, with the letter C encircled by a wreath, on the ribbon bar.

[1] Only the Cunene clasp was awarded, to members who served in Angola during Operation Savannah in 1975 and 1976. Recipients of the clasp wear a button, with the letter C encircled by a wreath, on the ribbon bar.

[2] Only the Cunene clasp was awarded, to members who served in Angola during Operation Savannah in 1975 and 1976. Recipients of the clasp wear a button, with the letter C encircled by a wreath, on the ribbon bar.

[3] Only the Cunene clasp was awarded, to members who served in Angola during Operation Savannah in 1975 and 1976. Recipients of the clasp wear a button, with the letter C encircled by a wreath, on the ribbon bar.

[a]

[b]

[c]