Difference between revisions of "Template:BRP/doc"

From blackwiki
Jump to navigation Jump to search
imported>DePiep
m (Add TemplateData (via WP:JWB))
imported>Zyxw
m (Since <tt> is obsolete in HTML5, replace it with <kbd> – see HTML element#tt, Wikipedia:HTML5, and mw:Help:Extension:Linter/obsolete-tag. using AWB)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
  
 
== Usage ==
 
== Usage ==
Line 8: Line 7:
 
=== Formal usage ===
 
=== Formal usage ===
  
* <tt><nowiki>{{BRP|Ship Name}}</nowiki></tt>
+
* <kbd><nowiki>{{BRP|Ship Name}}</nowiki></kbd>
* <tt><nowiki>{{BRP|Ship Name|ID}}</nowiki></tt>, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title.
+
* <kbd><nowiki>{{BRP|Ship Name|ID}}</nowiki></kbd>, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title.
  
 
=== Example ===
 
=== Example ===
Line 18: Line 17:
 
  ! Final result
 
  ! Final result
 
  |-
 
  |-
  | <tt><nowiki>{{BRP|Rajah Soliman|D-66}}</nowiki></tt>
+
  | <kbd><nowiki>{{BRP|Rajah Soliman|D-66}}</nowiki></kbd>
  | <tt><nowiki>[[BRP Rajah Soliman (D-66)|BRP ''Rajah Soliman'' (D-66)]]</nowiki></tt>
+
  | <kbd><nowiki>[[BRP Rajah Soliman (D-66)|BRP ''Rajah Soliman'' (D-66)]]</nowiki></kbd>
 
  | {{BRP|Rajah Soliman|D-66}}
 
  | {{BRP|Rajah Soliman|D-66}}
 
  |}
 
  |}
 
  
 
=== Optional display control parameter ===
 
=== Optional display control parameter ===
Line 35: Line 33:
 
! None
 
! None
 
| style="text-align:center;" | all
 
| style="text-align:center;" | all
| <tt><nowiki>{{BRP|Rajah Soliman|D-66}}</nowiki></tt>
+
| <kbd><nowiki>{{BRP|Rajah Soliman|D-66}}</nowiki></kbd>
| <tt><nowiki>[[BRP Rajah Soliman (D-66) |BRP ''Rajah Soliman'' (D-66)]]</nowiki></tt>
+
| <kbd><nowiki>[[BRP Rajah Soliman (D-66) |BRP ''Rajah Soliman'' (D-66)]]</nowiki></kbd>
 
| {{BRP|Rajah Soliman|D-66}}
 
| {{BRP|Rajah Soliman|D-66}}
 
|-
 
|-
 
! 1
 
! 1
 
| style="text-align:center;" | 3rd
 
| style="text-align:center;" | 3rd
| <tt><nowiki>{{BRP|Rajah Soliman|D-66|1}}</nowiki></tt>
+
| <kbd><nowiki>{{BRP|Rajah Soliman|D-66|1}}</nowiki></kbd>
| <tt><nowiki>[[BRP Rajah Soliman (D-66) |D-66]]</nowiki></tt>
+
| <kbd><nowiki>[[BRP Rajah Soliman (D-66) |D-66]]</nowiki></kbd>
 
| {{BRP|Rajah Soliman|D-66|1}}
 
| {{BRP|Rajah Soliman|D-66|1}}
 
|-
 
|-
 
! 2
 
! 2
 
| style="text-align:center;" | 2nd
 
| style="text-align:center;" | 2nd
| <tt><nowiki>{{BRP|Rajah Soliman|D-66|2}</nowiki>}</tt>
+
| <kbd><nowiki>{{BRP|Rajah Soliman|D-66|2}</nowiki>}</kbd>
| <tt><nowiki>[[BRP Rajah Soliman (D-66) |''Rajah Soliman'']]</nowiki></tt>   
+
| <kbd><nowiki>[[BRP Rajah Soliman (D-66) |''Rajah Soliman'']]</nowiki></kbd>   
 
| {{BRP|Rajah Soliman|D-66|2}}
 
| {{BRP|Rajah Soliman|D-66|2}}
 
|-
 
|-
 
! 3
 
! 3
 
| style="text-align:center;" | 2nd, 3rd
 
| style="text-align:center;" | 2nd, 3rd
| <tt><nowiki>{{BRP|Rajah Soliman|D-66|3}</nowiki>}
+
| <kbd><nowiki>{{BRP|Rajah Soliman|D-66|3}</nowiki>}</kbd>
| <tt><nowiki>[[BRP Rajah Soliman (D-66) |''Rajah Soliman'' (D-66)]]</nowiki>
+
| <kbd><nowiki>[[BRP Rajah Soliman (D-66) |''Rajah Soliman'' (D-66)]]</nowiki></kbd>
 
| {{BRP|Rajah Soliman|D-66|3}}
 
| {{BRP|Rajah Soliman|D-66|3}}
 
|-
 
|-
 
! 4
 
! 4
 
| style="text-align:center;" | invalid result
 
| style="text-align:center;" | invalid result
| <tt><nowiki>{{BRP|Rajah Soliman|D-66|4}</nowiki>}</tt>
+
| <kbd><nowiki>{{BRP|Rajah Soliman|D-66|4}</nowiki>}</kbd>
| <tt><nowiki>[[BRP Rajah Soliman (D-66) |Invalid Optional Parameter]]</nowiki></tt>   
+
| <kbd><nowiki>[[BRP Rajah Soliman (D-66) |Invalid Optional Parameter]]</nowiki></kbd>   
 
| {{BRP|Rajah Soliman|D-66|4}}
 
| {{BRP|Rajah Soliman|D-66|4}}
 
|-
 
|-
 
! 5
 
! 5
 
| style="text-align:center;" | 1st, 3rd
 
| style="text-align:center;" | 1st, 3rd
| <tt><nowiki>{{BRP|Rajah Soliman|D-66|5}</nowiki>}</tt>
+
| <kbd><nowiki>{{BRP|Rajah Soliman|D-66|5}</nowiki>}</kbd>
| <tt><nowiki>[[BRP Rajah Soliman (D-66) |BRP (D-66)]]</nowiki></tt>   
+
| <kbd><nowiki>[[BRP Rajah Soliman (D-66) |BRP (D-66)]]</nowiki></kbd>   
 
| {{BRP|Rajah Soliman|D-66|5}}
 
| {{BRP|Rajah Soliman|D-66|5}}
 
|-
 
|-
 
! 6
 
! 6
 
| style="text-align:center;" | 1st, 2nd
 
| style="text-align:center;" | 1st, 2nd
| <tt><nowiki>{{BRP|Rajah Soliman|D-66|6}</nowiki>}</tt>
+
| <kbd><nowiki>{{BRP|Rajah Soliman|D-66|6}</nowiki>}</kbd>
| <tt><nowiki>[[BRP Rajah Soliman (D-66) |BRP ''Rajah Soliman'']]</nowiki></tt>   
+
| <kbd><nowiki>[[BRP Rajah Soliman (D-66) |BRP ''Rajah Soliman'']]</nowiki></kbd>   
 
| {{BRP|Rajah Soliman|D-66|6}}
 
| {{BRP|Rajah Soliman|D-66|6}}
 
|}
 
|}
  
==Template data==
+
== TemplateData ==
{{TemplateDataHeader}}
+
{{Template:Ship/doc/fixed prefix: TemplateData}}
<templatedata>
 
{
 
"params": {
 
"1": {
 
"label": "Prefix",
 
"description": "Fleet identifier",
 
"example": "HMS, Japanese battleship",
 
"type": "string"
 
},
 
"2": {
 
"label": "Name",
 
"description": "Ship's name",
 
"example": "Bismarck, Belgrano",
 
"type": "string"
 
},
 
"3": {
 
"label": "ID",
 
"description": "Hull number, launch year, or pennanr number",
 
"example": "H75, 1975, ",
 
"type": "string"
 
},
 
"4": {
 
"label": "Format",
 
"description": "Formats label (parts showing)",
 
"example": "1, 2, 3, 5, 6",
 
"default": "blank",
 
"type": "number"
 
},
 
"up": {
 
"label": "unlink prefix",
 
"description": "yes=puts Fleet ID outside of 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",
 
"4",
 
"up"
 
]
 
}
 
</templatedata>
 
  
 
== See also ==
 
== See also ==
 
{{WPSHIPS shortcut templates}}
 
{{WPSHIPS shortcut templates}}
  
<includeonly>
+
<includeonly>{{sandbox other||
 
+
[[Category:Ship prefix templates|BRP]]
<!-- ADD CATEGORIES BELOW THIS LINE -->
+
}}</includeonly>
 
 
[[Category:Ship templates|BRP]]
 
 
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
 
 
</includeonly>
 

Latest revision as of 05:30, 5 August 2018

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

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:

Value Parameter(s)
displayed
Example Equivalent wikicode Final result
None all {{BRP|Rajah Soliman|D-66}} [[BRP Rajah Soliman (D-66) |BRP ''Rajah Soliman'' (D-66)]] BRP Rajah Soliman (D-66)
1 3rd {{BRP|Rajah Soliman|D-66|1}} [[BRP Rajah Soliman (D-66) |D-66]] D-66
2 2nd {{BRP|Rajah Soliman|D-66|2}} [[BRP Rajah Soliman (D-66) |''Rajah Soliman'']] Rajah Soliman
3 2nd, 3rd {{BRP|Rajah Soliman|D-66|3}} [[BRP Rajah Soliman (D-66) |''Rajah Soliman'' (D-66)]] Rajah Soliman (D-66)
4 invalid result {{BRP|Rajah Soliman|D-66|4}} [[BRP Rajah Soliman (D-66) |Invalid Optional Parameter]] BRP Rajah Soliman (D-66)
5 1st, 3rd {{BRP|Rajah Soliman|D-66|5}} [[BRP Rajah Soliman (D-66) |BRP (D-66)]] BRP D-66
6 1st, 2nd {{BRP|Rajah Soliman|D-66|6}} [[BRP Rajah Soliman (D-66) |BRP ''Rajah Soliman'']] BRP Rajah Soliman

TemplateData

Template:Ship/doc/fixed prefix: TemplateData

See also

Template:WPSHIPS shortcut templates