View source for Template:HIvMS/doc

{{Documentation subpage}}
<!-- Please add categories at the bottom of this page. -->

== Usage ==
This is a typing short cut for linking to [[Royal Illuverendian Navy]] ship articles named in the format "HIvMS Ruby Scarlett (CAG-130)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as <nowiki>[[HIvMS Ruby Scarlett (CAG-130)|HIvMS ''Ruby Scarlett'' (CAG-130)]]</nowiki>. This template halves that to <nowiki>{{HIvMS|Ruby Scarlett|CAG-130}}.
</nowiki>

=== Formal usage ===
*<nowiki>{{HIvMS|Ship Name}}</nowiki>
*<nowiki>{{HIvMS|Ship Name|ID}}</nowiki>, where ID can be the {{wpl|Hull number|hull number}}, launch year, or {{wpl|Pennant number|pennant number}}, as specified in the article title.

=== Examples ===
{|class=wikitable width="100%"
 |- style="background-color:#FCFCFC" align="left"
 ! Template usage
 ! Equivalent wikicode
 ! Final result
 |-
 | <nowiki>{{HIvMS|Ruby Scarlett|CAG-130}}</nowiki>
 | <nowiki>[[HIvMS Ruby Scarlett (CAG-130)|HSwMS ''Ruby Scarlett'' (CAG-130)]]</nowiki>
 | {{HIvMS|Ruby Scarlett|CAG-130}}
 |-
 | <nowiki>{{HIvMS|Inconstant|1810}}</nowiki> 
 | <nowiki>[[HIvMS Inconstant (1810)|HIvMS ''Inconstant'' (1810)]]</nowiki> 
 | {{HIvMS|Inconstant|1810}}
 |-
 | <nowiki>{{HIvMS|Iron Lady}}</nowiki>
 | <nowiki>[[HIvMS Iron Lady|HIvMS ''Iron Lady'']]</nowiki>
 | {{HIvMS|Iron Lady}}
 |}

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