Difference between revisions of "Template:Specs-Link/Documentation"

From War Thunder Wiki
Jump to: navigation, search
Visual (beta)Wikitext
(Added parameters to TemplateData)
(→‎Usage: Updated override example)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{docpage}}
 
{{docpage}}
 +
__NOTOC__
 +
== Description ==
 +
This template can be used to quickly insert a link to the corresponding article of a vehicle using their code. The displayed link uses a shortened name of the vehicle.
  
−
This template can be used to quickly insert a link to the corresponding article of a vehicle using their code. The displayed link uses a shortened name of the vehicle.
+
== Usage ==
 +
The template is structured as <code><nowiki>{{Specs-Link| "arg1" | "arg2"}}</nowiki></code>
  
−
Example: {{Specs-Link|f-86f-40_japan}}
+
* '''"arg1"''' must be the vehicle's in-game code. This can be found at the top of the vehicle's wiki article while in the wikitext editor, after "code=". This code is case sensitive. E.g. {{Specs-Link|f-86f-40_japan|f-86f-40_japan}}
−
<pre>{{Specs-Link|f-86f-40_japan}}</pre>
+
 
 +
* '''"arg2"''' is optional. It allows the overriding of the text inserted by the template, while retaining the correct link to the vehicle's article. Overriding should only be used in cases where it explicitly disambiguates the link. Example:
 +
** <code><nowiki>fw-190a-5</nowiki></code> displays as {{Specs-Link|fw-190a-5}}, while <code><nowiki>fw-190a-5_cannons</nowiki></code> also displays as {{Specs-Link|fw-190a-5_cannons}}. This can be confusing, so it would be acceptable to override <code><nowiki>fw-190a-5</nowiki></code> to display as {{Specs-Link|fw-190a-5|Fw 190 A-5/U12}}.
 +
** "arg2" also accepts 2 predefined values that set the form of the automatically inserted name.
 +
*** "short" - Inserts the name provided by <code><nowiki>{{Specs|pseudonym}}</nowiki></code> of the given vehicle. This is the same as the default behaviour (i.e. omitting "arg2" altogether).
 +
**** <code><nowiki>{{Specs-Link|us_m1_abrams}}</nowiki></code> : {{Specs-Link|us_m1_abrams}}
 +
**** <code><nowiki>{{Specs-Link|us_m1_abrams|short}}</nowiki></code> : {{Specs-Link|us_m1_abrams|short}}
 +
*** "full" - Inserts the name provided by <code><nowiki>{{Specs|name}}</nowiki></code> of the given vehicle, which sometimes but doesn't necessarily differ from <code><nowiki>{{Specs|pseudonym}}</nowiki></code>.
 +
**** <code><nowiki>{{Specs-Link|us_m1_abrams|full}}</nowiki></code> : {{Specs-Link|us_m1_abrams|full}}
  
 
{{sp-begin|TemplateData}}
 
{{sp-begin|TemplateData}}
Line 21: Line 33:
 
"label": "Optional name override",
 
"label": "Optional name override",
 
"description": "Overrides the displayed text of the link. DO NOT USE unless it explicitly disambiguates the link (i.e. if two different vehicles display with the same name).",
 
"description": "Overrides the displayed text of the link. DO NOT USE unless it explicitly disambiguates the link (i.e. if two different vehicles display with the same name).",
−
"example": "␗Ki-84 ko",
+
"example": "Fw 190 A-5/U12",
 
"type": "string"
 
"type": "string"
 
}
 
}

Latest revision as of 14:59, 27 April 2022

Template page   Documentation   Using the template

Description

This template can be used to quickly insert a link to the corresponding article of a vehicle using their code. The displayed link uses a shortened name of the vehicle.

Usage

The template is structured as {{Specs-Link| "arg1" | "arg2"}}

  • "arg1" must be the vehicle's in-game code. This can be found at the top of the vehicle's wiki article while in the wikitext editor, after "code=". This code is case sensitive. E.g. f-86f-40_japan
  • "arg2" is optional. It allows the overriding of the text inserted by the template, while retaining the correct link to the vehicle's article. Overriding should only be used in cases where it explicitly disambiguates the link. Example:
    • fw-190a-5 displays as Fw 190 A-5, while fw-190a-5_cannons also displays as Fw 190 A-5. This can be confusing, so it would be acceptable to override fw-190a-5 to display as Fw 190 A-5/U12.
    • "arg2" also accepts 2 predefined values that set the form of the automatically inserted name.
      • "short" - Inserts the name provided by {{Specs|pseudonym}} of the given vehicle. This is the same as the default behaviour (i.e. omitting "arg2" altogether).
      • "full" - Inserts the name provided by {{Specs|name}} of the given vehicle, which sometimes but doesn't necessarily differ from {{Specs|pseudonym}}.

TemplateData

This template can be used to quickly insert a link to the corresponding article of a vehicle using their code. The displayed link uses a shortened name of the vehicle.

Template parameters

ParameterDescriptionTypeStatus
Vehicle code1

The vehicle's in-game code. This can be found at the top of the vehicle's wiki page while in the wikitext editor, after "code=".

Default
empty
Example
f-86f-40_japan
Auto value
empty
Stringrequired
Optional name override2

Overrides the displayed text of the link. DO NOT USE unless it explicitly disambiguates the link (i.e. if two different vehicles display with the same name).

Default
empty
Example
Fw 190 A-5/U12
Auto value
empty
Stringoptional
Retrieved from "https://wiki.warthunder.com/index.php?title=Template:Specs-Link/Documentation&oldid=127885"