View source for Template:Sclass/doc

{{Documentation subpage}}
Ship class articles have titles that are hyphenated. A typical 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 {{tlx|sclass}}. Classes not named for a member of the class are not italicized, in which case use {{tlx|sclass2}}.

==Usage==
'''<code>sclass</code>''' 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:

::<code><nowiki>{{</nowiki>sclass | ''class name'' | ''ship type''<nowiki>}}</nowiki></code>

replaces:

::<code><nowiki>[[</nowiki>''class name''-class ''ship type'' | ''class name''-class<nowiki>]]</nowiki> <nowiki>[[</nowiki>''ship type''<nowiki>]]</nowiki></code>

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:

::<code>{{tlx|sclass| ''class name'' | ''ship type''  | ''format''}}</code>

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 [[Wikipedia:Red link|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.

{|class="wikitable nowraplinks"
|+Examples
|-
! Format
! Template usage
! Equivalent wikicode
! Final result
! Notes
|-
! None
| <code><nowiki>{{sclass |Valiant |harbor tug }}</nowiki></code>
| <code><nowiki>[[Valiant-class harbor tug |''Valiant''-class]] [[harbor tug ]]</nowiki></code>
| {{sclass |Valiant |harbor tug }}
| Default
|-
! 0
| <code><nowiki>{{sclass |Valiant |harbor tug |0}}</nowiki></code>
| <code><nowiki>[[Valiant-class harbor tug |''Valiant''-class]]</nowiki></code>
| {{sclass |Valiant |harbor tug |0}}
| Adjectival form
|-
! 1
| <code><nowiki>{{sclass |Valiant |harbor tug |1}}</nowiki></code>
| <code><nowiki>[[Valiant-class harbor tug |''Valiant''-class harbor tug ]]</nowiki></code>
| {{sclass |Valiant |harbor tug |1}}
| Article titles
|-
! 2
| <code><nowiki>{{sclass |Valiant |harbor tug |2}}</nowiki></code>
| <code><nowiki>[[Valiant-class harbor tug |''Valiant''-class]] harbor tug </nowiki></code>
| {{sclass |Valiant |harbor tug |2}}
| When the ship type article does not exist
|-
! 3
| <code><nowiki>{{sclass |Valiant |harbor tug |3}}</nowiki></code>
| <code><nowiki>[[Valiant-class harbor tug |''Valiant''-class]] [[harbor tug ]]</nowiki></code>
| {{sclass |Valiant |harbor tug |3}}
| Same as default
|-
! 4
| <code><nowiki>{{sclass |Valiant |harbor tug |4}}</nowiki></code>
| <code><nowiki>[[Valiant-class harbor tug |''Valiant'' class]]</nowiki></code>
| {{sclass |Valiant| harbor tug |4}}
| Noun form
|-
! 5
| <code><nowiki>{{sclass |Valiant |harbor tug |5}}</nowiki></code>
| <code><nowiki>[[Valiant-class harbor tug |''Valiant'']]</nowiki></code>
| {{sclass |Valiant |harbor tug |5}}
| Table or chart form
|-
! {{red|6}}
| <code><nowiki>{{sclass |Valiant |harbor tug |6}}</nowiki></code>
| <code><nowiki>[[Valiant-class harbor tug |''Valiant'']]</nowiki></code>
| {{sclass |Valiant |harbor tug |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 :

 <nowiki>{{</nowiki>sclass | ''class name'' | ''ship type''  | ''format'' | ''disambiguation'' <nowiki>}}</nowiki>

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====
{|class=wikitable width="100%"
|-
! <small>Format<br>Para-<br>meter</small>
! Template usage
! Equivalent wikicode
! Final result
! Notes
|-
! None
| <nowiki>{{sclass|Admirable|minesweeper||ship}}</nowiki>
| <nowiki>[[Admirable-class minesweeper|''Admirable''-class]] [[minesweeper (ship)|minesweeper]]</nowiki>
| {{sclass|Admirable|minesweeper||ship}}
| Default
|-
! 3
| <nowiki>{{sclass|Admirable|minesweeper|3|ship}}</nowiki>
| <nowiki>[[Admirable-class minesweeper |''Admirable''-class]] [[minesweeper (ship)|minesweeper]]</nowiki>
| {{sclass|Admirable|minesweeper|3|ship}}
| 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 {{sclass|Königsberg|cruiser}}, use the optional fifth parameter to disambiguate the class-name:
:<code><nowiki>{{sclass|Königsberg|cruiser|||1905}}</nowiki></code> produces {{sclass|Königsberg|cruiser|||1905}} which is the same as:
:<code><nowiki>[[Königsberg-class cruiser (1905)|''Königsberg''-class]] [[cruiser]]</nowiki></code>

The class-name disambiguator is never displayed.
==Template data==
{{TemplateDataHeader}}
<templatedata>
{
	"params": {
		"1": {
			"label": "class name",
			"type": "string"
		},
		"2": {
			"label": "ship type"
		},
		"3": {
			"label": "format",
			"description": "Format options 1, 2, 3, 4, 5",
			"type": "number"
		},
		"4": {
			"label": "ship type disambiguation",
            "description": "disambiguation for ship type",
            "type": "string"
		},
		"5": {
			"label": "class name disambiguation",
			"description": "disambiguation for class name",
            "type": "string"
		}
	},
	"description": "Formats ship class name and ship type into article link. Italicises class name."
}
</templatedata>

==See also==
{{WPSHIPS shortcut templates}}

<includeonly>{{sandbox other||

[[Category:Ship templates|Class]]
}}</includeonly>