Help:A quick guide to templates - Revision history

Caleb Cooper: Text replacement - "[[Help:Template" to "[[Wikipedia:Help:Template‏‎ "

2020-10-21T08:29:11Z

Text replacement - "[[Help:Template" to "[[Wikipedia:Help:Template‏‎ "

← Older revision		Revision as of 08:29, 21 October 2020
Line 26:		Line 26:

	===Parameters===		===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~~]].		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 [[Wikipedia:Help:Template‏‎ ]].

	===Editing existing templates===		===Editing existing templates===
Line 51:		Line 51:

	'''How can I add parameters?'''		'''How can I add parameters?'''
	: See [[Help:~~Template~~]] for instructions.		: See [[Wikipedia:Help:Template‏‎ ]] for instructions.

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

Caleb Cooper: /* FAQ */

2020-10-20T14:25:42Z

FAQ

← Older revision		Revision as of 14:25, 20 October 2020
Line 66:		Line 66:

	'''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 [[Wikipedia:Help:Template]] and Wikimedia's [[~~Wikimedia~~:Help:Template]], including all of "advanced functioning" help pages listed toward the bottom of [[~~Wikimedia~~:Help:Template#Links to other help pages\|that page]].		: 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 [[Wikipedia:Help:Template]] and Wikimedia's [[mediawikiwiki:Help:Template\|Help:Template]], including all of "advanced functioning" help pages listed toward the bottom of [[mediawikiwiki:Help:Template#Links to other help pages\|that page]].

	== See Also ==		== See Also ==

Caleb Cooper at 14:24, 20 October 2020

2020-10-20T14:24:10Z

← Older revision		Revision as of 14:24, 20 October 2020
Line 54:		Line 54:

	'''I edited the template, so why didn't the page it is used on change? '''		'''I edited the template, so why didn't the page it is used on change? '''
	: Wikipedia and your computer both store webpage ''[[Web cache\|caches]]'' – or saved copies – 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 '''Publish changes''' without having changed anything – there is no need to fill in the ''Summary'' field since there will not be any ''history'' of this as a change generated.		: Wikipedia and your computer both store webpage ''[[Wikipedia:Web cache\|caches]]'' – or saved copies – and don't always show you an updated page. First, try to [[Wikipedia:WP:BYPASS\|bypass your browser's cache]] by pressing ⌘R, Ctrl+R, or F5. If that fails, you may need to [[Wikipedia: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 '''Publish changes''' without having changed anything – 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 [[Help:Moving a page\|page moves]]. When a page called for inclusion is a redirect page, the redirect target is included instead.		: Yes, this works in exactly the same way as normal [[Wikipedia:Help: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?'''		'''Can I use a template within a template?'''
Line 66:		Line 66:

	'''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]].		: 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 [[Wikipedia:Help:Template]] and Wikimedia's [[Wikimedia:Help:Template]], including all of "advanced functioning" help pages listed toward the bottom of [[Wikimedia:Help:Template#Links to other help pages\|that page]].

	==~~Examples~~==		== See Also ==
			For more detail see wikipedia page [[wikipedia:Help:A quick guide to templates]]
	*[[w:en:Template:stub]]: an often used message (at English Wikipedia).
	<!-- *[[w:en:Template:europe]]: a navigational template -->
	*[[w:en:Template:Biological classification]]: a template with parameters (at English Wikipedia).
	*[[b:en:Template:GeneralChemTOC]]: a horizontal menu bar (at English [[Wikibooks]]).
	*[[w:en:Template:Underwater work]]: a template as a simple table with a picture (at English Wikipedia).

	== Wikipedia-specific help ==
	*[[Help:Template]] (more details)
	*[[m:Help:Templates]] (details from [[Wikimedia]])
	*[[m:Help:Advanced templates]] (advanced details from Wikimedia)
	*[[Wikipedia:Template namespace]] (the usual [[Wikipedia:Namespace\|namespace]] for templates)
	*[[Wikipedia:Transclusion]] (transcluding templates)
	*[[Wikipedia:Substitution]] (substituting templates)
	*[[Wikipedia:Template messages]] (categorised list of links to available templates)

	{{Help navigation}}
	{{Wikipedia technical help\|collapsed}}

Caleb Cooper at 14:19, 20 October 2020

2020-10-20T14:19:56Z

← Older revision		Revision as of 14:19, 20 October 2020
Line 1:		Line 1:
	{{pp-semi-indef\|small=yes}}		{{pp-semi-indef\|small=yes}}
	{{pp-move-indef\|small=yes}}		{{pp-move-indef\|small=yes}}
	{{Wikipedia how to~~\|H:TQG~~\|sort-by=Templates, A quick guide to}}{{Wiki markup}}		{{Wikipedia how to\|sort-by=Templates, A quick guide to}}{{Wiki markup}}
	This is a quick '''overview of templates'''. Full details can be found in '''[[Wikipedia:Help:Template\|Help:Template]]''' and '''[[metawikimedia:Help:Advanced templates\|Help:Advanced templates]]'''.		This is a quick '''overview of templates'''. Full details can be found in '''[[Wikipedia:Help:Template\|Help:Template]]''' and '''[[metawikimedia:Help:Advanced templates\|Help:Advanced templates]]'''.

	A '''template''' is a Wikipedia page created to be included in other pages. It usually contains repetitive material that may need to show up on multiple articles or pages, often with customizable input. Most templates are ''scripts'' using [[Wikipedia:MediaWiki\|MediaWiki]] parser functions, nicknamed "[[Wikipedia:Help:Magic words\|magic words]]", a simple [[scripting language]].		A '''template''' is a Wikipedia page created to be included in other pages. It usually contains repetitive material that may need to show up on multiple articles or pages, often with customizable input. Most templates are ''scripts'' using [[Wikipedia:MediaWiki\|MediaWiki]] parser functions, nicknamed "[[Wikipedia:Help:Magic words\|magic words]]", a simple [[Wikipedia:scripting language\|scripting language]].

	Template pages are found in the [[Wikipedia:Template namespace\|template namespace]]. This means any page whose title begins with "Template:", such as "[[Wikipedia:Template:foo\|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.		Template pages are found in the [[Wikipedia:Template namespace\|template namespace]]. This means any page whose title begins with "Template:", such as "[[Wikipedia:Template:foo\|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.

Caleb Cooper at 14:19, 20 October 2020

2020-10-20T14:19:06Z

← Older revision		Revision as of 14:19, 20 October 2020
Line 2:		Line 2:
	{{pp-move-indef\|small=yes}}		{{pp-move-indef\|small=yes}}
	{{Wikipedia how to\|H:TQG\|sort-by=Templates, A quick guide to}}{{Wiki markup}}		{{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 '''[[Wikipedia:Help:Template\|Help:Template]]''' and '''[[~~metawiki~~:Help:Advanced templates\|Help:Advanced templates]]'''.		This is a quick '''overview of templates'''. Full details can be found in '''[[Wikipedia:Help:Template\|Help:Template]]''' and '''[[metawikimedia:Help:Advanced templates\|Help:Advanced templates]]'''.

	A '''template''' is a Wikipedia page created to be included in other pages. It usually contains repetitive material that may need to show up on multiple articles or pages, often with customizable input. Most templates are ''scripts'' using [[MediaWiki]] parser functions, nicknamed "[[Help:Magic words\|magic words]]", a simple [[scripting language]].		A '''template''' is a Wikipedia page created to be included in other pages. It usually contains repetitive material that may need to show up on multiple articles or pages, often with customizable input. Most templates are ''scripts'' using [[Wikipedia:MediaWiki\|MediaWiki]] parser functions, nicknamed "[[Wikipedia: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.		Template pages are found in the [[Wikipedia:Template namespace\|template namespace]]. This means any page whose title begins with "Template:", such as "[[Wikipedia:Template:foo\|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.		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.

Caleb Cooper at 14:16, 20 October 2020

2020-10-20T14:16:33Z

← Older revision		Revision as of 14:16, 20 October 2020
Line 2:		Line 2:
	{{pp-move-indef\|small=yes}}		{{pp-move-indef\|small=yes}}
	{{Wikipedia how to\|H:TQG\|sort-by=Templates, A quick guide to}}{{Wiki markup}}		{{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 '''[[m:Help:Advanced templates]]'''.		This is a quick '''overview of templates'''. Full details can be found in '''[[Wikipedia:Help:Template\|Help:Template]]''' and '''[[metawiki:Help:Advanced templates\|Help:Advanced templates]]'''.

	A '''template''' is a Wikipedia page created to be included in other pages. It usually contains repetitive material that may need to show up on multiple articles or pages, often with customizable input. Most templates are ''scripts'' using [[MediaWiki]] parser functions, nicknamed "[[Help:Magic words\|magic words]]", a simple [[scripting language]].		A '''template''' is a Wikipedia page created to be included in other pages. It usually contains repetitive material that may need to show up on multiple articles or pages, often with customizable input. Most templates are ''scripts'' using [[MediaWiki]] parser functions, nicknamed "[[Help:Magic words\|magic words]]", a simple [[scripting language]].

Caleb Cooper: Created page with "{{pp-semi-indef|small=yes}} {{pp-move-indef|small=yes}} {{Wikipedia how to|H:TQG|sort-by=Templates, A quick guide to}}{{Wiki markup}} This is a quick '''overview of templates'..."

2020-10-20T14:15:37Z

Created page with "{{pp-semi-indef|small=yes}} {{pp-move-indef|small=yes}} {{Wikipedia how to|H:TQG|sort-by=Templates, A quick guide to}}{{Wiki markup}} This is a quick '''overview of templates'..."

New page

{{pp-semi-indef|small=yes}}
{{pp-move-indef|small=yes}}
{{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 '''[[m:Help:Advanced templates]]'''.

A '''template''' is a Wikipedia page created to be included in other pages. It usually contains repetitive material that may need to show up on multiple articles or pages, often with customizable input. Most templates are ''scripts'' using [[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.

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

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==
You can start a new template in the same way that you would [[Wikipedia:Starting an article|start an article page]]. The only difference is that its title must start with <code>Template:</code>.

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|substitutes]]''' 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 used, it is suggested to use sandboxes, 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]].

===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>
:generates
::{{tl|foo}}

==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.

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

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

'''I edited the template, so why didn't the page it is used on change? '''
: Wikipedia and your computer both store webpage ''[[Web cache|caches]]'' – or saved copies – 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 '''Publish changes''' without having changed anything – 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?'''
: Yes, this works in exactly the same way as normal [[Help: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?'''
: 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?'''
: 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==
*[[w:en:Template:stub]]: an often used message (at English Wikipedia).

*[[w:en:Template:Biological classification]]: a template with parameters (at English Wikipedia).
*[[b:en:Template:GeneralChemTOC]]: a horizontal menu bar (at English [[Wikibooks]]).
*[[w:en:Template:Underwater work]]: a template as a simple table with a picture (at English Wikipedia).

== Wikipedia-specific help ==
*[[Help:Template]] (more details)
*[[m:Help:Templates]] (details from [[Wikimedia]])
*[[m:Help:Advanced templates]] (advanced details from Wikimedia)
*[[Wikipedia:Template namespace]] (the usual [[Wikipedia:Namespace|namespace]] for templates)
*[[Wikipedia:Transclusion]] (transcluding templates)
*[[Wikipedia:Substitution]] (substituting templates)
*[[Wikipedia:Template messages]] (categorised list of links to available templates)

{{Help navigation}}
{{Wikipedia technical help|collapsed}}