Difference between revisions of "Template:ANS/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>隐世高人
(Created page with '{{Documentation subpage}} <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> == Usage == This is a typing short cut for linking to Alger...')
 
blackwiki>DePiep
m (Add TemplateData (via WP:JWB))
Line 33: Line 33:
  
 
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 ===
 
=== See also ===

Revision as of 17:37, 28 February 2018

Usage

This is a typing short cut for linking to Algerian National Navy ship articles named in the format "ANS Kalaat Béni Abbès (474)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[ANS Kalaat Béni Abbès (474)|ANS ''Kalaat Béni Abbès'' (474)]]. This template halves that to {{ANS|Kalaat Béni Abbès|474}}.

Formal usage

  • {{ANS|Ship Name}}
  • {{ANS|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
{{ANS|Kalaat Béni Abbès|474}} [[ANS Kalaat Béni Abbès (474)|ANS ''Kalaat Béni Abbès'' (474)]] ANS Kalaat Béni Abbès (474)
{{ANS|Kalaat Béni Abbès|2014}} [[ANS Kalaat Béni Abbès (2014)|ANS ''Kalaat Béni Abbès'' (2014)]] ANS Kalaat Béni Abbès (2014)
{{ANS|Kalaat Béni Abbès}} [[ANS Kalaat Béni Abbès|ANS ''Kalaat Béni Abbès'']] ANS Kalaat Béni Abbès

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 ANS

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