Difference between revisions of "Help:Templates"
(Undo revision 98500 by 155.250.128.25 (Talk)) |
(→Control template inclusion) |
||
| Line 56: | Line 56: | ||
When using the template on a page, you fill in the parameter values, separated by a pipe char (|): <code><nowiki>{{Thankyou|all|Joe}}</nowiki></code>. For named parameters use "name=value" pairs separated by a pipe char: <code><nowiki>{{Thankyou|reason=all|signature=Joe}}</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: <code><nowiki>{{Thankyou|2=Joe|1=all}}</nowiki></code>. | When using the template on a page, you fill in the parameter values, separated by a pipe char (|): <code><nowiki>{{Thankyou|all|Joe}}</nowiki></code>. For named parameters use "name=value" pairs separated by a pipe char: <code><nowiki>{{Thankyou|reason=all|signature=Joe}}</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: <code><nowiki>{{Thankyou|2=Joe|1=all}}</nowiki></code>. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Organizing templates== | ==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 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. | ||
Revision as of 06:43, 14 June 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).
Contents
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
| 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}}
|
|
| 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}}
|
|
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}}.
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.
See Also
- Help:External searches -- a template special use case example
- Help:Variables -- fancy stuff you may find in some templates
