Content deleted Content added
mNo edit summary |
|||
| (177 intermediate revisions by 75 users not shown) | |||
Line 1:
{{Short description|Main technical help page on templates}}
{{Redirect-multi|2|H:T|Wikipedia:Template|help regarding tables|Help:Table|content guidelines|Wikipedia:Template namespace}}
{{For-multi|lists of commonly used templates|Wikipedia:Template index|a quick introduction to templates|Help:A quick guide to templates}}
{{Pp-semi-indef}}
{{Wikipedia how to|H:T|WP:TEMPLATE}}
{{beginner version|Help:A quick guide to templates}}
{{Wiki markup}}
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
The most common method of inclusion is called [[
[[Help:A quick guide to templates]] gives a brief introduction to the subject. There is further help from MediaWiki
==General description==
[[File:Introduction to templates on Wikipedia.webm|thumb|A basic overview of how templates work (8-minute video)]]
Most templates are
Templates can contain any desired [[
To call a template (cause it to be [[Help:Transclusion|transcluded]] or [[Help:Substitution|substituted]] in the page), a page contains wikitext in double braces. For example, the wikitext {{tnull|under construction}} calls the {{tl|under construction}} template. Sometimes the call includes parameters and looks like <code><nowiki>{{under construction|comment=This is a comment}}</nowiki></code>. 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 (computer programming)|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'').
[[Wikipedia:Transclusion|Transcluding]] a template means that when MediaWiki <em>displays</em> the page, it treats the template as if it were directly in the page’s source. [[Wikipedia:Substitution|Substituting]] a template differs in that it inserts the content of the template permanently into the target page when it is <em>saved</em>
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 {{tnull|{{var|Template name}}}} at the point where it should appear in the page source. To substitute it, use {{tnull|subst:{{var|Template name}}}}. This wikitext is called a ''template call''.
In [[MediaWiki]], the [[wiki software]] that Wikipedia uses, [[Help:Magic words#Variables|variables]] are distinct from templates, though both are referenced by double [[Curly brackets|curly braces]] <code>{{ }}</code> 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 [[WP:NCHASHTAG|limitations]] as [[Help:Page names|page names]]. For example, they are [[Case sensitivity|case-sensitive]] (except for the first character), [[underscore]]s are parsed as spaces, and template names cannot contain the characters <code><nowiki># < > [ ] | { }</nowiki></code> because they are reserved for [[wiki markup]].
The [[number sign]] <code>#</code> is used as a [[URI fragment|fragment identifier]], which identifies a {{em|fragment}} or [[Help:Section|section]] of a page. Although you can use it in a [[WP:LINK|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, {{tnull|Portal{{var|#Location}}|Books}} is the same as {{tnull|Portal|Books}}.
The template namespace is the default, so you can leave out the namespace <code>Template:</code> 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 <code>User:</code>. To transclude a page in [[WP:MAINSPACE|mainspace]], precede its page name with a colon, as <code>{<nowiki />{:{{var|Page name}}}}</code>.
{{A note}} Attempting to transclude a template that does not exist produces a [[WP:Red link|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 ===
<!-- [[Help:Parameters]] redirects here, so: -->
{{about|template parameters|search parameters|Help:Searching#Parameters|section=yes}}
{{
{{shortcut|H:PARAMETER|WP:PARAMETER}}
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 <code><nowiki>{{Template name|</nowiki>''parameter''<nowiki>|</nowiki>''parameter''<nowiki>|...}}</nowiki></code>, where <code>{{var|Template name}}</code> is the template’s name, and each <code>{{var|parameter}}</code> can be either a simple value (known as an ''{{dfn|unnamed parameter}}'') or in the form <code>{{var|name}}={{var|value}}</code> (known as a ''{{dfn|named parameter}}''). The first, second, third, etc., unnamed parameters are named <code>1</code>, <code>2</code>, <code>3</code>, etc., so using <code><nowiki>{{Template name|1=value1|2=value2}}</nowiki></code> is equivalent to <code><nowiki>{{Template name|value1|value2}}</nowiki></code>.
The value of a parameter can be
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 {{tag|reason|open}} to add a brief explanation within the source as a [[Wikipedia:Manual of Style/Hidden text|hidden comment]]. (But some templates, such as [[Template:Requested move|Requested move]], are programmed to show the reason parameter if provided). Certain templates, especially complex ones like [[Wikipedia:Infobox|infoboxes]], may use the [[Module:Check for unknown parameters|check for unknown parameters module]] to alert editors about any [[:Category:Unknown parameters|unrecognized parameters]] they code by mistake.
===
Leading and trailing [[Wikipedia:Whitespace|whitespace]] (including line breaks) around {{em|named}} parameters and values is [[Whitespace collapsing|collapsed]] automatically, but spaces in the middle of the value are kept. For instance, <code><nowiki>{{ ... | myparam = this is a test }}</nowiki></code> has the same output as <code><nowiki>{{ ... |myparam=this is a test}}</nowiki></code>. However, with {{em|unnamed}} parameters, all whitespace is retained as preserved in the output.
The collapsing of line breaks around parameters can be used to [[Wikipedia:Template namespace#Readability of the code|improve the readability of a template call]] with many parameters by placing each parameter specification 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 <code>1</code>, <code>2</code>, and <code>3</code>. 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 [[Wikipedia:Lua|modules]]: For cases needing a flexible number of inputs, templates can use Lua modules or helper templates (like {{mfl|separated entries|main}} or {{tl|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 {{mfl|params}} module enables counting, listing, mapping, filtering, and handling a variable number of parameters without prior knowledge of the exact number.
Templates that accepts an open number of parameters are often collected under [[:Category:Variadic templates]].
===Examples===
{{A note}} If you wish to experiment with any of these, you can use the [[Template:Template sandbox|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 <code><nowiki>[[Trademark|™]]</nowiki></code>. The remainder of the page source is enclosed between {{xtag|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 {{tlx|TM}} into the source of that page (the target page) and click {{Button|Show preview}}. The page will be displayed with the template call replaced by the expansion of the template, as if the wikitext actually contained <code><nowiki>[[Trademark|™]]</nowiki></code> at that point. The displayed page will therefore contain the wikilink "[[Trademark|™]]".
For example, type <code>The trademark symbol is {{tl|TM}}</code> and you will see "The trademark symbol is {{TM}}" when previewing the page or after saving the change.
The other way to use a template is to [[Help:Substitution|substitute]] it. If you type <code>The trademark symbol is {{tls|TM}}</code> and preview or save the page, you will see "The trademark symbol is [[Trademark|™]]" just as with the transclusion example above. But if you save the page and then look again at the saved page <em>source</em>,{{efn|There is no way to preview the effect on the page source of substitution without saving the page}} you will see <code>The trademark symbol is <nowiki>[[Trademark|™]]</nowiki></code>, 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 <code>The trademark symbol is <nowiki>[[Trademark|™]]</nowiki></code> and if the {{tl|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 {{tl|TM}} template subsequently changes, your page may then display differently).
===={{anchor|Parameters}} Examples with parameters====
An example of a template that takes parameters is the template {{tlx|about}}. Try typing {{tnull|about|how to use templates|how to use modules|Help:Lua}} in the sandbox—it will produce the following text:
{{about|how to use templates|how to use modules|Help:Lua}}
The template {{tlx|about}} uses three [[unnamed parameter]]s (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 [[Template:About/doc|the template's documentation]]. For example, {{tnull|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: {{about||how to use modules|Help:Lua}}
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|<nowiki>{{payoff matrix | UL = 5 | UR = 7 | DL = 2 | DR = 9 | Name = Example usage }}</nowiki>|{{payoff matrix | UL = 5 | UR = 7 | DL = 2 | DR = 9 | Name = Example usage }}}}
See the [[Template:Payoff matrix|template page]] for more possibilities. Notice that the template is
===Hints and workarounds===
The following points may be worth noting when using templates:
* Templates are not the only method of [[Help:Transclusion|transclusion]], in some cases, other methods such as [[WP:SELECTIVETRANSCLUSION|selective transclusion]] are more appropriate.
* {{anchor|Equals}}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).{{efn|This does not apply if the equals sign comes within another template call or other item which the parser handles separately.}}
** To specify an unnamed parameter including an equals sign (for example in a [[URL]] with [[name–value pair]]s), replace the equals sign with the [[mw:Help:Magic words#Other|magic word]] {{tlx|{{=}}}}, 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 {{tl|done}} with <code>a=b</code> as the literal value for the first parameter, type either <code><nowiki>{{done|a{{=}}b}}</nowiki></code> or <code><nowiki>{{done|1=a=b}}</nowiki></code>.
* {{anchor|Pipe}}Similarly, it is not possible to use an ordinary pipe character <code>|</code> in a template parameter specification, as it would be interpreted as separating one parameter specification from another.{{efn|Again, this does not apply if it comes within another separately parsed item, such as a piped wikilink.}} This problem can similarly be solved by using the magic word {{tlx|!}} in place of the pipe, or—if the pipe is not intended to be parsed at a higher level—using the [[List of XML and HTML character entity references|HTML entity]] <code>&#124;</code>. Alternatively, for embedding [[Help:Table|wikitables]] in templates, you may use {{tlx|Wikitable}} to avoid excessive {{tlx|!}}.
* 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 {{tl|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 {{tl|Trim}} as the name of Template:Trim). If you just type <code><nowiki>{{Trim}}</nowiki></code> 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|tl}} template (the "'''t'''emplate '''l'''ink" template). For example, {{tnull|tl|Example}} produces {{tl|Example}}. There are various other [[Template:Template-linking templates|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 [[WP:Purge|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 [[Help:What links here|What links here]] link on the page when you display the template page. Note that this will {{em|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,{{efn|For an old version, the subtemplate tree will be constructed according to the templates' current state.}} or your newly edited version prior to saving, click {{Button|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|§ Expand limits]]" section for help with this.
* If you want the template to leave a [[WP:~|time stamp or signature]], you can write <code><noinclude><nowiki></noinclude><nowiki>~~~~~</nowiki><noinclude></nowiki></noinclude></code>, but this works only when you <em>substitute</em> the template. If you <em>transclude</em> it, you'll just get <nowiki>~~~~~</nowiki>.
* 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 <code><!--</code> before each newline character and <code>--></code> after it, which produces an [[HTML comment]].
==Writing templates==
<!--[[Help:Subtemplates]] redirects here.-->
===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 [[WP:Template namespace|template namespace]], though you can place a template intended for your own personal use or for experimentation in your own [[WP:User pages|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 [[WP:Navbox|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 [[Wikipedia:Template namespace|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 [[Help:Transclusion|transclusions]] (what is called ''breakage'') by leaving a [[WP:Redirect|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 [[WP:Protection policy|protected]] against editing except by [[WP:Administrators|administrators]] and [[WP:Template editor|template editors]]; other editors can propose changes on the talk page. Some templates offer a [[WP:Template sandbox and test cases|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 [[WP:Templates for discussion|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 ''{{dfn|subtemplates}}''). Templates often make use of programming features—parameters, parser functions, and other [[Help:Magic words|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 [[Help:Metatemplating|metatemplates]] and metamodules exist to help accomplish common template tasks. They are called like normal templates and [[Help:Modules|modules]], but they serve a purpose that makes writing templates easier. See {{Cl|Wikipedia metatemplates}} and {{Cl|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 {{em|triple}} braces, which is a ''parameter reference''.
* The code <code><nowiki>{{{xxx}}}</nowiki></code> expands to the value of the parameter named "xxx".
* The codes <code><nowiki>{{{1}}}</nowiki></code>, <code><nowiki>{{{2}}}</nowiki></code>, 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 <code><nowiki>{{{xxx}}}</nowiki></code> inside the template expands to literally ''<nowiki>{{{xxx}}}</nowiki>'' (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'': <code><nowiki>{{{xxx|dflt}}}</nowiki></code> specifies the default value <code>dflt</code> for the named parameter "xxx", and <code><nowiki>{{{1|dflt}}}</nowiki></code> specifies the default value <code>dflt</code> for the first unnamed parameter. Most often, one specifies a null default value, such as <code><nowiki>{{{1|}}}</nowiki></code> or <code><nowiki>{{{xxx|}}}</nowiki></code>.
If a call sets a parameter to the empty string like <code><nowiki>{{Template name|xxx=}}</nowiki></code> then <code><nowiki>{{{xxx|OK}}}</nowiki></code> will produce the empty string and not the default value "OK". Many users will expect that an empty parameter gives the same result as omitting the parameter. You can achieve this with: <code><nowiki>{{#if:{{{xxx|}}}|{{{xxx}}}|OK}}</nowiki></code>. This says: If <code>xxx</code> is assigned a non-empty value then use <code>xxx</code>, otherwise use "OK". If the default value is the empty string then you only have to write <code><nowiki>{{{xxx|}}}</nowiki></code>.
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 <code><nowiki>{{{message|{{{text|{{{1|}}}}}}}}}</nowiki></code>. 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 <code>|message=A|text=B|C</code>, the above wikitext expands to <code>A</code>.
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, <code><nowiki>{{ {{{xxx}}} }}</nowiki></code> or <code><nowiki>{{{ {{xxx}} }}}</nowiki></code>, 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 {{xtag|nowiki}} tags.
====Example====
The parameter usage example above refers to the {{tl|payoff matrix}} template. Here is the code in the template that implements those parameters:
<syntaxhighlight lang="wikitext">
{| id="Payoff matrix" style="background:white; float: {{{Float|right}}}; clear:right; text-align:center;" align={{{Float|right}}} cellspacing=0 cellpadding=8 width={{{Width|225}}}
|-
Line 102 ⟶ 188:
|}</syntaxhighlight>
The entity <syntaxhighlight lang="
====Special case: parameters within an XML-style opening tag====
*{{!mxt|<nowiki><ref name={{{param}}}> Smith, Adam (1776)...</ref></nowiki>}}
because the parameter is not expanded. Instead, you can use the <code><nowiki>{{#tag:}}</nowiki></code> [[WP:PF|parser function]], which is—for example—used in {{tlx|sfn}} to generate the {{tag|ref}} element; see also
*{{mxt|<nowiki>{{#tag:ref |
====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 ({{em|not}} a [[Non-breaking space|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 {{tlx|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]]
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]].
{| class="wikitable" style="text-align:center;" width="100%"
|+Examples of core parser functions
! width="30%" | Description !! width="40%" |
|-
| Uppercasing text
| <
| {{uc: Heavens to BETSY! }}
|-
| Lowercasing text
| <
| {{lc: Heavens to BETSY! }}
|-
| Getting a namespace name
| <
| {{NS: 1 }}
|-
| Getting a Wikipedia URL
| <
| {{fullurl: pagename }}
|}
The ParserFunctions extension provides more programming-oriented parser functions
{| class="wikitable" style="text-align:center;" width="100%"
|+Examples of extension parser functions
! width="30%" | Description !! width="40%" |
|-
| rowspan="2" | 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...! }}
|-
| <
| {{#ifeq: yes | no | Hooray...! | 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...! }}
|-
| [[Help:Calculation|Making a calculation (mathematics)]]<br />[area of circle of radius 4, to 3 decimal places]
| <
| {{#expr: ( pi * 4 ^ 2 ) round 3 }}
|-
| [[Help:Calculation|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.<br />[is 1230 even or odd?]
| <
| {{#ifexpr: 1.23E+3 mod 2 | Odd | Even }}
|}
Line 208 ⟶ 255:
{| class="wikitable" style="text-align:center;" width="100%"
|+Examples of system variables
! width="30%" | Description !! width="40%" |
|-
| rowspan="2" | Page names
| <
| {{PAGENAME}}
|-
| <
| {{FULLPAGENAME}}
|-
| Name of the current namespace
| <
| {{NAMESPACE}}
|-
| Number of registered users
| <
| {{NUMBEROFUSERS}}
|-
| Number of pages in a given category
| <
| {{PAGESINCATEGORY:"Weird Al" Yankovic albums}}
|-
| Current software version
| <
| {{CURRENTVERSION}}
|-
| Timestamp of last page revision
| <
| {{REVISIONTIMESTAMP}}
|}
The <
===Nesting templates===
{{shortcut|WP:NEST}}
While fairly straightforward in application, it involves some noteworthy quirks and tricks.
To pass a parameter value from a template call to a subtemplate, use a parameter reference in the template call to the subtemplate.
;Example{{colon}}
:Template:A contains <syntaxhighlight lang="wikitext" inline>"the quick brown {{B|{{{3}}} }} jumps over..."</syntaxhighlight>. Template:B (a subtemplate) contains <syntaxhighlight lang="moin" inline>'''{{{1}}}'''</syntaxhighlight>. Page X calls A with <syntaxhighlight lang="wikitext" inline>{{A|apple|pear|fox}}</syntaxhighlight> This expands to <syntaxhighlight lang="wikitext" inline>"the quick brown '''fox''' jumps over..."</syntaxhighlight>. 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{{colon}}
:Template:A contains <
{{shortcut|WP:TEMPLATE LOOP}}
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
See [[
===<span id="Noinclude, includeonly, and onlyinclude"></span>Inclusion control: noinclude, includeonly, and onlyinclude===
{{shortcut|WP:NOINCLUDE|WP:INCLUDEONLY|WP:ONLYINCLUDE}}
By default, when a
* {{
* {{
* {{
{| class="wikitable" style="text-align: center;"
! Wikitext
! What is rendered {{em|here}} (
! What is
|-
|
|
|
|-
|
|
|
|-
|
|
|
|-
|{{tag|onlyinclude|content={{tag|includeonly|content= {{bxt|text1}} }} }} {{mxtn|text2}}
|{{mxtn|text2}}
|{{bxt|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:
:{{
These tags can be nested inside each other, though (for a given page) this is really
===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 <code>subst:</code> 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 <code>msgnw:</code> (short for "'''m'''e'''s'''sa'''g'''e, '''n'''o'''w'''iki") 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—<code>:</code>, <code>;</code>, <code>*</code>, <code>#</code>{{efn|These are defined in the [https://web.archive.org/web/20180625163321/https://doc.wikimedia.org/mediawiki-core/master/php/classParser.html#ad463888e40c078ac9bcfcaf1231e39d7 <code>doBlockLevels</code> function of Parser.php].}}, 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 {{xtag|nowiki|s}} before the markup or {{tag|nowiki}} around it, or use the [[HTML]] entities <code>&#58;</code>, <code>&#59;</code>, <code>&#42;</code>, <code>&#35;</code>, or use the templates {{tl|colon}}, {{tl|;}}, {{tl|asterisk}}, {{tl|number sign}} (those templates may not exist at other wikis). In some cases, the HTML entities will work when the {{tag|nowiki|s}} does not. The problem often occurs when a parameter value in a template call starts with one of the four characters. See also {{tl|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 {{tlx|Trim}} to strip any initial or final whitespace from unnamed parameter values if this would cause problems; <em>named</em> 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 <code>NewPP limit report</code> comments.
* Do not use <code>=</code> 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 <em>template</em> for editing.
* You may avoid section edit links to the template by including <code><nowiki><includeonly>__NOEDITSECTION__</includeonly></nowiki></code>.
===Documentation===
{{Details|
Documentation for users, together with the template's categories, normally goes after the template code, inside {{tag|noinclude}} tags. It is normally necessary to put the opening {{tag|noinclude|o}} 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 [[WP:Subpages|subpage]] of the template page (named "Template:{{var|XXX}}/doc"). This applies especially to many [[WP:Protection policy|protected]] templates, so that non-administrators can edit the documentation. To do this, place a call to the {{tlx|Documentation}} template after the main template code and within {{tag|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===
{{See also|Wikipedia:Categorization#Templates}}
====Categorize pages by template inclusion====
Some 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 {{tag|noinclude}} [[html tag|tags]] if there is no documentation subpage) to avoid placing calling pages in the category.
===Aliases===
It is good to prepare template aliases
==Template limits==
{{details|Help:Template limits}}
{{shortcut|WP:INCLUDELIMIT}}
{{Anchor|Expand 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:
<syntaxhighlight lang="
<!--
NewPP limit report
Line 348 ⟶ 397:
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, {{red|1=<u>Template:{{var|Template name}}</u>}}). Common causes are the inclusion of too many [[Help:Citation Style 1|citation templates]], [[WP:NAVBOX|navbox templates]], and/or [[Wikipedia:WikiProject Flag Template|flag templates]]. To resolve this problem [[
'''Non-rendered tranclusions still count towards limit.''' For example, a page which contains only <code><nowiki>{{#if:{{:Main Page}}}}</nowiki></code> would still have a post-expand include size even though it would have no output at all.
The same applies to [[
<syntaxhighlight lang="lua">
mw.getCurrentFrame():preprocess
return {main = function() end} -- p.main() has no return value
</syntaxhighlight>
==Lua programming language==
{{main article|
==Terminology==
A ''template'' is a Wikipedia page whose purpose is to be transcluded or substituted in another page. Templates are usually in the [[WP:Template namespace|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, <syntaxhighlight lang="wikitext" inline>{{sic|constellation prize}}</syntaxhighlight>. Template calls are always delimited by double braces (<syntaxhighlight lang="text" inline>{{}}</syntaxhighlight>), 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 {{param|1}} as the value of the first positional parameter" and "{{param|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 {{tl|sic}} template when called by <syntaxhighlight lang="wikitext" inline>{{sic|constellation prize}}</syntaxhighlight> is <syntaxhighlight lang="wikitext" inline>constellation prize [''[[sic]]'']</syntaxhighlight>.
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 <syntaxhighlight lang="wikitext" inline>{{sic|constellation prize}}</syntaxhighlight> is "{{sic|constellation prize}}".
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 {{tl|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. {{tlf|tm}} is a template name, but {{tnull|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 {{tl|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. {{param|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 {{tl|short description}} template on this page.
* Upon seeing an {{tl|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==
{{main|
As an alternative to using this index linked above, you can search the Template namespace using the [[Special:Search]] box below:
<inputbox>
type=fulltext
Line 373 ⟶ 449:
searchbuttonlabel=Search Template namespace
break=no
placeholder=
</inputbox>
==See also==
=== Help pages ===
{{div col|colwidth=20em}}
* Introductions:
** [[Help:A quick guide to templates]]
** [[
** [[Help:
* [[Help:Magic words]]
* [[
* [[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 [[Wikipedia:VisualEditor|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:Templates]]
{{div col end}}
=== 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
* [{{fullurl:Special:Allpages|namespace=10}} 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==
{{Notelist}}
{{Wikipedia template messages
{{Wikipedia
{{Wikipedia technical help}}
[[Category:Wikipedia how-to]]
[[Category:Wikipedia template help]]
| |||