Template:Sclass2/doc

Ship class link template usage
sclass2 is an editor's shortcut for creating properly formatted links to ship class articles that follow the standard naming format of Class name class ship type. If you are tired of typing Flower-class corvette or similar, this is for you. The previous is replaced by Flower-class corvette, that's it.

The most basic form is:

 Class name-class ship type 

This form assumes that Ship type is its own separate article so produces a link to the class article, followed by a link to the ship type article.

This template is for ship classes that are named for a common theme. For ship classes that are named after the lead ship, such as the Haskell-class attack transport, use sclass instead.

Optional parameter: "format"
An optional third parameter allows you to control the format and use the template if Ship type is not an article:

 Class name-class ship type 

The values and resluts for format are:
 * 0 - supresses displaying ship type entirely. Adjectival form.
 * 1 - displays ship type, but as part of the single link to the class article.
 * 2 - displays ship type, but unlinked.
 * 3 - displays ship type as a separate link. Ship type must be the name of an article.
 * 4 - supresses displaying ship type entirely. Noun form.
 * 5 - class name only. Useful for tables.

To avoid the dreaded red link, one of the first three options must be used if Ship type is not already an article. Note that option 3 is the default, so may be omitted. Other values of format will let you know the error of your ways.

Optional parameter: "disambiguation"
An optional fourth parameter allows you to disambiguate the ship type if it would ordinarily link to a disambiguation page (i.e. minesweeper):

 Class name-class ship type 

This would only be needed with either the default or with the "format" parameter set to 3. Note: to use the disambiguation parameter, you must specifiy a "format" parameter, or use "||" (double pipe) between the "ship type" and "disambiguation" parameters.