Deleatur yhe: 1 revision imported

2026-09-09T16:01:52Z

1 revision imported

← Older revision	Revision as of 16:01, 9 September 2026
(No difference)

wikipedia>Dmoore5556: /* Usage */ change example ship name to minimize wrapping and avoid substitution

2026-07-04T15:55:37Z

Usage: change example ship name to minimize wrapping and avoid substitution

New page

{{Documentation subpage}}
{{High-use}}
{{For|Wikipedia:Summary style|WP:SS}}
{{Template shortcut|SS}}

==Usage==
This is a typing shortcut for linking to steamship articles named in the format "SS Shipname (Year)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as <nowiki>[[SS Shipname (Year)|SS ''Shipname'' (Year)]]</nowiki>. This template halves that to <nowiki>{{SS|Shipname|Year}}.
</nowiki>

SS is the abbreviation for [[screw steamer]], ''not'' steam-powered ship. It is almost never written out.

===Formal usage===
* <code><nowiki>{{SS|Ship Name}}</nowiki></code>
* <code><nowiki>{{SS|Ship Name|ID}}</nowiki></code>, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title.

===Examples===
{| class="wikitable"
|-
! Template usage
! Equivalent wikicode
! Final result
|-
| <code><nowiki>{{SS|Brazil|1928}}</nowiki></code>
| <code><nowiki>[[SS Brazil (1928)|SS ''Brazil'' (1928)]]</nowiki></code>
| {{SS|Brazil|1928}}
|-
| <code><nowiki>{{SS|Pierre Victory}}</nowiki></code>
| <code><nowiki>[[SS Pierre Victory|SS ''Pierre Victory'']]</nowiki></code>
| {{SS|Pierre Victory}}
|}

Last example could be used to link to ship index (disambiguation) page

===Optional display control parameter===
There is an optional third parameter that controls which pieces of text are displayed in the wikilink to the article. Its value is essentially treated as a binary number and will display some or all of the fields. The three fields are: SS, ship name, and ID. So, setting the 4's bit will display SS, setting the 2's bit will display the ship name (in italics), and setting the 1's bit will display the ID. Not all combinations are considered valid, and all fields are displayed when the parameter is omitted. Examples:

{|class=wikitable
! Value
! Binary
! Field(s)<br />displayed
! Example
! Equivalent wikicode
! Final result
|-
! None
! N/A
| style="text-align:center;" | {{nowrap|1st, 2nd, 3rd}}
| <code><nowiki>{{SS|Brazil|1928}}</nowiki></code>
| <code><nowiki>[[SS Brazil (1928)|SS ''Brazil'' (1928)]]</nowiki></code>
| {{SS|Brazil|1928}}
|-
! 0
! 000
| style="text-align:center;" | invalid result
| <code><nowiki>{{SS|Brazil|1928|0}</nowiki>}</code>
| style="text-align:center;" | ''not applicable'' (would display nothing)
| {{SS|Brazil|1928|0|no-tracking=yes}}
|-
! 1
! 001
| style="text-align:right;" | 3rd
| <code><nowiki>{{SS|Brazil|1928|1}}</nowiki></code>
| <code><nowiki>[[SS Brazil (1928)|1928]]</nowiki></code>
| {{SS|Brazil|1928|1}}
|-
! 2
! 010
| style="text-align:center;" | 2nd
| <code><nowiki>{{SS|Brazil|1928|2}</nowiki>}</code>
| <code><nowiki>[[SS Brazil (1928)|''Brazil'']]</nowiki></code>
| {{SS|Brazil|1928|2}}
|-
! 3
! 011
| style="text-align:right;" | 2nd, 3rd
| <code><nowiki>{{SS|Brazil|1928|3}</nowiki>}</code>
| <code><nowiki>[[SS Brazil (1928)|''Brazil'' (1928)]]</nowiki></code>
| {{SS|Brazil|1928|3}}
|-
! 4
! 100
| style="text-align:center;" | invalid result
| <code><nowiki>{{SS|Brazil|1928|4}</nowiki>}</code>
| style="text-align:center;" | ''not applicable'' (would only display SS)
| {{SS|Brazil|1928|4|no-tracking=yes}}
|-
! 5
! 101
| style="text-align:center;" | 1st,{{spaces|7}} 3rd
| <code><nowiki>{{SS|Brazil|1928|5}</nowiki>}</code>
| <code><nowiki>[[SS Brazil (1928)|SS ''1928'']]</nowiki></code>
| {{SS|Brazil|1928|5}}
|-
! 6
! 110
| style="text-align:left;" | 1st, 2nd
| <code><nowiki>{{SS|Brazil|1928|6}</nowiki>}</code>
| <code><nowiki>[[SS Brazil (1928)|SS ''Brazil'']]</nowiki></code>
| {{SS|Brazil|1928|6}}
|-
! 7
! 111
| style="text-align:center;" | invalid result
| <code><nowiki>{{SS|Brazil|1928|7}</nowiki>}</code>
| style="text-align:center;" | ''not applicable'' (omit the parameter, see None)
| {{SS|Brazil|1928|7|no-tracking=yes}}
|}

Note that omitting the control parameter yields the same results as using {{tl|warship}} to create the same link and text, but saves characters while editing:
:<code><nowiki>{{SS|Brazil|1928}}</nowiki></code> yields {{SS|Brazil|1928}}
:<code><nowiki>{{warship|SS|Brazil|1928}}</nowiki></code> yields {{warship|SS|Brazil|1928}}

====Use of third parameter without second parameter====
Be careful with the third parameter when not using the second parameter. For example, for articles such as [[SS Pierre Victory|SS ''Pierre Victory'']] there is no ID field. To only display [[SS Pierre Victory|''Pierre Victory'']], you can use one of the following:

:<code><nowiki>{{SS|Pierre Victory||2}}</nowiki></code> yields {{SS|Pierre Victory||2}}
:<code><nowiki>{{SS|Pierre Victory|3=2}}</nowiki></code> yields {{SS|Pierre Victory|3=2}}

In the first example, the consecutive pipes, <code><nowiki>||</nowiki></code> indicates a null ID field and 2 is the control parameter.
In the second example, the <code><nowiki>|3=2</nowiki></code> means "set the third parameter to a value of two".

==TemplateData==
{{Ship/doc/fixed prefix: TemplateData}}

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

<includeonly>{{sandbox other||

[[Category:Ship prefix templates]]
}}</includeonly>

Template:SS/doc - Revision history

Deleatur yhe: 1 revision imported

wikipedia>Dmoore5556: /* Usage */ change example ship name to minimize wrapping and avoid substitution