Template:HNLMS/doc: Difference between revisions
m Add TemplateData (via WP:JWB) |
m set categorisation to sandbox/other (via WP:JWB) |
||
Line 146: | Line 146: | ||
{{WPSHIPS shortcut templates}} |
{{WPSHIPS shortcut templates}} |
||
<includeonly> |
<includeonly>{{sandbox other|| |
||
[[Category:Ship templates|HNLMS]] |
[[Category:Ship templates|HNLMS]] |
||
⚫ | |||
⚫ |
Revision as of 19:11, 28 February 2018
This is a documentation subpage for Template:HNLMS. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
This is a typing short cut for linking to Royal Netherlands Navy ship articles named in the format "HNLMS Deep Six (A000)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HNLMS Deep Six (A000)|HNLMS ''Deep Six'' (A000)]]. This template halves that to {{HNLMS|Deep Six|A000}}.
Formal Usage
{{HNLMS|Ship Name}}
{{HNLMS|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 |
---|---|---|
{{HNLMS|De Zeven Provinciën|C802}} | [[HNLMS De Zeven Provinciën (C802)|HNLMS ''De Zeven Provinciën'' (C802)]] | HNLMS De Zeven Provinciën (C802) |
{{HNLMS|De Ruyter|1935}} | [[HNLMS De Ruyter (1935)|HNLMS ''De Ruyter'' (1935)]] | HNLMS De Ruyter (1935) |
{{HNLMS|De Ruyter}} | [[HNLMS De Ruyter|HNLMS ''De Ruyter'']] | HNLMS De Ruyter |
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 HNLMS, 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 | {{HNLMS|De Ruyter|F804}} | [[HNLMS De Ruyter (F804)|HNLMS ''De Ruyter'' (F804)]] | HNLMS De Ruyter (F804) |
1 | 3rd | {{HNLMS|De Ruyter|F804|1}} | [[HNLMS De Ruyter (F804)|F804]] | F804 |
2 | 2nd | {{HNLMS|De Ruyter|F804|2}} | [[HNLMS De Ruyter (F804)|''De Ruyter'']] | De Ruyter |
3 | 2nd, 3rd | {{HNLMS|De Ruyter|F804|3}} | [[HNLMS De Ruyter (F804)|''De Ruyter'' (F804)]] | De Ruyter (F804) |
4 | invalid result | {{HNLMS|De Ruyter|F804|4}} | [[HNLMS De Ruyter (F804)|Invalid Optional Parameter]] | Error: {{HNLMS}} invalid control parameter: 4 (help) |
5 | 1st, 3rd | {{HNLMS|De Ruyter|F804|5}} | [[HNLMS De Ruyter (F804)|HNLMS (F804)]] | HNLMS F804 |
6 | 1st, 2nd | {{HNLMS|De Ruyter|F804|6}} | [[HNLMS De Ruyter (F804)|HNLMS ''De Ruyter'']] | HNLMS De Ruyter |
2nd (no 3rd) |
{{HNLMS|De Ruyter|3=2}} Alternate usage: >{{HNLMS|De Ruyter||2}} |
[[HNLMS De Ruyter|''Du Ruyter'']] | De Ruyter |
N.B.: Be careful with the third parameter if not using the second parameter. In the last De Ruyter 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.
{{HNLMS|De Ruyter|F804|6}} yields the same results as {{warship|HNLMS|De Ruyter|F804}}
Template data
TemplateData for HNLMS
This template provides a wikilink to a ship's page, with label options
Parameter | Description | Type | Status | |
---|---|---|---|---|
Prefix | 1 | Fleet identifier
| String | optional |
Name | 2 | Ship's name
| String | optional |
ID | 3 | Hull number, launch year, or pennanr number
| String | optional |
Format | 4 | Formats label (parts showing)
| Number | optional |
unlink prefix | up | yes=puts Fleet ID outside of Wikilink
| Boolean | optional |
See also