Difference between revisions of "Template:INS/doc"

From blackwiki
Jump to navigation Jump to search
imported>Swpb
m (→‎See also: clean up using AWB)
imported>Jonesey95
m (Fix Linter errors using AutoEd)
 
(10 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
  
== Usage ==
 
 
This is a typing short cut for linking to [[Indian Navy]] ship articles named in the format "INS Mahé (M-83)".  Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as <nowiki>[[INS Mahé (M-83)|INS ''Mahé'' (M-83)]]</nowiki>.  This template halves that to <nowiki>{{INS|Mahé|M-83}}.
 
This is a typing short cut for linking to [[Indian Navy]] ship articles named in the format "INS Mahé (M-83)".  Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as <nowiki>[[INS Mahé (M-83)|INS ''Mahé'' (M-83)]]</nowiki>.  This template halves that to <nowiki>{{INS|Mahé|M-83}}.
 
</nowiki>
 
</nowiki>
  
=== Formal usage ===
+
== Formal usage ==
  
* <tt><nowiki>{{INS|Ship Name}}</nowiki></tt>
+
* <code><nowiki>{{INS|Ship Name}}</nowiki></code>
* <tt><nowiki>{{INS|Ship Name|ID}}</nowiki></tt>, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title.
+
* <code><nowiki>{{INS|Ship Name|ID}}</nowiki></code>, where ID can be the [[hull number]], launch year, or [[pennant number]], as specified in the article title.
  
 
=== Examples ===
 
=== Examples ===
Line 17: Line 16:
 
  ! Final result
 
  ! Final result
 
  |-
 
  |-
  | <tt><nowiki>{{INS|Mahé|M 83}}</nowiki></tt>
+
  | <code><nowiki>{{INS|Mahé|M 83}}</nowiki></code>
  | <tt><nowiki>[[INS Mahé (M 83)|INS ''Mahé'' (M 83)]]</nowiki></tt>
+
  | <code><nowiki>[[INS Mahé (M 83)|INS ''Mahé'' (M 83)]]</nowiki></code>
 
  | {{INS|Mahé|M 83}}
 
  | {{INS|Mahé|M 83}}
 
  |-
 
  |-
  | <tt><nowiki>{{INS|Mahé|1983}}</nowiki></tt>
+
  | <code><nowiki>{{INS|Mahé|1983}}</nowiki></code>
  | <tt><nowiki>[[INS Mahé (1983)|INS ''Mahé'' (1983)]]</nowiki></tt>
+
  | <code><nowiki>[[INS Mahé (1983)|INS ''Mahé'' (1983)]]</nowiki></code>
 
  | {{INS|Mahé|1983}}
 
  | {{INS|Mahé|1983}}
 
  |-
 
  |-
  | <tt><nowiki>{{INS|Mahé}}</nowiki></tt>
+
  | <code><nowiki>{{INS|Mahé}}</nowiki></code>
  | <tt><nowiki>[[INS Mahé|INS ''Mahé'']]</nowiki></tt>
+
  | <code><nowiki>[[INS Mahé|INS ''Mahé'']]</nowiki></code>
 
  | {{INS|Mahé}}
 
  | {{INS|Mahé}}
 
  |}
 
  |}
  
 
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==
+
{{Ship/doc/fixed prefix: label format options}}
{{TemplateDataHeader}}
+
 
<templatedata>
+
== TemplateData ==
{
+
{{Ship/doc/fixed prefix: 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 ==
Line 85: Line 40:
 
<includeonly>{{sandbox other||
 
<includeonly>{{sandbox other||
 
[[Category:Ship prefix templates|INS]]
 
[[Category:Ship prefix templates|INS]]
 +
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 02:15, 3 June 2020

This is a typing short cut for linking to Indian Navy ship articles named in the format "INS Mahé (M-83)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[INS Mahé (M-83)|INS ''Mahé'' (M-83)]]. This template halves that to {{INS|Mahé|M-83}}.

Formal usage

  • {{INS|Ship Name}}
  • {{INS|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
{{INS|Mahé|M 83}} [[INS Mahé (M 83)|INS ''Mahé'' (M 83)]] INS Mahé (M 83)
{{INS|Mahé|1983}} [[INS Mahé (1983)|INS ''Mahé'' (1983)]] INS Mahé (1983)
{{INS|Mahé}} [[INS Mahé|INS ''Mahé'']] INS Mahé

Last example could be used to link to ship index (disambiguation) page Template:Ship/doc/fixed prefix: label format options

TemplateData

Template:Ship/doc/fixed prefix: TemplateData

See also

Template:WPSHIPS shortcut templates