Difference between revisions of "Template:HMCS/doc"
imported>WOSlinker (change cat) |
imported>Chris the speller m (en dashes) |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
| − | |||
== Usage == | == Usage == | ||
| − | This is a typing short cut for linking to [[Canadian Forces Maritime Command]] ( | + | This is a typing short cut for linking to [[Canadian Forces Maritime Command]] (1968–present) and [[Royal Canadian Navy]] (1910–1968) ship articles named in the format "HMCS Toronto (FFH 333)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as <nowiki>[[HMCS Toronto (FFH 333)|HMCS ''Toronto'' (FFH 333)]]</nowiki>. This template halves that to <nowiki>{{HMCS|Toronto|FFH 333}}. |
</nowiki> | </nowiki> | ||
| Line 34: | Line 33: | ||
=== 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 "HMCS", 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 43: | Line 42: | ||
|- | |- | ||
! 1 | ! 1 | ||
| − | | align | + | | style="text-align:center;" | 3rd |
| colspan=2 | <nowiki>{{HMCS|Bonaventure|CVL 22|1}}</nowiki> | | colspan=2 | <nowiki>{{HMCS|Bonaventure|CVL 22|1}}</nowiki> | ||
| <nowiki>[[HMCS Bonaventure (CVL 22)|CVL 22]]</nowiki> | | <nowiki>[[HMCS Bonaventure (CVL 22)|CVL 22]]</nowiki> | ||
| Line 49: | Line 48: | ||
|- | |- | ||
! 2 | ! 2 | ||
| − | | align | + | | style="text-align:center;" | 2nd |
| colspan=2 | <nowiki>{{HMCS|Bonaventure|CVL 22|2}</nowiki>} | | colspan=2 | <nowiki>{{HMCS|Bonaventure|CVL 22|2}</nowiki>} | ||
| <nowiki>[[HMCS Bonaventure (CVL 22)|''Bonaventure'']]</nowiki> | | <nowiki>[[HMCS Bonaventure (CVL 22)|''Bonaventure'']]</nowiki> | ||
| Line 55: | Line 54: | ||
|- | |- | ||
! 3 | ! 3 | ||
| − | | align | + | | style="text-align:center;" | 2nd, 3rd |
| colspan=2 | <nowiki>{{HMCS|Bonaventure|CVL 22|3}}</nowiki> | | colspan=2 | <nowiki>{{HMCS|Bonaventure|CVL 22|3}}</nowiki> | ||
| <nowiki>[[HMCS Bonaventure (CVL 22)|''Bonaventure'' CVL 22]]</nowiki> | | <nowiki>[[HMCS Bonaventure (CVL 22)|''Bonaventure'' CVL 22]]</nowiki> | ||
| Line 61: | Line 60: | ||
|- | |- | ||
! 4 | ! 4 | ||
| − | | align | + | | style="text-align:center;" | invalid result |
| colspan=2 | <nowiki>{{HMCS|Bonaventure|CVL 22|4}}</nowiki> | | colspan=2 | <nowiki>{{HMCS|Bonaventure|CVL 22|4}}</nowiki> | ||
| <nowiki>[[HMCS Bonaventure (CVL 22)|Invalid Optional Parameter]]</nowiki> | | <nowiki>[[HMCS Bonaventure (CVL 22)|Invalid Optional Parameter]]</nowiki> | ||
| Line 67: | Line 66: | ||
|- | |- | ||
! 5 | ! 5 | ||
| − | | align | + | | style="text-align:center;" | 1st, 3rd |
| colspan=2 | <nowiki>{{HMCS|Bonaventure|CVL 22|5}}</nowiki> | | colspan=2 | <nowiki>{{HMCS|Bonaventure|CVL 22|5}}</nowiki> | ||
| <nowiki>[[HMCS Bonaventure (CVL 22)|HMCS CVL 22]]</nowiki> | | <nowiki>[[HMCS Bonaventure (CVL 22)|HMCS CVL 22]]</nowiki> | ||
| Line 73: | Line 72: | ||
|- | |- | ||
! 6 | ! 6 | ||
| − | | align | + | | style="text-align:center;" | 1st, 2nd |
| colspan=2 | <nowiki>{{HMCS|Bonaventure|CVL 22|6}}</nowiki> | | colspan=2 | <nowiki>{{HMCS|Bonaventure|CVL 22|6}}</nowiki> | ||
| <nowiki>[[HMCS Bonaventure (CVL 22)|HMCS ''Bonaventure'']]</nowiki> | | <nowiki>[[HMCS Bonaventure (CVL 22)|HMCS ''Bonaventure'']]</nowiki> | ||
| Line 79: | Line 78: | ||
|- | |- | ||
! | ! | ||
| − | | align | + | | style="text-align:center;" | 2nd<br><small>(no 3rd)</small> |
| <nowiki>{{HMCS|Athabaskan|3=2}}</nowiki> | | <nowiki>{{HMCS|Athabaskan|3=2}}</nowiki> | ||
| <nowiki>Alternate usage: {{HMCS|Athabaskan||2}}</nowiki> | | <nowiki>Alternate usage: {{HMCS|Athabaskan||2}}</nowiki> | ||
| Line 90: | Line 89: | ||
<nowiki>{{HMCS|Bonaventure|CVL 22|6}} yields the same results as {{warship|HMCS|Bonaventure|CVL 22}}</nowiki> | <nowiki>{{HMCS|Bonaventure|CVL 22|6}} yields the same results as {{warship|HMCS|Bonaventure|CVL 22}}</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 01:07, 9 July 2018
| This is a documentation subpage for Template:HMCS. 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 Canadian Forces Maritime Command (1968–present) and Royal Canadian Navy (1910–1968) ship articles named in the format "HMCS Toronto (FFH 333)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HMCS Toronto (FFH 333)|HMCS ''Toronto'' (FFH 333)]]. This template halves that to {{HMCS|Toronto|FFH 333}}.
Formal usage
- {{HMCS|Ship Name}}
- {{HMCS|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 |
|---|---|---|
| {{HMCS|Bonaventure|CVL 22}} | [[HMCS Bonaventure (CVL 22)|HMCS ''Bonaventure'' (CVL 22)]] | HMCS Bonaventure (CVL 22) |
| {{HMCS|Rainbow|1910}} | [[HMCS Rainbow (1910)|HMS ''Rainbow'' (1910)]] | HMCS Rainbow (1910) |
| {{HMCS|Athabaskan}} | [[HMCS Athabaskan|HMCS ''Athabaskan'']] | HMCS Athabaskan |
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 "HMCS", 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);br>displayed | Example | Equivalent wikicode | Final result | |
|---|---|---|---|---|---|
| 1 | 3rd | {{HMCS|Bonaventure|CVL 22|1}} | [[HMCS Bonaventure (CVL 22)|CVL 22]] | CVL 22 | |
| 2 | 2nd | {{HMCS|Bonaventure|CVL 22|2}} | [[HMCS Bonaventure (CVL 22)|''Bonaventure'']] | Bonaventure | |
| 3 | 2nd, 3rd | {{HMCS|Bonaventure|CVL 22|3}} | [[HMCS Bonaventure (CVL 22)|''Bonaventure'' CVL 22]] | Bonaventure (CVL 22) | |
| 4 | invalid result | {{HMCS|Bonaventure|CVL 22|4}} | [[HMCS Bonaventure (CVL 22)|Invalid Optional Parameter]] | HMCS Bonaventure (CVL 22) | |
| 5 | 1st, 3rd | {{HMCS|Bonaventure|CVL 22|5}} | [[HMCS Bonaventure (CVL 22)|HMCS CVL 22]] | HMCS CVL 22 | |
| 6 | 1st, 2nd | {{HMCS|Bonaventure|CVL 22|6}} | [[HMCS Bonaventure (CVL 22)|HMCS ''Bonaventure'']] | HMCS Bonaventure | |
| 2nd (no 3rd) |
{{HMCS|Athabaskan|3=2}} | Alternate usage: {{HMCS|Athabaskan||2}} | [[HMCS Athabaskan|''Athabaskan'']] | Athabaskan | |
N.B.: Be careful with the third parameter if not using the second parameter. In the Athabaskan 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.
{{HMCS|Bonaventure|CVL 22|6}} yields the same results as {{warship|HMCS|Bonaventure|CVL 22}}
TemplateData
Template:Ship/doc/fixed prefix: TemplateData
See also
Template:WPSHIPS shortcut templates