This help page is a how-to guide. It explains concepts or processes used by the Wikipedia community. It is not one of Wikipedia's policies or guidelines, and may reflect varying levels of consensus. |
A template is a Wikipedia page created to be included in other pages. Templates usually contain repetitive material that might need to show up on a larger number of articles or pages. They are commonly used for boilerplate messages, standardized warnings or notices, infoboxes, navigational boxes, and similar purposes. Templates can have parameters so that the same page generates different text on multiple pages that include it.
The most common method of inclusion is called transclusion, where the wiki source of the target page contains a reference to the template, using the {{Template name}} syntax. Another method is substitution, where the content of the template is copied into the wiki source of the target page, just once, when it is saved.
Help:A quick guide to templates gives a brief introduction to the subject. There is further help from MediaWiki at mw:Help:Templates and mw:Help:Advanced templates.
General description
Most templates are in the template namespace, which means that they have titles in the form "Template:XXXX". It is possible, however, to transclude and substitute from any namespace,[a] and so some template pages are placed in other namespaces, such as the user namespace. Template pages have associated talk pages.
Templates can contain any desired wikitext, including calls to other templates. There is some programming ability: customizable values (via parameters); calculation and branchings (using parser functions); and access to wiki-specific variables (magic words), such as dates, times, and page names. They may also contain markup to define certain parts of the page to be included while other parts are not. This means that when you display the template page itself, you may see more than when you display a page that includes it (for example, it can contain documentation, categories, etc. for the template).
To call a template (cause it to be transcluded or substituted in the page), a page contains wikitext in double braces. For example, the wikitext {{under construction}} calls the {{under construction}} template. Sometimes the call includes parameters and looks like {{under construction|comment=This is a comment}}. Note that template calls are not the only thing for which double braces are used in wikitext.
Note that while templates are the usual way transclusion and substitution happen on Wikipedia, they are not the only way.
Using templates
General
Using a template is similar to calling a function in programming. When called, it returns a value. For a template, calling is known as a template call and the return value is known as the expansion of the template, which is treated as part of the calling page's source. Like functions, some templates can take parameters that affect their output.
Calling a template causes it to be either transcluded or substituted in the page that calls it (the target page).
Transcluding a template means that when MediaWiki displays the page, it treats the template as if it were directly in the page’s source. Substituting a template differs in that it inserts the content of the template permanently into the target page when it is saved and subsequent editors cannot tell that it originated from a template.
When you update a template, every page that transcludes it automatically reflects the update when the page is displayed in the future, whereas updating a template has no effect on pages that have previously been saved with the template substituted.
To transclude a template, insert {{Template name}} at the point where it should appear in the page source. To substitute it, use {{subst:Template name}}. This wikitext is called a template call.
In MediaWiki, the wiki software that Wikipedia uses, variables are distinct from templates, though both are referenced by double curly braces {{ }} and they both return a value. These references differ in that variables in MediaWiki are always uppercase, while template names follow the same conventions and have the same limitations as page names. For example, they are case-sensitive (except for the first character), underscores are parsed as spaces, and template names cannot contain the characters # < > [ ] | { } because they are reserved for wiki markup.
The number sign # is used as a fragment identifier, which identifies a fragment or section of a page. Although you can use it in a link to link to a section of a template page (e.g., Template:Portal#Example), fragment identifiers have no meaning in a template call and are ignored. For example, {{Portal#Location|Books}} is the same as {{Portal|Books}}.
The template namespace is the default, so you can leave out the namespace Template: in the template name, and it is conventional to do so. However, you must specify the namespace prefix for templates in other namespaces, such as User:. To transclude a page in mainspace, precede its page name with a colon, as {{:Page name}}.
Note: Attempting to transclude a template that does not exist produces a red link, just like linking to any other nonexistent page. Following the link allows one to create that particular template. It is not possible to transclude templates between projects (such as different-language Wikipedias or MediaWiki) – to use a template on another language project, a copy of the template must be created in that project.
Parameters
The basic transclusion syntax for a template can be further controlled using parameters, which allow you to customize a template’s output. The syntax is {{Template name|parameter|parameter|...}}, where Template name is the template’s name, and each parameter can be either a simple value (known as an unnamed parameter) or in the form name=value (known as a named parameter). The first, second, third, etc., unnamed parameters are named 1, 2, 3, etc., so using {{Template name|1=value1|2=value2}} is equivalent to {{Template name|value1|value2}}.
Each template has specific parameters it can accept, as defined within its code. You can list named parameters in any order in a template call. Extra or misnamed parameters have no effect, while missing parameters cause a default value to be used. If a parameter is repeated, the last defined parameter value is used.
The value of a parameter can be an empty string, such as when the pipe (|) or equals sign is followed immediately by the next pipe or the closing braces. For example, {{Template name|1=|2=test}} produces the same output as {{Template name||2=test}}. This is different from not specifying the parameter at all, which results in a default value, although templates are often coded so as to behave the same in both cases.
If a template call specifies a parameter which is not defined in the template, it has no effect. Editors sometime specify a parameter they know is not defined in the template, For example, editors sometimes include a parameter like <reason> to add a brief explanation within the source as a hidden comment. (But some templates, such as Requested move, are programmed to show the reason parameter if provided). Certain templates, especially complex ones like infoboxes, may use the check for unknown parameters module to alert editors about any unrecognized parameters to help avoid unintentional errors.
If a parameter is specified as blank (e.g., |1=), it is treated as an empty string, which differs from leaving it out altogether (in which case the default value applies). However, templates are often coded to act the same in both cases.
Whitespace handling
Leading and trailing whitespace (including line breaks) around named parameters and values is collapsed automatically, but spaces in the middle of the value are kept. For instance, {{ ... | myparam = this is a test }} has the same output as {{ ... |myparam=this is a test}}. However, with unnamed parameters, all whitespace is retained as preserved in the output.
The trimming of line breaks around parameters can be used to improve the readability of templates with many parameters, by placing each parameter in its own line.
Variable length parameter lists
In MediaWiki, templates cannot automatically handle an unknown or unlimited number of parameters. Each possible parameter usually has to be predefined in the template code. For example, a template might be set up to use three specific parameters, such as 1, 2, and 3. If someone includes additional parameters beyond those, they will not affect expansion of the template.
However, there are some ways to work around this:
- Setting a limit: You can write the template to handle a fixed number of parameters by manually specifying each one (e.g., up to 10 or 20 parameters).
- Using templates or modules: For cases needing a flexible number of inputs, templates can use Lua modules or helper templates (like {{separated entries}}). These helper tools provide more advanced handling, such as counting or iterating through parameters, enabling the use of multiple inputs without setting an exact number.
However, modules can bypass this limitation. For simpler cases, the separated entries module expands all sequential parameters and lets you set custom delimiters. For more advanced usage, the params module enables counting, listing, mapping, filtering, and handling a variable number of parameters without prior knowledge of the exact number.
This workaround allows it to appear as if a template handles a variable number of parameters because the module processes each one iteratively up to a certain point, but true infinite flexibility is not built into the core MediaWiki system.
Examples
Note: If you wish to experiment with any of these, you can use the template sandbox or your user page or sandbox. You can try out your template with Special:ExpandTemplates.
An example of a very simple template can be found at Template:TM, which expands to wikitext that places the trademark symbol (™), linked to the trademark article, at that point in the displayed page. A programmer would say that the template "returns" the trademark symbol link wikitext.
Display Template:TM (by clicking on the foregoing link), then click on the "Edit" tab to see the template code (its page source). The active part of that code, which becomes the expansion of the template when it is transcluded, is the single link wikitext [[Trademark|™]]. The remainder of the page source is enclosed between <noinclude> tags, so it shows up when you display the template page itself but not when you display a page that calls the template.
To transclude Template:TM onto another page (i.e., to use it on another page), type {{TM}} into the source of that page (the target page) and click Show preview. The page will be displayed with the template call replaced by the expansion of the template, as if the wikitext actually contained [[Trademark|™]] at that point. The displayed page will therefore contain the wikilink "™".
For example, type The trademark symbol is {{TM}} and you will see "The trademark symbol is ™" when previewing the page or after saving the change.
The other way to use a template is to substitute it. If you type The trademark symbol is {{subst:TM}} and preview or save the page, you will see "The trademark symbol is ™" just as with the transclusion example above. But if you save the page and then look again at the saved page source,[b] you will see The trademark symbol is [[Trademark|™]], because the template call was replaced by the expansion of the template when you saved the page. There is no ongoing connection to the template call; no one can tell by looking at the page source that you didn't just type The trademark symbol is [[Trademark|™]] and if the {{TM}} template changes (or ceases to exist), your page will continue to display as it does now. (In contrast, in the transclusion example above, if the {{TM}} template subsequently changes, your page may then display differently).
Examples with parameters
An example of a template that takes parameters is the template {{about}}. Try typing {{about|how to use templates|how to use modules|Help:Lua}} in the sandbox—it will produce the following text:
The template {{about}} uses three unnamed parameters (also called positional parameters) in the example above, but you can call the same template with different numbers of parameters to give slightly different results, as explained in the template's documentation. For example, {{about||how to use modules|Help:Lua}}. Note the usage of an empty parameter—in this instance, the consecutive pipes mean that the first parameter specified is an empty string, which in this template will cause it to omit the initial "about" sentence. This produces:
A simple example of a template that has named parameters is Template:Payoff matrix, used to generate a 2-by-2 grid. For example:
| Markup | Renders as | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{payoff matrix | UL = 5 | UR = 7 | DL = 2 | DR = 9 | Name = Example usage }}
|
| ||||||||||||
See the template page for more possibilities. Notice that the template is called here without specifying all its possible parameters, so undefined parameters are given default values.
Hints and workarounds
The following points may be worth noting when using templates:
- Templates are not the only method of transclusion, in some cases, other methods such as selective transclusion are more appropriate.
- An unnamed parameter (positional parameter) value cannot contain an ordinary equals sign, as this would be interpreted in the parameter specification as a named parameter (with the equals sign separating the name from its value).[c]
- To specify an unnamed parameter including an equals sign (for example in a URL with name–value pairs), replace the equals sign with the magic word
{{=}}, which expands to an equals sign that will not be interpreted. - Another method is to explicitly specify the positional parameters. The first unnamed parameter is named "1" and so on. To call template {{done}} with
a=bas the literal value for the first parameter, type either{{done|a{{=}}b}}or{{done|1=a=b}}.
- To specify an unnamed parameter including an equals sign (for example in a URL with name–value pairs), replace the equals sign with the magic word
- Similarly, it is not possible to use an ordinary pipe character
|in a template parameter specification, as it would be interpreted as separating one parameter specification from another.[d] This problem can similarly be solved by using the magic word{{!}}in place of the pipe, or—if the pipe is not intended to be parsed at a higher level—using the HTML entity|. Alternatively, for embedding wikitables in templates, you may use{{Wikitable}}to avoid excessive{{!}}. - Remember that whitespace characters (spaces, tabs, carriage returns, and line feeds) are not automatically stripped from the start and end of unnamed parameters, unlike with named parameters. Including such characters (or any other non-visible characters in any parameters) may in some cases affect the template's behavior in unexpected ways. (Template designers can use {{Trim}} to remove unwanted whitespace in unnamed parameters).
- In documentation and discussions, it is customary to put the name of a template in double braces to emphasize the reference to a template (for example, use {{Trim}} as the name of Template:Trim). If you just type
{{Trim}}in the source page, that will of course call the template, so to make it easy to display the name with the braces, and also make the name a link to the template for the reader's convenience, there is the {{tl}} template (the "template link" template). For example,{{tl|Example}}produces {{Example}}. There are various other template-linking templates available with other functions. - When an editor changes a template (by editing the template or one of its subtemplates), the change will ultimately be reflected any time any page that transcludes that template is subsequently displayed. However, the change may not become visible on all pages immediately; a previously cached version of a page, based on the previous version of the template, may continue to be displayed for some time. Use the purge function to force a page to be displayed using the latest versions of templates—including on the template page itself, if it contains usage examples.
- When viewing old versions of pages, remember that templates will be transcluded as they are now, not necessarily as they were when the old page version was active.
- To list all pages that transclude a template, use the What links here link on the page when you display the template page. Note that this will not include pages where the template has been substituted, as there is no record of substitutions.
- To get a list of templates transcluded on a page, bring up the edit page and find the list below the edit window. This list also includes the subtemplates used by the templates that are directly transcluded. To get such a list for a page section, an old version of the page,[e] or your newly edited version prior to saving, click Show preview on the appropriate edit page.
- There are limits to the number and complexity of the templates that an article may have. See the "§ Expand limits" section for help with this.
- If you want the template to leave a time stamp or signature, you can write
<noinclude><nowiki></noinclude>~~~~~<noinclude></nowiki></noinclude>, but this works only when you substitute the template. If you transclude it, you'll just get ~~~~~. - To improve readability, programmers usually like to split code with newlines and indent it. Unfortunately, MediaWiki does not allow this technique; in many instances, these purpose-built newlines are treated by MediaWiki as content. One possible workaround is to add
<!--before each newline character and-->after it, which produces an HTML comment.
Writing templates
Process
Templates are just Wikipedia pages. They are created, deleted, and edited in much the same way as any other page.
Creating
To create a template, choose an appropriate name, navigate to that page, then click the "Edit" tab or create a new page as needed.
Templates are normally placed in the template namespace, though you can place a template intended for your own personal use or for experimentation in your own user space.
Before creating a template, do a quick search for existing templates (such as by exploring Category:Wikipedia templates) to see if there is already a template that does what you want or a similar template whose code can be copied and modified (or left in place and expanded). Look for generic templates on which the new template can be based; for example, you can create a navbox template easily by creating a brief template that calls the generic Template:Navbox.
There is no hard rule about what name to choose for a template—make it short but reasonably descriptive. The naming guideline says: "Template function should be clear from the template name". If similar templates exist, try to follow a consistent naming pattern. You can rename a template without breaking existing transclusions (what is called breakage) by leaving a redirect to the new template name.
Modifying
Edit a template the same way as any other page: navigate to the template and click the "Edit" tab.
Be extremely careful when editing existing templates—changes made can affect a large number of pages, often in ways you might not expect. For this reason many high-use templates are protected against editing except by administrators and template editors; other editors can propose changes on the talk page. Some templates offer a sandbox and test cases for experimentation.
Deleting
Unused or inappropriate templates should be deleted. Templates that can be easily merged into another should be merged.
To propose the deletion or merger of a template, go to Templates for discussion (TfD).
Coding a template
Anything that can be included on a normal page or article can be included on a template, including other templates (called subtemplates). Templates often make use of programming features—parameters, parser functions, and other magic words—which allow the transcluded content to vary depending on context. There are also special tags to control which information is transcluded and which is not.
Metatemplates
Various metatemplates and metamodules exist to help accomplish common template tasks. They are called like normal templates and modules, but they serve a purpose that makes writing templates easier. See Category:Wikipedia metatemplates and Category:Template metamodules for a list of those templates and modules.
Handling parameters
In template code, the value of a parameter is represented by items enclosed between triple braces, which is a parameter reference.
- The code
{{{xxx}}}expands to the value of the parameter named "xxx". - The codes
{{{1}}},{{{2}}}, and so on are expanded to the first, second, and so on unnamed parameters. (Note that an unnamed parameter can alternatively be specified in a template call as an equivalent named parameter named "1", "2", etc.).
If a parameter is not specified in the template call, then the parameter reference is not replaced with anything -- it is expanded literally; this means that if the template call does not specify the parameter "xxx", the wikitext {{{xxx}}} inside the template expands to literally {{{xxx}}} (not the null string you may have expected). You can get a more useful behavior by specifying a default value in the parameter reference. Do this with the pipe syntax: {{{xxx|dflt}}} specifies the default value dflt for the named parameter "xxx", and {{{1|dflt}}} specifies the default value dflt for the first unnamed parameter. Most often, one specifies a null default value, such as {{{1|}}} or {{{xxx|}}}.
You can use default parameter values to effect a parameter alias:
For example, if parameters "text" and "message" are names for the same parameter, which can also be specified as the only unnamed parameter, then refer to the parameter with {{{message|{{{text|{{{1|}}}}}}}}}. If the template call specifies more than one of those parameters, "message" will have priority, followed by "text", and finally by the first unnamed parameter. So if a template call specifies parameters |message=A|text=B|C, the above wikitext expands to A.
Because of the multiple meanings of double-brace and triple-brace syntax in wikitext, expressions can sometimes be ambiguous. It may be helpful or necessary to include spaces to resolve such ambiguity. For example, {{ {{{xxx}}} }} or {{{ {{xxx}} }}}, rather than typing five consecutive braces, may be more human-readable. But watch out for unwanted whitespace appearing in the template expansion.
Parameter references do not get expanded when they are wrapped in <nowiki> tags.
Example
The parameter usage example above refers to the {{payoff matrix}} template. Here is the code in the template that implements those parameters:
{| id="Payoff matrix" style="background:white; float: {{{Float|right}}}; clear:right; text-align:center;" align={{{Float|right}}} cellspacing=0 cellpadding=8 width={{{Width|225}}}
|-
|style="width:33%; "|
|style="width:33%; border-bottom: solid black 1px;"| {{{2L|Left}}}
|style="width:33%; border-bottom: solid black 1px;"| {{{2R|Right}}}
|-
|style="border-right: solid black 1px; text-align: right; "| {{{1U|Up}}}
|style="border-right: solid black 1px; border-bottom: solid black 1px; background:{{{ULc|white}}}; font-size:120%; "| {{{UL|0, 0}}}
|style="border-right: solid black 1px; border-bottom: solid black 1px; background:{{{URc|white}}}; font-size:120%; "| {{{UR|0, 0}}}
|-
|style="border-right: solid black 1px; text-align: right; "| {{{1D|Down}}}
|style="border-right: solid black 1px; border-bottom: solid black 1px; background:{{{DLc|white}}}; font-size:120%; "| {{{DL|0, 0}}}
|style="border-right: solid black 1px; border-bottom: solid black 1px; background:{{{DRc|white}}}; font-size:120%; "| {{{DR|0, 0}}}
|-
|style="font-size: 90%;" colspan=3 |''{{{Name|{{PAGENAME}}}}}''
|}
The entity {{{2L|Left}}} instructs the template to use the value of the named parameter 2L or the text Left if the parameter is not specified in the call.
Special case: parameters within an XML-style opening tag
Parameter references aren't expanded inside XML-style opening tags. Thus, the following will not work within a template:
- <ref name={{{param}}}> Smith, Adam (1776)...</ref>
because the parameter is not expanded. Instead, you can use the {{#tag:}} parser function, which is—for example—used in {{sfn}} to generate the <ref>...</ref> element; see also Help:Magic words § Formatting. Therefore, the following example will work:
- {{#tag:ref | Smith, Adam (1776)... | name={{{param}}} }}
Caution: overextending URLs
If a parameter's value is (or ends with) a URL, check whether it is displayed in Wikipedia with the link overextending by one or more characters after the URL so that clicking the link causes an error or failure.
This could happen because the source code does not have a space after the URL or it contains or generates a space that is discarded in the processing. Ensure that in the template expansion a soft space (not a hard or non-breaking space) follows the URL, regardless of whether you or a user supplied the URL or whether it was generated by automated processing. The {{spaces}} template may be useful.
System variables and conditional logic
Template code often makes use of the variables and parser functions described at Help:Magic words to make the template's behavior depend on the environment in which it is included (such as the current time or namespace). Parser functions can be used for some arithmetic calculations and string manipulations on variables and parameter values, but certain standard programming features such as loops and variable assignment are not available. Full string manipulation is not available; some templates providing such function have been created, but they are inefficient and imperfect.
Some of the most frequently used variables and functions are listed below. For more, see Help:Magic words and the fuller documentation at the MediaWiki pages mw:Help:Magic words and mw:Help:Extension:ParserFunctions.
| Description | wiki source | Displayed text |
|---|---|---|
| Uppercasing text | {{uc: Heavens to BETSY! }}
|
HEAVENS TO BETSY! |
| Lowercasing text | {{lc: Heavens to BETSY! }}
|
heavens to betsy! |
| Getting a namespace name | {{NS: 1 }}
|
Talk |
| Getting a Wikipedia URL | {{fullurl: pagename }}
|
//en.wikipedia.org/wiki/Pagename |
The ParserFunctions extension provides more programming-oriented parser functions:
| Description | Wiki source | Displayed text |
|---|---|---|
| Testing for equality between two strings (or parameters). If the first two parameters are equal, the third parameter is returned, otherwise the fourth parameter is returned. | {{#ifeq: yes | yes | Hooray...! | Darn...! }}
|
Hooray...! |
{{#ifeq: yes | no | Hooray...! | Darn...! }}
|
Darn...! | |
| Testing whether a string (or parameter) contains anything (other than whitespace). If it does, the second parameter is returned, otherwise the third parameter is returned. | {{#if: {{{param|}}} | Hooray...! | Darn...! }}
|
Darn...! |
| Making a calculation (mathematics) [area of circle of radius 4, to 3 decimal places] |
{{#expr: ( pi * 4 ^ 2 ) round 3 }}
|
50.265 |
| Testing the result of a calculation. If the expression is true or non-zero, the second parameter is returned, otherwise the third parameter is returned. [is 1230 even or odd?] |
{{#ifexpr: 1.23E+3 mod 2 | Odd | Even }}
|
Even |
| Description | Wiki source | Displayed text (for this help page) |
|---|---|---|
| Page names | {{PAGENAME}}
|
Template |
{{FULLPAGENAME}}
|
Help:Template | |
| Name of the current namespace | {{NAMESPACE}}
|
Help |
| Number of registered users | {{NUMBEROFUSERS}}
|
48,343,328 |
| Number of pages in a given category | {{PAGESINCATEGORY:"Weird Al" Yankovic albums}}
|
19 |
| Current software version | {{CURRENTVERSION}}
|
1.44.0-wmf.5 (d64f667) |
| Timestamp of last page revision | {{REVISIONTIMESTAMP}}
|
20241128235732 |
The {{PAGENAME}} and {{NAMESPACE}}variables are particularly useful, and frequently used, to change template behavior based on the context in which they are included. Templates that contain category links often do this. For example, a cleanup template contains a category link to categorize the calling page as one which needs cleanup, so the template is likely to condition that category link on the {{NAMESPACE}} variable so that talk pages, user pages, and any other pages that might call the template incidentally do not get categorized as pages needing cleanup.
Nesting templates
A template may call another template—this is called nesting and the called template is called, in this context, a subtemplate. When WikiMedia expands the template, it expands subtemplates as the calls to them appear, so that the final product is essentially the result of expanding templates from the most deeply nested out.
While fairly straightforward in application, it involves some noteworthy quirks and tricks.
To pass a parameter value from a template call to to a subtemplate, use a parameter reference in the template call to the subtemplate.
- Example:
- Template:A contains
"the quick brown {{B|{{{3}}} }} jumps over...". Template:B (a subtemplate) contains'''{{{1}}}'''. Page X calls A with{{A|apple|pear|fox}}This expands to"the quick brown '''fox''' jumps over...". The third unnamed parameter passed to Template:A gets passes as the first unnamed parameter to subtemplate B.
A template can even choose which subtemplate parameter to pass conditionally.
- Examples:
- Template:A contains
the quick brown {{B|{{{3}}}=fox}} jumps over.... Template:B (a subtemplate) contains'''{{{jumper}}}'''. Page X calls A with{{A|apple|pear|jumper}}. This expands to"the quick brown '''fox''' jumps over...". The third unnamed parameter passed to Template:A is passed as the name of the parameter passed to subtemplate B with the value "fox".
Template recursion is not available; that is, a template may not call itself directly, or indirectly by calling other templates which call it. Attempts to do so will result in an error message describing a "template loop".
When a subtemplate contains unmatched braces—as in {{lb}}}—the unmatched braces are treated as text during processing—they do not affect the parsing of braces in the calling template. But where the template is substituted, the unmatched braces will be parsed as braces when the page is subsequently displayed. This has little practical use, but can occasionally introduce unexpected errors.
See m:Help:Advanced templates and m:Help:Recursive conversion of wikitext for more information.
Inclusion control: noinclude, includeonly, and onlyinclude
By default, when a page calls a template, MediaWiki includes the expansion of the entire template in the calling page. However, it is possible to modify that behavior, using tags that specify which parts of the template code are to be included. This makes it possible for the template to contain information only for display when the template page itself is displayed, such as the template's documentation, or categories. It is also possible to have parts of the template be included in calling pages, but not be displayed when the template page itself is displayed and not be processed when the template page itself is saved (e.g., categories to be applied to calling pages which do not apply to the template). The tags are as follows:
<noinclude>...</noinclude>– The text between the tags is not included when the template is called, but is processed when the template itself is displayed or saved; a common use is for documentation in templates.<onlyinclude>...</onlyinclude>– Nothing on the page except what appears between the tags is included when the template is called.<includeonly>...</includeonly>– The text between the tags is included when the template is called, but is not processed when the template is displayed or saved.
| Wikitext | What is rendered here (template page) | What is included there (calling page) |
|---|---|---|
<noinclude> text1 </noinclude> text2
|
text1 text2
|
text2
|
<onlyinclude> text1 </onlyinclude> text2
|
text1 text2
|
text1
|
<includeonly> text1 </includeonly> text2
|
text2
|
text1 text2
|
<onlyinclude><includeonly> text1 </includeonly></onlyinclude> text2
|
text2
|
text1
|
Perhaps the most common issue with the use of these blocks is unwanted spaces or lines. It is important to remember that the effect of these tags begins immediately before the first angle bracket, not on the previous line or at the previous visible character; similarly the effect ends immediately after the last angle bracket, not on the next line or with the next visible character. For example:
- }}<includeonly>
- }}
</includeonly>
These tags can be nested inside each other, though (for a given page) this is really meaningful only for the <onlyinclude> tag; nesting <includeonly> and <noinclude> tags is fairly pointless. Be careful to properly nest the tags, however. Constructions like <onlyinclude>abc<includeonly>def</onlyinclude>ghi</includeonly> will not work as expected. Use the "first opened, last closed" rule that is standard for HTML/XML.
Problems and workarounds
- The following techniques are helpful in debugging a template:
- Use Special:ExpandTemplates to see the full recursive expansion of one or more templates.
- Use
subst:to substitute a template (rather than transclude it), which can show more clearly what is happening when the template is transcluded; see Help:Substitution. - Use
msgnw:(short for "message, nowiki") to more-or-less transclude the source of the template rather than its expansion. It is not perfect: lists are rendered, comments are removed, and single newlines are replaced with spaces (which is particularly confounding when transcluding wikitext tables).
- If the first character of a template expansion (or parser function result) is one of four wiki markup characters—
:,;,*,#[f], it is processed during display as though it were at the beginning of a line, even if the template call is not. This allows you to create various kinds of lists with templates where the template call may not be in the correct place for a list. To avoid this, use<nowiki />before the markup or<nowiki>...</nowiki>around it, or use the HTML entities:,;,*,#, or use the templates {{colon}}, {{;}}, {{asterisk}}, {{number sign}} (those templates may not exist at other wikis). In some cases, the HTML entities will work when the<nowiki />does not. The problem often occurs when a parameter value in a template call starts with one of the four characters. See also {{Encodefirst}}. - For issues with template substitution, such as how to control whether subtemplates are substituted as well when the parent template is substituted, see Help:Substitution.
- You can use the template
{{Trim}}to strip any initial or final whitespace from unnamed parameter values if this would cause problems; named parameter values are automatically stripped in this way. - To protect server resources and avoid infinite loops, the parser imposes certain limits on the depth of transclusion nesting and on the page size with expanded templates. This may cause a page to break if it uses very complex templates, particularly if there are multiple such templates on the same page. For more information, see WP:Template limits. You can check a page's overall load on the server by examining the generated HTML for a page and looking for the
NewPP limit reportcomments. - Do not use
=wikimarkup to create a section header in a template which is intended for use in article space; this will create an edit link on a page that transcludes the template that will confusingly open the template for editing. - You may avoid section edit links to the template by including
<includeonly>__NOEDITSECTION__</includeonly>.
Documentation
Documentation for users, together with the template's categories, normally goes after the template code, inside <noinclude>...</noinclude> tags. It is normally necessary to put the opening <noinclude> tag immediately after the end of the code, with no intervening spaces or newlines, to avoid transcluding unwanted whitespace.
In the case of complex templates, the documentation is often kept on a separate subpage of the template page (named "Template:XXX/doc"). This applies especially to many protected templates, so that non-administrators can edit the documentation. To do this, place a call to the {{Documentation}} template after the main template code and within <noinclude>...</noinclude> tags. If the "/doc" subpage does not exist, a link appears when you display the template that you can use to create the subpage.
The documentation subpage, rather than the template itself, is normally what is placed in categories to represent a template.
Categorization
Categorize pages by template inclusion
Some templates generate category declarations in their expansion, since the template is intended to place calling pages in particular categories. This is often done with maintenance categories. Placing articles into ordinary content categories in this way is discouraged. When doing this, you may have to use <includeonly>...</includeonly> tags to keep the template itself out of the category. While developing, testing, sandboxing, or demonstrating a template intended to apply a category, either temporarily replace each category with a test category (starting with X1, X2, or X3) or suppress categorization (see category suppression in templates).
Categorize templates
Categorizing your template and documenting its proper usage will make it easier for other editors to find and use.
Category declarations for a template itself should be placed on the template's documentation subpage (or inside <noinclude>...</noinclude> tags if there is no documentation subpage) to avoid placing calling pages in the category.
Aliases
A redirect of a template functions as an alias. For example, Template:Tsh redirects to Template:Template shortcut, so you can code {{tsh|foo}} instead of {{Template shortcut|foo}}.
It is good to prepare template aliases for variations in whitespace and capitalization. For example, there is a template called {{See Wiktionary}}. The "W" is capitalized, since the word "Wiktionary" is so, but a redirect {{See wiktionary}} (with lowercase "w") exists because editors may misremember it as the latter.
Template limits
"Post-expand include size" limit. When templates are rendered or expanded to HTML for viewing in your browser, they use memory. This is called the "post-expand include size" and has a limit of 2,048,000 bytes. This size is included as an invisible comment in the HTML output—use your browser's view source feature to show the raw HTML and search for "newpp". The report will look like:
<!--
NewPP limit report
Preprocessor node count: 2382/1000000
Post-expand include size: 63476/2048000 bytes
Template argument size: 9517/2048000 bytes
Expensive parser function count: 2/500
-->
The example shows that template expansion is using 63,476 bytes out of 2,048,000 bytes of available memory.
Display problem. If too many templates are included on a page, the post-expand include size may exceed the limit. When this happens, templates after the limit will no longer expand and will instead display as a wikilink (for example, Template:Template name). Common causes are the inclusion of too many citation templates, navbox templates, and/or flag templates. To resolve this problem substitute templates, directly invoke modules, remove templates, or split the page.
Non-rendered tranclusions still count towards limit. For example, a page which contains only {{#if:{{:Main Page}}}} would still have a post-expand include size even though it would have no output at all.
The same applies to Scribunto modules. For example, {{#invoke:Test|main}} would still increase post-expand include size even if Module:Test were simply:
mw.getCurrentFrame():preprocess "{{msgnw::Main Page}}" -- remove this line and post-expand include size becomes zero
return {main = function() end} -- p.main() has no return value
Lua programming language
The Lua programming language is available for use through the Scribunto MediaWiki extension. You can embed Lua code into templates by employing the {{#invoke:}} functionality of the Scribunto MediaWiki extension. The Lua source code is stored in pages called modules, and templates invoke these individual modules. For example, you can invoke Module:Example with the code {{#invoke:Example|hello}} to print the text "Hello World!".
Terminology
A template is a Wikipedia page whose purpose is to be transcluded or substituted in another page. Templates are usually in the template namespace, but don't have to be. Pages can transclude or substitute any page, not just templates; what makes a page a template is the page's purpose.
Calling a template means transcluding or substituting one. A page calls a template. The wikitext on a page that causes the page to call a template is called a template call. For example, {{sic|constellation prize}}. Template calls are always delimited by double braces ({{}}), but not everything enclosed in double braces is a template call.
Expansion is the process of generating page source from a template, when a page calls it, by applying parameters and other features. MediaWiki expands a template as it renders a page. One can also say that the template itself expands, so both "MediaWiki expands {{{1}}} as the value of the first positional parameter" and "{{{1}}} expands as the value of the first positional parameter" work.
Expansion of a page is also the page source that results from template expansion. For example, the expansion of the {{sic}} template when called by {{sic|constellation prize}} is constellation prize [''[[sic]]''].
The displayed page content generated by a template call (which is the rendering of the expansion of the called template) is the template result. The template result generated by the template call {{sic|constellation prize}} is "constellation prize [sic]".
The name of a template is the name of the wikipedia page (which is also the title of the page). The namespace is normally left off if it is "Template" (which it almost always is). Furthermore, it is customary to write the name with double braces, like a template call, to emphasize that it names a template. For example, "Use the {{tm}} template to generate the trademark symbol." But don't go so far as to put a template name in the code font, to prevent confusion with an actual template call. {{tm}} is a template name, but {{tm}} is a template call.
Some template calls perform a tagging function; such a template call is often called a tag, as in, "If you are in the middle of a major edit, place an {{in use}} tag at the top of the page." This is one of many ways the term "tag" is used in Wikipedia.
A parameter is a particular piece of information that can be specified in a template call to affect the expansion of the template. A parameter has a value. A named parameter has a name; an unnamed parameter has a position. A template call specifies a parameter and the code that does that is a parameter specification. A template defines a parameter (not explicitly -- just by the template being designed to use it). The code in a template that expands to the parameter value (e.g. {{{myparam}}}) is a parameter reference.
Common variations
It is common to use "template" to refer not only to a template, but to a template call, a template result, and a template name.
For example:
- I am going to put more detail in the {{short description}} template on this page.
- Upon seeing an {{under construction}} template, the reader may decide to come back later.
- There are many kinds of infoboxes. The templates all start with "Infobox".
These usages can be confusing, especially to someone less familiar with templates. Consider using more specific language.
Template search
As an alternative to using this index linked above, you can search the Template namespace using the Special:Search box below:
See also
Help pages
- Introductions:
- Help:Magic words
- Help:Manipulating strings
- Help:Metatemplating
- WP:Advanced template coding
- WP:Template documentation
- WP:Template index
- WP:Template limits
- WP:Template namespace
- WP:Template sandbox and test cases
- WP:TemplateData—standardized template description used by VisualEditor
- WP:WikiProject Templates
- mw:Manual:Advanced templates
- mw:Manual:Expr parser function syntax
- m:User:Happy-melon/Templates
- mw:Help:ExpandTemplates
- mw:Help:Extension:ParserFunctions
- mw:Help:Magic words
- mw:Help:Templates
Mediawiki manual pages
- mw:Manual:$wgEnableScaryTranscluding
- mw:Manual:$wgNonincludableNamespaces
- mw:Manual:Parser.php
- mw:Manual:Parser functions
Special pages
- WP:Database reports/Templates transcluded on the most pages—not counting transclusions through redirects
- Special:Allpages (namespace 10)—all pages in the Template namespace
- Special:ExpandTemplates
- Special:Unusedtemplates—templates which are not transcluded (but may be used for substitution)
Other backend pages
- Help:User style—CSS and JS pages
- Help:System message—MediaWiki namespace pages
- m:Project portals—Multilingual portal pages
- WP:Book sources—used by Special:Booksources
- m:Spam blacklist
- Template:Example
Notes
- ^ Namespaces from which transclusion is not allowed are specified on a wiki by the variable
$wgNonincludableNamespaces. - ^ There is no way to preview the effect on the page source of substitution without saving the page
- ^ This does not apply if the equals sign comes within another template call or other item which the parser handles separately.
- ^ Again, this does not apply if it comes within another separately parsed item, such as a piped wikilink.
- ^ For an old version, the subtemplate tree will be constructed according to the templates' current state.
- ^ These are defined in the
doBlockLevelsfunction of Parser.php.
| Main namespace | |
|---|---|
| Other namespaces | |
| All namespaces | |
| Navboxes with templates |
|
| Inline images | |
| Help pages | |
| Related topics | |
| Search | |