Template:NRP/doc
 | This is a documentation subpage for Template:NRP. It may contain usage information, categories and other content that is not part of the original template page. |
This is a typing short cut for linking to Navio da República Portuguesa ship articles named in the format "NRP Bartolomeu Dias (F333)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[NRP Bartolomeu Dias (F333)|NRP ''Bartolomeu Dias'' (F333)]]. This template halves that to {{NRP|Bartolomeu Dias|F333}}.
Usage
Formal usage
{{NRP|Ship Name}}{{NRP|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 |
|---|---|---|
| {{NRP|Dom Carlos I|A522}} | [[NRP Dom Carlos I (A522)|NRP ''Dom Carlos I'' (A522)]] | NRP Dom Carlos I (A522) |
| {{NRP|Sagres|1937}} | [[NRP Sagres (1937)|NRP ''Sagres'' (1937)]] | NRP Sagres (1937) |
| {{NRP|Sagres}} | [[NRP Sagres|NRP ''Sagres'']] | NRP Sagres |
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 NRP, 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 | {{NRP|Dom Carlos I|A522}} | [[NRP Dom Carlos I (A522)|NRP ''Dom Carlos I'' (A522)]] | NRP Dom Carlos I (A522) |
| 1 | 3rd | {{NRP|Dom Carlos I|A522|1}} | [[NRP Dom Carlos I (A522)|A522]] | NRP Dom Carlos I (A522) |
| 2 | 2nd | {{NRP|Dom Carlos I|A522|2}} | [[NRP Dom Carlos I (A522)|''Dom Carlos I'']] | NRP Dom Carlos I (A522) |
| 3 | 2nd, 3rd | {{NRP|Dom Carlos I|A522|3}} | [[NRP Dom Carlos I (A522)|''Dom Carlos I'' (A522)]] | NRP Dom Carlos I (A522) |
| 4 | invalid result | {{NRP|Dom Carlos I|A522|4}} | [[NRP Dom Carlos I (A522)|Invalid Optional Parameter]] | NRP Dom Carlos I (A522) |
| 5 | 1st, 3rd | {{NRP|Dom Carlos I|A522|5}} | [[NRP Dom Carlos I (A522)|NRP (A522)]] | NRP Dom Carlos I (A522) |
| 6 | 1st, 2nd | {{NRP|Dom Carlos I|A522|6}} | [[NRP Dom Carlos I (A522)|NRP ''Dom Carlos I'']] | NRP Dom Carlos I (A522) |
| 2nd (no 3rd) |
{{NRP|Sagres|3=2}} Alternate usage: {{NRP|Sagres||2}} |
[[NRP Sagres|''Sagres'']] | NRP Sagres |
N.B.: Be careful with the third parameter if not using the second parameter. In the last Dom Carlos I 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.
{{NRP|Dom Carlos I|A522|6}} yields the same results as {{warship|NRP|Dom Carlos I|A522}}
TemplateData
TemplateData
|
|---|
|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:NRP in articles based on its TemplateData.
TemplateData for NRP <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> |
See also
