Difference between revisions of "Template:HMS/doc"
imported>DePiep |
imported>Trappist the monk |
||
| Line 94: | Line 94: | ||
<templatedata>{ | <templatedata>{ | ||
| − | "description": "This is a typing short cut for linking to | + | "description": "This is a typing short cut 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 italicized 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": { | "params": { | ||
"1": { | "1": { | ||
| Line 102: | Line 102: | ||
"default": "", | "default": "", | ||
"required": true, | "required": true, | ||
| − | "example": " | + | "example": "Glouscester" |
}, | }, | ||
"2": { | "2": { | ||
| Line 110: | Line 110: | ||
"default": "", | "default": "", | ||
"type": "string", | "type": "string", | ||
| − | "example":" | + | "example":"1774" |
}, | }, | ||
"3": { | "3": { | ||
"label": "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 | + | "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.", |
"required": false, | "required": false, | ||
"suggested": false, | "suggested": false, | ||
Revision as of 12:45, 28 February 2018
| This is a documentation subpage for Template:HMS. It contains usage information, categories and other content that is not part of the original template page. |
Contents
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, 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}}.
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]] | HMS Illustrious (R06) | |
| 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}}
TemplataData section
Syntax error in JSON.
See also
Template:WPSHIPS shortcut templates