Difference between revisions of "Template:LÉ/doc"
Jump to navigation
Jump to search
imported>Varlaam (Irish Navy) |
imported>DePiep m (Add TemplateData (via WP:JWB)) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
| − | + | ||
== Usage == | == Usage == | ||
| Line 10: | Line 10: | ||
* <tt><nowiki>{{LÉ|Ship Name}}</nowiki></tt> | * <tt><nowiki>{{LÉ|Ship Name}}</nowiki></tt> | ||
* <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. | * <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. | ||
| − | |||
=== Examples === | === Examples === | ||
| Line 29: | Line 28: | ||
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> | ||
| + | { | ||
| + | "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 == | |
{{WPSHIPS shortcut templates}} | {{WPSHIPS shortcut templates}} | ||
<includeonly> | <includeonly> | ||
| − | + | ||
[[Category:Ship templates|LÉ]] | [[Category:Ship templates|LÉ]] | ||
</includeonly> | </includeonly> | ||
Revision as of 17:59, 28 February 2018
| This is a documentation subpage for Template:LÉ. It contains usage information, categories and other content that is not part of the original template page. |
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
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Prefix | 1 | Fleet identifier
| String | optional |
| Name | 2 | Ship's name
| String | optional |
| ID | 3 | Hull number, launch year, or pennanr number
| String | optional |
| Format | 4 | Formats label (parts showing)
| Number | optional |
| unlink prefix | up | yes=puts Fleet ID outside of Wikilink
| Boolean | optional |
See also
Template:WPSHIPS shortcut templates