Difference between revisions of "Help:Templates"

From FamiLAB Wiki
Jump to: navigation, search
m (fix)
(Using parameters in templates)
Line 11: Line 11:
 
:<code><nowiki>{{msgnw:Name}}</nowiki></code> includes the template in raw wiki syntax, like <code><nowiki>&lt;nowiki&gt;</nowiki></code> does
 
:<code><nowiki>{{msgnw:Name}}</nowiki></code> includes the template in raw wiki syntax, like <code><nowiki>&lt;nowiki&gt;</nowiki></code> does
  
==Using parameters in templates==
+
==Have you checked the site license? If not, read this before posting!
<div style="float:right">
+
MediaWiki.org uses two site licenses:  
{| {{Prettytable}}
 
|-
 
|{{Hl2}} colspan="2" align="center" |'''Template with numbered parameters'''
 
|-
 
| colspan="2" |
 
<pre><nowiki>
 
'''A little thank you...'''<br>
 
<small>for {{{1}}}.<br>
 
hugs, {{{2}}}</small>
 
</nowiki></pre>
 
|-
 
|{{Hl2}}|'''You type'''
 
|{{Hl2}}|'''You get'''
 
|-
 
|<code><nowiki>{{Thankyou|all|~~~}}</nowiki></code>
 
|
 
{{Thankyou|all|[[User:Someuser|Someuser]]}}
 
|-
 
|{{Hl2}} colspan="2" align="center" |'''with named parameters'''
 
|-
 
| colspan="2" |
 
<pre><nowiki>
 
'''A little thank you...'''<br>
 
<small>for {{{reason}}}.<br>
 
hugs, {{{signature}}}</small>
 
</nowiki></pre>
 
|-
 
|{{Hl2}}|'''You type'''
 
|{{Hl2}}|'''You get'''
 
|-
 
|<pre><nowiki>{{Thankyou
 
|reason=all
 
|signature=~~~}}</nowiki></pre>
 
|
 
{{Thankyou|all|[[User:Someuser|Someuser]]}}
 
|}
 
</div>
 
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 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.
+
Pages in the Help: namespace all have a thick blue border around them, indicating that their content is released into the public domain. Do not make edits to these pages unless you are comfortable releasing your contributions under this license.  
 +
Have you checked the site license? If not, read this before posting!
 +
MediaWiki.org uses two site licenses:  
  
When using the template on a page, you fill in the parameter values, separated by a pipe char (|): <code><nowiki>{{Thankyou|all|~~~}}</nowiki></code> or - if you have used named parameters  <code><nowiki>{{Thankyou|reason=all|signature=~~~}}</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=~~~|1=all}}</nowiki></code>.
+
Pages in the Help: namespace all have a thick blue border around them, indicating that their content is released into the public domain. Do not make edits to these pages unless you are comfortable releasing your contributions under this license.
  
 
==Control template inclusion==
 
==Control template inclusion==

Revision as of 16:49, 11 June 2006

Template:PD Help Page If you have standard texts you want to include on several pages, the MediaWiki template feature comes into play.

Creating a template

Templates must be 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 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

==Have you checked the site license? If not, read this before posting! MediaWiki.org uses two site licenses:

Pages in the Help: namespace all have a thick blue border around them, indicating that their content is released into the public domain. Do not make edits to these pages unless you are comfortable releasing your contributions under this license. Have you checked the site license? If not, read this before posting! MediaWiki.org uses two site licenses:

Pages in the Help: namespace all have a thick blue border around them, indicating that their content is released into the public domain. Do not make edits to these pages unless you are comfortable releasing your contributions under this license.

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.

External links

Template:Meta