Fyrimynd:Sclass-/doc

This template is for ship-class articles with hyphenated titles. For ship-class article titles that do not contain hyphens, see {{sclass}}

Ship class articles may have titles that are hyphenated. A typical hyphenated ship-class article name has the form:

<class name>-class <ship type>

When a ship class is named for a member of the class, the class name is italicized. For these classes use {{sclass}} or {{sclass-}}. Classes not named for a member of the class are not italicized. Use {{sclass2}}.

When ship-class article titles are hyphenated, use {{sclass-}}. Otherwise use {{sclass}} or {{sclass2}}.

Usage

sclass- is an editor's shortcut for creating properly formatted links to ship-class articles with hyphenated titles: Class name-class ship type.

The basic form:

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

replaces:

[[Class name-class ship type | 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. The text in the first link is properly formatted with the Class name displayed in italics followed by "-class". Note that if referring to the ship class as a noun, the hyphen may be removed with the formatting options below, even though is part of the article title.

Optional unnamed format control parameter

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 ship type display entirely. Adjectival form.

1: displays ship type as part of a 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, suitable 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

Format	Template usage	Equivalent wikicode	Final result	Notes
None	{{sclass- |Valiant |tugboat}}	[[Valiant-class tugboat |''Valiant''-class]] [[tugboat]]	Valiant-class tugboat	Default
0	{{sclass- |Valiant |tugboat |0}}	[[Valiant-class tugboat |''Valiant''-class]]	Valiant-class	Adjectival form
1	{{sclass- |Valiant |tugboat |1}}	[[Valiant-class tugboat |''Valiant''-class tugboat]]	Valiant-class tugboat	Article titles
2	{{sclass- |Valiant |tugboat |2}}	[[Valiant-class tugboat |''Valiant''-class]] tugboat	Valiant-class tugboat	When the ship type article does not exist
3	{{sclass- |Valiant |tugboat |3}}	[[Valiant-class tugboat |''Valiant''-class]] [[tugboat]]	Valiant-class tugboat	Same as default
4	{{sclass- |Valiant |tugboat |4}}	[[Valiant-class tugboat |''Valiant'' class]]	Valiant class	Noun form
5	{{sclass- |Valiant |tugboat |5}}	[[Valiant-class tugboat |''Valiant'']]	Valiant	Table or chart form
6	{{sclass- |Valiant |tugboat |6}}	[[Valiant-class tugboat |''Valiant'']]	Valiant ERROR: invalid option 6	Unrecognized format value

Optional parameter: "ship-type 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 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	{{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

Optional parameter: "class-name disambiguation"

When there are separate ship classes that share the same name and that use parenthetical disambiguation, for example Königsberg-class cruiser, use the optional fifth parameter to disambiguate the class-name:

{{sclass-|Königsberg|cruiser|||1905}} produces Königsberg-class cruiser which is the same as:

[[Königsberg-class cruiser (1905)|''Königsberg''-class]] [[cruiser]]

The class-name disambiguator is never displayed.

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)