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

From blackwiki
Jump to navigation Jump to search
imported>DePiep
m (Add TemplateData (via WP:JWB))
imported>DePiep
m (set categorisation to sandbox/other (via WP:JWB))
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
  
 
== Usage ==
 
== Usage ==
Line 80: Line 79:
 
{{WPSHIPS shortcut templates}}
 
{{WPSHIPS shortcut templates}}
  
<includeonly>
+
<includeonly>{{sandbox other||
 
 
 
[[Category:Ship templates|LÉ]]
 
[[Category:Ship templates|LÉ]]
</includeonly>
+
}}</includeonly>

Revision as of 19:12, 28 February 2018

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

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 LÉ

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