Template:USAT/doc
 | This is a documentation subpage for Template:USAT. 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 steamship articles named in the format "USAT Shipname (Year)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[USAT Shipname (Year)|USAT ''Shipname'' (Year)]]. This template halves that to {{USAT|Shipname|Year}}. The U.S. Army Transport prefix was not applied to the majority of Army vessels and should be applied only to those vessels, large troop or cargo vessels, owned, long term bareboat chartered and some other vessels. Tugs, specialized craft and the coastal transports (FS and such) were simply U.S. Army (#/name).
Formal Usage
{{USAT|Ship Name}}{{USAT|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 |
|---|---|---|
{{USAT|Havana|1917}}
|
[[USAT Havana (1917)|USAT ''Havana'' (1917)]]
|
USAT Havana (1917) |
{{USAT|Meigs}}
|
[[USAT Meigs|USAT ''Meigs'']]
|
USAT Meigs |
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 USAT, 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 | {{USAT|Havana|1917}}
|
[[USAT Havana (1917) |USAT ''Havana'' (1917)]]
|
USAT Havana (1917) |
| 1 | 3rd | {{USAT|Havana|1917|1}}
|
[[USAT Havana (1917) |1917]]
|
USAT Havana (1917) |
| 2 | 2nd | {{USAT|Havana|1917|2}}
|
[[USAT Havana (1917) |''Havana'']]
|
USAT Havana (1917) |
| 3 | 2nd, 3rd | {{USAT|Havana|1917|3}}
|
[[USAT Havana (1917) |''Havana'' (1917)]]
|
USAT Havana (1917) |
| 4 | invalid result | {{USAT|Havana|1917|4}}
|
[[USAT Havana (1917) |Invalid Optional Parameter]]
|
USAT Havana (1917) |
| 5 | 1st, 3rd | {{USAT|Havana|1917|5}}
|
[[USAT Havana (1917) |USAT (1917)]]
|
USAT Havana (1917) |
| 6 | 1st, 2nd | {{USAT|Havana|1917|6}}
|
[[USAT Havana (1917) |USAT ''Havana'']]
|
USAT Havana (1917) |
| 2nd (no 3rd) |
{{USAT|Meigs|3=2}} Alternate usage: {{USAT|Meigs||2}}
|
[[USAT Meigs|''Meigs'']]
|
USAT Meigs |
N.B.: Be careful with the third parameter if not using the second parameter. In the Meigs 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.
{{USAT|Havana|1917|6}}yields the same results as{{warship|USAT|Havana|1917}}
TemplateData
TemplateData
|
|---|
|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:USAT in articles based on its TemplateData.
TemplateData for USAT <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
