Difference between revisions of "Template:Specs-Link/Documentation"
(Added parameters to TemplateData) |
(Edits) |
||
| 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. | ||
| − | + | == Usage == | |
| + | The template is structured as <code><nowiki>{{Specs-Link| "arg1" | "arg2"}}</nowiki></code> | ||
| − | + | * '''"arg1"''' is 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}} | |
| − | < | + | |
| + | * '''"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>ki_84_ko</nowiki></code> displays as {{Specs-Link|ki_84_ko}}, while <code><nowiki>ki_84_ko_china</nowiki></code> also displays as {{Specs-Link|ki_84_ko_china}}. This can be confusing, so it would be acceptable to override <code><nowiki>ki_84_ko_china</nowiki></code> to display as {{Specs-Link|ki_84_ko_china|␗Ki-84 ko}}. | ||
| + | ** "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}} | ||
Revision as of 13:51, 6 August 2020
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" is 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:
-
ki_84_kodisplays as Ki-84 ko, whileki_84_ko_chinaalso displays as ␗Ki-84 ko. This can be confusing, so it would be acceptable to overrideki_84_ko_chinato display as ␗Ki-84 ko. - "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}}.-
{{Specs-Link|us_m1_abrams|full}}: Tank, Combat, Full Tracked, 105-mm Gun M1
-
- "short" - Inserts the name provided by
-
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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Vehicle code | 1 | 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=".
| String | required |
| Optional name override | 2 | 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).
| String | optional |
