Template:HSC

From Wikipedia, the free encyclopedia

[edit] Template documentation

Contents

[edit] Usage

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

[edit] Formal Usage

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

[edit] Examples

Template usage Equivalent wikicode Final result
{{HSC|Tarifa Jet|1997}} [[HSC Tarifa Jet (1997)|HSC ''Tarifa Jet'' (1997)]] HSC Tarifa Jet (1997)
{{HSC|Viking}} [[HSC Viking|HSC ''Viking'']] HSC Viking

Last example could be used to link to ship index (disambiguation) page

[edit] 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 HSC, 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
None all {{HSC|Tarifa Jet|1997}} [[HSC Tarifa Jet (1997) |HSC ''Tarifa Jet'' (1997)]] HSC Tarifa Jet (1997)
1 3rd {{HSC|Tarifa Jet|1997|1}} [[HSC Tarifa Jet (1997) |1997]] 1997
2 2nd {{HSC|Tarifa Jet|1997|2}} [[HSC Tarifa Jet (1997) |''Tarifa Jet'']] Tarifa Jet
3 2nd, 3rd {{HSC|Tarifa Jet|1997|3}} [[HSC Tarifa Jet (1997) |''Tarifa Jet'' (1997)]] Tarifa Jet (1997)
4 invalid result {{HSC|Tarifa Jet|1997|4}} [[HSC Tarifa Jet (1997) |Invalid Optional Parameter]] Invalid Optional Parameter
5 1st, 3rd {{HSC|Tarifa Jet|1997|5}} [[HSC Tarifa Jet (1997) |HSC (1997)]] HSC (1997)
6 1st, 2nd {{HSC|Tarifa Jet|1997|6}} [[HSC Tarifa Jet (1997) |HSC ''Tarifa Jet'']] HSC Tarifa Jet
2nd
(no 3rd)
{{HSC|Viking|3=2}}
Alternate usage: {{HSC|Viking||2}}
[[HSC Viking|''Viking'']] Viking

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

 {{HSC|Tarifa Jet|1997|6}} yields the same results as {{warship|HSC|Tarifa Jet|1997}}

[edit] See also

WP:SHIPS shortcut templates:

Class shortcuts
  • {{sclass}} – Shortcut for ship classes that are named for the lead ship
  • {{sclass2}} – Shortcut for ship classes that are named for a common theme


Ship prefix shortcuts
Dictionary of American Naval Fighting Ships (DANFS) templates