Template:Ability (LW2)/doc - Revision history

Tvol at 07:44, 12 February 2017

2017-02-12T07:44:04Z

← Older revision		Revision as of 07:44, 12 February 2017
Line 1:		Line 1:
			Ability template documentation.

	== Skeleton ==		== Skeleton ==

	<pre>		<pre>
	{{Ability_(LW2)		<!-- 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_image =
	\| s_caption =		\| s_caption =
Line 15:		Line 17:
	\| b_info = {{{ b_info \| {{Ability (LW2)/Constants \| b_INFO }} }}}		\| b_info = {{{ b_info \| {{Ability (LW2)/Constants \| b_INFO }} }}}
	\| b_table = {{{ b_table \| {{Ability (LW2)/Constants \| b_TABLE }} }}}		\| b_table = {{{ b_table \| {{Ability (LW2)/Constants \| b_TABLE }} }}}
	}}		}}</includeonly>
	</pre>		</pre>

Tvol at 07:25, 12 February 2017

2017-02-12T07:25:46Z

← Older revision		Revision as of 07:25, 12 February 2017
Line 1:		Line 1:

	== Skeleton ==		== Skeleton ==

Tvol at 07:25, 12 February 2017

2017-02-12T07:25:21Z

← Older revision		Revision as of 07:25, 12 February 2017
Line 1:		Line 1:
	==Skeleton==		== Skeleton ==

	<pre>		<pre>

Tvol at 07:55, 4 February 2017

2017-02-04T07:55:52Z

← Older revision		Revision as of 07:55, 4 February 2017
Line 3:		Line 3:
	<pre>		<pre>
	{{Ability_(LW2)		{{Ability_(LW2)
	\| s_image =		\| s_image =
	\| s_caption =		\| s_caption =
	\| s_link =		\| s_link =
	\| s_name =		\| s_name =
	\| s_descr =		\| s_descr =
	\| s_id =		\| s_id =
	\| s_templateName = {{subst:FULLPAGENAME}}		\| s_templateName = {{subst:FULLPAGENAME}}
	~~{{ #if: {{{ b_name~~ \|~~}}} \| {{!}}~~ b_name = {{{b_name~~}}}~~ \|}}		\| b_name = {{{ b_name \| {{Ability (LW2)/Constants \| b_NAME }} }}}
	~~{{ #if:~~ {{~~{ b_descr~~ \|}}} ~~\| {{!~~}} b_descr = {{{b_descr~~}}}~~ \|}}		\| b_descr = {{{ b_descr \| {{Ability (LW2)/Constants \| b_DESCR }} }}}
	~~{{ #if: {~~{{ ~~b_info~~ \|}}} ~~\| {{!~~}} b_info = {{{b_info~~}}}~~ \|}}		\| b_info = {{{ b_info \| {{Ability (LW2)/Constants \| b_INFO }} }}}
	~~{{ #if:~~ {{~~{ b_table~~ \|}}} ~~\| {{!~~}} b_table = {{{b_table}}} \|}}		\| b_table = {{{ b_table \| {{Ability (LW2)/Constants \| b_TABLE }} }}}
	}}		}}
	</pre>		</pre>
Line 37:		Line 37:
	'''This section of the skeleton should not be modified nor ommitted.'''		'''This section of the skeleton should not be modified nor ommitted.'''

	The ~~if parser functions of this section pass these parameters on from the caller to the Ability template only if they are declared. Otherwise nothing is passed~~ to {{tl\|~~Ability_~~(LW2)}} ~~and thus~~ {{tl\|~~Ability_~~(LW2)}} will ~~use its~~ default ~~values. Therefore, when calling an ability template, these values should only be declared if you want to make the behaviour of the call explicit~~.		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_name\|Set if name is visible. 0: Always invisible. 1: Always visible. Default: 0.}}

Tvol: Major Update; see documentation

2017-02-04T05:53:25Z

Major Update; see documentation

← Older revision		Revision as of 05:53, 4 February 2017
Line 3:		Line 3:
	<pre>		<pre>
	{{Ability_(LW2)		{{Ability_(LW2)
	\| s_image =		\| s_image =
	\| s_caption =		\| s_caption =
	\| s_link =		\| s_link =
	\| s_name =		\| s_name =
	\| s_descr =		\| s_descr =
	\| ~~s_info~~ = {{ {{subst:FULLPAGENAME}}~~/Info~~ }}		\| s_id =
	\| b_name = {{{ b_name \| 1 }}}		\| s_templateName = {{subst:FULLPAGENAME}}
	\| b_descr = {{{ b_descr \| 0 }}}		{{ #if: {{{ b_name \|}}} \| {{!}} b_name = {{{b_name}}} \|}}
	\| b_info = {{{ b_info \| 0 }}}		{{ #if: {{{ b_descr \|}}} \| {{!}} b_descr = {{{b_descr}}} \|}}
			{{ #if: {{{ b_info \|}}} \| {{!}} b_info = {{{b_info}}} \|}}
			{{ #if: {{{ b_table \|}}} \| {{!}} b_table = {{{b_table}}} \|}}
	}}		}}
	</pre>		</pre>
Line 21:		Line 23:
	{{Par\|s_caption\|Rollover text for the main image.}}		{{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.}}		{{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_name\|The perk/ability name.}}
Line 27:		Line 29:
	{{Par\|s_descr\|A (shortish) description of the perk.}}		{{Par\|s_descr\|A (shortish) description of the perk.}}

	{{Par\|~~s_info~~\|~~Rollover text~~ for the ~~info icon~~. ~~In practice this should always point to~~ the template's <code>~~Info~~</code> ~~subpage via transclusion~~ (~~see skeleton above~~) ~~so that it can be referenced elsewhere easily.~~}}		{{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\|~~b_name~~\|~~Set if~~ name ~~is visible~~. ~~0 = invisible~~. ~~1 = visible~~. ~~Default 1~~.}}		{{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.}}

	~~{{Par\|b_descr\|Set if description is visible. 0~~ = ~~invisible. 1~~ = ~~visible. Default 0.}}~~		=== Passthroughs ===

	~~{{Par\|b_info\|Set if info icon is visible~~. ~~0 = invisible. 1 = visible. Default 0.}}~~		'''This section of the skeleton should not be modified nor ommitted.'''

	~~===Notes About~~ the ~~Boolean Parameters===~~		The if parser functions of this section pass these parameters on from the caller to the Ability template only if they are declared. Otherwise nothing is passed to {{tl\|Ability_(LW2)}} and thus {{tl\|Ability_(LW2)}} will use its default values. Therefore, when calling an ability template, these values should only be declared if you want to make the behaviour of the call explicit.

	~~The skeleton above treats these as passthroughs~~. ~~It is expected that these parameters will be set wherever someone wants to include the ability info, and ''not'' inside the template itself~~. ~~The skeleton above will take the parameters given from the initial call (say from the Main Page) and pass them on to this template~~.		{{Par\|b_name\|Set if name is visible. 0: Always invisible. 1: Always visible. Default: 0.}}

	~~If that didn't make sense, look at [[~~:~~Category~~:~~Perks~~ (~~Long War 2~~)~~]] for examples~~.		{{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 ==		== Bugs ==

Tvol at 01:53, 4 February 2017

2017-02-04T01:53:33Z

← Older revision		Revision as of 01:53, 4 February 2017
Line 41:		Line 41:
	If that didn't make sense, look at [[:Category:Perks (Long War 2)]] for examples.		If that didn't make sense, look at [[:Category:Perks (Long War 2)]] for examples.

	==Bugs==		== Bugs ==

			None known.

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

Tvol at 12:54, 3 February 2017

2017-02-03T12:54:03Z

← Older revision		Revision as of 12:54, 3 February 2017
Line 44:		Line 44:


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

Tvol: Update documentation.

2017-02-02T11:10:52Z

Update documentation.

← Older revision		Revision as of 11:10, 2 February 2017
Line 5:		Line 5:
	\| s_image =		\| s_image =
	\| s_caption =		\| s_caption =
			\| s_link =
	\| s_name =		\| s_name =
	\| s_descr =		\| s_descr =
Line 16:		Line 17:
	==Parameters==		==Parameters==

	~~<code>~~s_image~~</code> :~~ 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_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>}}

	~~<code>~~s_caption~~</code> :~~ Rollover text for the main image.		{{Par\|s_caption\|Rollover text for the main image.}}

	~~<code>s_name</code> : The perk/ability name~~.		{{Par\|s_link\|Title of page on wiki or URL for the main image to link to.}}

	~~<code>s_descr<~~/~~code> : A (shortish) description of the perk~~.		{{Par\|s_name\|The perk/ability name.}}

	~~<code>s_info</code> : Rollover text for the info icon. In practice this should always point to the template's <code>Info</code> subpage via transclusion~~ (~~see skeleton above~~) ~~so that it can be referenced elsewhere easily~~.		{{Par\|s_descr\|A (shortish) description of the perk.}}

	<code>~~b_name~~</code> ~~: Set if name is visible. 0 = invisible. 1 = visible. Default 1~~.		{{Par\|s_info\|Rollover text for the info icon. In practice this should always point to the template's <code>Info</code> subpage via transclusion (see skeleton above) so that it can be referenced elsewhere easily.}}

	~~<code>b_descr</code> :~~ Set if ~~description~~ is visible. 0 = invisible. 1 = visible. Default 0.		{{Par\|b_name\|Set if name is visible. 0 = invisible. 1 = visible. Default 1.}}

	~~<code>~~b_info~~</code> :~~ Set if info icon is visible. 0 = invisible. 1 = visible. Default 0.		{{Par\|b_descr\|Set if description is visible. 0 = invisible. 1 = visible. Default 0.}}

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

	===Notes About the Boolean Parameters===		===Notes About the Boolean Parameters===
Line 40:		Line 43:
	==Bugs==		==Bugs==

	~~===Fixed===~~

	~~If using this in [[Template:Class_Tree_(LW2)]] you need to add a line break after this template.~~

	<strike>If this template is used inside a [[Template:Class_Tree_(LW2)]] and <code>b_info</code> is not <code>true</code>, then for some blasted reason the text overflows the cells. With <code>b_info</code> set, the text behaves and stays inside the table's cells as they should. (How very, very annoying.)

	~~The text also behaves if this template is instead used inside a subst: version of the Class_Tree template. It could be some weird issue with the parser/template-rendering-parsing-dohicky.~~

	~~Update: It appears that for some reason, the subst: version has a bunch of line breaks it in the source code. Weird.</strike>~~

	[[Category:Documentation]]		[[Category:Documentation]]

Tvol at 09:08, 31 January 2017

2017-01-31T09:08:47Z

← Older revision		Revision as of 09:08, 31 January 2017
Line 9:		Line 9:
	\| s_info = {{ {{subst:FULLPAGENAME}}/Info }}		\| s_info = {{ {{subst:FULLPAGENAME}}/Info }}
	\| b_name = {{{ b_name \| 1 }}}		\| b_name = {{{ b_name \| 1 }}}
	\| b_descr = {{{ b_descr \| 0}}}		\| b_descr = {{{ b_descr \| 0 }}}
	\| b_info = {{{ b_info \| 0}}}		\| b_info = {{{ b_info \| 0 }}}
	}}		}}
	</pre>		</pre>

Tvol-bot: Set default for b_name so that calls don't need to declare it

2017-01-31T09:07:18Z

Set default for b_name so that calls don't need to declare it

← Older revision		Revision as of 09:07, 31 January 2017
Line 8:		Line 8:
	\| s_descr =		\| s_descr =
	\| s_info = {{ {{subst:FULLPAGENAME}}/Info }}		\| s_info = {{ {{subst:FULLPAGENAME}}/Info }}
	\| b_name = {{{ b_name \| 1}}}		\| b_name = {{{ b_name \| 1 }}}
	\| b_descr = {{{ b_descr \| 0}}}		\| b_descr = {{{ b_descr \| 0}}}
	\| b_info = {{{ b_info \| 0}}}		\| b_info = {{{ b_info \| 0}}}