Template:USAT/doc
From Wikipedia, the free encyclopedia
Contents |
[edit] 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}}.
[edit] 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.
[edit] Examples
| Template usage | Equivalent wikicode | Final result |
|---|---|---|
| {{USAT|Havana|1917}} | [[USAT Havana (1917)|USAT ''Havana'' (1917)]] | USAT Havana (1917) |
| {{USAT|Dorchester}} | [[USAT Dorchester|USAT ''Dorchester'']] | USAT Dorchester |
Last example could be used to link to ship index (disambiguation) page
[edit] 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 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]] | 1917 |
| 2 | 2nd | {{USAT|Havana|1917|2}} | [[USAT Havana (1917) |''Havana'']] | Havana |
| 3 | 2nd, 3rd | {{USAT|Havana|1917|3}} | [[USAT Havana (1917) |''Havana'' (1917)]] | Havana (1917) |
| 4 | invalid result | {{USAT|Havana|1917|4}} | [[USAT Havana (1917) |Invalid Optional Parameter]] | Invalid Optional Parameter |
| 5 | 1st, 3rd | {{USAT|Havana|1917|5}} | [[USAT Havana (1917) |USAT (1917)]] | USAT (1917) |
| 6 | 1st, 2nd | {{USAT|Havana|1917|6}} | [[USAT Havana (1917) |USAT ''Havana'']] | USAT Havana |
| 2nd (no 3rd) |
{{USAT|Dorchester|3=2}} Alternate usage: {{USAT|Dorchester||2}} |
[[USAT Dorchester|''Dorchester'']] | Dorchester |
N.B.: Be careful with the third parameter if not using the second parameter. In the Dorchester 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}}
[edit] See also
WP:SHIPS shortcut templates:
|
|
