Difference between revisions of "Template:HMBS/doc"

From blackwiki
Jump to navigation Jump to search
imported>DePiep
m (Add TemplateData (via WP:JWB))
imported>DePiep
m (TemplateData: use central template form for all prefix ship templates (via WP:JWB))
 
(2 intermediate revisions by 2 users not shown)
Line 72: Line 72:
  
 
*<nowiki>{{HMBS|Nassau|P-61|6}} yields the same results as {{warship|HMBS|Nassau|P-61}}</nowiki>
 
*<nowiki>{{HMBS|Nassau|P-61|6}} yields the same results as {{warship|HMBS|Nassau|P-61}}</nowiki>
==Template data==
+
 
{{TemplateDataHeader}}
+
== TemplateData ==
<templatedata>
+
{{Template:Ship/doc/fixed prefix: 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 ==
 
{{WPSHIPS shortcut templates}}
 
{{WPSHIPS shortcut templates}}
  
<includeonly>
+
<includeonly>{{sandbox other||
[[Category:Ship templates]]
+
[[Category:Ship prefix templates]]
 
+
}}</includeonly>
</includeonly>
 

Latest revision as of 17:42, 19 March 2018

Usage

This is a typing short cut for linking to Royal Bahamas Defence Force ship articles named in the format "HMBS Nassau (P-61)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HMBS Nassau (P-61)|HMBS ''Nassau'' (P-61)]]. This template halves that to {{HMBS|Nassau|P-61}}.

Formal usage

  • {{HMBS|Ship Name}}
  • {{HMBS|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
{{HMBS|Nassau|P-61}} [[HMBS Nassau (P-61)|HMBS ''Nassau'' (P-61)]] HMBS Nassau (P-61)

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 "HMBS", 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 {{HMBS|Nassau|P-61|1}} [[HMBS Nassau (P-61)|P-61]] P-61
2 2nd {{HMBS|Nassau|P-61|2}} [[HMBS Nassau (P-61)|''Nassau'']] Nassau
3 2nd, 3rd {{HMBS|Nassau|P-61|3}} [[HMBS Nassau (P-61)|''Nassau'' (P-61)]] HMBS Nassau (P-61)
4 invalid result {{HMBS|Nassau|P-61|4}} [[HMBS Nassau (P-61)|Invalid Optional Parameter]] HMBS Nassau (P-61)
5 1st, 3rd {{HMBS|Nassau|P-61|5}} [[HMBS Nassau (P-61)|HMBS (P-61)]] HMBS P-61
6 1st, 2nd {{HMBS|Nassau|P-61|6}} [[HMBS Nassau (P-61)|HMBS ''Nassau'']] HMBS Nassau

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.

  • {{HMBS|Nassau|P-61|6}} yields the same results as {{warship|HMBS|Nassau|P-61}}

TemplateData

Template:Ship/doc/fixed prefix: TemplateData

See also

Template:WPSHIPS shortcut templates