Help:Templates
| Important note: When you edit this page, you agree to release your contribution into the Public Domain. If you don't want this or can't do this because of license restrictions, please don't edit. This page is one of the Public Domain Help Pages, which can be freely copied into fresh wiki installations and/or distributed with MediaWiki software; see Help:Contents for an overview of all pages. |
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 codeTemplate:/code, 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:
- codenowikiTemplate:Name/nowiki/code includes the current content of the page nowikiTemplate:Name/nowiki.
- codenowiki{{subst:Name}}/nowiki/code inserts the content of the page nowikiTemplate:Name/nowiki when you save your text.
- codenowiki[[:Template:Name]]/nowiki/code includes the template in raw wiki syntax, like codenowikilt;nowikigt;/nowiki/code does
Using parameters in templates
div style=float:right
| Template with numbered parameters | |
|
prenowiki A little thank you...br smallfor {{{1}}}.br hugs, {{{2}}}/small /nowiki/pre | |
| You type | You get |
| codenowikiA little thank you...
for {{{reason}}}. hugs, {{{signature}}} /nowiki/code |
A little thank you... for {{{reason}}}. hugs, {{{signature}}} |
| with named parameters | |
|
prenowiki A little thank you...br smallfor {{{reason}}}.br hugs, {{{signature}}}/small /nowiki/pre | |
| You type | You get |
| prenowikiA little thank you...
for all. hugs, ~~~ /nowiki/pre |
A little thank you... for all. hugs, Someuser |
/div You can define parameters in templates either numbered as codenowiki{{{1}}}/nowiki/code or named codenowiki{{{param}}}/nowiki/code.
Example: you want a little thank you note you can put other users on their talk page with a reason and your signature. In the Template:Thankyou you enter your text.
When using the template on a page, you fill in the parameter values, separated by a pipe char (|): codenowikiA little thank you...
for {{{reason}}}.
hugs, {{{signature}}} /nowiki/code or - if you have used named parameters codenowikiA little thank you...
for all.
hugs, ~~~ /nowiki/code. 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: codenowikiA little thank you...
for {{{reason}}}.
hugs, {{{signature}}} /nowiki/code.
Control template inclusion
You can control template inclusion by the use of codenowikinoinclude/nowiki/code and codenowikiincludeonly/nowiki/code tags.
Anything between codenowikinoinclude/nowiki/code and codenowiki/noinclude/nowiki/code 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 codenowikiincludeonly/nowiki/code. Text between codenowikiincludeonly/nowiki/code and codenowiki/includeonly/nowiki/code 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. Wiki are not user friendly when it comes to finding, using and working with templates. A simple technique is to have a usage on the template page. For example div style=display:table; width:auto;pre
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 trival true, 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
External links
| MetaWiki: Help:Template |
/pre/div Template:Languages
