Difference between revisions of "Help:Templates"

Revision as of 23:28, 5 April 2007

Template:PD Help Page If you have standard texts you want to include on several pages, the MediaWiki template feature comes into play (like the tag above which is included in the pages of the Help namespace).

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 current content of the page "[[Template:Name]]".

{{subst:Name}} inserts the content of the page "[[Template:Name]]" when you save your text.

{{msgnw:Name}} includes the template in raw wiki syntax, like <nowiki> does

Using parameters in templates

Template:Hl2 colspan="2" align="center" |Template with numbered parameters
'''A little thank you...'''<br> <small>for {{{1}}}.<br> hugs, {{{2}}}</small>
Template:Hl2|You type	Template:Hl2|You get
{{Thankyou|all|Joe}}	A little thank you... for all. hugs, Joe
Template:Hl2 colspan="2" align="center" |with named parameters
'''A little thank you...'''<br> <small>for {{{reason}}}.<br> hugs, {{{signature}}}</small>
Template:Hl2|You type	Template:Hl2|You get
{{Thankyou |reason=all |signature=Joe}}	A little thank you... for all. hugs, 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|Joe}}. For named parameters use "name=value" pairs separated by a pipe char: {{Thankyou|reason=all|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}}.

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.

Note that the usual update problems apply -- if you change the categories inside a template, the categories of the referring pages won't be updated until those pages are edited.

Making templates useful

For templates to be effective users need to find them and be able to use them. Wikis are not user friendly when it comes to finding, using and working with templates. 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>

The user can simply copy and paste the example to create a similar page. This example is trivial, however a working example that demonstrates how templates can be used in complex situations to save time, on specialty topics more easily. see working example at http://www.clickwiki.info/index.php/Template:Object

Also creating a Category:Template on your wiki to put your templates together may also be useful for editors along with links to this page will greatly improve productivity. example wiki category page

Usage

Allows to establish a link to a subject: Template:NameOfTemplate </pre></div>

The user can simply copy and paste the template to establish a new page that is similar to other pages. The example demonstrated is indeed trivial, however a working example that demonstrates how templates can be used in complex situations to save time, accuracy and help categories pages on specialty topics more easily. see working example here

Also creating a Category:Template on your wiki to put your templates together may also be useful for editors along with links to this page will greatly improve productivity. example wiki category page

See Also

Template uses

• Help:External searches

External links

Template:Meta </pre></div>Template:Languages