Difference between revisions of "Template:HMQS/doc"
imported>The Bushranger (→Examples: change) |
imported>DePiep m (TemplateData: use central template form for all prefix ship templates (via WP:JWB)) |
||
| (6 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
| − | <!-- | + | <!-- Please add categories at the bottom of this page. --> |
| − | |||
== Usage == | == Usage == | ||
| Line 20: | Line 19: | ||
| <nowiki>{{HMQS|Gayundah}}</nowiki> | | <nowiki>{{HMQS|Gayundah}}</nowiki> | ||
| <nowiki>[[HMQS Gayundah|HMQS ''Gayundah'']]</nowiki> | | <nowiki>[[HMQS Gayundah|HMQS ''Gayundah'']]</nowiki> | ||
| − | | {{ | + | | {{HMQS|Gayundah}} |
|} | |} | ||
| Line 26: | Line 25: | ||
=== Optional display control parameter === | === Optional display control parameter === | ||
| − | There is an optional third parameter that controls which pieces of text are displayed in the article. | + | 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 "HMVS", 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: |
{|class=wikitable width="100%" | {|class=wikitable width="100%" | ||
! Value | ! Value | ||
| Line 35: | Line 34: | ||
|- | |- | ||
! 1 | ! 1 | ||
| − | | align | + | | style="text-align:center;" | 3rd |
| colspan=2 | <nowiki>{{HMVS|Victoria|1855|1}}</nowiki> | | colspan=2 | <nowiki>{{HMVS|Victoria|1855|1}}</nowiki> | ||
| <nowiki>[[HMVS Victoria (1855)|1855]]</nowiki> | | <nowiki>[[HMVS Victoria (1855)|1855]]</nowiki> | ||
| Line 41: | Line 40: | ||
|- | |- | ||
! 2 | ! 2 | ||
| − | | align | + | | style="text-align:center;" | 2nd |
| colspan=2 | <nowiki>{{HMVS|Victoria|1855|2}</nowiki>} | | colspan=2 | <nowiki>{{HMVS|Victoria|1855|2}</nowiki>} | ||
| <nowiki>[[HMVS Victoria (1855)|''Victoria'']]</nowiki> | | <nowiki>[[HMVS Victoria (1855)|''Victoria'']]</nowiki> | ||
| Line 47: | Line 46: | ||
|- | |- | ||
! 3 | ! 3 | ||
| − | | align | + | | style="text-align:center;" | 2nd, 3rd |
| colspan=2 | <nowiki>{{HMVS|Victoria|1855|3}}</nowiki> | | colspan=2 | <nowiki>{{HMVS|Victoria|1855|3}}</nowiki> | ||
| <nowiki>[[HMVS Victoria (1855)|''Victoria'' 1855]]</nowiki> | | <nowiki>[[HMVS Victoria (1855)|''Victoria'' 1855]]</nowiki> | ||
| Line 53: | Line 52: | ||
|- | |- | ||
! 4 | ! 4 | ||
| − | | align | + | | style="text-align:center;" | invalid result |
| colspan=2 | <nowiki>{{HMVS|Victoria|1855|4}}</nowiki> | | colspan=2 | <nowiki>{{HMVS|Victoria|1855|4}}</nowiki> | ||
| <nowiki>[[HMVS Victoria (1855)|Invalid Optional Parameter]]</nowiki> | | <nowiki>[[HMVS Victoria (1855)|Invalid Optional Parameter]]</nowiki> | ||
| Line 59: | Line 58: | ||
|- | |- | ||
! 5 | ! 5 | ||
| − | | align | + | | style="text-align:center;" | 1st, 3rd |
| colspan=2 | <nowiki>{{HMVS|Victoria|1855|5}}</nowiki> | | colspan=2 | <nowiki>{{HMVS|Victoria|1855|5}}</nowiki> | ||
| <nowiki>[[HMVS Victoria (1855)|HMVS 1855]]</nowiki> | | <nowiki>[[HMVS Victoria (1855)|HMVS 1855]]</nowiki> | ||
| Line 65: | Line 64: | ||
|- | |- | ||
! 6 | ! 6 | ||
| − | | align | + | | style="text-align:center;" | 1st, 2nd |
| colspan=2 | <nowiki>{{HMVS|Victoria|1855|6}}</nowiki> | | colspan=2 | <nowiki>{{HMVS|Victoria|1855|6}}</nowiki> | ||
| <nowiki>[[HMVS Victoria (1855)|HMVS ''Victoria'']]</nowiki> | | <nowiki>[[HMVS Victoria (1855)|HMVS ''Victoria'']]</nowiki> | ||
| Line 71: | Line 70: | ||
|- | |- | ||
! | ! | ||
| − | | align | + | | style="text-align:center;" | 2nd<br><small>(no 3rd)</small> |
| <nowiki>{{HMVS|Gordon|3=2}}</nowiki> | | <nowiki>{{HMVS|Gordon|3=2}}</nowiki> | ||
| <nowiki>Alternate usage: {{HMVS|Gordon||2}}</nowiki> | | <nowiki>Alternate usage: {{HMVS|Gordon||2}}</nowiki> | ||
| Line 82: | Line 81: | ||
*<nowiki>{{HMVS|Victoria|1855|6}} yields the same results as {{warship|HMVS|Victoria|1855}}</nowiki> | *<nowiki>{{HMVS|Victoria|1855|6}} yields the same results as {{warship|HMVS|Victoria|1855}}</nowiki> | ||
| + | |||
| + | == TemplateData == | ||
| + | {{Template:Ship/doc/fixed prefix: TemplateData}} | ||
== See also == | == See also == | ||
{{WPSHIPS shortcut templates}} | {{WPSHIPS shortcut templates}} | ||
| − | <includeonly> | + | <includeonly>{{sandbox other|| |
| − | + | [[Category:Ship prefix templates]] | |
| − | + | }}</includeonly> | |
| − | |||
| − | [[Category:Ship templates]] | ||
| − | |||
| − | |||
| − | </includeonly> | ||
Latest revision as of 17:42, 19 March 2018
| This is a documentation subpage for Template:HMQS. 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 Queensland Maritime Defence Force ship articles named in the format "HMVS Victoria (1855)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HMVS Victoria (1855)|HMVS ''Victoria'' (1855)]]. This template halves that to {{HMVS|Victoria|1855}}.
Formal usage
- {{HMQS|Ship Name}}
- {{HMQS|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 |
|---|---|---|
| {{HMQS|Gayundah}} | [[HMQS Gayundah|HMQS ''Gayundah'']] | HMQS Gayundah |
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 "HMVS", 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 | {{HMVS|Victoria|1855|1}} | [[HMVS Victoria (1855)|1855]] | 1855 | |
| 2 | 2nd | {{HMVS|Victoria|1855|2}} | [[HMVS Victoria (1855)|''Victoria'']] | Victoria | |
| 3 | 2nd, 3rd | {{HMVS|Victoria|1855|3}} | [[HMVS Victoria (1855)|''Victoria'' 1855]] | Victoria (1855) | |
| 4 | invalid result | {{HMVS|Victoria|1855|4}} | [[HMVS Victoria (1855)|Invalid Optional Parameter]] | HMVS Victoria (1855) | |
| 5 | 1st, 3rd | {{HMVS|Victoria|1855|5}} | [[HMVS Victoria (1855)|HMVS 1855]] | HMVS 1855 | |
| 6 | 1st, 2nd | {{HMVS|Victoria|1855|6}} | [[HMVS Victoria (1855)|HMVS ''Victoria'']] | HMVS Victoria | |
| 2nd (no 3rd) |
{{HMVS|Gordon|3=2}} | Alternate usage: {{HMVS|Gordon||2}} | [[HMVS Gordon|''Gordon'']] | Gordon | |
N.B.: Be careful with the third parameter if not using the second parameter. In the Gordon 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.
- {{HMVS|Victoria|1855|6}} yields the same results as {{warship|HMVS|Victoria|1855}}
TemplateData
Template:Ship/doc/fixed prefix: TemplateData
See also
Template:WPSHIPS shortcut templates