قالب:Sclass/doc

هذه هي صفحة توثيق القالب {{Sclass}}. ليس الغرض من تلك الصفحة أن تـُشاهـَد مباشرة. لو استعملـَت متغيرات, فبعض الروابط قد تظهر مكسورة. لا تستبدل تلك المتغيرات بأسماء مباشرة (hardcoded) لصفحات أو عناوين URLs.

 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، طراز 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 displaying ship type entirely. Adjectival form.

1 - displays ship type, but 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 displaying ship type entirely. Noun form.

5 - class name only. Suitable for tables

6 - as article name, but properly italicized

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-طراز attack transport	Default
0	{{sclass|Haskell|attack transport|0}}	[[Haskell class attack transport|''Haskell''-class]]	Haskell، طراز	Adjectival form
1	{{sclass|Haskell|attack transport|1}}	[[Haskell class attack transport|''Haskell''-class attack transport]]	Haskell، طراز attack transport	Use when the ship type article does not exist
2	{{sclass|Haskell|attack transport|2}}	[[Haskell class attack transport|''Haskell''-class]] attack transport	Haskell، طراز attack transport
3	{{sclass|Haskell|attack transport|3}}	[[Haskell class attack transport|''Haskell''-class]] [[attack transport]]	Haskell، طراز attack transport	Same as default
4	{{sclass|Haskell|attack transport|4}}	[[Haskell class attack transport|''Haskell'' class]]	Haskell، طراز	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 طراز attack transport	Use to refer to article, but with proper italics

 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 specifiy 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-طراز minesweeper	Default
3	{{sclass|Admirable|minesweeper|3|ship}}	[[Admirable class minesweeper |''Admirable''-class]] [[minesweeper (ship)|minesweeper]]	Admirable، طراز minesweeper	Same as default

 See also

WP:SHIPS shortcut templates:

Class shortcuts

• {{sclass}} – Shortcut for ship classes that are named for the lead ship
• {{sclass2}} – Shortcut for ship classes that are named for a common theme

Ship prefix shortcuts

• Generic ship prefixes
  • {{GTS}} - Shortcut for linking to Gas Turbine Ship articles
  • {{HSC}} - Shortcut for linking to High Speed Craft articles
  • {{MS}} - Shortcut for Motor ship articles
  • {{MV}} - Shortcut for Merchant vessel (or "Motor vessel") articles
  • {{SS}} - Shortcut for Steam Ship articles
  • {{ship}} - Shortcut for linking ship articles
• Commonwealth ship prefixes
  • {{HMAS}} - Shortcut for linking to Royal Australian Navy ship articles
  • {{HMCS}} - Shortcut for linking to Royal Canadian Navy ship articles
  • {{HMS}} - Shortcut for linking to Royal Navy ship articles
  • {{RMS}} - Shortcut for Royal Mail Ship articles
• United States ship prefixes
  • {{USAT}} - Shortcut for United States Army Transport articles
  • {{USCGC}} - Shortcut for United States Coast Guard Cutter articles
  • {{USNS}} - Shortcut for United States Naval Ship articles
  • {{USS}} - Shortcut for United States Navy ship articles
• Other navies' prefixes
  • {{SMS}} – Shortcut for Imperial German Navy and Austro-Hungarian Navy ships
  • {{SMU}} - Shortcut for U-boats of the Imperial German Navy and Austro-Hungarian Navy
  • {{HNLMS}} - Shortcut for Royal Netherlands Navy ships

Dictionary of American Naval Fighting Ships (DANFS) templates

• {{DANFS}} — notice for attribution public domain text
• {{Cite DANFS}} — shortcut for citing DANFS material