మూస:Sclass/doc
 | This is a documentation subpage for మూస:Sclass. It may contain usage information, categories and other content that is not part of the original మూస page. |
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 {{sclass}}. Classes not named for a member of the class are not italicized, in which case use {{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.
| Format | Template usage | Equivalent wikicode | Final result | Notes |
|---|---|---|---|---|
| None | {{sclass |Valiant |harbor tug }}
|
[[Valiant-class harbor tug |''Valiant''-class]] [[harbor tug ]]
|
Valiant-class harbor tug | Default |
| 0 | {{sclass |Valiant |harbor tug |0}}
|
[[Valiant-class harbor tug |''Valiant''-class]]
|
Valiant-class | Adjectival form |
| 1 | {{sclass |Valiant |harbor tug |1}}
|
[[Valiant-class harbor tug |''Valiant''-class harbor tug ]]
|
Valiant-class harbor tug | Article titles |
| 2 | {{sclass |Valiant |harbor tug |2}}
|
[[Valiant-class harbor tug |''Valiant''-class]] harbor tug
|
Valiant-class harbor tug | When the ship type article does not exist |
| 3 | {{sclass |Valiant |harbor tug |3}}
|
[[Valiant-class harbor tug |''Valiant''-class]] [[harbor tug ]]
|
Valiant-class harbor tug | Same as default |
| 4 | {{sclass |Valiant |harbor tug |4}}
|
[[Valiant-class harbor tug |''Valiant'' class]]
|
Valiant class | Noun form |
| 5 | {{sclass |Valiant |harbor tug |5}}
|
[[Valiant-class harbor tug |''Valiant'']]
|
Valiant | Table or chart form |
| 6 | {{sclass |Valiant |harbor tug |6}}
|
[[Valiant-class harbor tug |''Valiant'']]
|
Valiant-class harbor tug | 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 :
{{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.
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.
Template data
[మార్చు]TemplateData for Sclass
Formats ship class name and ship type into article link. Italicises class name.
| పరామితి | వివరణ | రకం | స్థితి | |
|---|---|---|---|---|
| class name | 1 | వివరణ లేదు | స్ట్రింగు | ఐచ్చికం |
| ship type | 2 | వివరణ లేదు | తెలియనిది | ఐచ్చికం |
| format | 3 | Format options 1, 2, 3, 4, 5 | సంఖ్య | ఐచ్చికం |
| ship type disambiguation | 4 | disambiguation for ship type | స్ట్రింగు | ఐచ్చికం |
| class name disambiguation | 5 | disambiguation for class name | స్ట్రింగు | ఐచ్చికం |
See also
[మార్చు]WP:SHIPS shortcut templates:
- Ship class article shortcuts
- For articles about ship classes named for a member of the class:
- For articles about ship classes named for a common theme:
- Ship prefix shortcuts
- Generic ship prefixes
{{barge}}—barge articles{{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{{SV}}—Sailing vessel articles{{PS}}—Paddle steamer articles{{ship}}—Non–prefixed ship articles{{SS}}—Steam Ship articles{{tugboat}}—tugboat articles
- Commonwealth ship prefixes
{{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{{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}}—Japanese Maritime Self-Defense Force ships (older){{JS}}—Japan Maritime Self-Defense Force ships (newer){{HNLMS}}—Royal Netherlands 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 Navy 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 units{{DWT}}—deadweight tonnage{{Displacement}}—displacement (ships)