Difference between revisions of "Help:Templates"
m |
m |
||
| Line 13: | Line 13: | ||
{| {{Prettytable}} | {| {{Prettytable}} | ||
|- | |- | ||
| − | |{{ | + | |{{Hl2}} colspan="2" align="center" |'''Defining the template''' |
| − | |||
|- | |- | ||
| − | |<code><nowiki>{{Thankyou| | + | | colspan="2" | |
| + | <pre><nowiki> | ||
| + | '''A little thank you...'''<br> | ||
| + | <small>for {{{1}}}.<br> | ||
| + | hugs, {{{2}}}</small> | ||
| + | </nowiki></pre> | ||
| + | |- | ||
| + | |{{Hl2}} colspan="2" align="center" |'''Using the template''' | ||
| + | |- | ||
| + | |{{Hl1}}|'''You type''' | ||
| + | |{{Hl1}}|'''You get''' | ||
| + | |- | ||
| + | |<code><nowiki>{{Thankyou|all|~~~}}</nowiki></code> | ||
| | | | ||
{{Thankyou|your good work|[[User:Someuser|Someuser]]}} | {{Thankyou|your good work|[[User:Someuser|Someuser]]}} | ||
| Line 23: | Line 34: | ||
You can define parameters in templates either numbered as <code><nowiki>{{{1}}}</nowiki></code> or named <code><nowiki>{{{param}}}</nowiki></code>. | You can define parameters in templates either numbered as <code><nowiki>{{{1}}}</nowiki></code> or named <code><nowiki>{{{param}}}</nowiki></code>. | ||
| − | When using the template on a page, you fill in the parameter values, separated by a pipe char (|): <code><nowiki>{{ | + | '''Example:''' you want a litte 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 (|): <code><nowiki>{{Thankyou|myreason|~~~}}</nowiki></code> or <code><nowiki>{{Thankyou|reason=happiness|signature=~~~}}</nowiki></code>. The advantage of using named parameters in your template is that they are flexible in order, it's also easier to keep track in a template with many parameters. If you want to change the order of numbered parameters, you have to mention them explicitly: <code><nowiki>{{Example|2=~~~|1=good work}}</nowiki></code>. | ||
==Control template inclusion== | ==Control template inclusion== | ||
| Line 38: | Line 51: | ||
The converse is <code><nowiki><includeonly></nowiki></code>. Text between <code><nowiki><includeonly></nowiki></code> and | The converse is <code><nowiki><includeonly></nowiki></code>. Text between <code><nowiki><includeonly></nowiki></code> and | ||
| − | </includeonly> will be processed and displayed only when the page is | + | <code><nowiki></includeonly></nowiki></code> will be processed and displayed only when the page is |
| − | being included. The obvious application 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 | Note that the usual update problems apply -- if you change the | ||
Revision as of 04:43, 7 September 2005
Template:PD text If you have standard texts you want to include on several pages, the MediaWiki template feature comes into play. 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
Creating a template
Templates must be prefixed with Template, you create them like any other wiki page.
Parameters
| Template:Hl2 colspan="2" align="center" |Defining the template | |
'''A little thank you...'''<br>
<small>for {{{1}}}.<br>
hugs, {{{2}}}</small>
| |
| Template:Hl2 colspan="2" align="center" |Using the template | |
| Template:Hl1|You type | Template:Hl1|You get |
{{Thankyou|all|~~~}}
|
|
You can define parameters in templates either numbered as {{{1}}} or named {{{param}}}.
Example: you want a litte 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 (|): {{Thankyou|myreason|~~~}} or {{Thankyou|reason=happiness|signature=~~~}}. The advantage of using named parameters in your template is that they are flexible in order, it's also easier to keep track in a template with many parameters. If you want to change the order of numbered parameters, you have to mention them explicitly: {{Example|2=~~~|1=good work}}.
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.
