Difference between revisions of "Template:HSC/doc"

From blackwiki
Jump to navigation Jump to search
imported>WOSlinker
(fix tags)
imported>Jonesey95
m (Fix Linter errors using AutoEd)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
  
 
== Usage ==
 
== Usage ==
Line 8: Line 7:
 
=== Formal Usage ===
 
=== Formal Usage ===
  
* <tt><nowiki>{{HSC|Ship Name}}</nowiki></tt>
+
* <code><nowiki>{{HSC|Ship Name}}</nowiki></code>
* <tt><nowiki>{{HSC|Ship Name|ID}}</nowiki></tt>, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title.
+
* <code><nowiki>{{HSC|Ship Name|ID}}</nowiki></code>, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title.
  
 
=== Examples ===
 
=== Examples ===
Line 18: Line 17:
 
  ! Final result
 
  ! Final result
 
  |-
 
  |-
  | <tt><nowiki>{{HSC|Tarifa Jet|1997}}</nowiki></tt>
+
  | <code><nowiki>{{HSC|Tarifa Jet|1997}}</nowiki></code>
  | <tt><nowiki>[[HSC Tarifa Jet (1997)|HSC ''Tarifa Jet'' (1997)]]</nowiki></tt>
+
  | <code><nowiki>[[HSC Tarifa Jet (1997)|HSC ''Tarifa Jet'' (1997)]]</nowiki></code>
 
  | {{HSC|Tarifa Jet|1997}}
 
  | {{HSC|Tarifa Jet|1997}}
 
  |-
 
  |-
  | <tt><nowiki>{{HSC|Viking}}</nowiki></tt>
+
  | <code><nowiki>{{HSC|Viking}}</nowiki></code>
  | <tt><nowiki>[[HSC Viking|HSC ''Viking'']]</nowiki></tt>
+
  | <code><nowiki>[[HSC Viking|HSC ''Viking'']]</nowiki></code>
 
  | {{HSC|Viking}}
 
  | {{HSC|Viking}}
 
  |}
 
  |}
Line 33: Line 32:
 
{|class=wikitable width=100%
 
{|class=wikitable width=100%
 
! Value
 
! Value
! Parameter(s)<br>displayed
+
! Parameter(s)<br />displayed
 
! Example
 
! Example
 
! Equivalent wikicode
 
! Equivalent wikicode
Line 40: Line 39:
 
! None
 
! None
 
| style="text-align:center;" | all
 
| style="text-align:center;" | all
| <tt><nowiki>{{HSC|Tarifa Jet|1997}}</nowiki></tt>
+
| <code><nowiki>{{HSC|Tarifa Jet|1997}}</nowiki></code>
| <tt><nowiki>[[HSC Tarifa Jet (1997) |HSC ''Tarifa Jet'' (1997)]]</nowiki></tt>
+
| <code><nowiki>[[HSC Tarifa Jet (1997) |HSC ''Tarifa Jet'' (1997)]]</nowiki></code>
 
| {{HSC|Tarifa Jet|1997}}
 
| {{HSC|Tarifa Jet|1997}}
 
|-
 
|-
 
! 1
 
! 1
 
| style="text-align:center;" | 3rd
 
| style="text-align:center;" | 3rd
| <tt><nowiki>{{HSC|Tarifa Jet|1997|1}}</nowiki></tt>
+
| <code><nowiki>{{HSC|Tarifa Jet|1997|1}}</nowiki></code>
| <tt><nowiki>[[HSC Tarifa Jet (1997) |1997]]</nowiki></tt>
+
| <code><nowiki>[[HSC Tarifa Jet (1997) |1997]]</nowiki></code>
 
| {{HSC|Tarifa Jet|1997|1}}
 
| {{HSC|Tarifa Jet|1997|1}}
 
|-
 
|-
 
! 2
 
! 2
 
| style="text-align:center;" | 2nd
 
| style="text-align:center;" | 2nd
| <tt><nowiki>{{HSC|Tarifa Jet|1997|2}</nowiki>}</tt>
+
| <code><nowiki>{{HSC|Tarifa Jet|1997|2}</nowiki>}</code>
| <tt><nowiki>[[HSC Tarifa Jet (1997) |''Tarifa Jet'']]</nowiki></tt>   
+
| <code><nowiki>[[HSC Tarifa Jet (1997) |''Tarifa Jet'']]</nowiki></code>   
 
| {{HSC|Tarifa Jet|1997|2}}
 
| {{HSC|Tarifa Jet|1997|2}}
 
|-
 
|-
 
! 3
 
! 3
 
| style="text-align:center;" | 2nd, 3rd
 
| style="text-align:center;" | 2nd, 3rd
| <tt><nowiki>{{HSC|Tarifa Jet|1997|3}</nowiki>}</tt>
+
| <code><nowiki>{{HSC|Tarifa Jet|1997|3}</nowiki>}</code>
| <tt><nowiki>[[HSC Tarifa Jet (1997) |''Tarifa Jet'' (1997)]]</nowiki></tt>
+
| <code><nowiki>[[HSC Tarifa Jet (1997) |''Tarifa Jet'' (1997)]]</nowiki></code>
 
| {{HSC|Tarifa Jet|1997|3}}
 
| {{HSC|Tarifa Jet|1997|3}}
 
|-
 
|-
 
! 4
 
! 4
 
| style="text-align:center;" | invalid result
 
| style="text-align:center;" | invalid result
| <tt><nowiki>{{HSC|Tarifa Jet|1997|4}</nowiki>}</tt>
+
| <code><nowiki>{{HSC|Tarifa Jet|1997|4}</nowiki>}</code>
| <tt><nowiki>[[HSC Tarifa Jet (1997) |Invalid Optional Parameter]]</nowiki></tt>   
+
| <code><nowiki>[[HSC Tarifa Jet (1997) |Invalid Optional Parameter]]</nowiki></code>   
 
| {{HSC|Tarifa Jet|1997|4}}
 
| {{HSC|Tarifa Jet|1997|4}}
 
|-
 
|-
 
! 5
 
! 5
 
| style="text-align:center;" | 1st, 3rd
 
| style="text-align:center;" | 1st, 3rd
| <tt><nowiki>{{HSC|Tarifa Jet|1997|5}</nowiki>}</tt>
+
| <code><nowiki>{{HSC|Tarifa Jet|1997|5}</nowiki>}</code>
| <tt><nowiki>[[HSC Tarifa Jet (1997) |HSC (1997)]]</nowiki></tt>   
+
| <code><nowiki>[[HSC Tarifa Jet (1997) |HSC (1997)]]</nowiki></code>   
 
| {{HSC|Tarifa Jet|1997|5}}
 
| {{HSC|Tarifa Jet|1997|5}}
 
|-
 
|-
 
! 6
 
! 6
 
| style="text-align:center;" | 1st, 2nd
 
| style="text-align:center;" | 1st, 2nd
| <tt><nowiki>{{HSC|Tarifa Jet|1997|6}</nowiki>}</tt>
+
| <code><nowiki>{{HSC|Tarifa Jet|1997|6}</nowiki>}</code>
| <tt><nowiki>[[HSC Tarifa Jet (1997) |HSC ''Tarifa Jet'']]</nowiki></tt>   
+
| <code><nowiki>[[HSC Tarifa Jet (1997) |HSC ''Tarifa Jet'']]</nowiki></code>   
 
| {{HSC|Tarifa Jet|1997|6}}
 
| {{HSC|Tarifa Jet|1997|6}}
 
|-
 
|-
 
|
 
|
| style="text-align:center;" | 2nd<br><small>(no 3rd)</small>
+
| style="text-align:center;" | 2nd<br /><small>(no 3rd)</small>
| <tt><nowiki>{{HSC|Viking|3=2}}</nowiki></tt> <br/> ''Alternate usage'': <tt><nowiki>{{HSC|Viking||2}}</nowiki></tt>
+
| <code><nowiki>{{HSC|Viking|3=2}}</nowiki></code> <br/> ''Alternate usage'': <code><nowiki>{{HSC|Viking||2}}</nowiki></code>
| <tt><nowiki>[[HSC Viking|''Viking'']]</nowiki></tt>
+
| <code><nowiki>[[HSC Viking|''Viking'']]</nowiki></code>
 
| {{HSC|Viking||2}}
 
| {{HSC|Viking||2}}
 
|}
 
|}
Line 90: Line 89:
 
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.
 
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.
  
   <tt><nowiki>{{HSC|Tarifa Jet|1997|6}}</nowiki></tt> yields the same results as <tt><nowiki>{{warship|HSC|Tarifa Jet|1997}}</nowiki></tt>
+
   <code><nowiki>{{HSC|Tarifa Jet|1997|6}}</nowiki></code> yields the same results as <code><nowiki>{{warship|HSC|Tarifa Jet|1997}}</nowiki></code>
 +
 
 +
== TemplateData ==
 +
{{Template:Ship/doc/fixed prefix: TemplateData}}
  
 
== See also ==
 
== See also ==
 
{{WPSHIPS shortcut templates}}
 
{{WPSHIPS shortcut templates}}
  
<includeonly>
+
<includeonly>{{sandbox other||
 
+
[[Category:Ship prefix templates]]
<!-- ADD CATEGORIES BELOW THIS LINE -->
+
}}</includeonly>
 
 
[[Category:Ship templates]]
 
 
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
 
 
</includeonly>
 

Latest revision as of 02:09, 3 June 2020

Usage

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

Formal Usage

  • {{HSC|Ship Name}}
  • {{HSC|Ship Name|ID}}, where ID can be the hull number, launch year, or pennant number, as specified in the article title.

Examples

Template usage Equivalent wikicode Final result
{{HSC|Tarifa Jet|1997}} [[HSC Tarifa Jet (1997)|HSC ''Tarifa Jet'' (1997)]] HSC Tarifa Jet (1997)
{{HSC|Viking}} [[HSC Viking|HSC ''Viking'']] HSC Viking

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 HSC, 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:

Value Parameter(s)
displayed
Example Equivalent wikicode Final result
None all {{HSC|Tarifa Jet|1997}} [[HSC Tarifa Jet (1997) |HSC ''Tarifa Jet'' (1997)]] HSC Tarifa Jet (1997)
1 3rd {{HSC|Tarifa Jet|1997|1}} [[HSC Tarifa Jet (1997) |1997]] 1997
2 2nd {{HSC|Tarifa Jet|1997|2}} [[HSC Tarifa Jet (1997) |''Tarifa Jet'']] Tarifa Jet
3 2nd, 3rd {{HSC|Tarifa Jet|1997|3}} [[HSC Tarifa Jet (1997) |''Tarifa Jet'' (1997)]] Tarifa Jet (1997)
4 invalid result {{HSC|Tarifa Jet|1997|4}} [[HSC Tarifa Jet (1997) |Invalid Optional Parameter]] HSC Tarifa Jet (1997)
5 1st, 3rd {{HSC|Tarifa Jet|1997|5}} [[HSC Tarifa Jet (1997) |HSC (1997)]] HSC 1997
6 1st, 2nd {{HSC|Tarifa Jet|1997|6}} [[HSC Tarifa Jet (1997) |HSC ''Tarifa Jet'']] HSC Tarifa Jet
2nd
(no 3rd)
{{HSC|Viking|3=2}}
Alternate usage: {{HSC|Viking||2}}
[[HSC Viking|''Viking'']] Viking

N.B.: Be careful with the third parameter if not using the second parameter. In the Viking 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 {{warship}} to create the same link and text, but saving, coincidentally, 6 characters while editing.

 {{HSC|Tarifa Jet|1997|6}} yields the same results as {{warship|HSC|Tarifa Jet|1997}}

TemplateData

Template:Ship/doc/fixed prefix: TemplateData

See also

Template:WPSHIPS shortcut templates