Difference between revisions of "Template:HMQS/doc"

From blackwiki
Jump to navigation Jump to search
imported>John of Reading
m (→‎Optional display control parameter: Typo fixing, replaced: It's value is → Its value is using AWB)
imported>DePiep
m (Add TemplateData (via WP:JWB))
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
+
<!-- Please add categories at the bottom of this page. -->
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
  
 
== Usage ==
 
== Usage ==
Line 82: Line 81:
  
 
*<nowiki>{{HMVS|Victoria|1855|6}} yields the same results as {{warship|HMVS|Victoria|1855}}</nowiki>
 
*<nowiki>{{HMVS|Victoria|1855|6}} yields the same results as {{warship|HMVS|Victoria|1855}}</nowiki>
 +
==Template data==
 +
{{TemplateDataHeader}}
 +
<templatedata>
 +
{
 +
"params": {
 +
"1": {
 +
"label": "Prefix",
 +
"description": "Fleet identifier",
 +
"example": "HMS, Japanese battleship",
 +
"type": "string"
 +
},
 +
"2": {
 +
"label": "Name",
 +
"description": "Ship's name",
 +
"example": "Bismarck, Belgrano",
 +
"type": "string"
 +
},
 +
"3": {
 +
"label": "ID",
 +
"description": "Hull number, launch year, or pennanr number",
 +
"example": "H75, 1975, ",
 +
"type": "string"
 +
},
 +
"4": {
 +
"label": "Format",
 +
"description": "Formats label (parts showing)",
 +
"example": "1, 2, 3, 5, 6",
 +
"default": "blank",
 +
"type": "number"
 +
},
 +
"up": {
 +
"label": "unlink prefix",
 +
"description": "yes=puts Fleet ID outside of Wikilink",
 +
"example": "up=yes",
 +
"default": "no",
 +
"type": "boolean"
 +
}
 +
},
 +
"description": "This template provides a wikilink to a ship's page, with label options",
 +
"paramOrder": [
 +
"1",
 +
"2",
 +
"3",
 +
"4",
 +
"up"
 +
]
 +
}
 +
</templatedata>
  
 
== See also ==
 
== See also ==
Line 87: Line 134:
  
 
<includeonly>
 
<includeonly>
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
  
 
[[Category:Ship templates]]
 
[[Category:Ship templates]]
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
 
</includeonly>
 
</includeonly>

Revision as of 17:51, 28 February 2018

Usage

This is a typing short cut for linking to Queensland Maritime Defence Force ship articles named in the format "HMVS Victoria (1855)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HMVS Victoria (1855)|HMVS ''Victoria'' (1855)]]. This template halves that to {{HMVS|Victoria|1855}}.

Formal usage

  • {{HMQS|Ship Name}}
  • {{HMQS|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
{{HMQS|Gayundah}} [[HMQS Gayundah|HMQS ''Gayundah'']] HMQS Gayundah

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

N.B.: Be careful with the third parameter if not using the second parameter. In the Gordon 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.

  • {{HMVS|Victoria|1855|6}} yields the same results as {{warship|HMVS|Victoria|1855}}

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for HMQS

This template provides a wikilink to a ship's page, with label options

Template parameters

ParameterDescriptionTypeStatus
Prefix1

Fleet identifier

Example
HMS, Japanese battleship
Stringoptional
Name2

Ship's name

Example
Bismarck, Belgrano
Stringoptional
ID3

Hull number, launch year, or pennanr number

Example
H75, 1975,
Stringoptional
Format4

Formats label (parts showing)

Default
blank
Example
1, 2, 3, 5, 6
Numberoptional
unlink prefixup

yes=puts Fleet ID outside of Wikilink

Default
no
Example
up=yes
Booleanoptional

See also

Template:WPSHIPS shortcut templates