View source for Template:USRC/doc

{{Documentation subpage}}

== Usage ==
This is a typing short cut for linking to [[United States Revenue Cutter Service|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 <nowiki>[[USRC Cutter (year)|USRC ''Cutter'' (year)]]</nowiki>.  This template halves that to <nowiki>{{USRC|Cutter|year}}.
</nowiki>

=== Formal Usage ===
* <nowiki>{{USRC|Ship Name}}</nowiki>
* <nowiki>{{USRC|Ship Name|ID}}</nowiki>, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title.

=== Examples ===
{|class=wikitable width="100%"
 |- style="background-color:#FCFCFC" align="left"
 ! Template usage
 ! Equivalent wikicode
 ! Final result
 |-
 | <nowiki>{{USRC|Harriet Lane|1857}}</nowiki>
 | <nowiki>[[USRC Harriet Lane (1857)|USRC ''Harriet Lane'' (1857)]]</nowiki>
 | {{USRC|Harriet Lane|1857}}
 |-
 | <nowiki>{{USRC|Bear}}</nowiki>
 | <nowiki>[[USRC Bear|USRC ''Bear'']]</nowiki>
 | {{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:
{|class=wikitable width=100%
! Value
! Parameter(s)<br>displayed
! colspan=2 | Example
! Equivalent wikicode
! Final result
|-
! None
| style="text-align:center;" | all
| colspan=2 | <nowiki>{{USRC|Harriet Lane|1857}}</nowiki>
| <nowiki>[[USRC Harriet Lane (1857)|USRC ''Harriet Lane'' (1857)]]</nowiki>
| {{USRC|Harriet Lane|1857}}
|-
! 1
| style="text-align:center;" | 3rd
| colspan=2 | <nowiki>{{USRC|Harriet Lane|1857|1}}</nowiki>
| <nowiki>[[USRC Harriet Lane (1857)|1857]]</nowiki>
| {{USRC|Harriet Lane|1857|1}}
|-
! 2
| style="text-align:center;" | 2nd
| colspan=2 | <nowiki>{{USRC|Harriet Lane|1857|2}</nowiki>}
| <nowiki>[[USRC Harriet Lane (1857)|''Harriet Lane'']]</nowiki>  
| {{USRC|Harriet Lane|1857|2}}
|-
! 3
| style="text-align:center;" | 2nd, 3rd
| colspan=2 | <nowiki>{{USRC|Harriet Lane|1857|3}</nowiki>}
| <nowiki>[[USRC Harriet Lane (1857)|''Harriet Lane'' (1857)]]</nowiki>  
| {{USRC|Harriet Lane|1857|3}}
|-
! 4
| style="text-align:center;" | invalid result
| colspan=2 | <nowiki>{{USRC|Harriet Lane|1857|4}</nowiki>}
| —
| {{USRC|Harriet Lane|1857|4|no-tracking=yes}}
|-
! 5
| style="text-align:center;" | 1st, 3rd
| colspan=2 | <nowiki>{{USRC|Harriet Lane|1857|5}</nowiki>}
| <nowiki>[[USRC Harriet Lane (1857)|USRC (1857)]]</nowiki>  
| {{USRC|Harriet Lane|1857|5}}
|-
! 6
| style="text-align:center;" | 1st, 2nd
| colspan=2 | <nowiki>{{USRC|Harriet Lane|1857|6}</nowiki>}
| <nowiki>[[USRC Harriet Lane (1857)|USRC ''Harriet Lane'']]</nowiki>  
| {{USRC|Harriet Lane|1857|6}}
|-
|
| style="text-align:center;" | 2nd<br><small>(no 3rd)</small>
| <nowiki>{{USRC| Bear|3=2}}</nowiki>
| <nowiki>Alternate usage: {{USRC|Bear||2}}</nowiki>
| <nowiki>[[USRC Bear|''Bear'']]</nowiki>
| {{USRC| Bear||2}}
|}
''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 ==
{{Ship/doc/fixed prefix: TemplateData}}

== See also ==
{{WPSHIPS shortcut templates}}

<includeonly>{{sandbox other||
[[Category:Ship prefix templates]]
}}</includeonly>