View source for Template:HMS/doc

{{Documentation subpage}}
{{High-risk}}
{{lua|Module:WPSHIPS utilities}}

==Usage==
This is a typing shortcut for linking to ship articles of the [[Royal Navy]] named in the format 'HMS Gloucester (D96)'.  Since ship names are italicised in article text, and editors often don't want to include its [[pennant number]], linking to them in the usual manner means typing everything twice, such as <code><nowiki>[[HMS Gloucester (D96)|HMS ''Gloucester'']]</nowiki></code>.  This template halves that to <code><nowiki>{{HMS|Gloucester|D96|6}}</nowiki></code>.

===Basic usage===
:<nowiki>{{HMS|Ship name}}</nowiki>
:<nowiki>{{HMS|Ship name|ID}}</nowiki>: the optional ID can be the [[hull number]], [[pennant number]] or launch year as specified in the article title: <nowiki>[[HMS Ship name (ID)]]</nowiki>.
:<nowiki>{{HMS|Ship name|ID|6}}</nowiki>: the last code (e.g., '6') sets the formatting of the blue wikilink label.

;Examples
{|class=wikitable width=100%
|-style=background-color:#FCFCFC align=left
!template usage!!equivalent wiki-code!!final result
|-
|<code><nowiki>{{HMS|Illustrious|R06}}</nowiki></code>||<code><nowiki>[[HMS Illustrious (R06)|HMS ''Illustrious'' (R06)]]</nowiki></code>||{{HMS|Illustrious|R06}}
|-
|<code><nowiki>{{HMS|Raisonnable|1768}}</nowiki></code>||<code><nowiki>[[HMS Raisonnable (1768)|HMS ''Raisonnable'' (1768)]]</nowiki></code>||{{HMS|Raisonnable|1768}}
|-
|<code><nowiki>{{HMS|Victory}}</nowiki></code>||<code><nowiki>[[HMS Victory|HMS ''Victory'']]</nowiki></code>||{{HMS|Victory}}
|}
Last example could be used to link to ship index (disambiguation) page.

===Format options parameter===
A third, unnamed parameter {{Para|3}} allows setting which pieces of text are <u>displayed</u> in the rendered wikilink.  It sets the ''label'' in the link: <code><nowiki>[[targetpage|label]]</nowiki></code>.

For example, the ship's article is entered as <code><nowiki>{{HMS|Illustrious|R06}}</nowiki></code>, by default showing as {{HMS|Illustrious|R06}}.

But in your article, the pennant number (disambiguator) may not be needed to display.  In that case, add {{Para|4|2}}, and the result is:
:<code><nowiki>{{HMS</nowiki>|Illustrious|R06<span style=background:yellow>|2</span>}} <code><nowiki>[[HMS Illustrious (R06)|''Illustrious'']]</nowiki></code>  </code> &rarr; {{HMS|Illustrious|R06|2}}.

The options are:
{|class=wikitable width=100%
!value!!displayed!!template example!!equivalent wiki-code!!rendered display
|-same as default
!none
|style=text-align:center|prefix, name, ID
|<code><nowiki>{{HMS|Illustrious|R06}}</nowiki></code>
|<nowiki>[[HMS Illustrious (R06)|HMS ''Illustrious'' (R06)]]</nowiki>
|{{HMS|Illustrious|R06}}
|-
!1
|style=text-align:center|ID
|<code><nowiki>{{HMS|Illustrious|R06|1}}</nowiki></code>
|<nowiki>[[HMS Illustrious (R06)|R06]]</nowiki>
|{{HMS|Illustrious|R06|1}}
|-
!2
|style=text-align:center|name
|<code><nowiki>{{HMS|Illustrious|R06|2}}</nowiki></code>
|<nowiki>[[HMS Illustrious (R06)|''Illustrious'']]</nowiki>
|{{HMS|Illustrious|R06|2}}
|-
!3
|style=text-align:center|name, ID
|<code><nowiki>{{HMS|Illustrious|R06|3}}</nowiki></code>
|<nowiki>[[HMS Illustrious (R06)|''Illustrious'' (R06)]]</nowiki>
|{{HMS|Illustrious|R06|3}}
|-
!4
|style=text-align:center|invalid
|<code><nowiki>{{HMS|Illustrious|R06|4}}</nowiki></code>
|—
|{{HMS|Illustrious|R06|4|no-tracking=yes}}
|-
!5
|style=text-align:center|prefix, ID
|<code><nowiki>{{HMS|Illustrious|R06|5}}</nowiki></code>
|<nowiki>[[HMS Illustrious (R06)|HMS ''R06'']]</nowiki>
|{{HMS|Illustrious|R06|5}}
|-
!6
|style=text-align:center|prefix, name
|<code><nowiki>{{HMS|Illustrious|R06|6}}</nowiki></code>
|<nowiki>[[HMS Illustrious (R06)|HMS ''Illustrious'']]</nowiki>
|{{HMS|Illustrious|R06|6}}
|}

==TemplataData==
{{TemplateData header}}
<templatedata>{
"description": "This is a typing shortcut for linking to Royal Navy ship articles named in the format 'HMS Gloucester (D96)' (that is, the initial letters HMS, the ship's name, and its pennant number).  Since ship names are italicised in article text and editors often don't want to include the pennant number, linking to them in the usual manner means typing everything twice, such as [[HMS Gloucester (D96)|HMS ''Gloucester'']].  This template halves that to {{HMS|Gloucester|D96|6}}.  Note that this template cannot be used for ships which are not part of the Royal Navy.",
  "params": {
    "1": {
      "label": "Ship name",
      "description": "This parameter gives the name of this ship.",
      "default": "",
      "example": "Gloucester",
      "type": "string",
      "required": true
	},
    "2": {
      "label": "ID",
      "description": "This parameter gives the ship's hull number, pennant number, year of construction, or any other identifying information that will allow the ship to be distinguished from other ships of the same name.",
      "default": "",
      "example":"1774",
      "type": "string",
      "required": false
    },
    "3": {
      "label": "3",
      "description": "This is an optional parameter which sets out in bits the way the editor would like to display the name of the ship within an article.  If it is set to 1, the ship will be displayed only by its ID number (that is, but the entry given in parameter 2) without the prefix HMS and without the ship's name; if given as 2, it will give just the ship's name, in italics, without the HMS prefix nor the ID number; if given as 3, it will give the ship's name and its ID number, but not the HMS prefix; 4 is not a valid entry; if given as 5, it will give the HMS prefix and the ID number, but will drop the ship's name; if given as 6, it will give the prefix HMS and the ship's name but will drop the ID number.  If left blank, the ship will be displayed as HMS plus the ship's name plus its ID number.",
      "suggested": false,
      "default": "",
      "example": "5",
      "autovalue": "",
      "type": "number",
      "required": false
       }
    }
  }</templatedata>

==See also==
{{WPSHIPS shortcut templates}}

<includeonly>{{Sandbox other||

[[Category:Ship prefix templates]]
}}</includeonly>