View source for Template:TSS/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
== Usage ==
This is a typing short cut for linking to steamship articles named in the format "TSS Shipname (Year)".  Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as <nowiki>[[TSS Shipname (Year)|TSS ''Shipname'' (Year)]]</nowiki>.  This template halves that to <nowiki>{{TSS|Shipname|Year}}.
</nowiki>

=== Formal Usage ===

* <code><nowiki>{{TSS|Ship Name}}</nowiki></code>
* <code><nowiki>{{TSS|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" style="width:100%;"
|-
! Template usage
! Equivalent wikicode
! Final result
|-
| <code><nowiki>{{TSS|Princess Maud|1934}}</nowiki></code>
| <code><nowiki>[[TSS Princess Maud (1934)|TSS ''Princess Maud'' (1934)]]</nowiki></code>
| {{TSS|Princess Maud|1934}}
|-
| <code><nowiki>{{TSS|Caledonian Princess}}</nowiki></code>
| <code><nowiki>[[TSS Caledonian Princess|TSS ''Caledonian Princess'']]</nowiki></code>
| {{TSS|Caledonian Princess}}
|}

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 article.  Its value is treated as a binary number and will display the corresponding "bits".  So setting the 4's bit will display TSS, setting the 2's bit will display the ship name, and setting the 1's bit will display the ID.  If binary math isn't your thing, refer to these examples:
{|class=wikitable width=100%
! Value
! Parameter(s)<br />displayed
! Example
! Equivalent wikicode
! Final result
|-
! None
| style="text-align:center;" | all
| <code><nowiki>{{TSS|Princess Maud|1934}}</nowiki></code>
| <code><nowiki>[[TSS Princess Maud (1934) |TSS ''Princess Maud'' (1934)]]</nowiki></code>
| {{TSS|Princess Maud|1934}}
|-
! 1
| style="text-align:center;" | 3rd
| <code><nowiki>{{TSS|Princess Maud|1934|1}}</nowiki></code>
| <code><nowiki>[[TSS Princess Maud (1934) |1934]]</nowiki></code>
| {{TSS|Princess Maud|1934|1}}
|-
! 2
| style="text-align:center;" | 2nd
| <code><nowiki>{{TSS|Princess Maud|1934|2}</nowiki>}</code>
| <code><nowiki>[[TSS Princess Maud (1934) |''Princess Maud'']]</nowiki></code>  
| {{TSS|Princess Maud|1934|2}}
|-
! 3
| style="text-align:center;" | 2nd, 3rd
| <code><nowiki>{{TSS|Princess Maud|1934|3}</nowiki>}</code>
| <code><nowiki>[[TSS Princess Maud (1934) |''Princess Maud'' (1934)]]</nowiki></code>
| {{TSS|Princess Maud|1934|3}}
|-
! 4
| style="text-align:center;" | invalid result
| <code><nowiki>{{TSS|Princess Maud|1934|4}</nowiki>}</code>
| <code><nowiki>[[TSS Princess Maud (1934) |Invalid Optional Parameter]]</nowiki></code>  
| {{TSS|Princess Maud|1934|4}}
|-
! 5
| style="text-align:center;" | 1st, 3rd
| <code><nowiki>{{TSS|Princess Maud|1934|5}</nowiki>}</code>
| <code><nowiki>[[TSS Princess Maud (1934) |TSS (1934)]]</nowiki></code>  
| {{TSS|Princess Maud|1934|5}}
|-
! 6
| style="text-align:center;" | 1st, 2nd
| <code><nowiki>{{TSS|Princess Maud|1934|6}</nowiki>}</code>
| <code><nowiki>[[TSS Princess Maud (1934) |TSS ''Princess Maud'']]</nowiki></code>  
| {{TSS|Princess Maud|1934|6}}
|-
|
| style="text-align:center;" | 2nd<br /><small>(no 3rd)</small>
| <code><nowiki>{{TSS|Caledonian Princess|3=2}}</nowiki></code> <br/> ''Alternate usage'': <code><nowiki>{{TSS|Caledonian Princess||2}}</nowiki></code>
| <code><nowiki>[[TSS Caledonian Princess|''Caledonian Princess'']]</nowiki></code>
| {{TSS|Caledonian Princess||2}}
|}
''N.B.'':  Be careful with the third parameter if not using the second parameter. In the ''Caledonian Princess'' example above, the "|3=2" means set the third parameter to a value of two, while the alternate syntax shows using a pair of pipes, "||2", to position the value two in the third parameter position. 

Using an optional display control parameter value of 6 yields the same results as using {{tl|warship}} to create the same link and text, but saving, coincidentally, 6 characters while editing.

  <code><nowiki>{{TSS|Princess Maud|1934|6}}</nowiki></code> yields the same results as <code><nowiki>{{warship|TSS|Princess Maud|1934}}</nowiki></code>

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

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

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->

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