Fyrimynd: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 | Flower-class]] [[corvette]] or similar, this is for you. The previous is replaced by {{sclass2 | Flower | corvette}}, that's it.

The most basic form is:

{{sclass2 | 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.

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:

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

The values and resluts for format are:

0 - suppresses ship type display entirely. Adjectival form.

1 - displays ship type as part of the single link to the class article.

2 - displays unlinked ship type.

3 - displays ship type as a separate link. Ship type must be the name of an article.

4 - suppresses ship type display 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.

Examples

Para- meter	Template usage	Equivalent wikicode	Final result	Notes
None	{{sclass2|Flower|corvette}}	[[Flower class corvette|Flower-class]] [[corvette]]	Flower-class corvette	Default
0	{{sclass2|Flower|corvette|0}}	[[Flower class corvette|Flower-class]]	Flower-class	Adjectival form
1	{{sclass2|Flower|corvette|1}}	[[Flower class corvette|Flower-class corvette]]	Flower-class corvette	Article titles
2	{{sclass2|Flower|corvette|2}}	[[Flower class corvette|Flower-class]] corvette	Flower-class corvette	When the ship type article does not exist
3	{{sclass2|Flower|corvette|3}}	[[Flower class corvette|Flower-class]] [[corvette]]	Flower-class corvette	Same as default
4	{{sclass2|Flower|corvette|4}}	[[Flower class corvette|Flower class]]	Flower class	Noun form
5	{{sclass2|Flower|corvette|5}}	[[Flower class corvette|Flower]]	Flower	Table form

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

{{sclass2 | 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 specify 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	{{sclass2|Ton|minesweeper||ship}}	[[Ton class minesweeper|Ton-class]] [[minesweeper (ship)|minesweeper]]	Ton-class minesweeper	Default
3	{{sclass2|Ton|minesweeper|3|ship}}	[[Ton class minesweeper |Ton-class]] [[minesweeper (ship)|minesweeper]]	Ton-class minesweeper	Same as default

See also

en:WP:SHIPS shortcut templates:

Ship class article shortcuts

• For articles about ship classes named for a member of the class:

  {{sclass}}—article titles that are not hyphenated

  {{sclass-}}—article titles that are hyphenated

• For articles about ship classes named for a common theme:

  {{sclass2}}—article titles that are not hyphenated

  {{sclass2-}}—article titles that are hyphenated

Ship prefix shortcuts

• Generic ship prefixes

• {{GTS}}—Gas Turbine Ship articles
• {{HSC}}—High Speed Craft articles
• {{MS}}—Motor ship articles
• {{MV}}—Merchant vessel (or "Motor vessel") articles
• {{MY}}—Motor yacht articles
• {{RV}}—Research vessel articles
• {{SV}}—Sailing vessel articles
• {{PS}}—Paddle steamer articles
• {{ship}}—Non–prefixed ship articles
• {{SS}}—Steam Ship articles

• Commonwealth ship prefixes

• {{BNS}}—Bangladesh Navy ships
• {{HMS}}—Royal Navy ships
• {{HMT}}—Royal Navy trawlers
• {{HMAS}}—Royal Australian Navy ships
• {{HMBS}}—Royal Bahamas Defence Force ships
• {{HMCS}}—Royal Canadian Navy ships
• {{HMNZS}}—Royal New Zealand Navy ships
• {{HMQS}}—Queensland Maritime Defence Force ships
• {{HMVS}}—Victorian Naval Forces ships
• {{RMS}}—Royal Mail Ships
• {{RFAux}}-Royal Fleet Auxiliary ships
• {{INS}}—Indian Navy ships
• {{SAS}}—South African Navy ships

• United States ship prefixes

• {{USAT}}—United States Army Transport articles
• {{USCGC}}—United States Coast Guard Cutter articles
• {{USNS}}—United States Naval Ship articles
• {{USRC}}—United States Revenue Cutter Service articles
• {{USS}}—United States Navy ship articles

• Other navies' prefixes

• {{SMS}}—Imperial German Navy and Austro-Hungarian Navy ships
• {{SMU}}—Imperial German Navy and Austro-Hungarian Navy U-boats
• {{GS}}—World War II and later U-boats
• {{Jsub}}—Imperial Japanese Navy submarines
• {{JDS}}—Japan Maritime Self-Defense Force ships (older)
• {{JS}}—Japan Maritime Self-Defense Force ships (newer)
• {{KRI}}—Indonesian Navy ships
• {{HNLMS}}—Royal Netherlands Navy ships
• {{HDMS}}—Royal Danish Navy ships
• {{HNoMS}}—Royal Norwegian Navy ships
• {{HSwMS}}—Swedish Navy ships
• {{RPS}}—older Philippine Navy ships
• {{BRP}}—newer Philippine Navy ships
• {{ORP}}—Polish Navy ships
• {{LÉ}}—Irish Navy ships
• {{TCG}}—Turkish Naval Forces ships

Dictionary of American Naval Fighting Ships (DANFS) templates

• {{DANFS}}—public domain attribution notice
• {{Cite DANFS}}—DANFS material citation

Measurement shortcut templates

• {{GT}}—gross tonnage
• {{NetT}}—net tonnage
• {{GRT}}—gross register tonnage
• {{NRT}}—net register tonnage
• {{TEU}}—twenty-foot equivalent unit
• {{DWT}}—deadweight tonnage
• {{Displacement}}—displacement (ship)