Difference between revisions of "Template:SkillTime/doc"

From EVE University Wiki
Jump to: navigation, search
(Wrote the template docs)
 
m (Rewrote doc. Add short parameter info. Add sample to show the difference between short/non short. Update link.)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
  
;Documentation
+
; Description
:This template is useful if you want to display the time required to train a skill on the Uni wiki.
+
: This template displays the time required to train a skill level.
  
;Syntax
+
; Dependencies
{{code|<nowiki>{{SkillTime | skill | level | short= }}</nowiki>}}
+
:; Uses
 +
:: {{T|GetSkillMult}} to look up the training time multiplier.
 +
:; Used by
 +
:: {{T|RequiredSkill}}
  
:The first two parameters (<code>skill</code> and <code>level</code>) are mandatory, the others are optional.
+
; Syntax
 +
: {{T|SkillTime|2= skill|3= level|4= short=}}
 +
:; Parameters
 +
::; skill [Required] : The name of the skill you wish to link to. Please make sure it's capitalized properly (use spelling and capitalization exactly as used on the skill pages/in-game, i.e. <code>Gallente Strategic Cruiser</code>, not <code>Gallente strategic cruiser</code>).
 +
::; level [Required] : The level or rank of the skill you wish to train. In keeping with the EVE conventions, use upper-case Roman numerals (for instance, <code>IV</code>, not <code>iv</code> or <code>4</code>).
 +
::; short : Controls displaying. Use <code>yes</code> to display a short version, no seconds and time units abbreviated. Omit for full version.
  
;skill
+
; Samples
: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>{{SkillTime|Industry|IV}}</nowiki></code> gives {{SkillTime|Industry|IV}}.
 +
: <code><nowiki>{{SkillTime|Industry|IV|short= yes}}</nowiki></code> gives {{SkillTime|Industry|IV|short= yes}}.
  
;level
+
: <code><nowiki>{{SkillTime|Caldari Battleship|IV|short= yes}}</nowiki></code> gives {{SkillTime|Caldari Battleship|IV|short=yes}}.
:The level or rank of the skill you wish to train. In keeping with the Eve conventions, use upper-case Roman numerals (for instance, <code>IV</code>, not <code>iv</code> or <code>4</code>).  
 
  
;Examples
+
; See also
:<code><nowiki>{{SkillTime|Industry|IV}}</nowiki></code> gives {{SkillTime|Industry|IV}}.
+
* {{Tl|Skill}}, which produces the beautiful skill overview boxes used on the <span class=plainlinks>[https://wiki.eveuniversity.org/Special:PrefixIndex?prefix=skills%3A&namespace=0 skills pages]</span>.
:<code><nowiki>{{SkillTime|Caldari Battleship|IV|short=yes}}</nowiki></code> gives {{SkillTime|Industry|IV|short=yes}}.
 
  
;Dependencies
+
<includeonly>[[Category:Data templates]]<!-- Any categories for the template itself --></includeonly>
:This template uses {{t|GetSkillMult}} to look up and display the correct training time multiplier.
+
<noinclude>[[Category:Template documentation]]</noinclude>
 
 
;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 10:30, 18 January 2023

Description
This template displays the time required to train a skill level.
Dependencies
Uses
{{GetSkillMult}} to look up the training time multiplier.
Used by
{{RequiredSkill}}
Syntax
{{SkillTime|<skill>|<level>|<short=>}}
Parameters
skill [Required]
The name of the skill you wish to link to. Please make sure it's capitalized properly (use spelling and capitalization exactly as used on the skill pages/in-game, i.e. Gallente Strategic Cruiser, not Gallente strategic cruiser).
level [Required]
The level or rank of the skill you wish to train. In keeping with the EVE conventions, use upper-case Roman numerals (for instance, IV, not iv or 4).
short
Controls displaying. Use yes to display a short version, no seconds and time units abbreviated. Omit for full version.
Samples
{{SkillTime|Industry|IV}} gives 1 day, 1 hour, 8 minutes, 30 seconds.
{{SkillTime|Industry|IV|short= yes}} gives 1d 1h 8m.
{{SkillTime|Caldari Battleship|IV|short= yes}} gives 8d 9h 8m.
See also
  • {{Skill}}, which produces the beautiful skill overview boxes used on the skills pages.