Template:BRP/doc
 | This is a documentation subpage for Template:BRP. 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 Philippine Navy ship articles named in the format "BRP Deep Six (AWOL-99)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[w:BRP Deep Six (AWOL-99)|BRP ''Deep Six'' (AWOL-99)]]. This template halves that to {{BRP|Deep Six|AWOL-99}}.
Formal usage
- {{BRP|Ship Name}}
- {{BRP|Ship Name|ID}}, where ID can be the hull number, launch year, or pennant number, as specified in the article title.
Example
| Template usage | Equivalent wikicode | Final result |
|---|---|---|
| {{BRP|Rajah Soliman|D-66}} | [[w:BRP Rajah Soliman (D-66)|BRP ''Rajah Soliman'' (D-66)]] | BRP Rajah Soliman (D-66) |
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 BRP, 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 | {{BRP|Rajah Soliman|D-66}} | [[w:BRP Rajah Soliman (D-66) |BRP ''Rajah Soliman'' (D-66)]] | BRP Rajah Soliman (D-66) |
| 1 | 3rd | {{BRP|Rajah Soliman|D-66|1}} | [[w:BRP Rajah Soliman (D-66) |D-66]] | BRP Rajah Soliman (D-66) |
| 2 | 2nd | {{BRP|Rajah Soliman|D-66|2}} | [[w:BRP Rajah Soliman (D-66) |''Rajah Soliman'']] | BRP Rajah Soliman (D-66) |
| 3 | 2nd, 3rd | {{BRP|Rajah Soliman|D-66|3}} | [[w:BRP Rajah Soliman (D-66) |''Rajah Soliman'' (D-66)]] | BRP Rajah Soliman (D-66) |
| 4 | invalid result | {{BRP|Rajah Soliman|D-66|4}} | [[w:BRP Rajah Soliman (D-66) |Invalid Optional Parameter]] | BRP Rajah Soliman (D-66) |
| 5 | 1st, 3rd | {{BRP|Rajah Soliman|D-66|5}} | [[w:BRP Rajah Soliman (D-66) |BRP (D-66)]] | BRP Rajah Soliman (D-66) |
| 6 | 1st, 2nd | {{BRP|Rajah Soliman|D-66|6}} | [[w:BRP Rajah Soliman (D-66) |BRP ''Rajah Soliman'']] | BRP Rajah Soliman (D-66) |
TemplateData
TemplateData
|
|---|
|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:BRP in articles based on its TemplateData.
TemplateData for BRP <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
