ទំព័រគំរូ:Ship/doc
 | This is a documentation subpage for ទំព័រគំរូ:Ship. 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 ship articles named in the format "Russian battleship Petropavlovsk (1914)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[Russian battleship Petropavlovsk (1914)|Russian battleship ''Petropavlovsk'']]. This template approximately halves that to {{ship|Russian battleship|Petropavlovsk|1914}}.
Formal usage
កែប្រែ {{ship|Ship Name}}
{{ship|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 |
|---|---|---|
| {{ship|ARA|General Belgrano}} | [[ARA General Belgrano|ARA ''General Belgrano'']] | ARA General Belgrano |
| {{ship|HMCS|Kootenay|H75}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] | HMCS Kootenay (H75) |
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 USS, 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 | {{ship|HMCS|Kootenay|H75}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] | HMCS Kootenay (H75) | |
| 1 | 3rd | {{ship|HMCS|Kootenay|H75|1}} | [[HMCS Kootenay (H75)|H75]] | H75 | |
| 2 | 2nd | {{ship|HMCS|Kootenay|H75|2}}} | [[HMCS Kootenay (H75)|''Kootenay'']] | Kootenay | |
| 3 | 2nd, 3rd | {{ship|HMCS|Kootenay|H75|3}}} | [[HMCS Kootenay (H75)|''Kootenay'' (H75)]] | Kootenay (H75) | |
| 4 | invalid result | {{ship|HMCS|Kootenay|H75|4}}} | [[HMCS Kootenay (H75)|Invalid Optional Parameter]] | Invalid Optional Parameter | |
| 5 | 1st, 3rd | {{ship|HMCS|Kootenay|H75|5}}} | [[HMCS Kootenay (H75)|HMCS (H75)]] | HMCS (H75) | |
| 6 | 1st, 2nd | {{ship|HMCS|Kootenay|H75|6}}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'']] | HMCS Kootenay | |
| 2nd (no 3rd) |
{{ship|Japanese battleship|Yamato|4=2}} | Alternate usage: {{ship|Japanese battleship|Yamato||2}} | [[Japanese battleship Yamato|''Yamato'']] | Yamato | |
N.B.: Be careful with the third parameter if not using the second parameter. In the Yamato example above, the "|4=2" means set the fourth parameter to a value of two, while the alternate syntax shows using a pair of pipes, "||2", to position the value two in the fourth parameter position.
Optional prefix parameter
កែប្រែThe parameter up (for unlinked prefix) can be used to have an unlinked prefix. When set to "yes", the template will display the prefix before the wikilink. This should be used with one of the optional display parameters above. (If not, it will result in a doubling of the prefix.)
- Examples
{{ship|Japanese battleship|Yamato||2|up=yes}}
displays as:
- Japanese battleship Yamato
Using without one of the optional display parameters:
{{ship|Japanese battleship|Yamato|up=yes}}
gives this:
- Japanese battleship Japanese battleship Yamato
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)