Template:USRC
Template documentationUsage
This is a typing short cut for linking to U.S. Revenue Cutter Service cutter articles named in the format "USRC Cutter (year)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[USRC Cutter (year)|USRC ''Cutter'' (year)]]. This template halves that to {{USRC|Cutter|year}}.
Formal Usage
- {{USRC|Ship Name}}
- {{USRC|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 |
|---|---|---|
| {{USRC|Harriet Lane|1857}} | [[USRC Harriet Lane (1857)|USRC ''Harriet Lane'' (1857)]] | USRC Harriet Lane (1857) |
| {{USRC|Bear}} | [[USRC Bear|USRC ''Bear'']] | USRC Bear |
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 USRC, 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 | {{USRC|Harriet Lane|1857}} | [[USRC Harriet Lane (1857)|USRC ''Harriet Lane'' (1857)]] | USRC Harriet Lane (1857) | |
| 1 | 3rd | {{USRC|Harriet Lane|1857|1}} | [[USRC Harriet Lane (1857)|1857]] | 1857 | |
| 2 | 2nd | {{USRC|Harriet Lane|1857|2}} | [[USRC Harriet Lane (1857)|''Harriet Lane'']] | Harriet Lane | |
| 3 | 2nd, 3rd | {{USRC|Harriet Lane|1857|3}} | [[USRC Harriet Lane (1857)|''Harriet Lane'' (1857)]] | Harriet Lane (1857) | |
| 4 | invalid result | {{USRC|Harriet Lane|1857|4}} | [[USRC Harriet Lane (1857)|Invalid Optional Parameter]] | USRC Harriet Lane (1857) | |
| 5 | 1st, 3rd | {{USRC|Harriet Lane|1857|5}} | [[USRC Harriet Lane (1857)|USRC (1857)]] | USRC 1857 | |
| 6 | 1st, 2nd | {{USRC|Harriet Lane|1857|6}} | [[USRC Harriet Lane (1857)|USRC ''Harriet Lane'']] | USRC Harriet Lane | |
| 2nd (no 3rd) |
{{USRC| Bear|3=2}} | Alternate usage: {{USRC|Bear||2}} | [[USRC Bear|''Bear'']] | Bear | |
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.
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.
{{USRC|Harriet Lane|1857|6}} yields the same results as {{warship|USRC|Harriet Lane|1857}}
TemplateData
TemplateData
| |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.
TemplateData for USRC This template provides a wikilink to a ship's page, with label options
| |||||||||||||||||||||||||