Template:RPS/doc
This is a documentation subpage for Template:RPS. It contains 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 "RPS 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 [[RPS Deep Six (AWOL-99)|RPS ''Deep Six'' (AWOL-99)]]. This template halves that to {{BRP|Deep Six|AWOL-99}}.
Formal usage
{{RPS|Ship Name}}
{{RPS|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 |
---|---|---|
{{RPS|Rajah Soliman|D-66}}
|
[[RPS Rajah Soliman (D-66)|RPS ''Rajah Soliman'' (D-66)]]
|
RPS 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 | {{RPS|Rajah Soliman|D-66}}
|
[[RPS Rajah Soliman (D-66) |RPS ''Rajah Soliman'' (D-66)]]
|
RPS Rajah Soliman (D-66) |
1 | 3rd | {{RPS|Rajah Soliman|D-66|1}}
|
[[RPS Rajah Soliman (D-66) |D-66]]
|
D-66 |
2 | 2nd | {{RPS|Rajah Soliman|D-66|2}}
|
[[RPS Rajah Soliman (D-66) |''Rajah Soliman'']]
|
Rajah Soliman |
3 | 2nd, 3rd | {{RPS|Rajah Soliman|D-66|3}}
|
[[RPS Rajah Soliman (D-66) |''Rajah Soliman'' (D-66)]]
|
Rajah Soliman (D-66) |
4 | invalid result | {{RPS|Rajah Soliman|D-66|4}}
|
[[RPS Rajah Soliman (D-66) |Invalid Optional Parameter]]
|
RPS Rajah Soliman (D-66) |
5 | 1st, 3rd | {{RPS|Rajah Soliman|D-66|5}}
|
[[RPS Rajah Soliman (D-66) |RPS (D-66)]]
|
RPS D-66 |
6 | 1st, 2nd | {{RPS|Rajah Soliman|D-66|6}}
|
[[RPS Rajah Soliman (D-66) |RPS ''Rajah Soliman'']]
|
RPS Rajah Soliman |
TemplateData
TemplateData
| |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.
TemplateData for RPS This template provides a wikilink to a ship's page, with label options
|
See also
Template:WPSHIPS shortcut templates