How To...Create A Template: Difference between revisions

From HorizonXI Wiki
mNo edit summary
mNo edit summary
Line 35: Line 35:
|}</div></div>
|}</div></div>


=== Pre-Defined ===
Now that I have my table, it's time to add a parameter. Looking at the table, we need to add the "type" parameter, which will fill the empty table cell, adjacent to type. To create a parameter, we simply surround text with '''3 curly brackets''', like so:
Now that I have my table, it's time to add a parameter. Looking at the table, we need to add the "type" parameter, which will fill the empty table cell, adjacent to type. To create a parameter, we simply surround text with '''3 curly brackets''', like so:
<pre>{{{type}}}</pre>
<pre>{{{type}}}</pre>
Whatever text we surround is the '''parameter name'''. We need to add this parameter to our table.
Whatever text we surround is the '''parameter name''' and is our '''pre-defined parameter'''. Essentially this means that we have named it and thus must use that name if we wish to use it. However first of all, we need to add this parameter to our table.
<pre>|-
<pre>|-
! style="border:1px #aaa solid" width="50%" | Type
! style="border:1px #aaa solid" width="50%" | Type
| style="border:1px #aaa solid" width="50%" | {{{type}}}</pre>
| style="border:1px #aaa solid" width="50%" | {{{type}}}</pre>
We can now use the template and the newly created parameter. On the left in the next example is how to use the template and it's parameter and on the right is the output.
We can now use the template and the pre-defined parameter. In the example below is how to use the template and it's filled parameter, followed by what it outputs.


<div class="flex-container">
<div class="flex-container">
Line 55: Line 56:
| style="border:1px #aaa solid" width="50%" | Rabbit
| style="border:1px #aaa solid" width="50%" | Rabbit
|}</div></div>
|}</div></div>
=== Undefined Parameter ===
An undefined parameter is one that we '''haven't named'''. On our template page we simply surround the number 1 with 3 curly brackets, to create it. If we wish to have a second, we would then surround the number 2 with th brackets. So on and so forth for as many parameters as is necessary.
In our example below: we have our code, how we would call the template finally how it will appear. We will be sticking with the template name of "Animals".
<div class="flex-container">
<div class="flex-container-item-3">
<pre><h2> Animals </h2>
A list on animals that are commonly kept as pets.
* {{{1}}}
* {{{2}}}
* {{{3}}}
* {{{4}}}
* {{{5}}}</pre></div>
<div class="flex-container-item-3">
<pre>{{Animals|Cat|Dog|Rabbit|Goldfish|Hamster}}</pre></div>
<div class="flex-container-item-3">
<h2> Animals </h2>
A list on animals that are commonly kept as pets.
* Cat
* Dog
* Rabbit
* Goldfish
* Hamster
</div></div>

Revision as of 14:29, 23 January 2024

Welcome to this "how to create a template" guide. Disclaimer, I'm no expert myself and I'm writing this guide as much as anything to serve as a point of reference for myself when editing templates. The aim is the guide will be as foolproof as possible, for my own benefit and for anyone else who can make use of it.

The Basics

There are many uses for templates but in their simplest form is simply a page that an editor has created, that can be called upon on other pages. You could create a template to call upon:

  • An image
  • Text
  • A pre-made table

For example, if I created the template called "Template:Animals" and added the text "Welcome to this page, all about", I could then call this template on pages names "Dog", "Cat" etc. To call the template, I would simply write the following:

{{Animals}}

I could then add the name of each animal after the template call. So on the dog page, I would write the following code:

{{Animals}} Dogs

Which would then show on the page as:

Welcome to this page, all about Dogs

Parameters

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.

{| width="50% border="1px #aaa solid";
! style="border:1px #aaa solid" colspan="2"| Animals
|-
! style="border:1px #aaa solid" width="50%" | Type
| style="border:1px #aaa solid" width="50%" | 
|}
Animals
Type

Pre-Defined

Now that I have my table, it's time to add a parameter. Looking at the table, we need to add the "type" parameter, which will fill the empty table cell, adjacent to type. To create a parameter, we simply surround text with 3 curly brackets, like so:

{{{type}}}

Whatever text we surround is the parameter name and is our pre-defined parameter. Essentially this means that we have named it and thus must use that name if we wish to use it. However first of all, we need to add this parameter to our table.

|-
! style="border:1px #aaa solid" width="50%" | Type
| style="border:1px #aaa solid" width="50%" | {{{type}}}

We can now use the template and the pre-defined parameter. In the example below is how to use the template and it's filled parameter, followed by what it outputs.

{{Animals
| type = Rabbit
}}
Animals
Type Rabbit

Undefined Parameter

An undefined parameter is one that we haven't named. On our template page we simply surround the number 1 with 3 curly brackets, to create it. If we wish to have a second, we would then surround the number 2 with th brackets. So on and so forth for as many parameters as is necessary.

In our example below: we have our code, how we would call the template finally how it will appear. We will be sticking with the template name of "Animals".

<h2> Animals </h2>
A list on animals that are commonly kept as pets.
* {{{1}}}
* {{{2}}}
* {{{3}}}
* {{{4}}}
* {{{5}}}
{{Animals|Cat|Dog|Rabbit|Goldfish|Hamster}}

Animals

A list on animals that are commonly kept as pets.

  • Cat
  • Dog
  • Rabbit
  • Goldfish
  • Hamster