View source for Help:Editing/Templates

{{TocRight}}
{| style="border:0px;" cellspacing="0"
|- valign="top"
| style="padding-right:1.5em" |

Templates enable you to do things much faster and/or easier. Templates are used very frequently on pages, so it's best to learn about them. When the wiki sees a template it recognizes on a page, it will automatically replace it with something else. What appears there is up to the users.

==How to use a Template==
Before a template can be added somewhere, first its contents must be defined on its own page. Template pages should start with the prefix <code>Template:</code>.

Templates have some limited programming abilities, which gives them lots of possibilities. We'll talk more about those later.

To add a template to a page (which is called ''transcluding''), simply type <code>{{</code>, the name of the template, and then <code>}}</code>. If you wish to add any parameters, put a <code>|</code> between the template's name and the <code>}}</code>, and define the parameters there. All parameters you define need to be separated by another <code>|</code>.

{{note|Any page can be transcluded by another one actually. See more at ExpandBox}}
===Examples===
Here's a template where we don't define any parameters, you just drop it right in.
<pre>{{example}}</pre>
Result: {{example}}

If you visit [[Template:Example|this template's page]], you'll see that its just those five words.

===Substitution (for advanced users)===
Instead of transcluding a template, one can choose to ''substitute'' it. Substitution will replace a template with the contents ''of'' the template directly onto the page. To substitute a template, transclude it like you normally would, then add <code>subst:</code> between <code>{{</code> and the template's name. After that, click the save button and the wikitext will automatically be added. Do not substitute carelessly, because the substituted wikitext will not be updated when the template is. See [[Wikipedia:Help:Substitution]] for more information.
<pre>{{subst:delete|This is a bad page.}}</pre>
When the page is saved, that text will be replaced with this:
<pre>{{DeleteMeta|{{#if: This is a bad page. | This is a bad page. }} }}[[Category:Candidates for deletion]]</pre>
Note the automatic forwarding of parameters. When substituting, the page should not appear any differently than it would if transcluded. The only difference is in the page code.

==Making Templates==
Making a template like [[Template:Example]] is rather easy - just type the text you want, and save it. What about ones with parameters?

{{tip|When making templates, you may want to space out your code to make it easier to read, but watch out for unintentional whitespace. HTML comments (<code><nowiki><!-- --></nowiki></code>) can also be useful.}}

| style="width:1%" |
|}
===Unnamed Parameters===
To add an unnamed parameter, simply put <code>{{{1}}}</code> where you want it to be.

Here's part of the code for [[Template:Tip]]:
<pre>Tip:{{{1}}}</pre>
If you've seen this template before you know that it has its own special look, but this is all we will look at for now. All the user has to do when transcluding this is enter the text they want:
<pre>{{tip|Do not carve without vertex editing afterward.}}</pre>
Result: {{tip|Do not carve without vertex editing afterward.}}

If you want to add more than one unnamed parameter, simply add another number, increased by 1. For example:
<pre>SomeTemplate:{{{1}}} and {{{2}}}</pre>

===Named Parameters===
Usually you would want to have named parameters affect anything only if they are defined when being transcluded. Conditions will be discussed later. For now, let's look at [[Template:MessageBox]], which has some named parameters. In this template, <code>{{{text}}}</code> marks a place to add wikitext that's defined by <code>|text = Text here</code> when transcluding.

With named parameter:
<pre>{{MessageBox|text=my text}}</pre>
Result: {{MessageBox|text=my text}}

Without named parameter:
<pre>{{MessageBox}}</pre>
Result: {{MessageBox}}

===Default Value===
To make a parameter have a value by default, add a <code>|</code> to the right of the parameter name, and then define the value. Named ''and'' unnamed parameters can use this.
<pre>{{{1|3000}}}</pre>
This would make the value for <code>1</code> {{{1|3000}}}.
<pre>{{{value|}}}</pre>
This returns nothing. Without the <code>|</code>, it would literally return "{{{value}}}" as text, if it hasn't already been defined at some other point.

===Documentation===
Please give a description of what your template is, and maybe examples. To keep this describing text from appearing on pages, there are 3 different HTML tags you can use.

<code>noinclude</code> keeps wikitext inside it from appearing on the destination page, while keeping it on the source page.

<code>onlyinclude</code> makes only wikitext inside it appear on destination pages. Text not inside these will still appear on the template's page.

<code>includeonly</code> wikitext inside this will not appear on the template page. It has no effect on the destination page however.

They can sound very confusing at first. If you're confused on how to use them, check the source code for a template, because almost all use them for one purpose or another.

==Templates not Updating==
If you've recently edited a template and the changes are not applying on pages it's been transcluded to, add <code>?action=purge</code> at the end of the URL for those pages. This will tell the server to update the page's HTML immediately. You can achieve the same effect by editing a page and saving it without making any changes.

==Template Shortcuts==
Some templates may have template shortcuts, which are redirects that are abbreviated or otherwise different forms of their target templates. Template shortcuts can be transcluded just like their target templates.

==Useful templates==
All templates in '''{{style|color:#8BC53F|green text}}''' are that color so that they stand out against the greyscale tones of most pages. Most templates with that color also automatically add pages they are transcluded on into [[:Category:TODO]].

===How===
[[Template:How]] asks the question ''how?''
<pre>Players can get past these.{{how}}</pre>
Result: Players can get past these.{{how}}

===Why===
[[Template:Why]] asks the question ''why?''
<pre>This shader has been deprecated.{{why}}</pre>
Result: This shader has been deprecated.{{why}}

===Clarify===
[[Template:Clarify]] marks things that should be clarified.
<pre>A user module can be created following the usual class creation procedure.{{clarify}}</pre>
Result: A user module can be created following the usual class creation procedure.{{clarify}}

===Confirm===
[[Template:Confirm]] marks things that should be confirmed. This is mostly for when a statement can't be ruled out as false and contains potentially useful information.
<pre>This might require changing the distance parameter.{{confirm}}</pre>
Result: This might require changing the distance parameter.{{confirm}}

===Required Version===
[[Template:ReqVer]] is for noting a version required to do something.
<pre>{{ReqVer|1.3}}</pre>
Result: {{ReqVer|1.3}}

===Note===
[[Template:Note]] is for making notes stand out more.
<pre>{{note|This will spawn at the map origin if you do not specify the position.}}</pre>
Result: {{note|This will spawn at the map origin if you do not specify the position.}}

===Idea===
[[Template:Idea]] is a nifty way to suggest ideas.
<pre>{{idea|Reward players for being clever and creative, instead of forcing things to be only one way.}}</pre>
Result: {{idea|Reward players for being clever and creative, instead of forcing things to be only one way.}}

===Tip===
[[Template:Tip]] marks text as a tip to readers.
<pre>{{tip|This is a much less tricky process when using the vertex edit tool as well.}}</pre>
Result: {{tip|This is a much less tricky process when using the vertex edit tool as well.}}

===Warning===
[[Template:Warning]] marks things that readers should take caution of when doing something.
<pre>{{warning|This tool has been known to corrupt files. Try an alternative listed below.}}</pre>
Result: {{warning|This tool has been known to corrupt files. Try an alternative listed below.}}

===Delete===
[[Template:Delete]] marks a page that should be deleted. If you do not give sufficient reason for the notice on the transclusion or the talk page, expect it to be removed by someone else. When putting this on a page, you should also list the reason on that page's talk page, for any future readers that may want to know the purpose of the deletion.
<pre>{{delete|This is not a real thing.}}</pre>
Result: {{delete|This is not a real thing.}}

===Stub===
[[Template:Stub]] marks pages that are very small. See [[Help:Stubs]] for info on using.
<pre>{{stub}}</pre>
Result: {{stub}}

===Wip===
[[Template:Wip]] marks pages that are in the middle of major edits. The adder requests that other users do not edit in the meantime.
<pre>{{Wip}}</pre>
Result:
{{Wip}}

===Cleanup===
[[Template:Cleanup]] marks a page that needs to be fixed up, preferably by someone knowledgeable. The text message is optional. If you do not give sufficient reason for the notice on the transclusion or the talk page, expect it to be removed by someone else.
<pre>{{cleanup|The last section needs to be clarified.}}</pre>
Result: {{cleanup|The last section needs to be clarified.}}

===MessageBox===
[[Template:MessageBox]] provides a standard message box. This template is used by many notice templates, such as merge and cleanup.
<pre>{{messageBox|text=Remember to follow wiki etiquette.}}</pre>
Result: {{messageBox|text=Remember to follow wiki etiquette.}}

===Bug===
[[Template:Bug]] notifies readers of a [[Wikipedia:Software bug|bug]].
<pre>{{bug|The amount is double what it should be. Be careful!}}</pre>
Result: {{bug|The amount is double what it should be. Be careful!}}

===Merge===
[[Template:Merge]] is a notice that notifies editors that it's been suggested for two or more pages to be combined into one. All merges should be discussed before being done.
<pre>{{merge|HDR}}</pre>
Result: {{merge|HDR}}

There's also a variant which allows linking to other namespaces: [[Template:Merge2]]
<pre>{{merge2|HDR}}</pre>

===SplitApart===
[[Template:SplitApart]] marks pages that should be split into multiple pages. All splits should be discussed before being done.
<pre>{{splitApart}}</pre>
Result:
{{splitApart}}

===Todo===
[[Template:Todo]] marks things that need to be done. It's green color is meant to stand out.
<pre>{{todo|Find where this is in the game files.}}</pre>
Result: {{todo|Find where this is in the game files.}}

===ExpandBox===
[[Template:ExpandBox]] allows you to hide stuff inside a box that can be shrunk down so that it doesn't make pages as long.
<pre>{{ExpandBox|{{:Help:Contents}}}}</pre>
Result: {{ExpandBox|{{:Help:Contents}}}}

===Quote===
[[Template:Quote]] will format a sentence and put an author under its right side.
<pre>{{Quote|That taste... that fragrance...|Daniel}}</pre>
Result:{{Quote|That taste... that fragrance...|Daniel}}

===Clr===
[[Template:Clr]] clears the vertical space to the left or right of something. This is commonly used for making headlines not get moved around by images.

[[File:apple.png|50px|frameless|left]]

This text should appear next to the image. If you put <code><nowiki>{{clr}}</nowiki></code> right after this,

this bit of text here will get moved down.
----
[[File:apple.png|50px|frameless|left]]

This text should appear next to the image. If you put <code><nowiki>{{clr}}</nowiki></code> right after this,{{clr}}

this bit of text here will get moved down.

===TocRight===
[[Template:TocRight]] shifts the [[Help:Table of Contents|table of contents]] over to the right side of a page. This page, for example, uses this template.
<pre>{{TocRight}}</pre>

==Magic Words==
Magic words are special character strings that are kind of like templates. To apply one, simply type it on the page.

===<code><nowiki>__TOC__</nowiki></code>===
Forces the [[Help:Table of Contents|table of contents]] to be placed at this spot.

===<code><nowiki>__FORCETOC__</nowiki></code>===
Forces the table of contents to be placed at its normal spot. (Only useful on pages that don't have enough sections to automatically display a TOC.)

===<code><nowiki>__NOTOC__</nowiki></code>===
Hides the table of contents.

===<code><nowiki>__HIDDENCAT__</nowiki></code>===
Marks a [[Help:Categories|category]] as hidden. To make the website show hidden categories for you, check the '''Show hidden categories''' box in [[Special:Preferences#mw-prefsection-rendering|Special:Preferences]].

===<code><nowiki>{{DISPLAYTITLE:title}}</nowiki></code>===
Changes the title of a page at the top bar ''only''.

==See Also==
*[[Special:ExpandTemplates]] - Shows completely expanded versions of templates, including substituted wikitext code and automatic substitution for any nested templates.
*[[Special:MostTranscludedPages]] - Lists templates most frequently used on pages. This doesn't show ''just'' templates actually; any page can be transcluded.
*[[Special:UncategorizedTemplates]] - Lists templates that are not listed under any categories.
*[[Special:UnusedTemplates]] - Lists templates that are not used on any pages.
*[[Special:WantedTemplates]] - Lists templates that are frequently used on pages, but do not exist. This list should be showing no pages, ideally.
*[[Wikipedia:Help:Magic_words_for_beginners]] - More about magic words.
*[[Wikipedia:Help:Template]] - A very helpful resource for template programming.