Help:Template

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.

The most common method of inclusion is called transclusion, where the wikitext of the target page contains a reference to the template, using the syntax. Another method is substitution, where the content of the template is copied into the wikitext 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 and Wikimedia at mw:Help:Templates, m:Help:Template, and m:Help:Advanced templates.

Template link to template
To include the actual full name of the template as text (including the surrounding braces) in a Wikipedia article, apply the template link template. The primary motivation to do this is in instruction and documentation. A short example is the code:


 * generates
 * foo
 * foo

General description


Most templates are pages 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, 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. They have some limited programming capacities: customizable values (called 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 tags which define which parts of the wikitext are to be included when the template is transcluded or substituted. This means that the appearance of the template page itself need not be the same as that of the transcluded content (for example, it can contain documentation, categories, etc. for the template).

To transclude a template into an article or page, type in the wikitext at the place where the template is to appear. The first letter may be indifferently lower- or upper-case.

The prefix  before the template name is the default one and need not be included. However, for templates stored in other namespaces, the prefix, such as, must be specified. To transclude a page in mainspace, precede its title with a colon, as.

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 pages 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 given above can be extended by the addition of parameters, which are used to control the template's output. The syntax for this is

where  is the name of the template, and each   may either contain just a value (these are called ') or be of the form   ('). The first, second, third, etc. unnamed parameters will be given the names,  ,  , etc.

Whitespace characters (spaces, tabs, returns) are stripped from the beginnings and ends of parameter names and values, but not from the middle: thus   has the same effect as. This does not apply to parameters, where all whitespace characters are preserved.

Which parameters (if any) can or should be passed to a template and how they are to be named depends on the coding of that template. Named parameters can be defined in any order. Superfluous or misnamed parameters will be ignored; undefined parameters will be assigned default values. If a parameter is defined more than once, the last value takes effect.

The value of a parameter can be the empty string, such as when the pipe or equals sign is followed immediately by the next pipe or the closing braces. This is different from omitting the parameter altogether, which leaves it undefined, although templates are often coded so as to behave the same in both cases.

Parameters can be specified (and will do nothing) even if not represented in the template's code. For example, reason is frequently used as a pseudo-parameter to explain briefly in the wikisource why the template was placed. Some templates call Module:Check for unknown parameters to warn the editor if a parameter is being used that is not accounted for in the template's code; this is mostly used for infoboxes and other templates with a large number of complicated parameters, where the presence of an unknown one is usually an unintentional error. If you update such a template to include a new parameter, its call to the module must also be updated to include the new parameter.

Calling
Using a template is much like calling a function in a programming language – call it, and it returns a value (the output). Like functions, some templates accept parameters that change the output.

In MediaWiki, the wiki software that Wikipedia uses, variables have a more specific meaning that distinguishes them from templates, but they are both identified by double braces  and they both return a value.

Whereas MediaWiki variable names are all uppercase, template names have the same basic features and limitations as all page names: they are case-sensitive (except for the first character); underscores are parsed as spaces; and they cannot contain any of these characters:. This is because those are reserved for wiki markup and HTML.

The number sign  is called a fragment identifier because it denotes a  or section of a document (such as a section in a Wikipedia article). Although it can be used to link to a section of a template page (like Template:Portal), there is no reason to put a fragment identifier or fragment name in a template reference. In, for example, the string  has no purpose and is thus ignored.

Substitution
When a template is substituted, its content is hard-coded in the page rather than transcluded. To learn how and when to substitute a template, see.

Basic template usage examples
If you wish to experiment with any of these, please use either the template sandbox, Special:ExpandTemplates or your user page or sandbox.

An example of a very simple template can be found at Template:TM, which expands to place the trademark symbol (™), linked to the trademark article, at that point in the text. A programmer would say that the template the trademark symbol.

Click on Template:TM, then click on the "Edit source" tab to see the template code (its wikitext). The "active" part of that code, called the of the template, is the single link. The remainder of the wikitext is enclosed between noinclude tags, so it is displayed on the template page itself but will not be displayed when the template is used (or called) on another page.

To transclude Template:TM onto another page (i.e., to use it on another page), type into the wikitext of the target page and press. The page will be displayed with the replaced by the expansion of the template, as if the wikitext actually contained   at that point. The displayed page will therefore contain the wikilink "™".

For example, type  and you will see "The trademark symbol is " when previewing the page or after saving the change. You can use templates without knowing the details of their code; you only need to remember what result they produce, which is usually described on the template page.

Another way to use a template is to substitute it. If you type  and preview or save the page, you will again see "The trademark symbol is ™". If you look again at the saved wikitext, however, you will see that the template calls really were replaced by the expansion of the template when you saved the page. The link between the output text and the template is now broken, and the output will not be affected by future changes to the template (as it would be in the case of transclusion).

Examples with parameters
An example of a template that takes parameters is the template. Try typing in the sandbox—it will produce the following text:

The template uses three unnamed parameters (also called positional parameters) in the example above, but the same template can also be used with different numbers of parameters to give slightly different results, as explained in the template's documentation. For example,. Note the usage of an empty parameter—in this instance, the consecutive pipes mean that the first parameter that was "passed" to the template is an empty string, which in this template will cause it to omit the initial "about" sentence. This produces:

Other templates, particularly more complex ones, take named parameters or a mixture of named and unnamed ones. A simple example is Template:Payoff matrix, used to generate a 2-by-2 grid. For example:

See the template page for more possibilities. Notice that the template is used here without defining all its possible parameters—undefined parameters are given default values.

The spaces around the equal signs and before and after the parameters are used only for clarity—they are not needed and are ignored when the template is evaluated (although this is not the case with unnamed parameters). Parameter names fully case-sensitive, though; for example, it is not possible to replace   with   or   in the above example. Parameters with names that are not used by the template are simply ignored.

Examining the source code of the template shows the standard table markup with some extra triple bracket entities representing the parameters:

The entity  instructs the template to use the named parameter   or the text   if the parameter is not present in the call.

Usage hints and workarounds
The following points may be worth noting when using templates:
 * Templates are not the only method of transclusion, there may also be topically more appropriate methods such as selective transclusion.
 * An unnamed parameter cannot contain an ordinary equals sign, as this would be interpreted as setting off a named parameter. To pass an equals sign in an unnamed parameter (for example in a URL with name–value pairs), replace the equals sign with the special template, which returns an equals sign that will not be interpreted. Another method is to replace the unnamed parameter (and any subsequent unnamed parameters) with named parameters—the first unnamed parameter is equivalent to a named parameter 1 and so on. To call template with   as the literal value for the first parameter, type either   or.
 * Similarly, it is not possible to use an ordinary pipe character  in template parameters, as it will be interpreted as a separator. This time, the problem can 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  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 behaviour in unexpected ways. (Template designers can use to remove unwanted whitespace in unnamed parameters.)
 * In documentation and discussions, it is often convenient to be able to produce the template call syntax with a link to the template in question, but without actually calling the template. This can be done easily using the template (the "template link" template). For example,  produces Example. There are multiple other template-linking templates available with different functionalities.
 * When a template is changed (when the template or one of its subtemplates is edited), the change will be reflected on all pages on which the template is transcluded. 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 onto which a template is transcluded, use What links here on the template page. This will include pages where the template has been substituted.
 * To get a list of templates transcluded on a page, click "Edit" 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, or your newly edited version prior to saving, click 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 in resolving this.
 * If you want the template to leave a time stamp or signature, you can write, but this will only work if you substitute the template. If you transclude it, you'll just get.
 * To improve readability, usually programmers like to split the code with newlines and indent it. Unfortunately, MediaWiki software does not allow this functionality; in many instances, these purpose-built newlines are treated by the software as content. One possible workaround is to add  before each newline character and   after it, which produces an HTML comment.

Creating and editing templates
Templates are created and edited in much the same way as any other page: choose an appropriate name, navigate to that page, then click the "Edit" tab or create a new page as needed. As mentioned above, templates are normally placed in the template namespace, though templates intended for your own personal use or for experimentation can be created in your own user space. Anything that can be included on a normal page or article can be included on a template, including other templates (called ). 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.

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, navbox templates can be easily created by calling the generic Template:Navbox.

There is no hard rule about what name to choose for a template—make it short but reasonably descriptive. If similar templates exist, try to follow a consistent naming pattern. Templates can be renamed without breaking existing transclusions (what is called breakage), provided a redirect to the new template name is left behind.

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.

To propose the deletion or merger of unused or inappropriate templates or templates that can easily be merged, go to Templates for discussion (TfD).

Handling parameters
The values of the parameters which can be fed to a template are represented in the template code by items enclosed between braces:
 * The code  will be replaced by the value of the parameter named  . these are known as s.
 * The codes,  , and so on will be replaced by the first, second, and so on unnamed parameter (or the value of a parameter named  ,  , etc.); these are known as s.

If a parameter is not assigned a value, then no replacement will take place; this means that if no value is passed for parameter xxx, the value of the expression  inside the template will literally be   , not the 'blank' you may have expected. A more intuitive behaviour can be achieved by specifying default parameter values. This is done with the pipe syntax:  specifies the default value   for the named parameter xxx, and   specifies the default value   for the first unnamed parameter. Most often, this is used to specify null default values, such as  or.

Parameter aliases are a special case of default values. For example, if parameters 1, text, and message are names for the same parameter, then wikitext  could be used. If more than one of those parameters are given, then  will have priority, followed by , and finally by the first unnamed parameter. That is, if a template containing that wikitext is passed the parameters, the wikitext will expand to.

Because of the multiple uses of double-brace and triple-brace syntax, expressions can sometimes be ambiguous. It may be helpful or necessary to include spaces to resolve such ambiguity. For example,  or , rather than typing five consecutive braces, may be more human-readable. However, watch out for unwanted whitespace appearing in template expansions.

Special case: parameters within an XML-style opening tag
Parameters do not get expanded when they are wrapped in nowiki tags. They aren't expanded either if placed within the actual XML-style opening tag. Thus, the following will not work within a template: because the parameter is not expanded. Instead, you can use the  parser function, which is—for example—used in  to generate the  element; see also. Therefore, the following example will work:

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. Ensure that, after processing by the software, a soft space ( 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. Possibly, the source code could contain or generate a space that is discarded in the processing or there might not be any space there. Correct the source code, perhaps by forcing a soft space to appear after the URL. The 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 in order to make the template's behaviour depend on the environment (such as the current time or namespace) or on the parameter values that are passed to it. They can also be used for arithmetical calculations, but certain standard programming features such as loops and variable assignment are not available. Full string manipulation is also not available; some templates providing such functionality 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.

The ParserFunctions extension provides more programming-oriented parser functions.

The  and  variables are particularly useful, and frequently used, to change template behaviour based on context. For example, if the template transcludes a category link (e.g., cleanup templates, which transclude a link categorizing the page as a page which needs cleanup), it will often check the  variable to make sure that talk pages, user pages, or anywhere else the tag might incidentally be placed do not themselves get categorized as pages needing cleanup.

Nesting templates
Templates may contain other templates—this is usually called . As the template is processed, the wikitext produced by any nested templates is transcluded into the nesting template, so that the final product is essentially processed from the most deeply nested template out. While fairly straightforward in application, it involves some noteworthy quirks and tricks.

To pass a parameter value to a nested template, place a parameter tag as the value of one of the nested template's parameters.
 * Examples:
 * Template:A contains  This takes the value passed to the third positional parameter of Template:A and passes it as the first positional parameter of Template:B, then returns the wikitext produced by B as part of the phrase.
 * Template:A contains  As previously, except the third positional parameter of Template:A is passed to the named parameter "waldo" of Template:B.

Template parameters themselves can be chosen conditionally.
 * Examples:
 * Template:A contains  Template:A passes the word "fox" as a named parameter of Template:B whose name is A's third positional parameter.

A template can call itself but will stop after one iteration to prevent an infinite loop.

When a nested template contains unmatched braces—as in —the unmatched braces are treated as text during processing, and do not affect the parsing of braces in the nesting template. If the nested template is substituted, however, the substitution is processed first, and this change how braces are parsed in the nesting template. 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. These pages also contain information on unusual calls such as.

 Inclusion control: noinclude, includeonly, and onlyinclude
By default, when a template is transcluded (or substituted), the entire wikitext (code) of the template page gets included in that of the target page. However, it is possible to modify that behaviour, using tags that specify which parts of the template code are to be included. This makes it possible to avoid transcluding information intended for display only on the template page itself, such as the template's documentation, or categories. It is also possible to have parts of the code be transcluded, but be processed on the template page itself (e.g., categories to be applied to the target pages which do not apply to the template). The tags are as follows:
 * p – The text between the tags will be included when the template is transcluded (substituted), but  be processed on the template's page; a common use is for documentation in templates.
 * p – This specifies that nothing on the page what appears between the tags will be transcluded (substituted).
 * p – The text between the tags be transcluded (substituted), but will  be processed on the template's own page.

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
 * }}

}}
 * noinclude
 * }}


 * cnoinclude

These tags can be nested inside each other, though (for a given page) this really only applies to the o tag; nesting o and o tags is fairly pointless. Be careful to properly nest the tags, however. Constructions like oabcodefcghic will work as expected. Use the "first opened, last closed" rule that is standard for HTML/XML.

Problems and workarounds

 * If the first character produced by a template or parser function is one of four wiki markup characters—, ,  ,  —then it is processed as though it were at the beginning of a line, even when the template tag is not. This allows the creation of various kinds of lists in templates where the template may not always be in the correct place for a list. To avoid this, either use s before the markup or use the HTML entities  ,  ,  , and   respectively. In some cases, the HTML entities will work when the  does not. The problem often occurs when a parameter value in a template call starts with one of the four characters.
 * For issues involving the substitution of templates, such as how to control whether subtemplates are substituted as well when the parent template is substituted, see Help:Substitution.
 * The template can be used 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.
 * For debugging templates, the following techniques are sometimes helpful:
 * Use  to substitute a template (rather than transcluding it), which can show more clearly what is happening when the template is transcluded; see Help:Substitution.
 * Use  (short for "message, nowiki") to more-or-less transclude the wikitext of the template page rather than the processed contents. 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).
 * Use Special:ExpandTemplates to see the full recursive expansion of one or more templates.
 * To protect server resources and avoid infinite loops, the parser imposes certain limits on the depth transclusion nesting and on the page size with expanded templates. This may cause pages to break when using very complex templates, particularly if there are multiple such templates on the same page. For more information, see WP:Template limits. A page's overall load on the server can be checked by examining the generated HTML for a page and looking for the  comments.
 * Do not use  wikimarkup to create section headers within a template which is intended for use in article space; this will create an   link that, when transcluded, will confusingly open the template for editing.
 * You may avoid  links to the template by including.

Documentation
Categorizing your template and documenting its proper usage will make it easier for other editors to find and use.

Documentation for users, together with the template's categories, is normally placed after the template code, inside  tags. It is normally necessary to put the opening 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 (together with categories) is often kept on a separate subpage of the template page (named "Template:XXX/doc"). This also applies to many protected templates, which allows the information to be edited by non-administrators. This is achieved by placing the template after the main template code and within  tags. If the "/doc" subpage does not exist, a link will then appear enabling it to be created.

Categorize pages by template inclusion
Some templates contain category definitions in their transcluded code, since they are intended to place the target 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, it may be necessary to use  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
Categorization declaration  should be placed on the template's documentation page (or inside  tags if there is no documentation page) to avoid polluting the transcluding pages.

Aliases
Aliases can be created with redirects. For example, Template:Tsh redirects to Template:Template shortcut. You can then write instead of.

It is good to prepare template aliases which only differ in whitespaces and capitalization. For example, there is a template called. The "W" is capital, since the word "Wiktionary" is so, but a redirect with lower "w" exists because users may type the latter instead.

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:

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, ). Common causes are the inclusion of too many citation templates and/or flag templates. To resolve this problem substitute templates, remove templates, or split the page.

Non-rendered tranclusions still count towards limit. For example, a page which contains only  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,  would still increase post-expand include size even if Module:Test were simply:

Lua programming language
Since February 2013, the Lua programming language is available for use through the Scribunto MediaWiki extension. Lua code can be embedded into templates by employing the  functionality of the Scribunto MediaWiki extension. The Lua source code is stored in pages called modules, and these individual modules are then invoked on template pages. For example, Module:Example can be invoked using the code  to print the text "".

Template search
As an alternative to using this index linked above, you can search the Template namespace using the Special:Search box below:

Help pages

 * Introductions:
 * Help:A quick guide to templates
 * Help:Substitution
 * Help:Transclusion
 * 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
 * m:Help:Advanced templates
 * m:Help:Calculation
 * m:Help:Parameter default
 * m:Help:Template
 * 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
 * Project portals—Multilingual portal pages
 * WP:Book sources—used by Special:Booksources
 * Spam blacklist
 * Template:Example