Difference between revisions of "Template:Sk/doc"

From EVE University Wiki
Jump to: navigation, search
(Wrote the template docs by extracting it from the Template page)
 
m (Https)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
; Description
 +
: This template is useful if you want to link to a skill page on the Uni wiki. It can be used to show different levels of information, from just a simple link, to additional information about rank, skillbook cost and skill multiplier (including tooltips (shown when the mouse is moved over the text) for the last two). It's recommended you use this template when linking to skills (instead of manually linking to the skills page), as it automatically tracks obsolete skill names or groups, making it easier to update the UniWiki when CCP next decides to change the skills in the game (for more information on how this works, see the documentation for {{t|GetSkillLink}}). Plus, using this template saves you having to go look up what group a skill belongs to :)
  
−
;Documentation
+
; Dependencies
−
:This template is useful if you want to link to a skill page on the Uni wiki. It can be used to show different levels of information, from just a simple link, to additional information about rank, skillbook cost and skill multiplier (including tooltips (shown when the mouse is moved over the text) for the last two). It's recommended you use this template when linking to skills (instead of manually linking to the skills page), as it automatically tracks obsolete skill names or groups, making it easier to update the UniWiki when CCP next decides to change the skills in the game (for more information on how this works, see the documentation for {{t|GetSkillLink}}). Plus, using this template saves you having to go look up what group a skill belongs to :)
+
:; Uses
 +
:: {{T|GetSkillLink}} - Look up skill link.
 +
:: {{T|GetSkillMult}} - Look up skill multiplier.
 +
:: {{T|GetSkillPrice}} - Look up skill price.
 +
:: {{T|SkillTimeInfo}} - Skill multiplier tooltip
 +
:: {{T|SkillPriceInfo}} - Skill price tooltip.
  
 
;Syntax
 
;Syntax
−
{{code|<nowiki>{{sk | skill | level | icon= | price= | mult= }}</nowiki>}}
+
: {{T|Sk|skill|level|4= icon= icon|5= price= price|6= mult= mult}}
 +
:; Parameters
 +
:: Only the first parameter (<code>skill</code>) is mandatory, the others are optional.
  
−
:Only the first parameter (<code>skill</code>) is mandatory, the others are optional.
+
::; skill : The name of the skill you wish to link to. Please make sure it's capitalized properly (use title case spelling, i.e. <code>Gallente Strategic Cruiser</code>, not <code>Gallente strategic cruiser</code>). 
 +
::;level : If you would like to refer to a particular level or rank of the skill, you can enter it here. In keeping with the EVE conventions, use upper-case Roman numerals (for instance, <code>IV</code>, not <code>iv</code> or <code>4</code>).
 +
::;icon : Use <code>icon= yes</code> to display a small skill icon [[Image:Skill.png|link=|16px]] in front of the link (to denote it as a skill) - this can be particularly useful in the middle of a paragraph. If you use <code>icon=no</code> or omit the parameter completely, then no icon will be displayed.
 +
::; price : If you would like to indicate how much the skill book costs, use <code>price= yes</code>. If you use <code>price= no</code> or omit the parameter completely, then no price will be displayed.
 +
::;mult : If you would like to indicate what the skill's [[Skills and learning#Training Time Multipliers|training time multiplier]] is, use <code>mult= yes</code>. The mouseover tooltip will give a rough indication of how long the training time for that skill will be. If combined with a <code>level</code> parameter, then the mouseover tooltip will show the training time to that specific skill level. If you use <code>mult= no</code> or omit the parameter completely, then no multiplier will be displayed.  
  
−
;skill
+
; Examples
−
:The name of the skill you wish to link to. Please make sure it's capitalised properly (use title case spelling, i.e. <code>Gallente Strategic Cruiser</code>, not <code>Gallente strategic cruiser</code>).
+
: <code><nowiki>{{sk|Mass Production}}</nowiki></code> gives {{sk|Mass Production}}.
 +
: <code><nowiki>{{sk|Industry|IV|icon=yes}}</nowiki></code> gives {{sk|Industry|IV|icon=yes}}.
 +
: <code><nowiki>{{sk|Reprocessing Efficiency|price=yes|mult=yes}}</nowiki></code> gives {{sk|Reprocessing Efficiency|price=yes|mult=yes}}.
 +
: <code><nowiki>{{sk|Afterburner|mult=yes}}</nowiki></code> gives {{sk|Navigation|Afterburner|mult=yes}}.
 +
: <code><nowiki>{{sk|Gallente Titan|IV|mult=yes|price=no}}</nowiki></code> gives {{sk|Gallente Titan|IV|mult=yes|price=no}}.
 +
: <code><nowiki>{{sk|Wabbit-Hunting}}</nowiki></code> gives {{sk|Wabbit-Hunting}}.
  
−
;level
+
; See also
−
:If you would like to refer to a particular level or rank of the skill, you can enter it here. In keeping with the Eve conventions, use upper-case Roman numerals (for instance, <code>IV</code>, not <code>iv</code> or <code>4</code>).  
+
: {{t|Skill}}, which produces the beautiful skill overview boxes used on the [https://wiki.eveuniversity.org/index.php?title=Special:PrefixIndex&prefix=Skills:&namespace=0 skill category pages].
  
−
;icon
+
<includeonly>[[Category:Data templates]]<!-- Any categories for the template itself --></includeonly>
−
:Use <code>icon=yes</code> to display a small skill icon [[Image:Skill.png|link=|16px]] in front of the link (to denote it as a skill) - this can be particularly useful in the middle of a paragraph. If you use <code>icon=no</code> or omit the parameter completely, then no icon will be displayed.
+
<noinclude>[[Category:Template documentation]]</noinclude>
−
 
 
−
;price
 
−
:If you would like to indicate how much the skill book costs, use <code>price=yes</code>. If you use <code>price=no</code> or omit the parameter completely, then no price will be displayed.
 
−
 
 
−
;mult
 
−
:If you would like to indicate what the skill's [[Skill_training#Training_Time_Multipliers|training time multiplier]] is, use <code>mult=yes</code>. The mouseover tooltip will give a rough indication of how long the training time for that skill will be. If combined with a <code>level</code> parameter, then the mouseover tooltip will show the training time to that specific skill level. If you use <code>mult=no</code> or omit the parameter completely, then no multiplier will be displayed.
 
−
 
 
−
;Examples
 
−
:<code><nowiki>{{sk|Mass Production}}</nowiki></code> gives {{sk|Mass Production}}.
 
−
:<code><nowiki>{{sk|Industry|IV|icon=yes}}</nowiki></code> gives {{sk|Industry|IV|icon=yes}}.
 
−
:<code><nowiki>{{sk|Reprocessing Efficiency|price=yes|mult=yes}}</nowiki></code> gives {{sk|Reprocessing Efficiency|price=yes|mult=yes}}.
 
−
:<code><nowiki>{{sk|Afterburner|mult=yes}}</nowiki></code> gives {{sk|Navigation|Afterburner|mult=yes}}.
 
−
:<code><nowiki>{{sk|Gallente Titan|IV|mult=yes|price=no}}</nowiki></code> gives {{sk|Gallente Titan|IV|mult=yes|price=no}}.
 
−
:<code><nowiki>{{sk|Wabbit-Hunting}}</nowiki></code> gives {{sk|Wabbit-Hunting}}.
 
−
 
 
−
;Dependencies
 
−
:This template uses {{t|GetSkillLink}}, {{t|GetSkillPrice}} and {{t|GetSkillMult}} to look up and display the correct skill link, skillbook price, and training time multiplier, respectively. Additionally, {{t|SkillTimeInfo}} and {{t|SkillPriceInfo}} are used to generate the tooltips for the training multiplier and the skillbook price.
 
−
 
 
−
;See also
 
−
:{{t|Skill}}, which produces the beautiful skill overview boxes used on the [http://wiki.eveuniversity.org/w/index.php?title=Special%3APrefixIndex&prefix=Skills%3A&namespace=0 skill category pages].
 
−
 
 
−
<includeonly>[[Category:Template|{{PAGENAME}}]]<!-- Any categories for the template itself --></includeonly>
 
−
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
 

Latest revision as of 20:37, 10 June 2023

Description
This template is useful if you want to link to a skill page on the Uni wiki. It can be used to show different levels of information, from just a simple link, to additional information about rank, skillbook cost and skill multiplier (including tooltips (shown when the mouse is moved over the text) for the last two). It's recommended you use this template when linking to skills (instead of manually linking to the skills page), as it automatically tracks obsolete skill names or groups, making it easier to update the UniWiki when CCP next decides to change the skills in the game (for more information on how this works, see the documentation for {{GetSkillLink}}). Plus, using this template saves you having to go look up what group a skill belongs to :)
Dependencies
Uses
{{GetSkillLink}} - Look up skill link.
{{GetSkillMult}} - Look up skill multiplier.
{{GetSkillPrice}} - Look up skill price.
{{SkillTimeInfo}} - Skill multiplier tooltip
{{SkillPriceInfo}} - Skill price tooltip.
Syntax
{{Sk|<skill>|<level>|<icon= icon>|<price= price>|<mult= mult>}}
Parameters
Only the first parameter (skill) is mandatory, the others are optional.
skill
The name of the skill you wish to link to. Please make sure it's capitalized properly (use title case spelling, i.e. Gallente Strategic Cruiser, not Gallente strategic cruiser).
level
If you would like to refer to a particular level or rank of the skill, you can enter it here. In keeping with the EVE conventions, use upper-case Roman numerals (for instance, IV, not iv or 4).
icon
Use icon= yes to display a small skill icon Icon skillbook2.png in front of the link (to denote it as a skill) - this can be particularly useful in the middle of a paragraph. If you use icon=no or omit the parameter completely, then no icon will be displayed.
price
If you would like to indicate how much the skill book costs, use price= yes. If you use price= no or omit the parameter completely, then no price will be displayed.
mult
If you would like to indicate what the skill's training time multiplier is, use mult= yes. The mouseover tooltip will give a rough indication of how long the training time for that skill will be. If combined with a level parameter, then the mouseover tooltip will show the training time to that specific skill level. If you use mult= no or omit the parameter completely, then no multiplier will be displayed.
Examples
{{sk|Mass Production}} gives Mass Production.
{{sk|Industry|IV|icon=yes}} gives Icon skillbook2.png Industry IV.
{{sk|Reprocessing Efficiency|price=yes|mult=yes}} gives Reprocessing Efficiency (3x, 300k ISK).
{{sk|Afterburner|mult=yes}} gives Navigation Afterburner (1x).
{{sk|Gallente Titan|IV|mult=yes|price=no}} gives Gallente Titan IV (16x).
{{sk|Wabbit-Hunting}} gives [[Skills:Wabbit-Hunting]].
See also
{{Skill}}, which produces the beautiful skill overview boxes used on the skill category pages.
Retrieved from "https://wiki.eveuniversity.org/index.php?title=Template:Sk/doc&oldid=204784"