Help:A quick guide to templates: Difference between revisions

Revision as of 17:56, 31 December 2016

Revision as of 13:33, 30 August 2025

(42 intermediate revisions by 36 users not shown)

Line 1:

{{Short description|Wikimedia project page or help page}}

{{Wikipedia how to|sort-by=Templates, A quick guide to}}{{Wiki markup}}

{{pp-semi-indef|small=yes}}

This is a quick '''overview of templates'''. Full details can be found in '''[[Help:Template]]''' and '''[[m:Help:Advanced templates]]'''.

{{pp-move-indef|small=yes}}

[[Image:Sandfoermchen-3.jpg|right|300px|thumb|A template allows you to reproduce content.]]

{{Wikipedia how to|H:TQG|sort-by=Templates, A quick guide to}}{{Wiki markup}}

This is a quick '''overview of templates'''. Full details can be found in '''[[Help:Template]]''' and '''[[mw:Manual:Advanced_templates|m:HelpManual:Advanced templates]]'''.

A '''template''' is a Wikipedia page created to be included in other pages. andIt usually containcontains repetitive material that mightmay need to show up on any number ofmultiple articles or pages, often with customizable input. Templates sometimes use [[MediaWiki]] parser functions, nicknamed "[[Help:Magic words|magic words]]", a simple [[scripting language]].

Template pages are found in the ¹[[Wikipedia:Template namespace|template namespace]]. This means any page whose title begins with "Template:", such as "[[Template:foo]]", can be used for that purpose. The content from a template titled Template:foo can be added into a Wikipedia page by editing a page and typing <code><nowiki>{{foo}}</nowiki></code> into it. When then viewing the page, <code><nowiki>{{foo}}</nowiki></code> is automatically replaced by the content of the page "Template:foo". If the page "Template:foo" is later altered, all the pages with <code><nowiki>{{foo}}</nowiki></code> in them will change automatically.

Among other things, templates are used to add recurring messages to pages in a consistent way, to add [[Wikipedia:Glossary#Boilerplate text|boilerplate]] messages, and to create navigational boxes.

Line 11 ⟶ 13:

When a template is automatically expanded and appears on a page, it is said to be "[[Wikipedia:Transclusion|transcluded]]".

[[Wikipedia:Template documentation|Templates are documented]] (or should be) at their pages. Thus if you want to know how to use a template whose name is "foo" (perhaps because you've seen <code><nowiki>{{foo|...}}</nowiki></code> in the source of an article), then go to "Template:foo". (The documentation itself will usually be located at "Template:foo/doc", but is also transcluded onto the "Template:foo" main page).)

==Creating, editing, and using templates==

Line 18 ⟶ 20:

Once you have made the template—for example ''Template:foo''—you can add <code><nowiki>{{</nowiki>''foo''<nowiki>}}</nowiki></code> to the pages that you want to use it on. Every page using this template uses the same [[boilerplate (text)|boilerplate]] text each time that a user visits it. When the template is updated, all pages containing the template tag are automatically updated.

Alternatively, if you do not wish the page to reflect future updates to the template, you can add <code><nowiki>{{</nowiki>subst:''foo''<nowiki>}}</nowiki></code> to the pages on which you want to use the boilerplate text. The system fetches a one-time copy of the template text and '''[[Wikipedia:Substitution|substisubstitutes]]''' it into the page in place of the template tag. If anyone edits the template afterwards, pages that used the <code>subst:</code> keyword do '''not update'''. Sometimes that is what you want.

'''[[Wikipedia:Substitution|tutes]]''' it into the page in place of the template tag. If anyone edits the template afterwards, pages that used the <code>subst:</code> keyword do '''not update'''. Sometimes that is what you want.

If the template that you want to edit looks like <code><nowiki>{{foo}}</nowiki></code>, you would go to Template:foo to edit it. To get there, type "Template:foo" in the search box (see [[Help:Searching|search]]), or make a wikilink like <code><nowiki>[[Template:foo]]</nowiki></code> somewhere, such as in the [[{{ns:4}}:sandbox|sandbox]], and click on it.

Once you are there, just click "edit" or "edit this page" at the very top of the page (not the documentation edit button lower down) and edit it in the same way that you would any other page. You can add anything that you would add to a normal page, including text, images, and other templates. When editing templates that are usedin use, it is suggesteda good idea to usedo so in a sandboxessandbox, as described in the [[Wikipedia:template sandbox and test cases|template sandbox and test cases]] how-to guide.

===Parameters===

Templates can have parameters which the page can dynamically incorporate into the transcluded page. Instead of just the template name, like <code><nowiki>{{foo}}</nowiki></code>, an embedded template tag would have additional values separated by [[vertical bar]]s (|), e.g. <code><nowiki>{{foo|July|lc=yes}}</nowiki></code>. Here <code>July</code> is the value of the first unnamed parameter; <code>yes</code> is the value of the named parameter <code>lc</code>. Writing the template page for a template with parameters is more complicated than for a template with no parameters. See [[Help:Template|Help:T emplate]].

===Editing existing templates===

When you edit a template that is in use, it can affect many pages throughout Wikipedia all at once.

{{slink|Wikipedia:Template editor|Use}} has tips to help avoid problems.

== Template link template==

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

::<code><nowiki>{{tl|foo}}</nowiki></code>

Line 37 ⟶ 42:

==FAQ==

; How can I find out how to use an existing template?
: To see the documentation for the template whose name is "foo", go to "Template:foo".

;Can I use a template in more than one project? : No, if you want to use it on two different language Wikipedias, for example, you would need to create it twice.

; How do I find out where a template is used?

; Are templates case-sensitive? : Yes, except usually the first letter.

: To list all pages onto which a template is transcluded, use '''[[Special:WhatLinksHere]]''' and type in template:''templatename'' ([[Help:What links here|more info]]).

; How can I add parameters? : See [[Help:Template]] for instructions.

; I edited the template, so why didn't the page it is used on c

; Can I use a template withinin amore template?than :one Yes.project?

; hange? : Wikipedia and your computer both store webpage ''[[Web cache|caches]]''&nbsp;– or saved copies&nbsp;– and don't always show you an updated page. First, try to [[WP:BYPASS|bypass your browser's cache]] by pressing ⌘R, Ctrl+R, or F5. If that fails, you may need to [[WP:PURGE|purge]] the page's cache (which can be done several different ways). Perhaps the easiest way to do this is by clicking '''edit''' on the page in which the template appears, and then clicking on '''Save page''' without having changed anything&nbsp;– there is no need to fill in the ''Summary'' field since there will not be any ''history'' of this as a change generated.

;Can I use a template in more than one project? : No, if you want to use it on two different language Wikipedias, for example, you would need to create it twice.

; Can I move a template to a new name? : Yes, this works in exactly the same way as normal [[Wikipedia:Moving a page|page moves]]. When a page called for inclusion is a redirect page, the redirect target is included instead.

; Can I use a template within a template? : Yes.

; Are template names case-sensitive?

;How do I add a new template?: You start a new template in the same way you would start a normal page. The only difference is that its title must start with {{code|Template:}}. Don't forget to document it so that other editors can use it!

: Yes, except usually (on most wikis)^{[[meta:Help:Template#Case sensitivity|[1]]]} the first letter.

; Where is the manual for the programming language used to write templates?: The language inside templates is the same language as regular wiki markup, but template writers tend to use the more complex available functions such as #if: statements. See Wikipedia's [[Help:Template]] and Wikimedia's [[mw:Help:Template]], including all of "advanced functioning" help pages listed toward the bottom of [[mw:Help:Template#Links to other help pages|that page]].

; How can I add parameters?

; How can I add parameters? : See [[Help:Template]] for instructions.

; I edited the template, so why didn't the page it is used on cchange?

; hange? : Wikipedia and your computer both store webpage ''[[Web cache|caches]]''&nbsp;– or saved copies&nbsp;– and don't always show you an updated page. First, try to [[WP:BYPASS|bypass your browser's cache]] by pressing ⌘R{{key press|Opt|Cmd|R}}, {{key press|Ctrl+|Shift|R}}, or {{key press|Ctrl|F5}}. If that fails, you may need to [[WP:PURGE|purge]] the page's cache (which can be done several different ways). Perhaps the easiest way to do this is by clicking '''edit''' on the page in which the template appears, and then clicking on '''SavePublish pagechanges''' without having changed anything&nbsp;– there is no need to fill in the ''Summary'' field since there will not be any ''history'' of this as a change generated.

; Can I move a template to a new name?

; Can I move a template to a new name? : Yes, this works in exactly the same way as normal [[WikipediaHelp:Moving a page|page moves]]. When a page called for inclusion is a redirect page, the redirect target is included instead.

; Can I use a template within a template?

: Yes.

; How do I add a new template?

;How do I add a new template?: You start a new template in the same way you would start a normal page. The only difference is that its title must start with {{code|Template:}}. Don't forget to document it so that other editors can use it!

; Where is the manual for the programming language used to write templates?

; Where is the manual for the programming language used to write templates?: The language inside templates is the same language as regular wiki markup, but template writers tend to use the more complex available functions such as #if: statements. See Wikipedia's [[Help:Template]] and Wikimedia's [[mw:Help:Template]], including all of "advanced functioning" help pages listed toward the bottom of [[mw:Help:Template#Links to other help pages|that page]].

==Examples==

Line 52 ⟶ 76:

<!-- *[[w:en:Template:europe]]: a navigational template -->

*[[w:en:Template:Biological classification]]: a template with parameters (at English Wikipedia).

*[[b:en:Template:GeneralChemTOC|b:en:Template]]:General a horizontal menu bar (at English [[Wikibooks]]).

*[[b:en:Template:GeneralChemTOC|ChemTOC]]: a horizontal menu bar (at English [[Wikibooks]]).

*[[w:en:Template:Underwater work]]: a template as a simple table with a picture (at English Wikipedia).

Line 59 ⟶ 82:

*[[Help:Template]] (more details)

*[[m:Help:Templates]] (details from [[Wikimedia]])

*[[mmw:HelpManual:Advanced templates]] (advanced details from Wikimedia)

*[[Wikipedia:Template namespace]] (the usual [[Wikipedia:Namespace|namenamespace]] for templates)

*[[Wikipedia:Namespace|space]] for templates)

*[[Wikipedia:Transclusion]] (transcluding templates)

*[[Wikipedia:Substitution]] (substituting templates)

Line 68 ⟶ 90:

{{Help navigation}}

{{Wikipedia technical help|collapsed}}

[[Category:Wikipedia templates| ]]

{{DEFAULTSORT:Quick guide to templates, A}}