Template:USAV/doc

{{Documentation subpage}}


== Usage ==
This is a typing short cut for linking to [[US Navy]] ship articles named in the format "USAV Spearhead (TSV-X1)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[USAV Spearhead (TSV-X1)|USAV ''Spearhead'' (TSV-X1)]]. This template halves that to {{USAV|Spearhead|TSV-X1}}.


=== Formal usage ===

* {{USAV|Ship Name}}
* {{USAV|Ship Name|ID}}, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title.

=== Examples ===
{|class=wikitable width="100%"
! Template usage
! Equivalent wikicode
! Final result
|-
| {{USAV|Spearhead|TSV-X1}}
| [[USAV Spearhead (TSV-X1)|USAV ''Spearhead'' (TSV-X1)]]
| {{USAV|Spearhead|TSV-X1}}
|-
| {{USAV|Constellation|1797}}
| [[USAV Constellation (1797)|USAV ''Constellation'' (1797)]]
| {{USAV|Constellation|1797}}
|-
| {{USAV|Constitution}}
| [[USAV Constitution|USAV ''Constitution'']]
| {{USAV|Constitution}}
|}

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 USAV, 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)
displayed
! Example
! Equivalent wikicode
! Final result
|-
! None
| style="text-align:center;" | all
| {{USAV|Spearhead|TSV-X1}}
| [[USAV Spearhead (TSV-X1) |USAV ''Spearhead'' (TSV-X1)]]
| {{USAV|Spearhead|TSV-X1}}
|-
! 1
| style="text-align:center;" | 3rd
| {{USAV|Spearhead|TSV-X1|1}}
| [[USAV Spearhead (TSV-X1) |TSV-X1]]
| {{USAV|Spearhead|TSV-X1|1}}
|-
! 2
| style="text-align:center;" | 2nd
| {{USAV|Spearhead|TSV-X1|2}}
| [[USAV Spearhead (TSV-X1) |''Spearhead'']]
| {{USAV|Spearhead|TSV-X1|2}}
|-
! 3
| style="text-align:center;" | 2nd, 3rd
| {{USAV|Spearhead|TSV-X1|3}}
| [[USAV Spearhead (TSV-X1) |''Spearhead'' (TSV-X1)]]
| {{USAV|Spearhead|TSV-X1|3}}
|-
! 4
| style="text-align:center;" | invalid result
| {{USAV|Spearhead|TSV-X1|4}}
| —
| {{USAV|Spearhead|TSV-X1|4|no-tracking=yes}}
|-
! 5
| style="text-align:center;" | 1st, 3rd
| {{USAV|Spearhead|TSV-X1|5}}
| [[USAV Spearhead (TSV-X1) |USAV (TSV-X1)]]
| {{USAV|Spearhead|TSV-X1|5}}
|-
! 6
| style="text-align:center;" | 1st, 2nd
| {{USAV|Spearhead|TSV-X1|6}}
| [[USAV Spearhead (TSV-X1) |USAV ''Spearhead'']]
| {{USAV|Spearhead|TSV-X1|6}}
|-
|
| style="text-align:center;" | 2nd
(no 3rd)
| {{USAV|Constitution|3=2}}
''Alternate usage'': {{USAV|Constitution||2}}
| [[USAV Constitution |''Constitution'']]
| {{USAV|Constitution||2}}
|}
''N.B.'': Be careful with the third parameter if not using the second parameter. In the ''Constitution'' 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}}

{{sandbox other||
[[Category:Ship prefix templates]]
}}