You must log in to edit. If you don't have an account create one now!

From WikiStory

If you have standard texts you want to include on several pages, the template feature comes into play.

Creating a template

Template names are prefixed with Template:, you create them like any other wiki page.

Using a template

Templates are wiki pages which can be used in other pages in three ways:

• {{Name}} includes the content of the template at the moment the page containing it is fetched "[[Template:Name]]".
• {{subst:Name}} inserts the content of the template into the code of the page in a form that is editable normally "[[Template:Name]]" after you have saved your text.
• {{msgnw:Name}} when the page containing it is fetched, includes the template in a form that displays it as raw wiki syntax, like <nowiki> does

Using parameters in templates

 
'''A little thank you...'''<br>
<small>for {{{1}}}.<br>
from, {{{2}}}</small>

 
'''A little thank you...'''<br>
<small>for {{{reason}}}.<br>
from, {{{signature}}}</small>

{{Thankyou
|reason=all your hard work
|signature=Joe}}

You can define parameters in templates either numbered as {{{1}}} or named {{{param}}}.

Example: You want a little thank you note you can put on the talk page of other authors. It will contain a reason and your signature. You could create Template:Thankyou to enter your text, as in the example in the table.

When using the template on a page, you fill in the parameter values, separated by a pipe char (|): {{Thankyou|all your hard work|Joe}}. For named parameters use "name=value" pairs separated by a pipe char: {{Thankyou|reason=all your hard work|signature=Joe}}. The advantage of using named parameters in your template is that they are flexible in order. It also makes the template easier to understand if you have many parameters. If you want to change the order of numbered parameters, you have to mention them explicitly: {{Thankyou|2=Joe|1=all your hard work}}.

You can also provide default values for parameters, i.e. values that are going to be used if no value is provided for a parameter. For example, {{{reason|all your hard work}}} would result in "all your hard work" if no value was provided for the parameter reason.

Control template inclusion

You can control template inclusion by the use of <noinclude> and <includeonly> tags.

Anything between <noinclude> and </noinclude> will be processed and displayed only when the page is being viewed directly, not included.

Possible applications are:

• Categorising templates
• Interlanguage links to similar templates in other languages
• Explanatory text about how to use the template

The converse is <includeonly>. Text between <includeonly> and </includeonly> will be processed and displayed only when the page is being included. The obvious application is to add all pages containing a given template to a category, without putting the template itself into that category.

Organizing templates

For templates to be effective users need to find them and be able to use them. A simple technique is to include an example on the template page. For example:

<noinclude>
==Usage==
Allows to establish a link to a subject:
{{NameOfTemplate|Term1+Term2+Term3}}
</noinclude>

Then, an editor can simply copy and paste the example to create a similar page.

More: Embed non-template pages

You can embed pages that are not template pages with the following process.

Syntax

{{Namespace:Pagename}}

If you do not provide a namespace, the Template namespace will be used. For the pages in the main namespace, add a colon before the page name.

Example

{{:Sample Page}} produces the following, which displays the contents of Sample Page inside the box:

This page is a sample page, used as an example in Help:Templates#More:_Embed_non-template_pages...

You can verify this by looking directly at the Sample Page. (Note that the whole page name following the colon is "Sample Page"; this is not an example of some sort of template command called ":Sample"! The box is created by indenting {{:Sample Page}} by one space.)

See Also

• Help:Variables -- fancy stuff you may find in some templates