Difference between revisions of "Template:HMNZS/doc"

From blackwiki
Jump to navigation Jump to search
imported>WOSlinker
(tidy style)
imported>DePiep
m (TemplateData: use central template form for all prefix ship templates (via WP:JWB))
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
+
<!-- Please add categories at the bottom of this page. -->
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
  
 
== Usage ==
 
== Usage ==
Line 34: Line 33:
  
 
=== Optional display control parameter ===
 
=== Optional display control parameter ===
There is an optional third parameter that controls which pieces of text are displayed in the article.  It's 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:
+
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%"
 
{|class=wikitable width="100%"
 
! Value
 
! Value
Line 90: Line 89:
  
 
*<nowiki>{{HMNZS|Endeavour|I91|6}} yields the same results as {{warship|HMNZS|Endeavour|I91}}</nowiki>
 
*<nowiki>{{HMNZS|Endeavour|I91|6}} yields the same results as {{warship|HMNZS|Endeavour|I91}}</nowiki>
 +
 +
== TemplateData ==
 +
{{Template:Ship/doc/fixed prefix: TemplateData}}
  
 
== See also ==
 
== See also ==
 
{{WPSHIPS shortcut templates}}
 
{{WPSHIPS shortcut templates}}
  
<includeonly>
+
<includeonly>{{sandbox other||
 
+
[[Category:Ship prefix templates]]
<!-- ADD CATEGORIES BELOW THIS LINE -->
+
}}</includeonly>
 
 
[[Category:Ship templates]]
 
 
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
 
 
</includeonly>
 

Latest revision as of 17:42, 19 March 2018

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 [[HMNZS Endeavour (A11)|HMNZS ''Endeavour'' (A11)]]. This template halves that to {{HMNZS|Endeavour|A11}}.

Formal usage

  • {{HMNZS|Ship Name}}
  • {{HMNZS|Ship Name|ID}}, where ID can be the hull number, launch year, or pennant number, as specified in the article title.

Examples

Template usage Equivalent wikicode Final result
{{HMNZS|Endeavour|A11}} [[HMNZS Endeavour (A11)|HMNZS ''Endeavour'' (A11)]] HMNZS Endeavour (A11)
{{HMNZS|Hawea|1975}} [[HMNZS Hawea (1975)|HMNZS ''Hawea'' (1975)]] HMNZS Hawea (1975)
{{HMNZS|Charles Upham}} [[HMNZS Charles Upham|HMNZS ''Charles Upham'']] 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:

Value Parameter(s)
displayed
Example Equivalent wikicode Final result
1 3rd {{HMNZS|Endeavour|I91|1}} [[HMNZS Endeavour (I91)|I91]] I91
2 2nd {{HMNZS|Endeavour|I91|2}} [[HMNZS Endeavour (I91)|''Endeavour'']] Endeavour
3 2nd, 3rd {{HMNZS|Endeavour|I91|3}} [[HMNZS Endeavour (I91)|''Endeavour'' I91]] Endeavour (I91)
4 invalid result {{HMNZS|Endeavour|I91|4}} [[HMNZS Endeavour (I91)|Invalid Optional Parameter]] HMNZS Endeavour (I91)
5 1st, 3rd {{HMNZS|Endeavour|I91|5}} [[HMNZS Endeavour (I91)|HMS I91]] HMNZS I91
6 1st, 2nd {{HMNZS|Endeavour|I91|6}} [[HMNZS Endeavour (I91)|HMS ''Endeavour'']] HMNZS Endeavour
2nd
(no 3rd)
{{HMNZS|Charles Uphamr|3=2}} Alternate usage: {{HMNZS|Charles Upham||2}} [[HMNZS Charles Upham|''Charles Upham'']] Charles Upham

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 {{warship}} to create the same link and text, but saving, coincidentally, 6 characters while editing.

  • {{HMNZS|Endeavour|I91|6}} yields the same results as {{warship|HMNZS|Endeavour|I91}}

TemplateData

Template:Ship/doc/fixed prefix: TemplateData

See also

Template:WPSHIPS shortcut templates