Difference between revisions of "Help:Templates"

From FamiLAB Wiki
Jump to: navigation, search
Line 10: Line 10:
 
   
 
   
 
==Parameters==
 
==Parameters==
 +
<div style="float:right">
 +
{| {{Prettytable}}
 +
|-
 +
|{{Hl3}}|'''Description'''
 +
|{{Hl3}}|'''You type'''
 +
|{{Hl3}}|'''You get'''
 +
|-
 +
|Usage of a template</br>
 +
with two parameters
 +
|
 +
<code><nowiki>{{Thankyou</nowiki></code>}}
 +
|
 +
{{Thankyou|your good work|[[User:Elian|elian]] <sup>[[:de:Benutzer Diskussion:Elian|talk]]</sup> 03:46, 7 September 2005 (UTC)}}
 +
|}
 +
</div>
 +
You can define parameters in templates either numbered as <code><nowiki>{{{1}}}</nowiki></code> or named <code><nowiki>{{{param}}}</nowiki></code>. 
  
You can use 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</nowiki></code>}} or <code><nowiki>{{Example</nowiki></code>}}.
  
 
==Control template inclusion==
 
==Control template inclusion==

Revision as of 03:46, 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:Hl3|Description Template:Hl3|You type Template:Hl3|You get
Usage of a template</br>

with two parameters

{{Thankyou}}

Example sunflower image
A little thank you...
for your good work.
hugs, elian talk 03:46, 7 September 2005 (UTC)

You can define parameters in templates either numbered as {{{1}}} or named {{{param}}}.

When using the template on a page, you fill in the parameter values, separated by a pipe char (|): {{Example}} or {{Example}}.

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:

  • Adding 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.