Difference between revisions of "Help:Templates"

Latest revision as of 23:42, 31 October 2013

Script error 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 designed to be transcluded (embedded) inside other pages. Templates follow a convention that the name is prefixed with "Template:", assigning it to that namespace; besides this, you can create them like any other wiki page.

The simplest use of templates is as follows. If you create a page called "Template:Welcome" with contents:

Hello! Welcome to the wiki.

you'll have created your first template! If you then insert the code:

{{Welcome}}

in any other page, when that page is viewed the text "Hello! Welcome to the wiki." will appear instead of {{Welcome}}. The template content is "transcluded" into the other page, i.e. it is integrated in the page.

You can then insert {{Welcome}} at any point of any page where you wish to welcome someone. Suppose it is used in 100 pages. If you then change the template contents to:

Hi there! Welcome to this wonderful wiki.

and revisit any of the 100 pages where the template was used, you'll see the new text instead of the original one. In this way, you have changed the content of 100 pages without editing them, because the template is transcluded into these pages.

This is the basic mechanism. There are several additional features of transclusion that enrich this mechanism and make templates very useful.

Usage

Templates can be used in other pages in these ways:

• {{Name}} — as described above, this link will be dynamically replaced by the current content of [[Template:Name]] at the time the page with the template link is loaded. The link will remain unchanged in the page's source.
• {{subst:Name}} — when this template link is used, it will be replaced once and for all with the content of [[Template:Name]] as of the time the page with the link is saved: a copy of the contents of [[Template:Name]] will be substituted for the template link. The contents are then a part of the including page, and can be edited normally, separately from the original. Note: changes to the source template page will not be propagated to the page with the template link.
• {{safesubst:Name}} — this was introduced in rev:61710 to allow for substitution that doesn't break transclusion, see w:en:Help:Substitution#The safesubst: modifier.
• {{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]]
  • {{subst::Pagename}} replaces itself with the contents of [[Pagename]]

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

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

Parameters

To enrich the mechanism of transclusion, MediaWiki allows parameters to be passed to a template when it is transcluded. Parameters allow the template to produce different contents or have different behaviors.

Suppose you wish to insert a little thank you note in the talk page of other users, such as:

The thank you note will have a reason (in this case, "all your effort") and a signature ("Me"). Your objective is that any user is able to thank any other user, for any reason whatsoever.

So that the note will look similar everywhere it is used, you can define a template called Template:Thankyou, for example. Although the note should look similar whenever a user thanks another user, its specific contents (i.e. the reason and the signature) will be different. For that reason, you should pass them as parameters. If we ignore the remaining elements to format the box and place the image, the core content of the template will be this:

'''A little thank you...'''
for {{{1}}}.
hugs, {{{2}}}

Notice the use of {{{1}}} and {{{2}}}. This is the way to identify, within templates, the parameters that will be passed in when the template is used. Note that, within the template, each parameter is surrounded by three braces: {{{ }}}. This is different from normal template name usage.

When using the template on a page, you fill in the parameter values, separated by a "pipe" character (|). MediaWiki allows parameters to be passed to the template in three ways: Anonymously, Numbered, and Named.

Anonymous parameters

To pass in anonymous parameters, list the values of those parameters sequentially:

{{Thankyou|all your effort|Me}}

In this case, the {{Thankyou}} template receives parameters {{{1}}}=all your effort and {{{2}}}=Me, producing:

The order in which anonymous parameters are passed in is crucial to its behaviour. Reversing the order of the parameters, like so:

{{Thankyou|Me|all your effort}}

would produce this result:

Note: identifying parameters by order (with {{{1}}}, etc) works only with anonymous parameters. If your page identifies any parameter by number or name, as shown below, this method will no longer be available to the template which receives them.

Numbered parameters

To pass in parameters by number, identify each parameter when passing it:

{{Thankyou|2=Me|1=your friendship}}

This time, template {{Thankyou}} receives parameters {{{1}}}=your friendship and {{{2}}}=Me, though they have been supplied in inverse order, and produces:

Named parameters

The third way of passing parameters is by name, instead of numbers. In this case, the template contents would be changed to:

'''A little thank you...'''
for {{{reason}}}.
hugs, {{{signature}}}

Within the template, we use {{{reason}}} and {{{signature}}} to identify each parameter, instead of a number. To pass these parameters by name, identify each parameter when passing it:

{{Thankyou|signature=Me|reason=being who you are}}

In this case, template {{Thankyou}} receives parameters {{{reason}}}=being who you are and {{{signature}}}=Me and produces:

The advantage of using named parameters in your template, besides also being flexible in the order parameters can be passed, is that it makes the template code much easier to understand if there are many parameters.

Default values

If you transclude a template that expects parameters, but do not provide them, in this way:

{{Thankyou}}

in the numbered parameters example above you would get the following:

Since no parameters were passed in, the template presents the parameters themselves, instead of their respective values. In these cases, it may be useful to define default values for the parameters, i.e. values that will be used if no value is passed in. For example, if the template contents are changed to:

'''A little thank you...'''
for {{{reason|everything}}}.
hugs, {{{signature|Me}}}

then {{{reason|everything}}} defines that if no parameter {{{reason}}} is provided, then the value everything will be used. Similarly, {{{signature|Me}}}, defaults parameter {{{signature}}} to value Me. Now, transcluding the template again without passing any parameter, results in the following:

Control template inclusion

By default, a template's content is displayed in its entirety, both when viewed directly and when included in another page. However, you can control which parts of a template will be seen and included by the use of the <noinclude> and <includeonly> tags.

Anything between <noinclude> and </noinclude> will be seen only when the template's page is being viewed directly, but not when it is included in another page. This is useful when you want to include text or code in a template that you do not want to propagate to any pages which include it, such as:

• Category links when categorizing the template itself
• interlanguage links to similar templates in other languages
• Explanatory text about how to use the template

Likewise, anything between <includeonly> and </includeonly> will be processed and displayed only when the page is being included, but not when the template page is being viewed directly, and is useful in situations such as:

• Categorizing pages which include the template. Note: when changing the categories applied by a template in this fashion, the categorization of the pages which include that template may not be updated until some time later: this is handled by the {{ #ifeq:

 GridPACK

| MediaWiki | job queue | [[{{#if:|{{#ifexist:Manual:Job queue||mw:}}}}Manual:Job queue|job queue]] }}. To force the re-categorization of a particular page, open that page for editing and save it without changes.

• Ensuring that the template's code is not executed when viewing the template page itself. Typically this is because it expects parameters, and its execution without parameters has an undesired result.

Everything outside <noinclude> and <includeonly> tags is processed and displayed normally; that is, both when the template page is being viewed directly and when the template is included in another page.

Organizing templates

For templates to be effective, users need to find them, and find out how to use them.

To find them, users can:

1. Click Special Pages > All Pages
2. In the Namespace list, choose Template and click Go.

To give usage information, include an example like this one on the template page:

<noinclude>
== Usage ==
Welcome users:
{{Thankyou|reason=your reason|signature=your signature}}
</noinclude>

Then, an editor can simply copy and paste the example to use the template.

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.

MediaWiki code

If you have import rights on the new wiki:

1. Go to Special:Export on the original wiki, and download an .xml file with the complete history of all necessary templates, as follows:
   • Enter the name of the template in the big text box, e.g. "Template:Welcome". Pay special attention to capitalization and special characters — if the template name isn't exactly correct, the export may still occur but the .xml file will not have the expected data.
   • Check the box "Include templates".
   • Uncheck the box "Include only the current revision".
   • Click Export.
2. Go to Special:Import on the new wiki and upload the .xml file.

If you don't have import rights on the new wiki:

1. Go to Special:Export on the original wiki, and download an .xml file with the latest version only of all necessary templates, as follows:
   • Enter the name of the template in the big text box.
   • Check the box "Include templates".
   • Check the box "Include only the current revision".
   • Click Export.
   • Open the file in a text editor and replace certain XML entities with the corresponding characters: &lt; → <, &gt; → >, &quot; → " and &amp; → &. Because of XML syntax rules, these entities appear in the XML file, but they should not appear in the edit box of the MediaWiki instance.
   • Manually copy the text inside the <text> tag of each listed template into a similarly named template in your wiki. In the edit summary of each template, link to the original page for attribution.

This will copy the entire code necessary, and will suffice for some templates.

Extensions

An extension often used in templates is ParserFunctions. Visit page {{ #ifeq:

 GridPACK

| MediaWiki | ParserFunctions | [[{{#if:|{{#ifexist:Help:Extension:ParserFunctions||mw:}}}}Help:Extension:ParserFunctions|ParserFunctions]] }} and check if any of the functions listed there are used in the templates you've copied. If so, you have to install the {{ #ifeq:

 GridPACK

| MediaWiki | ParserFunctions extension | [[{{#if:|{{#ifexist:Extension:ParserFunctions||mw:}}}}Extension:ParserFunctions|ParserFunctions extension]] }}. To install it, you'll need system admin access to the server of your MediaWiki installation.

Another dependency that may be used in templates, especially those on Wikipedia, is Lua. Having {{#invoke: }} in template code is a good sign for it. In case it's used, you need to install the {{ #ifeq:

 GridPACK

| MediaWiki | Scribunto extension | [[{{#if:|{{#ifexist:Extension:Scribunto||mw:}}}}Extension:Scribunto|Scribunto extension]] }} and system admin access is required too. See that page for more instructions about installing and using the extension.

CSS and JavaScript code

Besides MediaWiki code, many templates make use of CSS and some rely on JavaScript to work fully. If the copied templates are not behaving as expected, this may be the cause. To copy the required CSS and JavaScript to your wiki you'll normally need to have admin priviledges, because you'll be editing system messages in the "MediaWiki:" namespace.

1. Look for the use of CSS classes (text 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 and check if the template is now fine.
2. If the copied template is still not working as expected, check if there is code in "MediaWiki:Common.js" or "MediaWiki:Monobook.js" on the original wiki. If so, you can try copying it to "MediaWiki:Common.js" on the new wiki. Normally, it is a good idea to only copy code from trusted sources, and first browsing the code to identify and select the parts that are relevant. You may find comments that can serve as clues to identify the functionality of each part.

See also

• Help:External searches – a template special use case example
• Help:Magic words – fancy stuff you may find in some templates
• Help:Parser functions in templates
• MetaWiki:Help:Template – contains a much more thorough manual on how exactly templates function
  • MetaWiki:Help:Advanced templates – describes even more advanced techniques such dynamic template calls and variable variables
• MetaWiki:Help:Embed page – embedding pages from namespaces other than Template:.

}}

 |Afrikaans
 |Afrikaans
 }}

 |العربية
 |العربية
 }}

 |asturianu
 |asturianu
 }}

 |azərbaycanca
 |azərbaycanca
 }}

 |جهلسری بلوچی
 |جهلسری بلوچی
 }}

 |български
 |български
 }}

 |brezhoneg
 |brezhoneg
 }}

 |বাংলা
 |বাংলা
 }}

 |bosanski
 |bosanski
 }}

 |català
 |català
 }}

 |čeština
 |čeština
 }}

 |dansk
 |dansk
 }}

 |Deutsch
 |Deutsch
 }}

 |Zazaki
 |Zazaki
 }}

 |Ελληνικά
 |Ελληνικά
 }}

 |Esperanto
 |Esperanto
 }}

 |español
 |español
 }}

 |فارسی
 |فارسی
 }}

 |suomi
 |suomi
 }}

 |français
 |français
 }}

 |galego
 |galego
 }}

 |ગુજરાતી
 |ગુજરાતી
 }}

 |עברית
 |עברית
 }}

 |हिन्दी
 |हिन्दी
 }}

 |magyar
 |magyar
 }}

 |Հայերեն
 |Հայերեն
 }}

 |Bahasa Indonesia
 |Bahasa Indonesia
 }}

 |Ido
 |Ido
 }}

 |italiano
 |italiano
 }}

 |日本語
 |日本語
 }}

 |ქართული
 |ქართული
 }}

 |қазақша
 |қазақша
 }}

 |ភាសាខ្មែរ
 |ភាសាខ្មែរ
 }}

 |한국어
 |한국어
 }}

 |Ripoarisch
 |Ripoarisch
 }}

 |kernowek
 |kernowek
 }}

 |Latina
 |Latina
 }}

 |Baso Minangkabau
 |Baso Minangkabau
 }}

 |македонски
 |македонски
 }}

 |മലയാളം
 |മലയാളം
 }}

 |मराठी
 |मराठी
 }}

 |Bahasa Melayu
 |Bahasa Melayu
 }}

 |Nederlands
 |Nederlands
 }}

 |norsk bokmål
 |norsk bokmål
 }}

 |occitan
 |occitan
 }}

 |ଓଡ଼ିଆ
 |ଓଡ଼ିଆ
 }}

 |polski
 |polski
 }}

 |português
 |português
 }}

 |português do Brasil
 |português do Brasil
 }}

 |română
 |română
 }}

 |русский
 |русский
 }}

 |සිංහල
 |සිංහල
 }}

 |slovenčina
 |slovenčina
 }}

 |slovenščina
 |slovenščina
 }}

 |shqip
 |shqip
 }}

 |српски / srpski
 |српски / srpski
 }}

 |svenska
 |svenska
 }}

 |தமிழ்
 |தமிழ்
 }}

 |ไทย
 |ไทย
 }}

 |Türkçe
 |Türkçe
 }}

 |українська
 |українська
 }}

 |Tiếng Việt
 |Tiếng Việt
 }}

 |ייִדיש
 |ייִדיש
 }}

 |粵語
 |粵語
 }}

 |中文
 |中文
 }}

 |中文（简体）‎
 |中文（简体）‎
 }}

 |中文（繁體）‎
 |中文（繁體）‎
 }}

 |中文（台灣）‎
 |中文（台灣）‎
 }}