Template:USAV

Template documentation[view] [edit] [history] [purge]

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

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:

Value	Parameter(s) displayed	Example	Equivalent wikicode	Final result
None	all	{{USAV|Spearhead|TSV-X1}}	[[USAV Spearhead (TSV-X1) |USAV ''Spearhead'' (TSV-X1)]]	USAV Spearhead (TSV-X1)
1	3rd	{{USAV|Spearhead|TSV-X1|1}}	[[USAV Spearhead (TSV-X1) |TSV-X1]]	TSV-X1
2	2nd	{{USAV|Spearhead|TSV-X1|2}}	[[USAV Spearhead (TSV-X1) |''Spearhead'']]	Spearhead
3	2nd, 3rd	{{USAV|Spearhead|TSV-X1|3}}	[[USAV Spearhead (TSV-X1) |''Spearhead'' (TSV-X1)]]	Spearhead (TSV-X1)
4	invalid result	{{USAV|Spearhead|TSV-X1|4}}	[[USAV Spearhead (TSV-X1) |Invalid Optional Parameter]]	USAV Spearhead (TSV-X1)
5	1st, 3rd	{{USAV|Spearhead|TSV-X1|5}}	[[USAV Spearhead (TSV-X1) |USAV (TSV-X1)]]	USAV TSV-X1
6	1st, 2nd	{{USAV|Spearhead|TSV-X1|6}}	[[USAV Spearhead (TSV-X1) |USAV ''Spearhead'']]	USAV Spearhead
	2nd (no 3rd)	{{USAV|Constitution|3=2}} Alternate usage: {{USAV|Constitution||2}}	[[USAV Constitution |''Constitution'']]	Constitution

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

This section:

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 USAV This template provides a wikilink to a ship's page, with label options Template parameters Parameter Description Type Status Name 1 Ship's name Example Bismarck, Belgrano String optional ID 2 Hull number, launch year, or pennant number Example H75, 1975 String optional Format 3 Formats the label (which name parts will show) Default blank Example 1, 2, 3, 5, 6 Number optional unlink prefix up up=yes puts prefix before (outside of) the wikilink Default no Example up=yes Boolean optional

See also

The above documentation is transcluded from Template:USAV/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.