How To...Create A Template - Revision history

imported>Spiffly at 10:46, 15 November 2024

2024-11-15T10:46:01Z

← Older revision		Revision as of 10:46, 15 November 2024
Line 294:		Line 294:
	* Add a line break if lists aren't working correctly.		* Add a line break if lists aren't working correctly.
	* Categorisation		* Categorisation
			* note for future self. template:job trait for examples on switching content on/off depending on defined parameters. check "tier 1 " parameter in the "tiers" section.

	<!--		<!--

imported>Aramachus: /* Conditionals (if-functions) */ some flex containers to structure the section

2024-10-21T13:22:06Z

Conditionals (if-functions): some flex containers to structure the section

← Older revision		Revision as of 13:22, 21 October 2024
Line 169:		Line 169:
	<pre>{{{<parameter name>\|<output if parameter is empty>}}}</pre>		<pre>{{{<parameter name>\|<output if parameter is empty>}}}</pre>

			Example:
⚫	~~Example:~~ Assume the following template called "Animals":

		⚫	'''Assume the following template called "Animals": '''

	<pre>Welcome to this page, all about {{{animal}}}s! Sound: {{{sound\|none}}}</pre>		<pre>Welcome to this page, all about {{{animal}}}s! Sound: {{{sound\|none}}}</pre>

			<div class="flex-container">
⚫	If you use this template with the parameter "sound" like this:
			<div class="flex-container-item-2">
		⚫	'''If you use this template with the parameter "sound" like this:'''

	<pre>{{Animals		<pre>{{Animals
Line 179:		Line 183:
	\|sound=bark		\|sound=bark
	}}</pre>		}}</pre>
			</div><div class="flex-container-item-2">

	You get:		'''You get:'''

	<pre>Welcome to this page, all about dogs! Sound: bark</pre>		<pre>Welcome to this page, all about dogs! Sound: bark</pre>
			</div></div>

			<div class="flex-container">
⚫	If you omit the parameter ''sound'', the alternative output after the pipe will be returned, so

			<div class="flex-container-item-2">
		⚫	'''If you omit the parameter ''sound'', the alternative output after the pipe will be returned, so'''
	<pre>{{Animals		<pre>{{Animals
	\|animal=dog		\|animal=dog
	\|sound=bark		\|sound=bark
	}}</pre>		}}</pre>
			</div>

			<div class="flex-container-item-2">
	will give:
			'''you get:'''

	<pre>Welcome to this page, all about dogs! Sound: none</pre>		<pre>Welcome to this page, all about dogs! Sound: none</pre>
			</div></div>

	''Notes: ''		''Notes: ''
Line 202:		Line 212:
	'''Important:''' If the parameter is given in the use of the template but it is ''empty'', it will return the empty value, not trigger the return of the alternative output. To catch empty inputs, you need to use real conditional functions, see the next section.		'''Important:''' If the parameter is given in the use of the template but it is ''empty'', it will return the empty value, not trigger the return of the alternative output. To catch empty inputs, you need to use real conditional functions, see the next section.

			<div class="flex-container">
	So
			<div class="flex-container-item-2">
			'''So with the input:'''

	<pre>{{Animals		<pre>{{Animals
Line 208:		Line 220:
	\|sound=		\|sound=
	}}</pre>		}}</pre>
			</div><div class="flex-container-item-2">

			'''You get:'''
	will return

	<pre>Welcome to this page, all about dogs! Sound: </pre>		<pre>Welcome to this page, all about dogs! Sound: </pre>
			</div></div>

	Since the parameter is given (as empty), the alternative behind the pipe is not used but the parameter is returned as given.		Since the parameter is given (as empty), the alternative behind the pipe is not used but the parameter is returned as given.

Line 232:		Line 244:
	<pre>Welcome to this page, all about {{{animal}}}s! {{#if: {{{sound\|}}} \| They {{{sound}}}. \| }}</pre>		<pre>Welcome to this page, all about {{{animal}}}s! {{#if: {{{sound\|}}} \| They {{{sound}}}. \| }}</pre>

	''(Note the pipe-character "\|" in the condition, this will make sure that if the <nowiki>{{{sound}}}</nowiki> is not given, it will return empty. If the pipe is not used and the parameter is not given, MediaWiki will literally return <nowiki>{{{sound}}}</nowiki> in the condition, which is not empty and therefore the condition evaluates as true.)''		''Note the pipe-character "\|" in the condition, this will make sure that if the <nowiki>{{{sound}}}</nowiki> is not given, it will return empty. If the pipe is not used and the parameter is not given, MediaWiki will literally return <nowiki>{{{sound}}}</nowiki> in the condition, which is not empty and therefore the condition evaluates as true.''

			<div class="flex-container">
⚫	If you use it like
			<div class="flex-container-item-2">
		⚫	'''If you use it like'''

	<pre>{{Animals		<pre>{{Animals
Line 240:		Line 254:
	\| sound = bark		\| sound = bark
	}}</pre>		}}</pre>
			</div><div class="flex-container-item-2">

	You get		'''You get:'''

	<pre>Welcome to this page, all about dogs! They bark. </pre>		<pre>Welcome to this page, all about dogs! They bark. </pre>
			</div></div>

⚫	If you were to omit the parameter ''sound'' ~~like~~

			<div class="flex-container">
			<div class="flex-container-item-2">
		⚫	'''If you were to omit the parameter ''sound'''''
			{\| style="width: 100%"
			\| valign="top" \| '''like'''
	<pre>{{Animals		<pre>{{Animals
	\| animal = dog		\| animal = dog
	}}</pre>		}}</pre>
			\| valign="top" \| '''or'''

	or

	<pre>{{Animals		<pre>{{Animals
	\| animal = dog		\| animal = dog
	\| sound =		\| sound =
	}}</pre>		}}</pre>
			\|}

			</div><div class="flex-container-item-2">
	the if-function would see that the parameter is empty (because of the use of the pipe-character in the parameter in the condition) and return:		'''the if-function would see that the parameter is empty (because of the use of the pipe-character in the parameter in the condition) and return:'''

	<pre>Welcome to this page, all about dogs!</pre>		<pre>Welcome to this page, all about dogs!</pre>
			</div></div>


	=== ifeq (If equal) ===		=== ifeq (If equal) ===
Line 268:		Line 285:

	=== ifexist ===		=== ifexist ===


	== Further Information ==		== Further Information ==

imported>Aramachus: started some documentation about conditionals

2024-10-21T12:37:34Z

started some documentation about conditionals

@@ Line 157: / Line 157: @@
 Confusing right? A litte rule of thumb is to use < noinclude > for keeping documentation on template pages. Use a mixture of the other two when trying to transclude your templates code. Sadly there's no one size fits all method here, trial and error ''will'' be necessary.
 == Further Information ==
@@ Line 162: / Line 274: @@
 == To Add ==
 * Removing a table row if no parameter set.
 * Add a line break if lists aren't working correctly.
 * Categorisation

imported>Spiffly: added information about noinclude/includeony/onlyinclude

2024-09-13T13:00:56Z

added information about noinclude/includeony/onlyinclude

@@ Line 149: / Line 149: @@
 </div></div>
 As a word of warning, take care when combining defined and non-defined parameters, as it would be quite easy to confuse an editor as which parameters need to be defined and which do not. Sometimes it may be better to define all parameters and name them eg. "item1", "item2", "item3" etc.
 == To Add ==

imported>Spiffly at 17:42, 1 July 2024

2024-07-01T17:42:32Z

← Older revision		Revision as of 17:42, 1 July 2024
Line 156:		Line 156:
	* Add a line break if lists aren't working correctly.		* Add a line break if lists aren't working correctly.
	* Categorisation		* Categorisation

			<!--

			{{#if:}}

			Example 1
			{{#if: {{{test\|}}}\|no}}

			If you assign the parameter with any test, the word "no" will be displayed.
			If you do not assign the parameter, the parameter will display nothing.


			Example 2
			{{#if: {{{test\|}}}\|no {{{test}}}}}

			If you assign the parameter, the word "no" will be displayed followed by whatever is defined in the parameter. For example
			\| test = chance
			will display "no chance"

			If you do not assign the parameter, the parameter will display nothing.

			-->

imported>Spiffly: /* Examples */

2024-01-26T13:42:59Z

Examples

@@ Line 134: / Line 134: @@
 <div class="flex-container-item-3">
 '''Calling the Template'''
 </pre></div>
 <div class="flex-container-item-3">

imported>Spiffly: /* Undefined Parameter */

2024-01-26T13:42:22Z

Undefined Parameter

← Older revision		Revision as of 13:42, 26 January 2024
Line 86:		Line 86:
	<div class="flex-container-item-3">		<div class="flex-container-item-3">
	'''Calling the template'''		'''Calling the template'''
	<pre>{{Animals~~\|Cat\|Dog\|Rabbit\|Goldfish\|Hamster}}</pre></div>~~		<pre>{{Animals
			\|Cat
			\|Dog
			\|Rabbit
			\|Goldfish
			\|Hamster
			}}</pre></div>
	<div class="flex-container-item-3">		<div class="flex-container-item-3">
	'''How it appears...'''		'''How it appears...'''

imported>Spiffly: /* Parameters */

2024-01-26T13:40:49Z

Parameters

← Older revision		Revision as of 13:40, 26 January 2024
Line 25:		Line 25:
	Parameters can be used to allow an editor to eaisly add information to a page, which will then be displayed in a pre-determined way. The name "Infobox" is commonly used to describe this and it's more easily described with examples.		Parameters can be used to allow an editor to eaisly add information to a page, which will then be displayed in a pre-determined way. The name "Infobox" is commonly used to describe this and it's more easily described with examples.

	First of all the template needs some code so it knows how to display the information an editor will provide. I will use a simple table in my ~~examples~~. On the left is my table code and on the right is the simple table it produces.		First of all the template needs some code so it knows how to display the information an editor will provide. I will use a simple table in my example. On the left is my table code and on the right is the simple table it produces.

	<div class="flex-container">		<div class="flex-container">

imported>Spiffly: /* Examples */

2024-01-26T13:40:09Z

Examples

← Older revision		Revision as of 13:40, 26 January 2024
Line 134:		Line 134:
	[[File:How To...Create A Template_example_1.png]]		[[File:How To...Create A Template_example_1.png]]
	</div></div>		</div></div>
			As a word of warning, take care when combining defined and non-defined parameters, as it would be quite easy to confuse an editor as which parameters need to be defined and which do not. Sometimes it may be better to define all parameters and name them eg. "item1", "item2", "item3" etc.

	== To Add ==		== To Add ==

imported>Spiffly: /* Examples Uses */

2024-01-26T13:36:32Z

Examples Uses

← Older revision		Revision as of 13:36, 26 January 2024
Line 97:		Line 97:
	Need to write about this.		Need to write about this.

	== Examples ~~Uses~~ ==		== Examples ==
	This template will be called <nowiki>{{Items}}</nowiki> and will demonstrate how to create a page template that editors add information to with ease. I'm using the example to show various ways to apply formatting, such as: adding images and setting a standard picture format, appling '''bold''' and ''italic'', how the editor can still add their own internal wiki and two forms of lists (bullet points and numbered).		This template will be called <nowiki>{{Items}}</nowiki> and will demonstrate how to create a page template that editors add information to with ease. I'm using the example to show various ways to apply formatting, such as: adding images and setting a standard picture format, appling '''bold''' and ''italic'', how the editor can still add their own internal wiki and two forms of lists (bullet points and numbered).

Line 134:		Line 134:
	[[File:How To...Create A Template_example_1.png]]		[[File:How To...Create A Template_example_1.png]]
	</div></div>		</div></div>



	== To Add ==		== To Add ==