Help:Templates: Difference between revisions
m 1 revision: Imported Help files from IT department's wiki |
m Removed category templates. |
||
| Line 7: | Line 7: | ||
==Using a template== | ==Using a template== | ||
Templates are wiki pages which can be used in other pages in three ways: | Templates are wiki pages which can be used in other pages in three ways: | ||
*<code><nowiki>{{Name}}</nowiki></code> includes the content of the template at the moment the page containing it is fetched <nowiki>"[[Template:Name]]"</nowiki>. | *<code> | ||
*<code><nowiki>{{subst:Name}}</nowiki></code> inserts the content of the template into the code of the page in a form that is editable normally <nowiki>"[[Template:Name]]"</nowiki> after you have saved your text. | <nowiki>{{Name}}</nowiki> </code> includes the content of the template at the moment the page containing it is fetched | ||
*<code><nowiki>{{msgnw:Name}}</nowiki></code> when the page containing it is fetched, includes the template in a form that displays it as raw wiki syntax, like <code><nowiki><nowiki></nowiki></code> does | <nowiki>"[[Template:Name]]"</nowiki> . | ||
*<code> | |||
<nowiki>{{subst:Name}}</nowiki> </code> inserts the content of the template into the code of the page in a form that is editable normally | |||
<nowiki>"[[Template:Name]]"</nowiki> after you have saved your text. | |||
*<code> | |||
<nowiki>{{msgnw:Name}}</nowiki> </code> when the page containing it is fetched, includes the template in a form that displays it as raw wiki syntax, like <code> | |||
<nowiki><nowiki></nowiki> </code> does | |||
==Using parameters in templates== | ==Using parameters in templates== | ||
| Line 18: | Line 24: | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
<pre><nowiki> | <pre> | ||
<nowiki> | |||
'''A little thank you...'''<br> | '''A little thank you...'''<br> | ||
<small>for {{{1}}}.<br> | <small>for {{{1}}}.<br> | ||
hugs, {{{2}}}</small> | hugs, {{{2}}}</small> | ||
</nowiki></pre> | </nowiki> </pre> | ||
|- | |- | ||
|{{Hl2}}|'''You type''' | |{{Hl2}}|'''You type''' | ||
|{{Hl2}}|'''You get''' | |{{Hl2}}|'''You get''' | ||
|- | |- | ||
|<code><nowiki>{{Thankyou|all your hard work|Joe}}</nowiki></code> | |<code> | ||
<nowiki>{{Thankyou|all your hard work|Joe}}</nowiki> </code> | |||
| | | | ||
{{Thankyou|all your hard work|Joe}} | {{Thankyou|all your hard work|Joe}} | ||
| Line 34: | Line 42: | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
<pre><nowiki> | <pre> | ||
<nowiki> | |||
'''A little thank you...'''<br> | '''A little thank you...'''<br> | ||
<small>for {{{reason}}}.<br> | <small>for {{{reason}}}.<br> | ||
hugs, {{{signature}}}</small> | hugs, {{{signature}}}</small> | ||
</nowiki></pre> | </nowiki> </pre> | ||
|- | |- | ||
|{{Hl2}}|'''You type''' | |{{Hl2}}|'''You type''' | ||
|{{Hl2}}|'''You get''' | |{{Hl2}}|'''You get''' | ||
|- | |- | ||
|<pre><nowiki>{{Thankyou | |<pre> | ||
<nowiki>{{Thankyou | |||
|reason=all your hard work | |reason=all your hard work | ||
|signature=Joe}}</nowiki></pre> | |signature=Joe}}</nowiki> </pre> | ||
| | | | ||
{{Thankyou|all your hard work|Joe}} | {{Thankyou|all your hard work|Joe}} | ||
|} | |} | ||
</div> | </div> | ||
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>. | |||
'''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. | '''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 (|): <code><nowiki>{{Thankyou|all your hard work|Joe}}</nowiki></code>. For named parameters use "name=value" pairs separated by a pipe char: <code><nowiki>{{Thankyou|reason=all your hard work|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 your hard work}}</nowiki></code>. | When using the template on a page, you fill in the parameter values, separated by a pipe char (|): <code> | ||
<nowiki>{{Thankyou|all your hard work|Joe}}</nowiki> </code>. For named parameters use "name=value" pairs separated by a pipe char: <code> | |||
<nowiki>{{Thankyou|reason=all your hard work|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 your hard work}}</nowiki> </code>. | |||
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, <code><nowiki>{{{reason|all your hard work}}}</nowiki></code> would result in ''"all your hard work"'' if no value was provided for the parameter <tt>reason</tt>. | 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, <code> | ||
<nowiki>{{{reason|all your hard work}}}</nowiki> </code> would result in ''"all your hard work"'' if no value was provided for the parameter <tt>reason</tt>. | |||
==Control template inclusion== | ==Control template inclusion== | ||
You can control template inclusion by the use of <code><nowiki><noinclude></nowiki></code> and | You can control template inclusion by the use of <code> | ||
<code><nowiki><includeonly></nowiki></code> tags. | <nowiki><noinclude></nowiki> </code> and | ||
<code> | |||
<nowiki><includeonly></nowiki> </code> tags. | |||
Anything between <code><nowiki><noinclude></nowiki></code> and <code><nowiki></noinclude></nowiki></code> will be processed and | Anything between <code> | ||
<nowiki><noinclude></nowiki> </code> and <code> | |||
<nowiki></noinclude></nowiki> </code> will be processed and | |||
displayed only when the page is being viewed directly, not included. | displayed only when the page is being viewed directly, not included. | ||
| Line 70: | Line 90: | ||
* Explanatory text about how to use the template | * Explanatory text about how to use the template | ||
The converse is <code><nowiki><includeonly></nowiki></code>. Text between <code><nowiki><includeonly></nowiki></code> and | The converse is <code> | ||
<code><nowiki></includeonly></nowiki></code> will be processed and displayed only when the page is | <nowiki><includeonly></nowiki> </code>. Text between <code> | ||
<nowiki><includeonly></nowiki> </code> and | |||
<code> | |||
<nowiki></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|category]], without putting the template itself into that category. | being included. The obvious application is to add all pages containing a given template to a [[Category|category]], without putting the template itself into that category. | ||
| Line 96: | Line 119: | ||
==External links== | ==External links== | ||
{{meta|Help:Template}} | {{meta|Help:Template}} | ||
{{Languages|Help:Templates}} | |||
[[Category:Help|{{PAGENAME}}]] | [[Category:Help|{{PAGENAME}}]] | ||
Latest revision as of 14:39, 28 December 2011
| 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 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 with numbered parameters | |
'''A little thank you...'''<br>
<small>for {{{1}}}.<br>
hugs, {{{2}}}</small>
| |
| You type | You get |
|
|
| 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.
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.
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
- meta:Help:Embed page -- embedding pages from namespaces other than
Template:.
External links
| Template:Click | MetaWiki: Help:Template |
