साँचा:Sclass/doc

Ship class link template usage

sclass 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 [[Haskell class attack transport | ''Haskell''-class]] [[attack transport]] or similar, this is for you. The previous is replaced by {{sclass | Haskell | attack transport}}, that's it.

The most basic form is:

{{sclass | Class name | 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. The text in the first link is properly formatted with the Class name displayed in italics followed by "-class".

This template is for ship classes that are named after the lead ship. For ship classes that are named for a common theme, such as the साँचा:Sclass2, use {{sclass2}} 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:

{{sclass | Class name | ship type  | format }}

The values and results for format are:

0 - suppresses 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 - suppresses displaying ship type entirely. Noun form.

5 - class name only. Suitable for tables

6 - as article name, but properly italicized

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.

Examples

Para- meter	Template usage	Equivalent wikicode	Final result	Notes
None	{{sclass|Haskell|attack transport}}	[[Haskell class attack transport|''Haskell''-class]] [[attack transport]]	Haskell-class attack transport	Default
0	{{sclass|Haskell|attack transport|0}}	[[Haskell class attack transport|''Haskell''-class]]	Haskell-class	Adjectival form
1	{{sclass|Haskell|attack transport|1}}	[[Haskell class attack transport|''Haskell''-class attack transport]]	Haskell-class attack transport	Use when the ship type article does not exist
2	{{sclass|Haskell|attack transport|2}}	[[Haskell class attack transport|''Haskell''-class]] attack transport	Haskell-class attack transport
3	{{sclass|Haskell|attack transport|3}}	[[Haskell class attack transport|''Haskell''-class]] [[attack transport]]	Haskell-class attack transport	Same as default
4	{{sclass|Haskell|attack transport|4}}	[[Haskell class attack transport|''Haskell'' class]]	Haskell class	Noun form
5	{{sclass|Haskell|attack transport|5}}	[[Haskell class attack transport|''Haskell'']]	Haskell	Table or chart form
6	{{sclass|Haskell|attack transport|6}}	[[Haskell class attack transport|''Haskell'' class attack transport]]	Haskell class attack transport	Use to refer to article, but with proper italics

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):

{{sclass | Class name | ship type  | format | disambiguation }}

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.

Examples

Format Para- meter	Template usage	Equivalent wikicode	Final result	Notes
None	{{sclass|Admirable|minesweeper||ship}}	[[Admirable class minesweeper|''Admirable''-class]] [[minesweeper (ship)|minesweeper]]	Admirable-class minesweeper	Default
3	{{sclass|Admirable|minesweeper|3|ship}}	[[Admirable class minesweeper |''Admirable''-class]] [[minesweeper (ship)|minesweeper]]	Admirable-class minesweeper	Same as default