Difference between revisions of "Template:HMQS/doc"

From blackwiki
Jump to navigation Jump to search
imported>WOSlinker
(tidy style)
imported>John of Reading
m (→‎Optional display control parameter: Typo fixing, replaced: It's value is → Its value is using AWB)
Line 26: Line 26:
  
 
=== 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 "HMVS", 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 "HMVS", 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

Revision as of 14:08, 23 June 2017

Usage

This is a typing short cut for linking to Queensland Maritime Defence Force ship articles named in the format "HMVS Victoria (1855)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HMVS Victoria (1855)|HMVS ''Victoria'' (1855)]]. This template halves that to {{HMVS|Victoria|1855}}.

Formal usage

  • {{HMQS|Ship Name}}
  • {{HMQS|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
{{HMQS|Gayundah}} [[HMQS Gayundah|HMQS ''Gayundah'']] HMQS Gayundah

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 "HMVS", 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 {{HMVS|Victoria|1855|1}} [[HMVS Victoria (1855)|1855]] 1855
2 2nd {{HMVS|Victoria|1855|2}} [[HMVS Victoria (1855)|''Victoria'']] Victoria
3 2nd, 3rd {{HMVS|Victoria|1855|3}} [[HMVS Victoria (1855)|''Victoria'' 1855]] Victoria (1855)
4 invalid result {{HMVS|Victoria|1855|4}} [[HMVS Victoria (1855)|Invalid Optional Parameter]] HMVS Victoria (1855)
5 1st, 3rd {{HMVS|Victoria|1855|5}} [[HMVS Victoria (1855)|HMVS 1855]] HMVS 1855
6 1st, 2nd {{HMVS|Victoria|1855|6}} [[HMVS Victoria (1855)|HMVS ''Victoria'']] HMVS Victoria
2nd
(no 3rd)
{{HMVS|Gordon|3=2}} Alternate usage: {{HMVS|Gordon||2}} [[HMVS Gordon|''Gordon'']] Gordon

N.B.: Be careful with the third parameter if not using the second parameter. In the Gordon 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.

  • {{HMVS|Victoria|1855|6}} yields the same results as {{warship|HMVS|Victoria|1855}}

See also

Template:WPSHIPS shortcut templates