Difference between revisions of "Template:LÉ/doc"

From blackwiki
Jump to navigation Jump to search
imported>DePiep
m (Add TemplateData (via WP:JWB))
imported>Jonesey95
m (Fix Linter errors using AutoEd)
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
  
 
== Usage ==
 
== Usage ==
Line 8: Line 7:
 
=== Formal usage ===
 
=== Formal usage ===
  
* <tt><nowiki>{{LÉ|Ship Name}}</nowiki></tt>
+
* <code><nowiki>{{LÉ|Ship Name}}</nowiki></code>
* <tt><nowiki>{{LÉ|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>{{LÉ|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>{{LÉ|Emer|P21}}</nowiki></tt>
+
  | <code><nowiki>{{LÉ|Emer|P21}}</nowiki></code>
  | <tt><nowiki>[[LÉ Emer (P21)|LÉ ''Emer'' (P21)]]</nowiki></tt>
+
  | <code><nowiki>[[LÉ Emer (P21)|LÉ ''Emer'' (P21)]]</nowiki></code>
 
  | {{LÉ|Emer|P21}}
 
  | {{LÉ|Emer|P21}}
 
  |-
 
  |-
  | <tt><nowiki>{{LÉ|Emer}}</nowiki></tt>
+
  | <code><nowiki>{{LÉ|Emer}}</nowiki></code>
  | <tt><nowiki>[[LÉ Emer|LÉ ''Emer'']]</nowiki></tt>
+
  | <code><nowiki>[[LÉ Emer|LÉ ''Emer'']]</nowiki></code>
 
  | {{LÉ|Emer}}
 
  | {{LÉ|Emer}}
 
  |}
 
  |}
  
 
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 ==
 
{{WPSHIPS shortcut templates}}
 
{{WPSHIPS shortcut templates}}
  
<includeonly>
+
<includeonly>{{sandbox other||
 
+
[[Category:Ship prefix templates|LÉ]]
[[Category:Ship templates|LÉ]]
+
}}</includeonly>
</includeonly>
 

Latest revision as of 17:51, 3 June 2020

Usage

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

Formal usage

  • {{LÉ|Ship Name}}
  • {{LÉ|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
{{LÉ|Emer|P21}} [[LÉ Emer (P21)|LÉ ''Emer'' (P21)]] LÉ Emer (P21)
{{LÉ|Emer}} [[LÉ Emer|LÉ ''Emer'']] LÉ Emer

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