Template:USS/doc

This is a documentation subpage for Template:USS (see that page for the template itself).
It contains usage information, categories, and other content that is not part of the original template page.

This template is used on a very large number of pages.
To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages, or in your own user space. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them.

Usage

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

This template does not support subst: (substitution). Behind the scenes, it invokes {{ship}}.

Formal usage

{{USS|Ship Name}}
{{USS|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
`{{USS\|Enterprise\|CVN-65}}`	`[[USS Enterprise (CVN-65)\|USS ''Enterprise'' (CVN-65)]]`	Script error: No such module "WPSHIPS utilities".
`{{USS\|Constellation\|1797}}`	`[[USS Constellation (1797)\|USS ''Constellation'' (1797)]]`	Script error: No such module "WPSHIPS utilities".
`{{USS\|Constitution}}`	`[[USS Constitution\|USS ''Constitution'']]`	Script error: No such module "WPSHIPS utilities".

Last example could be used to link to ship index (disambiguation) page

Target page

By default, the wikilink is build like this:

{{PREFIX|ship's name|ID}}.

With {{USS|Enterprise|CVN-65}}, the targetpage is

[[USS Enterprise (CVN-65)]].

Elements PREFIX and ID can be omitted (if they are not part of the targetpage title).

Formatted label

Then the template by default adds the formatted label:

[[targetpage|label]]. By default:

{{USS|Enterprise|CVN-65}}, by default the label is:

[[USS Enterprise (CVN-65)|USS ''Enterprise'' (CVN-65)]], showing as:

Script error: No such module "WPSHIPS utilities"..

The default label can be changed with a simple parameter. The extra third position, unnamed parameter allows setting which changes the elements of the ship's full name. It sets the label in the link: For example, in your article, the hull number (disambiguator) may not be needed to show. In that case, add option |2, and the result is:

{{USS|Enterprise|CVN-65|2}} →

[[USS Enterprise (CVN-65)|''Enterprise'']] →

Script error: No such module "WPSHIPS utilities".

The options are:

Value	Will show	Example	Wikilink [[targetpage\|label]]	Shows
(default)	PREFIX name (ID)	{{USS\|Enterprise\|CVN-65}}	[[USS Enterprise (CVN-65)\|USS ''Enterprise'' (CVN-65)]]	Script error: No such module "WPSHIPS utilities".
1	ID	{{USS\|Enterprise\|CVN-65\|1}}	[[USS Enterprise (CVN-65)\|''CVN-65'']]	Script error: No such module "WPSHIPS utilities".
2	name	{{USS\|Enterprise\|CVN-65\|2}}	[[USS Enterprise (CVN-65)\|''Enterprise'']]	Script error: No such module "WPSHIPS utilities".
3	name (ID)	{{USS\|Enterprise\|CVN-65\|3}}	[[USS Enterprise (CVN-65)\|''Enterprise'' (CVN-65)]]	Script error: No such module "WPSHIPS utilities".
4	invalid	{{USS\|Enterprise\|CVN-65\|4}}	—	Script error: No such module "WPSHIPS utilities".
5	PREFIX ID	{{USS\|Enterprise\|CVN-65\|5}}	[[USS Enterprise (CVN-65)\|USS ''CVN-65'']]	Script error: No such module "WPSHIPS utilities".
6	PREFIX name	{{USS\|Enterprise\|CVN-65\|6}}	[[USS Enterprise (CVN-65)\|USS ''Enterprise'']]	Script error: No such module "WPSHIPS utilities".

Note: options default (=blank), 2 and 6 are mostly used.

PREFIX not in article name

It is possible that the prefix is not part of the target pagename. In that case, extra parameter |up=yes (unlink prefix) puts the name outside of the link: [example here]

TemplateData

Template:Ship/doc/fixed prefix: TemplateData