Template:GS/doc
 | This is a documentation subpage for Template:GS. It may contain usage information, categories and other content that is not part of the original template page. |
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)]]
|
GS U-39 (1938) |
{{GS|U-31}}
|
[[German submarine U-31|German submarine ''U-31'']]
|
GS 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. Its 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)]]
|
GS U-95 (1940) |
| 1 | 3rd | {{GS|U-95|1940|1}}
|
[[German submarine U-95 (1940) |1940]]
|
GS U-95 (1940) |
| 2 | 2nd | {{GS|U-95|1940|2}}
|
[[German submarine U-95 (1940) |''U-95'']]
|
GS U-95 (1940) |
| 3 | 2nd, 3rd | {{GS|U-95|1940|3}}
|
[[German submarine U-95 (1940) |''U-95'' (1940)]]
|
GS U-95 (1940) |
| 4 | invalid result | {{GS|U-95|1940|4}}
|
[[German submarine U-95 (1940) |Invalid Optional Parameter]]
|
GS U-95 (1940) |
| 5 | 1st, 3rd | {{GS|U-95|1940|5}}
|
[[German submarine U-95 (1940) |German submarine (1940)]]
|
GS U-95 (1940) |
| 6 | 1st, 2nd | {{GS|U-95|1940|6}}
|
[[German submarine U-95 (1940) |German submarine ''U-95'']]
|
GS U-95 (1940) |
| 2nd (no 3rd) |
{{GS|U-110|3=2}} Alternate usage: {{GS|U-110||2}}
|
[[German submarine U-110 |''U-110'']]
|
GS 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.
TemplateData
TemplateData
|
|---|
|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:GS in articles based on its TemplateData.
TemplateData for GS <templatedata> { "params": { "1": { "label": "Name", "description": "Ship's name", "example": "Bismarck, Belgrano", "type": "string" }, "2": { "label": "ID", "description": "Hull number, launch year, or pennant number", "example": "H75, 1975", "type": "string" }, "3": { "label": "Format", "description": "Formats the label (which name parts will show)", "example": "1, 2, 3, 5, 6", "type": "number", "default": "blank" }, "up": { "label": "unlink prefix", "description": "up=yes puts prefix before (outside of) the wikilink", "example": "up=yes", "default": "no", "type": "boolean" } }, "description": "This template provides a wikilink to a ship's page, with label options", "paramOrder": [ "1", "2", "3", "up" ] } </templatedata> |
See also
