View source for Template:Ability (LW2)/doc

Ability template documentation.

== Skeleton ==

<pre>
<!-- NOTICE TO EDITORS: For the sake of future maintainability, please do not remove parameters nor rearrange them. This will make it easier in future to update this template using a bot and regular expressions if necessary.
--><includeonly>{{Ability_(LW2)
  | s_image   =
  | s_caption = 
  | s_link    =
  | s_name    = 
  | s_descr   =
  | s_id      =
  | s_templateName = {{subst:FULLPAGENAME}} 
  | b_name = {{{ b_name | {{Ability (LW2)/Constants | b_NAME }} }}}
  | b_descr = {{{ b_descr | {{Ability (LW2)/Constants | b_DESCR }} }}}
  | b_info = {{{ b_info | {{Ability (LW2)/Constants | b_INFO }} }}}
  | b_table = {{{ b_table | {{Ability (LW2)/Constants | b_TABLE }} }}}
}}</includeonly>
</pre>

==Parameters==

{{Par|s_image|Image filename without link or prefix, but including extension, e.g. <code>Image_name.jpg</code>. This get's expanded in the template to <code>[[File:Image_name.jpg|blahblah]]</code>}}

{{Par|s_caption|Rollover text for the main image.}}

{{Par|s_link|Title of page on wiki or URL for the main image to link to. Do not use this to link to a template page! It should lead to a content page in the Main namespace. See <code>s_templateName</code> below for that.}}

{{Par|s_name|The perk/ability name.}}

{{Par|s_descr|A (shortish) description of the perk.}}

{{Par|s_id|ID of HTML elements. This should contain no special characters, no spaces, and must be unique across the wiki for future compability. A good option is the ability's name suffixed with the game it belongs to, e.g. on the {{tl|Aggression (LW2)}} template it would read <code>aggressionLW</code> (yes, the beginning lowercase is intentional; please useCamelCase.)}}

{{Par|s_templateName|The base name of the ability template page, including namespace. E.g. for {{tl|Aggression (LW2)}} this value will read <code>Template:Aggression (LW2)</code>. The function in the skeleton will do this for you the first time the page is saved.}}

=== Passthroughs ===

'''This section of the skeleton should not be modified nor ommitted.'''

The calls to {{tl|Ability (LW2)/Constants}} return default values to be used by all ability templates. This permits users to declare, or not, any of these parameters when calling a perk template, e.g. {{tl|Aggression (LW2)}}. Doing so will override the default value.

{{Par|b_name|Set if name is visible. 0: Always invisible. 1: Always visible. Default: 0.}}

{{Par|b_descr|Set if description is visible. 0: Always invisible. 1: Always visible. Default: 0.}}

{{Par|b_info|Set if info icon is visible. 0: Always invisible. 1: Always visible. Default: 0.}}

{{Par|b_table|Set if extra padding should be added. This is intended for use in tables, such as {{tl|Class Tree (LW2)}}. 0: Never have extra padding. 1: Always have extra padding. Default: 0. }}

=== Depreciated or Removed ===

{{Par|s_info| Removed {{#time: d-M-Y | 20170204055325 }} . Was previously used to add info rollover text. This text has since been moved to the /Info subpage of each ability template. Superceded by s_templateName.}}

== Bugs ==

None known.

<noinclude>[[Category:Documentation]]</noinclude>