Difference between revisions of "Template:HS/doc"

From blackwiki
Jump to navigation Jump to search
imported>DePiep
m (set categorisation to sandbox/other (via WP:JWB))
imported>Jonesey95
m (Fix Linter errors using AutoEd)
 
(2 intermediate revisions by 2 users not shown)
Line 7: Line 7:
 
=== Formal usage ===
 
=== Formal usage ===
  
* <tt><nowiki>{{HS|Ship Name}}</nowiki></tt>
+
* <code><nowiki>{{HS|Ship Name}}</nowiki></code>
* <tt><nowiki>{{HS|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>{{HS|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 17: Line 17:
 
  ! Final result
 
  ! Final result
 
  |-
 
  |-
  | <tt><nowiki>{{HS|Georgios Averof|1910}}</nowiki></tt>
+
  | <code><nowiki>{{HS|Georgios Averof|1910}}</nowiki></code>
  | <tt><nowiki>[[HS Georgios Averof (1910)|HS ''Georgios Averof'' (1910)]]</nowiki></tt>
+
  | <code><nowiki>[[HS Georgios Averof (1910)|HS ''Georgios Averof'' (1910)]]</nowiki></code>
 
  | {{HS|Georgios Averof|1910}}
 
  | {{HS|Georgios Averof|1910}}
 
  |-
 
  |-
  | <tt><nowiki>{{HS|Georgios Averof}}</nowiki></tt>
+
  | <code><nowiki>{{HS|Georgios Averof}}</nowiki></code>
  | <tt><nowiki>[[HS Georgios Averof|HS ''Georgios Averof'']]</nowiki></tt>
+
  | <code><nowiki>[[HS Georgios Averof|HS ''Georgios Averof'']]</nowiki></code>
 
  | {{HS|Georgios Averof}}
 
  | {{HS|Georgios Averof}}
 
  |}
 
  |}
  
 
Last example could be used to link to ship index (disambiguation) page
 
Last example could be used to link to ship index (disambiguation) page
==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 ==
Line 80: Line 35:
  
 
<includeonly>{{sandbox other||
 
<includeonly>{{sandbox other||
[[Category:Ship templates|HS]]
+
[[Category:Ship prefix templates|HS]]
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 02:09, 3 June 2020

Usage

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

Formal usage

  • {{HS|Ship Name}}
  • {{HS|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
{{HS|Georgios Averof|1910}} [[HS Georgios Averof (1910)|HS ''Georgios Averof'' (1910)]] HS Georgios Averof (1910)
{{HS|Georgios Averof}} [[HS Georgios Averof|HS ''Georgios Averof'']] HS Georgios Averof

Last example could be used to link to ship index (disambiguation) page

TemplateData

Template:Ship/doc/fixed prefix: TemplateData

See also

Template:WPSHIPS shortcut templates