Template:HMS

From Wiki
Revision as of 23:43, 1 February 2014 by AlexNik (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
50px Template documentation[view] [edit] [history] [purge]


Usage

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

Formal usage

{{HMS|Ship Name}}
{{HMS|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
{{HMS|Illustrious|R06}} [[HMS Illustrious (R06)|HMS ''Illustrious'' (R06)]] HMS Illustrious (R06)
{{HMS|Raisonnable|1768}} [[HMS Raisonnable (1768)|HMS ''Raisonnable'' (1768)]] HMS Raisonnable (1768)
{{HMS|Victory}} [[HMS Victory|HMS ''Victory'']] HMS Victory

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

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

 {{HMS|Illustrious|R06|6}} yields the same results as {{warship|HMS|Illustrious|R06}}

See also

WP:SHIPS shortcut templates:

Ship class article shortcuts
  • For articles about ship classes named for a member of the class:
    {{sclass}}—article titles that are not hyphenated
    {{sclass-}}—article titles that are hyphenated
  • For articles about ship classes named for a common theme:
    {{sclass2}}—article titles that are not hyphenated
    {{sclass2-}}—article titles that are hyphenated
Ship prefix shortcuts
  • Generic ship prefixes
  • Commonwealth ship prefixes
  • United States ship prefixes
  • Other navies' prefixes
Dictionary of American Naval Fighting Ships (DANFS) templates
Measurement shortcut templates
sv:Mall:HMS