Difference between revisions of "Template:HNoMS/doc"

From blackwiki
Jump to navigation Jump to search
imported>Mjroots
(rmv page stretch)
imported>DePiep
m (TemplateData: use central template form for all prefix ship templates (via WP:JWB))
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
  
 
== Usage ==
 
== Usage ==
Line 34: Line 33:
  
 
=== Optional display control parameter ===
 
=== Optional display control parameter ===
There is an optional third parameter that controls which pieces of text are displayed in the article.  It's value is treated as a binary number and will display the corresponding "bits".  So setting the 4's bit will display "HNoMS", 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:
+
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 "HNoMS", 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%"
 
{|class=wikitable width="100%"
 
! Value
 
! Value
Line 43: Line 42:
 
|-
 
|-
 
! 1
 
! 1
| align=center | 3rd
+
| style="text-align:center;" | 3rd
 
| colspan=2 | <nowiki>{{HNoMS|Svenner|G03|1}}</nowiki>
 
| colspan=2 | <nowiki>{{HNoMS|Svenner|G03|1}}</nowiki>
 
| <nowiki>[[HNoMS Svenner (G03)|G03]]</nowiki>
 
| <nowiki>[[HNoMS Svenner (G03)|G03]]</nowiki>
Line 49: Line 48:
 
|-
 
|-
 
! 2
 
! 2
| align=center | 2nd
+
| style="text-align:center;" | 2nd
 
| colspan=2 | <nowiki>{{HNoMS|Svenner|G03|2}</nowiki>}
 
| colspan=2 | <nowiki>{{HNoMS|Svenner|G03|2}</nowiki>}
 
| <nowiki>[[HNoMS Svenner (G03)|''Svenner'']]</nowiki>
 
| <nowiki>[[HNoMS Svenner (G03)|''Svenner'']]</nowiki>
Line 55: Line 54:
 
|-
 
|-
 
! 3
 
! 3
| align=center | 2nd, 3rd
+
| style="text-align:center;" | 2nd, 3rd
 
| colspan=2 | <nowiki>{{HNoMS|Svenner|G03|3}}</nowiki>
 
| colspan=2 | <nowiki>{{HNoMS|Svenner|G03|3}}</nowiki>
 
| <nowiki>[[HNoMS Svenner (G03)|''Svenner'' G03]]</nowiki>
 
| <nowiki>[[HNoMS Svenner (G03)|''Svenner'' G03]]</nowiki>
Line 61: Line 60:
 
|-
 
|-
 
! 4
 
! 4
| align=center | invalid result
+
| style="text-align:center;" | invalid result
 
| colspan=2 | <nowiki>{{HNoMS|Svenner|G03|4}}</nowiki>
 
| colspan=2 | <nowiki>{{HNoMS|Svenner|G03|4}}</nowiki>
 
| <nowiki>[[HNoMS Svenner (G03)|Invalid Optional Parameter]]</nowiki>
 
| <nowiki>[[HNoMS Svenner (G03)|Invalid Optional Parameter]]</nowiki>
Line 67: Line 66:
 
|-
 
|-
 
! 5
 
! 5
| align=center | 1st, 3rd
+
| style="text-align:center;" | 1st, 3rd
 
| colspan=2 | <nowiki>{{HNoMS|Svenner|G03|5}}</nowiki>
 
| colspan=2 | <nowiki>{{HNoMS|Svenner|G03|5}}</nowiki>
 
| <nowiki>[[HNoMS Svenner (G03)|HNoMS G03]]</nowiki>
 
| <nowiki>[[HNoMS Svenner (G03)|HNoMS G03]]</nowiki>
Line 73: Line 72:
 
|-
 
|-
 
! 6
 
! 6
| align=center | 1st, 2nd
+
| style="text-align:center;" | 1st, 2nd
 
| colspan=2 | <nowiki>{{HNoMS|Svenner|G03|6}}</nowiki>
 
| colspan=2 | <nowiki>{{HNoMS|Svenner|G03|6}}</nowiki>
 
| <nowiki>[[HNoMS Svenner (G03)|HNoMS ''Svenner'']]</nowiki>
 
| <nowiki>[[HNoMS Svenner (G03)|HNoMS ''Svenner'']]</nowiki>
Line 79: Line 78:
 
|-
 
|-
 
!
 
!
| align=center | 2nd<br><small>(no 3rd)</small>
+
| style="text-align:center;" | 2nd<br><small>(no 3rd)</small>
 
| <nowiki>{{HNoMS|Eidsvold|3=2}}</nowiki>
 
| <nowiki>{{HNoMS|Eidsvold|3=2}}</nowiki>
 
| <nowiki>Alternate usage: {{HNoMS|Eidsvold||2}}</nowiki>
 
| <nowiki>Alternate usage: {{HNoMS|Eidsvold||2}}</nowiki>
Line 87: Line 86:
 
''N.B.'':  Be careful with the third parameter if not using the second parameter. In the ''Eidsvold'' 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.
 
''N.B.'':  Be careful with the third parameter if not using the second parameter. In the ''Eidsvold'' 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.
+
Using an optional display control parameter value of 6 yields the same results as using {{tl|warship}} to create the same link and text. <nowiki>{{HNoMS|Svenner|G03|6}} yields the same results as {{warship|HNoMS|Svenner|G03}}</nowiki>
  
<nowiki>{{HNoMS|Svenner|G03|6}} yields the same results as {{warship|HNoMS|Svenner|G03}}</nowiki>
+
== 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:WikiProject Ships templates|HMS]]
 
 
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
 
 
</includeonly>
 

Latest revision as of 17:43, 19 March 2018

Usage

This is a typing short cut for linking to Royal Norwegian Navy ship articles named in the format "HNoMS Svenner (G03)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HnoMS Svenner (G03)|HNoMS ''Svenner'' (G03)]]. This template halves that to {{HNoMS|Svenner|G03}}.

Formal usage

 {{HNoMS|Ship Name}}
 {{HNoMS|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
{{HNoMS|Svenner|G03}} [[HNoMS Svenner (G03)|HNoMS ''Svenner'' (G03)]] HNoMS Svenner (G03)
{{HNoMS|Sleipner|1936}} [[HNoMS Sleipner (1936)|HMS ''Sleipner'' (1768)]] HNoMS Sleipner (1936)
{{HNoMS|Eidsvold}} [[HNoMS Eidsvold|HMS ''Eidsvold'']] HNoMS Eidsvold

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 "HNoMS", 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
1 3rd {{HNoMS|Svenner|G03|1}} [[HNoMS Svenner (G03)|G03]] G03
2 2nd {{HNoMS|Svenner|G03|2}} [[HNoMS Svenner (G03)|''Svenner'']] Svenner
3 2nd, 3rd {{HNoMS|Svenner|G03|3}} [[HNoMS Svenner (G03)|''Svenner'' G03]] Svenner (G03)
4 invalid result {{HNoMS|Svenner|G03|4}} [[HNoMS Svenner (G03)|Invalid Optional Parameter]] HNoMS Svenner (G03)
5 1st, 3rd {{HNoMS|Svenner|G03|5}} [[HNoMS Svenner (G03)|HNoMS G03]] HNoMS G03
6 1st, 2nd {{HNoMS|Svenner|G03|6}} [[HNoMS Svenner (G03)|HNoMS ''Svenner'']] HNoMS Svenner
2nd
(no 3rd)
{{HNoMS|Eidsvold|3=2}} Alternate usage: {{HNoMS|Eidsvold||2}} [[HNoMS Eidsvold|''Eidsvold'']] Eidsvold

N.B.: Be careful with the third parameter if not using the second parameter. In the Eidsvold 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. {{HNoMS|Svenner|G03|6}} yields the same results as {{warship|HNoMS|Svenner|G03}}

TemplateData

Template:Ship/doc/fixed prefix: TemplateData

See also

Template:WPSHIPS shortcut templates