Template:HMSAS/doc
 | This is a documentation subpage for Template:HMSAS. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
This is a typing short cut for linking to South African Navy ship articles named in the format "HMSAS President Kruger (F150)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[w:HMSAS President Kruger (F150)|HMSAS ''President Kruger'' (F150)]]. This template halves that to {{HMSAS|President Kruger|F150}}.
Formal usage
- {{HMSAS|Ship Name}}
- {{HMSAS|Ship Name|ID}}, where ID can be the hull number, launch year, or pennant number, as specified in the article title.
Examples
| Template usage | Equivalent wikicode | Final result |
|---|---|---|
| {{HMSAS|Mendi|F148}} | [[w:HMSAS Mendi (F148)|HMSAS ''Mendi'' (F148)]] | HMSAS Mendi (F148) |
| {{HMSAS|Tafelberg}} | [[w:HMSAS Tafelberg|HMSAS ''Tafelberg'']] | HMSAS Tafelberg |
Last example could be used to link to ship index (disambiguation) page
Optional display control parameter
There is an optional third parameter that controls which pieces of text are displayed in the article. Its value is treated as a binary number and will display the corresponding "bits". So setting the 4's bit will display "SAS", setting the 2's bit will display the ship name, and setting the 1's bit will display the ID. If binary math isn't your thing, refer to these examples:
| Value | Parameter(s) displayed |
Example | Equivalent wikicode | Final result | |
|---|---|---|---|---|---|
| 1 | 3rd | {{SAS|Drakensberg|A301|1}} | [[w:SAS Drakensberg (A301)|A301]] | SAS Drakensberg (A301) | |
| 2 | 2nd | {{SAS|Drakensberg|A301|2}} | [[w:SAS Drakensberg (A301)|''Drakensberg'']] | SAS Drakensberg (A301) | |
| 3 | 2nd, 3rd | {{SAS|Drakensberg|A301|3}} | [[w:SAS Drakensberg (A301)|''Drakensberg'' A301]] | SAS Drakensberg (A301) | |
| 4 | invalid result | {{SAS|Drakensberg|A301|4}} | [[w:SAS Drakensberg (A301)|Invalid Optional Parameter]] | SAS Drakensberg (A301) | |
| 5 | 1st, 3rd | {{HMSAS|Drakensberg|A301|5}} | [[w:HMSAS Drakensberg (A301)|HMSAS A301]] | HMSAS Drakensberg (A301) | |
| 6 | 1st, 2nd | {{SAS|Drakensberg|A301|6}} | [[w:SAS Drakensberg (A301)|SAS ''Drakensberg'']] | SAS Drakensberg (A301) | |
| 2nd (no 3rd) |
{{HMSAS|Drakensberg|3=2}} | Alternate usage: {{HMSAS|Drakensberg||2}} | [[w:HMSAS Drakensberg|''Drakensberg'']] | HMSAS Drakensberg | |
N.B.: Be careful with the third parameter if not using the second parameter. In the Drakensberg example above, the "|3=2" means set the third parameter to a value of two, while the alternate syntax shows using a pair of pipes, "||2", to position the value two in the third parameter position.
Using an optional display control parameter value of 6 yields the same results as using {{warship}} to create the same link and text, but saving, coincidentally, 6 characters while editing.
{{HMSAS|Drakensberg|A301|6}} yields the same results as {{warship|HMSAS|Drakensberg|A301}}
Template data
TemplateData for HMSAS
<templatedata> { "params": { "1": { "label": "Prefix", "description": "Fleet identifier", "example": "HMS, Japanese battleship", "type": "string" }, "2": { "label": "Name", "description": "Ship's name", "example": "Bismarck, Belgrano", "type": "string" }, "3": { "label": "ID", "description": "Hull number, launch year, or pennanr number", "example": "H75, 1975, ", "type": "string" }, "4": { "label": "Format", "description": "Formats label (parts showing)", "example": "1, 2, 3, 5, 6", "default": "blank", "type": "number" }, "up": { "label": "unlink prefix", "description": "yes=puts Fleet ID outside of Wikilink", "example": "up=yes", "default": "no", "type": "boolean" } }, "description": "This template provides a wikilink to a ship's page, with label options", "paramOrder": [ "1", "2", "3", "4", "up" ] } </templatedata>
See also
