 | This template is used on approximately 2,600 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Usage
This is a typing short cut for linking to U.S. Coast Guard cutter articles named in the format "USCGC Cutter (WDMG-99)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[USCGC Cutter (WDMG-99)|USCGC ''Cutter'' (WDMG-99)]]. This template halves that to {{USCGC|Cutter|WDMG-99}}.
Formal Usage
- {{USCGC|Cutter Name}}
- {{USCGC|Cutter 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 |
|---|---|---|
| {{USCGC|Healy|WAGB-20}} | [[USCGC Healy (WAGB-20)|USCGC ''Healy'' (WAGB-20)]] | USCGC Healy (WAGB-20) |
| {{USCGC|Seneca|1908}} | [[USCGC Seneca (1908)|USCGC ''Seneca'' (1908)]] | USCGC Seneca (1908) |
| {{USCGC|Matagorda}} | [[USCGC Matagorda|USCGC ''Matagorda'']] | USCGC Matagorda |
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 USCGC, 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 | {{USCGC|Healy|WAGB-20}} | [[USCGC Healy (WAGB-20)|USCGC ''Healy'' (WAGB-20)]] | USCGC Healy (WAGB-20) | |
| 1 | 3rd | {{USCGC|Healy|WAGB-20|1}} | [[USCGC Healy (WAGB-20)|WAGB-20]] | WAGB-20 | |
| 2 | 2nd | {{USCGC|Healy|WAGB-20|2}} | [[USCGC Healy (WAGB-20)|''Healy'']] | Healy | |
| 3 | 2nd, 3rd | {{USCGC|Healy|WAGB-20|3}} | [[USCGC Healy (WAGB-20)|''Healy'' (WAGB-20)]] | Healy (WAGB-20) | |
| 4 | invalid result | {{USCGC|Healy|WAGB-20|4}} | — | Error: {{USCGC}} invalid control parameter: 4 (help) | |
| 5 | 1st, 3rd | {{USCGC|Healy|WAGB-20|5}} | [[USCGC Healy (WAGB-20)|USCGC (WAGB-20)]] | USCGC WAGB-20 | |
| 6 | 1st, 2nd | {{USCGC|Healy|WAGB-20|6}} | [[USCGC Healy (WAGB-20)|USCGC ''Healy'']] | USCGC Healy | |
| 2nd (no 3rd) |
{{USCGC| Matagorda|3=2}} | Alternate usage: {{USCGC|Matagorda||2}} | [[USCGC Matagorda|''Matagorda'']] | Matagorda | |
N.B.: Be careful with the third parameter if not using the second parameter. In the Matagorda 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:USCGC in articles based on its TemplateData.
TemplateData for USCGC This template provides a wikilink to a ship's page, with label options
| |||||||||||||||||||||||||
