Template:ROKS
Template documentationUsage
This is a typing short cut for linking to Republic of Korea Navy ship articles named in the format "ROKS Dokdo (LPH-6111)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[ROKS Dokdo (LPH-6111)|ROKS ''Dokdo'' (LPH-6111)]]. This template halves that to {{ROKS|Dokdo|LPH-6111}}.
Formal Usage
{{ROKS|Ship Name}}{{ROKS|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 |
|---|---|---|
{{ROKS|Dokdo|LPH-6111}}
|
[[ROKS Dokdo (LPH-6111)|ROKS ''Dokdo'' (LPH-6111)]]
|
ROKS Dokdo (LPH-6111) |
{{ROKS|Dokdo|2005}}
|
[[ROKS Dokdo (2005)|ROKS ''Dokdo'' (2005)]]
|
ROKS Dokdo (2005) |
{{ROKS|Dokdo}}
|
[[ROKS Dokdo|ROKS ''Dokdo'']]
|
ROKS Dokdo |
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 ROKS, 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 |
|---|---|---|---|---|
| None | all | {{ROKS|Dokdo|LPH-6111}}
|
[[ROKS Dokdo (LPH-6111)|ROKS ''Dokdo'' (LPH-6111)]]
|
ROKS Dokdo (LPH-6111) |
| 1 | 3rd | {{ROKS|Dokdo|LPH-6111|1}}
|
[[ROKS Dokdo (LPH-6111)|LPH-6111]]
|
ROKS Dokdo (LPH-6111) |
| 2 | 2nd | {{ROKS|Dokdo|LPH-6111|2}}
|
[[ROKS Dokdo (LPH-6111)|''Dokdo'']]
|
ROKS Dokdo (LPH-6111) |
| 3 | 2nd, 3rd | {{ROKS|Dokdo|LPH-6111|3}}
|
[[ROKS Dokdo (LPH-6111)|''Dokdo'' (LPH-6111)]]
|
ROKS Dokdo (LPH-6111) |
| 4 | invalid result | {{ROKS|Dokdo|LPH-6111|4}}
|
[[ROKS Dokdo (LPH-6111)|Invalid Optional Parameter]]
|
ROKS Dokdo (LPH-6111) |
| 5 | 1st, 3rd | {{ROKS|Dokdo|LPH-6111|5}}
|
[[ROKS Dokdo (LPH-6111)|ROKS (LPH-6111)]]
|
ROKS Dokdo (LPH-6111) |
| 6 | 1st, 2nd | {{ROKS|Dokdo|LPH-6111|6}}
|
[[ROKS Dokdo (LPH-6111)|ROKS ''Dokdo'']]
|
ROKS Dokdo (LPH-6111) |
| 2nd (no 3rd) |
{{ROKS|Dokdo|3=2}} Alternate usage: >{{ROKS|Dokdo||2}}
|
[[ROKS Dokdo|''Dokdo'']]
|
ROKS Dokdo |
N.B.: Be careful with the third parameter if not using the second parameter. In the last Dokdo 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.
{{ROKS|Dokdo|LPH-6111|6}}yields the same results as{{warship|ROKS|Dokdo|LPH-6111}}
TemplateData
TemplateData
|
|---|
|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:ROKS in articles based on its TemplateData.
TemplateData for ROKS <templatedata> { "params": { "1": { "label": "Name", "description": "Ship's name", "example": "Bismarck, Belgrano", "type": "string" }, "2": { "label": "ID", "description": "Hull number, launch year, or pennant number", "example": "H75, 1975", "type": "string" }, "3": { "label": "Format", "description": "Formats the label (which name parts will show)", "example": "1, 2, 3, 5, 6", "type": "number", "default": "blank" }, "up": { "label": "unlink prefix", "description": "up=yes puts prefix before (outside of) the 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", "up" ] } </templatedata> |
