ಟೆಂಪ್ಲೇಟು: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 link template usage
[ಬದಲಾಯಿಸಿ]sclass 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 [[Haskell class attack transport | ''Haskell''-class]] [[attack transport]] or similar, this is for you. The previous is replaced by {{sclass | Haskell | attack transport}}, that's it.
The most basic form is:
{{sclass | 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. The text in the first link is properly formatted with the Class name displayed in italics followed by "-class".
This template is for ship classes that are named after the lead ship. For ship classes that are named for a common theme, such as the Flower-class corvette, use {{Sclass2}} 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:
{{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 the single link to the class article
- 2: displays ship type, but unlinked
- 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
- 6: DeprecatedUse Option 1
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 | {{sclass|Haskell|attack transport}} | [[Haskell class attack transport|''Haskell''-class]] [[attack transport]] | Haskell-class attack transport | Default |
| 0 | {{sclass|Haskell|attack transport|0}} | [[Haskell class attack transport|''Haskell''-class]] | Haskell-class | Adjectival form |
| 1 | {{sclass|Haskell|attack transport|1}} | [[Haskell class attack transport|''Haskell''-class attack transport]] | Haskell-class attack transport | Article title |
| 2 | {{sclass|Haskell|attack transport|2}} | [[Haskell class attack transport|''Haskell''-class]] attack transport | Haskell-class attack transport | When the ship type article does not exist |
| 3 | {{sclass|Haskell|attack transport|3}} | [[Haskell class attack transport|''Haskell''-class]] [[attack transport]] | Haskell-class attack transport | Same as default |
| 4 | {{sclass|Haskell|attack transport|4}} | [[Haskell class attack transport|''Haskell'' class]] | Haskell class | Noun form |
| 5 | {{sclass|Haskell|attack transport|5}} | [[Haskell class attack transport|''Haskell'']] | Haskell | Table or chart form |
| 6 | {{sclass|Haskell|attack transport|6}} | [[Haskell class attack transport|''Haskell'' class attack transport]] | Haskell-class attack transport | DeprecatedUse Option 1 |
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):
{{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 |
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)