Help:Templates

From ErfWiki

(Difference between revisions)
Jump to: navigation, search
(Created page with 'If you have standard texts you want to include on several pages, the MediaWiki template feature comes into play. ==Creation== Templates are standard wiki pages whose content is ...')
m
 
(One intermediate revision not shown)
Line 37: Line 37:
|{{Hl2}}|'''You get'''
|{{Hl2}}|'''You get'''
|-
|-
-
|<code><nowiki>{{Thankyou|all your hard work|Joe}}</nowiki></code>
+
|<code><nowiki>{{Cookie|all your hard work|Joe}}</nowiki></code>
|
|
-
{{Thankyou|all your hard work|Joe}}
+
{{Cookie|all your hard work|Joe}}
|-
|-
|{{Hl2}} colspan="2" align="center" |'''with named parameters'''
|{{Hl2}} colspan="2" align="center" |'''with named parameters'''
Line 53: Line 53:
|{{Hl2}}|'''You get'''
|{{Hl2}}|'''You get'''
|-
|-
-
|<pre><nowiki>{{Thankyou
+
|<pre><nowiki>{{Cookie
|reason=all your hard work
|reason=all your hard work
|signature=Joe}}</nowiki></pre>
|signature=Joe}}</nowiki></pre>
|
|
-
{{Thankyou|all your hard work|Joe}}
+
{{Cookie|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:Cookie]] 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>{{Cookie|all your hard work|Joe}}</nowiki></code>.  For named parameters use "name=value" pairs separated by a pipe char:  <code><nowiki>{{Cookie|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>{{Cookie|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>.
Line 106: Line 106:
[[Category:Help|{{PAGENAME}}]]
[[Category:Help|{{PAGENAME}}]]
-
[[Category:Template]]
+
[[Category:Templates]]

Latest revision as of 23:08, 2 November 2009

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

Contents

[edit] Creation

Templates are standard wiki pages whose content is designed to be transcluded (embedded) inside other pages. Templates follow a convention that the name is prefixed with "Template:", assigning it to that namespace. Therefore you can create them like any other wiki page.

[edit] Usage

Templates are wiki pages which can be used in other pages in three ways:

  • {{Name}} 'transcludes' (i.e. includes a copy of) the content of the template (stored in the page [[Template:Name]]) whenever the page containing the template transclusion is fetched and displayed; i.e. if the template is later changed, the displayed transcluding page will automatically change too
  • {{subst:Name}} replaces that string with the contents of the template, in the source of the transcluding page, when you save that page; the copy of the template contents can then be edited normally (and separately from the original in the template page). Note: don't use this if you are looking to continually propagate changes from the source template to the page(s) that references it.
  • {{msgnw:Name}} includes the template in a form that displays it as raw wiki syntax (the way <nowiki> does) when the page containing it is fetched

In fact, an ordinary wiki page can also be used as a template, simply by specifying the namespace it resides in, so:

  • {{Template:Pagename}} includes [[Template:Pagename]]
  • {{Foo:Pagename}} includes [[Foo:Pagename]]
  • {{:Pagename}} includes [[Pagename]]

If no such namespace exists, the full title is assumed to be a template:

  • {{Foo:Bar}} includes [[Template:Foo:Bar]]

[edit] Parameters

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
{{Cookie|all your hard work|Joe}}
Cookie Image
And here's a cookie...
for all your hard work.
--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
{{Cookie
|reason=all your hard work
|signature=Joe}}
Cookie Image
And here's a cookie...
for all your hard work.
--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:Cookie 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 (|): {{Cookie|all your hard work|Joe}}. For named parameters use "name=value" pairs separated by a pipe char: {{Cookie|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: {{Cookie|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.

[edit] 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 template's page is being viewed directly.

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.

[edit] 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.

[edit] Copying from one wiki to another

Templates often require CSS or other templates, so users frequently have trouble copying templates from one wiki to another. The steps below should work for most templates:

  1. Copy the template text to the new wiki, either by importing or with a link in the edit summary to the original page (for attribution).
  2. Look for CSS classes (like class="foobar") in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy them to "MediaWiki:Common.css" on the new wiki.
  3. Look for templates (like {{foobar}}) inside the template text, and copy those templates to the new wiki.
  4. If the template uses ParserFunctions, ParserFunctions extension.
Go To:
Personal tools
http://www.erfworld.com/wiki/index.php?title=Help:Templates&diff=29134&oldid=18531
www.erfworld.com
crawl=CC-MAIN-2014-23
35478
application/http; msgtype=response
sha1:C3AKZAVK5QVDZIQWLCFG3EVASILZSLAC
<urn:uuid:f4c4db20-670e-48a8-8f96-957e8b4b0665>
2014-07-30T09:57:23Z
63.247.141.250
sha1:ZEF2M444ADK4UQUHHDHZCP5CAL4K6HF6
<urn:uuid:a3ee3449-964a-4804-9248-c6e57ee9e16a>
http://www.erfworld.com/wiki/index.php?title=Help:Templates&diff=29134&oldid=18531
response
<urn:uuid:ce47ec9a-bf56-4866-a5ab-5d862465088a>
robots: classic
hostname: ip-10-146-231-18.ec2.internal
software: Nutch 1.6 (CC)/CC WarcExport 1.0
isPartOf: CC-MAIN-2014-23
operator: CommonCrawl Admin
description: Wide crawl of the web with URLs provided by Blekko for July 2014
publisher: CommonCrawl
format: WARC File Format 1.0
conformsTo: http://bibnum.bnf.fr/WARC/WARC_ISO_28500_version1_latestdraft.pdf