Difference between revisions of "Template:ICGV/doc"

From blackwiki
Jump to navigation Jump to search
imported>隐世高人
imported>Jonesey95
m (Fix Linter errors using AutoEd)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
  
 
== Usage ==
 
== Usage ==
Line 8: Line 7:
 
=== Formal usage ===
 
=== Formal usage ===
  
* <tt><nowiki>{{ICGV|Ship Name}}</nowiki></tt>
+
* <code><nowiki>{{ICGV|Ship Name}}</nowiki></code>
  
 
=== Example ===
 
=== Example ===
Line 17: Line 16:
 
  ! Final result
 
  ! Final result
 
  |-
 
  |-
  | <tt><nowiki>{{ICGV|Óðinn}}</nowiki></tt>
+
  | <code><nowiki>{{ICGV|Óðinn}}</nowiki></code>
  | <tt><nowiki>[[ICGV Óðinn|ICGV ''Óðinn'']]</nowiki></tt>
+
  | <code><nowiki>[[ICGV Óðinn|ICGV ''Óðinn'']]</nowiki></code>
 
  | {{ICGV|Óðinn}}
 
  | {{ICGV|Óðinn}}
 
  |}
 
  |}
 
+
==Template data==
 
+
{{TemplateDataHeader}}
=== Optional display control parameter ===
+
<templatedata>
There is an optional third parameter that controls which pieces of text are displayed in the article.  Its value is treated as a binary number and will display the corresponding "bits".  So setting the 1's bit will display the ship name.  If binary math isn't your thing, refer to below examples:
+
{
{|class=wikitable width=100%
+
"params": {
! Value
+
"1": {
! Parameter(s)<br>displayed
+
"label": "Prefix",
! Example
+
"description": "Fleet identifier",
! Equivalent wikicode
+
"example": "HMS, Japanese battleship",
! Final result
+
"type": "string"
|-
+
},
! None
+
"2": {
| style="text-align:center;" | all
+
"label": "Name",
| <tt><nowiki>{{ICGV|Óðinn}}</nowiki></tt>
+
"description": "Ship's name",
| <tt><nowiki>[[ICGV Óðinn|ICGV ''Óðinn'']]</nowiki></tt>
+
"example": "Bismarck, Belgrano",
| {{ICGV|Óðinn}}
+
"type": "string"
|-
+
},
! 1
+
"3": {
| style="text-align:center;" | 2nd
+
"label": "ID",
| <tt><nowiki>{{ICGV|Óðinn|1}}</nowiki></tt>
+
"description": "Hull number, launch year, or pennanr number",
| <tt><nowiki>[[ICGV Óðinn|Óðinn]]</nowiki></tt>
+
"example": "H75, 1975, ",
| {{ICGV|Óðinn|1}}
+
"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||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+
[[Category:Ship prefix templates]]
[[Category:Ship templates|ICGV]]
+
}}</includeonly>
</includeonly>
 

Latest revision as of 02:15, 3 June 2020

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

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