Wikipedia>DePiep: TemplateData: use central template form for all prefix ship templates (via WP:JWB)

2018-03-19T17:42:19Z

TemplateData: use central template form for all prefix ship templates (via WP:JWB)

New page

{{Documentation subpage}}


== Usage ==
This is a typing short cut for linking to [[Royal New Zealand Navy]] ship articles named in the format "HMNZS Endeavour (A11)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as <nowiki>[[HMNZS Endeavour (A11)|HMNZS ''Endeavour'' (A11)]]</nowiki>. This template halves that to <nowiki>{{HMNZS|Endeavour|A11}}.
</nowiki>

=== Formal usage ===
*<nowiki>{{HMNZS|Ship Name}}</nowiki>
*<nowiki>{{HMNZS|Ship Name|ID}}</nowiki>, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title.

=== Examples ===
{|class=wikitable width="100%"
|- style="background-color:#FCFCFC" align="left"
! Template usage
! Equivalent wikicode
! Final result
|-
| <nowiki>{{HMNZS|Endeavour|A11}}</nowiki>
| <nowiki>[[HMNZS Endeavour (A11)|HMNZS ''Endeavour'' (A11)]]</nowiki>
| {{HMNZS|Endeavour|A11}}
|-
| <nowiki>{{HMNZS|Hawea|1975}}</nowiki>
| <nowiki>[[HMNZS Hawea (1975)|HMNZS ''Hawea'' (1975)]]</nowiki>
| {{HMNZS|Hawea|1975}}
|-
| <nowiki>{{HMNZS|Charles Upham}}</nowiki>
| <nowiki>[[HMNZS Charles Upham|HMNZS ''Charles Upham'']]</nowiki>
| {{HMNZS|Charles Upham}}
|}

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 "HMNZS", 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)<br>displayed
! colspan=2 | Example
! Equivalent wikicode
! Final result
|-
! 1
| style="text-align:center;" | 3rd
| colspan=2 | <nowiki>{{HMNZS|Endeavour|I91|1}}</nowiki>
| <nowiki>[[HMNZS Endeavour (I91)|I91]]</nowiki>
| {{HMNZS|Endeavour|I91|1}}
|-
! 2
| style="text-align:center;" | 2nd
| colspan=2 | <nowiki>{{HMNZS|Endeavour|I91|2}</nowiki>}
| <nowiki>[[HMNZS Endeavour (I91)|''Endeavour'']]</nowiki>
| {{HMNZS|Endeavour|I91|2}}
|-
! 3
| style="text-align:center;" | 2nd, 3rd
| colspan=2 | <nowiki>{{HMNZS|Endeavour|I91|3}}</nowiki>
| <nowiki>[[HMNZS Endeavour (I91)|''Endeavour'' I91]]</nowiki>
| {{HMNZS|Endeavour|I91|3}}
|-
! 4
| style="text-align:center;" | invalid result
| colspan=2 | <nowiki>{{HMNZS|Endeavour|I91|4}}</nowiki>
| <nowiki>[[HMNZS Endeavour (I91)|Invalid Optional Parameter]]</nowiki>
| {{HMNZS|Endeavour|I91|4}}
|-
! 5
| style="text-align:center;" | 1st, 3rd
| colspan=2 | <nowiki>{{HMNZS|Endeavour|I91|5}}</nowiki>
| <nowiki>[[HMNZS Endeavour (I91)|HMS I91]]</nowiki>
| {{HMNZS|Endeavour|I91|5}}
|-
! 6
| style="text-align:center;" | 1st, 2nd
| colspan=2 | <nowiki>{{HMNZS|Endeavour|I91|6}}</nowiki>
| <nowiki>[[HMNZS Endeavour (I91)|HMS ''Endeavour'']]</nowiki>
| {{HMNZS|Endeavour|I91|6}}
|-
!
| style="text-align:center;" | 2nd<br><small>(no 3rd)</small>
| <nowiki>{{HMNZS|Charles Uphamr|3=2}}</nowiki>
| <nowiki>Alternate usage: {{HMNZS|Charles Upham||2}}</nowiki>
| <nowiki>[[HMNZS Charles Upham|''Charles Upham'']]</nowiki>
| {{HMNZS|Charles Upham||2}}
|}
''N.B.'': Be careful with the third parameter if not using the second parameter. In the ''Charles Upham'' 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 {{tl|warship}} to create the same link and text, but saving, coincidentally, 6 characters while editing.

*<nowiki>{{HMNZS|Endeavour|I91|6}} yields the same results as {{warship|HMNZS|Endeavour|I91}}</nowiki>

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

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

<includeonly>{{sandbox other||
[[Category:Ship prefix templates]]
}}</includeonly>

Template:HMNZS/doc - Revision history

Wikipedia>DePiep: TemplateData: use central template form for all prefix ship templates (via WP:JWB)