Difference between revisions of "Template:ICGV/doc"
Jump to navigation
Jump to search
imported>Jonesey95 |
|||
| (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 === | ||
| − | * < | + | * <code><nowiki>{{ICGV|Ship Name}}</nowiki></code> |
=== Example === | === Example === | ||
| Line 17: | Line 16: | ||
! Final result | ! Final result | ||
|- | |- | ||
| − | | < | + | | <code><nowiki>{{ICGV|Óðinn}}</nowiki></code> |
| − | | < | + | | <code><nowiki>[[ICGV Óðinn|ICGV ''Óðinn'']]</nowiki></code> |
| {{ICGV|Óðinn}} | | {{ICGV|Óðinn}} | ||
|} | |} | ||
| + | ==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 == | == See also == | ||
{{WPSHIPS shortcut templates}} | {{WPSHIPS shortcut templates}} | ||
| − | <includeonly> | + | <includeonly>{{sandbox other|| |
| − | + | [[Category:Ship prefix templates]] | |
| − | [[Category:Ship templates | + | }}</includeonly> |
| − | </includeonly> | ||
Latest revision as of 02:15, 3 June 2020
| This is a documentation subpage for Template:ICGV. 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 Icelandic Coast Guard ship articles named in the format "ICGV Óðinn". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[ICGV Óðinn|ICGV ''Óðinn'']]. This template halves that to {{ICGV|Óðinn}}.
Formal usage
{{ICGV|Ship Name}}
Example
| Template usage | Equivalent wikicode | Final result |
|---|---|---|
{{ICGV|Óðinn}}
|
[[ICGV Óðinn|ICGV ''Óðinn'']]
|
ICGV Óðinn |
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 ICGV
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