Template:HMIS/doc

From blackwiki
Jump to navigation Jump to search

Usage

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

Formal usage

  • {{HMIS|Ship Name}}
  • {{HMIS|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
{{HMIS|Endeavour|A11}} [[HMIS Endeavour (A11)|HMIS ''Endeavour'' (A11)]] HMIS Endeavour (A11)
{{HMIS|Hawea|1975}} [[HMIS Hawea (1975)|HMIS ''Hawea'' (1975)]] HMIS Hawea (1975)
{{HMIS|Charles Upham}} [[HMIS Charles Upham|HMIS ''Charles Upham'']] HMIS 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 "HMIS", 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 {{HMIS|Endeavour|I91|1}} [[HMIS Endeavour (I91)|I91]] I91
2 2nd {{HMIS|Endeavour|I91|2}} [[HMIS Endeavour (I91)|''Endeavour'']] Endeavour
3 2nd, 3rd {{HMIS|Endeavour|I91|3}} [[HMIS Endeavour (I91)|''Endeavour'' I91]] Endeavour (I91)
4 invalid result {{HMIS|Endeavour|I91|4}} [[HMIS Endeavour (I91)|Invalid Optional Parameter]] HMIS Endeavour (I91)
5 1st, 3rd {{HMIS|Endeavour|I91|5}} [[HMIS Endeavour (I91)|HMS I91]] HMIS I91
6 1st, 2nd {{HMIS|Endeavour|I91|6}} [[HMIS Endeavour (I91)|HMS ''Endeavour'']] HMIS Endeavour
2nd
(no 3rd)
{{HMIS|Charles Uphamr|3=2}} Alternate usage: {{HMIS|Charles Upham||2}} [[HMIS 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.

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

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for HMIS

This template provides a wikilink to a ship's page, with label options

Template parameters

ParameterDescriptionTypeStatus
Prefix1

Fleet identifier

Example
HMS, Japanese battleship
Stringoptional
Name2

Ship's name

Example
Bismarck, Belgrano
Stringoptional
ID3

Hull number, launch year, or pennanr number

Example
H75, 1975,
Stringoptional
Format4

Formats label (parts showing)

Default
blank
Example
1, 2, 3, 5, 6
Numberoptional
unlink prefixup

yes=puts Fleet ID outside of Wikilink

Default
no
Example
up=yes
Booleanoptional

See also

Template:WPSHIPS shortcut templates