This is a documentation subpage for Template:Sclass2. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 10,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
When a ship class is not named for a member of the class, the class name is not italicized. For these classes use ((sclass2))
. Classes named for a member of the class are italicized. Use ((sclass))
.
sclass2
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:
((sclass2 | 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 normal upright font followed by "-class".
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 results for format are:
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.
Format | 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 or chart form |
6 | ((sclass2 |Flower |corvette |6))
|
[[Flower-class corvette |Flower]]
|
Error: ((sclass2)) invalid format code: 6. Should be 0–5, or blank (help) | Unrecognized format value |
When there are separate ship classes that share the same name and that use parenthetical disambiguation, for example Tribal-class destroyer, use the optional fifth parameter to disambiguate the class-name:
((sclass2|Tribal|destroyer|||1905))
produces Tribal-class destroyer which is the same as:[[Tribal-class destroyer (1905)|Tribal-class]] [[destroyer]]
The class-name disambiguator is never displayed.
TemplateData for Sclass2
Formats ship class name and ship type into article link. Italicises class name.
Parameter | Description | Type | Status | |
---|---|---|---|---|
class name | 1 | no description | String | optional |
ship type | 2 | no description | Unknown | optional |
format | 3 | Format options 1, 2, 3, 4, 5 | Number | optional |
disambiguation | 4 | no description | Unknown | optional |
unknown | 5 | (undocumented) | Unknown | optional |
disambiguation | 6 | no description | Unknown | optional |