Template:GS/doc
{{#invoke:Message box|mbox}}
Usage
This is a typing short cut for linking to World War II and later German U-boat articles named in the format "German submarine U-9999 (1939)". (World War I U-boats articles are named in a different manner. See Template:SMU for the shortcut template to assist with those.) Since U-boat names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[German submarine U-9999 (1939)|German submarine ''U-9999'' (1939)]]. This template more than halves that to {{GS|U-9999|1939}}.
Formal Usage
- {{GS|Ship Name}}
- {{GS|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 |
|---|---|---|
| {{GS|U-39|1938}} | [[German submarine U-39 (1938)|German submarine ''U-39'' (1938)]] | German submarine U-39 (1938) |
| {{GS|U-31}} | [[German submarine U-31|German submarine ''U-31'']] | German submarine U-31 |
The 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 German submarine, 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 | {{GS|U-95|1940}} | [[German submarine U-95 (1940) |German submarine ''U-95'' (1940)]] | German submarine U-95 (1940) |
| 1 | 3rd | {{GS|U-95|1940|1}} | [[German submarine U-95 (1940) |1940]] | 1940 |
| 2 | 2nd | {{GS|U-95|1940|2}} | [[German submarine U-95 (1940) |''U-95'']] | U-95 |
| 3 | 2nd, 3rd | {{GS|U-95|1940|3}} | [[German submarine U-95 (1940) |''U-95'' (1940)]] | U-95 (1940) |
| 4 | invalid result | {{GS|U-95|1940|4}} | [[German submarine U-95 (1940) |Invalid Optional Parameter]] | Invalid Optional Parameter |
| 5 | 1st, 3rd | {{GS|U-95|1940|5}} | [[German submarine U-95 (1940) |German submarine (1940)]] | German submarine (1940) |
| 6 | 1st, 2nd | {{GS|U-95|1940|6}} | [[German submarine U-95 (1940) |German submarine ''U-95'']] | German submarine U-95 |
| 2nd (no 3rd) |
{{GS|U-110|3=2}} Alternate usage: {{GS|U-110||2}} |
[[German submarine U-110 |''U-110'']] | U-110 |
N.B.: Be careful with the third parameter if not using the second parameter. In the U-110 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.
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{{RV}}—Research vessel 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)