Help:Templates
From Governance Wiki
If you have standard texts you want to include on several pages, you can use the template feature.
Contents |
[edit] Creating a template
Templates are standard wiki pages, only the template names are prefixed with "Template:". Therefore you can create them like any other wiki page.
[edit] Using a template
Templates are wiki pages which can be used in other pages in three ways:
{{Name}}'transcludes' (i.e. includes a copy) the content of the template (stored in the page [[Template:Name]]) whenever the page containing the template transclusion is fetched and displayed; i.e. if the template is later changed, the displayed transcluding page will automatically change too{{subst:Name}}replaces that string with the contents of the template, in the source of the transcluding page, when you save that page; the copy of the template contents can then be edited normally (and separately from the original in the template page). Note: don't use this if you are looking to continually propagate changes from the source template to the page(s) that references it.{{msgnw:Name}}includes the template in a form that displays it as raw wiki syntax (the way<nowiki>does) when the page containing it is fetched
[edit] Using parameters in templates
| Template with numbered parameters | |
'''A little thank you...'''<br>
<small>for {{{1}}}.<br>
hugs, {{{2}}}</small>
| |
| You type | You get |
{{Thankyou|all your hard work|Joe}}
| |
| with named parameters | |
'''A little thank you...'''<br>
<small>for {{{reason}}}.<br>
hugs, {{{signature}}}</small>
| |
| You type | You get |
{{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 users. 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.
[edit] 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.
Note: when you change the categories applied by a template, the categorization of the pages that use that template may not be updated until some time later: this is handled by the job queue.
[edit] 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.
[edit] See Also
- Help:External searches -- a template special use case example
- Help:Magic words -- fancy stuff you may find in some templates
- meta:Help:Embed page -- embedding pages from namespaces other than
Template:.
A template is a special type of page that has been designed so its content can be included in one or more other pages. Since a given template can be included in many pages, templates can help reduce duplication and promote a uniform style between pages.
Templates are usually located in the Template namespace, which means any page name beginning with Template:, such as Template:Name. However, any page can act as a template.
Referencing templates
The content of a template can be added to a page by referencing it using the wiki markup: {{templatename}}. This references the template and includes its output at the point of insertion. Articles will be updated automatically when referenced templates are changed. A page that references templates cannot be edited to change the content of a referenced template, although a list of referenced templates will be displayed at the bottom of the page for convenience while editing it.
Substituting templates
A different way to use a template is to substitute its content into a page. This is done by inserting subst: immediately after the opening braces: {{subst:templatename}}. Once the page is saved, the link to the template is removed and the template output is substituted in its place and can be further edited. Any updates to the template will not affect the content that was substituted into the page.
Benefits of templates
Templates are used to add recurring messages to pages in a consistent way, to add boilerplate messages, to create infoboxes and navigational boxes, and to provide cross-language portability of texts.
Templates can also make it much easier for new and casual editors to use advanced designs, features and extensions by hiding confusing code.
Creating a template
In short, create the text you want to have copied onto the target pages on a page in the Template namespace. Creating Template:Templatename will allow users to insert {{templatename}} into a page to display your text.
See Help:Creating templates for details.
For an overview, see the quick guide to templates on Wikimedia's Meta-Wiki.
Creating an advanced template
To learn how to change the output of the template based on what the user inputs, see Help:Template parameters and Help:Parser functions.
Updating and adding standard templates
Wikia's Starter Pages and Templates wikis occasionally improve some of their documentation as well as adding new templates specifically designed for Wikia sites, and are therefore worth checking from time to time. For sites created before about December 2008, the Starter Pages wiki should be compared and ideally used for upgrading to its standard documentation system similar to that introduced in Wikipedia.
