ಟೆಂಪ್ಲೇಟು:HMCS/doc
 | This is a documentation subpage for ಟೆಂಪ್ಲೇಟು:HMCS It may contain usage information, categories and other content that is not part of the original ಟೆಂಪ್ಲೇಟು page. |
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. It's 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]] | Invalid Optional Parameter | |
| 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}}
See also
[ಬದಲಾಯಿಸಿ]WP:SHIPS shortcut templates:
- Ship class article shortcuts
- For articles about ship classes named for a member of the class:
- For articles about ship classes named for a common theme:
- Ship prefix shortcuts
- Generic ship prefixes
{{barge}}—barge articles{{GTS}}—Gas Turbine Ship articles{{HSC}}—High Speed Craft articles{{MS}}—Motor ship articles{{MV}}—Merchant vessel (or "Motor vessel") articles{{MY}}—Motor yacht articles{{SV}}—Sailing vessel articles{{PS}}—Paddle steamer articles{{ship}}—Non–prefixed ship articles{{SS}}—Steam Ship articles{{tugboat}}—tugboat articles
- Commonwealth ship prefixes
{{HMS}}—Royal Navy ships{{HMT}}—Royal Navy trawlers{{HMAS}}—Royal Australian Navy ships{{HMBS}}—Royal Bahamas Defence Force ships{{HMCS}}—Royal Canadian Navy ships{{HMNZS}}—Royal New Zealand Navy ships{{HMQS}}—Queensland Maritime Defence Force ships{{HMVS}}—Victorian Naval Forces ships{{RMS}}—Royal Mail Ships{{INS}}—Indian Navy ships{{SAS}}—South African Navy ships
- United States ship prefixes
{{USAT}}—United States Army Transport articles{{USCGC}}—United States Coast Guard Cutter articles{{USNS}}—United States Naval Ship articles{{USRC}}—United States Revenue Cutter Service articles{{USS}}—United States Navy ship articles
- Other navies' prefixes
{{SMS}}—Imperial German Navy and Austro-Hungarian Navy ships{{SMU}}—Imperial German Navy and Austro-Hungarian Navy U-boats{{GS}}—World War II and later U-boats{{Jsub}}—Imperial Japanese Navy submarines{{JDS}}—Japanese Maritime Self-Defense Force ships (older){{JS}}—Japan Maritime Self-Defense Force ships (newer){{HNLMS}}—Royal Netherlands Navy ships{{HNoMS}}—Royal Norwegian Navy ships{{HSwMS}}—Swedish Navy ships{{RPS}}—older Philippine Navy ships{{BRP}}—newer Philippine Navy ships{{ORP}}—Polish Navy ships{{LÉ}}—Irish Navy ships{{TCG}}—Turkish Navy ships
- Dictionary of American Naval Fighting Ships (DANFS) templates
{{DANFS}}—public domain attribution notice{{Cite DANFS}}—DANFS material citation
- Measurement shortcut templates
{{GT}}—gross tonnage{{NetT}}—net tonnage{{GRT}}—gross register tonnage{{NRT}}—net register tonnage{{TEU}}—twenty-foot equivalent units{{DWT}}—deadweight tonnage{{Displacement}}—displacement (ships)