Template:BRP/doc

{{Documentation subpage}}

== 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 [[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 ===
{|class=wikitable width="100%"
! Template usage
! Equivalent wikicode
! Final result
|-
| {{BRP|Rajah Soliman|D-66}}
| [[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:
{|class=wikitable width=100%
! Value
! Parameter(s)
displayed
! Example
! Equivalent wikicode
! Final result
|-
! None
| style="text-align:center;" | all
| {{BRP|Rajah Soliman|D-66}}
| [[BRP Rajah Soliman (D-66) |BRP ''Rajah Soliman'' (D-66)]]
| {{BRP|Rajah Soliman|D-66}}
|-
! 1
| style="text-align:center;" | 3rd
| {{BRP|Rajah Soliman|D-66|1}}
| [[BRP Rajah Soliman (D-66) |D-66]]
| {{BRP|Rajah Soliman|D-66|1}}
|-
! 2
| style="text-align:center;" | 2nd
| {{BRP|Rajah Soliman|D-66|2}}
| [[BRP Rajah Soliman (D-66) |''Rajah Soliman'']]
| {{BRP|Rajah Soliman|D-66|2}}
|-
! 3
| style="text-align:center;" | 2nd, 3rd
| {{BRP|Rajah Soliman|D-66|3}}
| [[BRP Rajah Soliman (D-66) |''Rajah Soliman'' (D-66)]]
| {{BRP|Rajah Soliman|D-66|3}}
|-
! 4
| style="text-align:center;" | invalid result
| {{BRP|Rajah Soliman|D-66|4}}
| —
| {{BRP|Rajah Soliman|D-66|4|no-tracking=yes}}
|-
! 5
| style="text-align:center;" | 1st, 3rd
| {{BRP|Rajah Soliman|D-66|5}}
| [[BRP Rajah Soliman (D-66) |BRP (D-66)]]
| {{BRP|Rajah Soliman|D-66|5}}
|-
! 6
| style="text-align:center;" | 1st, 2nd
| {{BRP|Rajah Soliman|D-66|6}}
| [[BRP Rajah Soliman (D-66) |BRP ''Rajah Soliman'']]
| {{BRP|Rajah Soliman|D-66|6}}
|}

== TemplateData ==
{{Ship/doc/fixed prefix: TemplateData}}

== See also ==
{{WPSHIPS shortcut templates}}

{{sandbox other||
[[Category:Ship prefix templates|BRP]]
}}