 |
For a list of all the templates on this wiki, see this list |
Three very common types of templates are shown here as examples:
- At the top, there is an example of a "message box" template, usually used for article maintenance.
- To the right, there is an example of an "infobox" template. Nearly every wiki provides at least one of these.
- Below, there is an example of a navigation template called a "navbox" typically used at the bottom of pages.
| |||||
Speaking generally, a template is any wiki page whose content is designed to be transcluded (embedded) inside other pages. Templates follow a convention that the name is prefixed with Template:, assigning it to that namespace.
Templates in the page source
When editing wiki pages, it is likely you might encounter something like this:
{{Example}}
Or perhaps something more complex like this:
{{Infobox
|name = Example infobox
|image = Curse hydra.png
|race = Plushie
|location = Curse Headquarters
|source = [[User:Encredechine{{!}}Encredechine]]
|related = Fun
}}
These are examples of templates being used on these wiki pages. The first is using [[Template:Example]], the second is using [[Template:Infobox]]. The double curly brackets, {{ and }} usually mean that a template is being used there, but unfortunately, double curly brackets also have other uses in wikitext, which can cause some confusion.
Templates can also use lua to run faster.
How to tell if it's a template
Let's look at our examples above again.
{{Infobox
|name = Example infobox
|image = Curse hydra.png
|race = Plushie
|location = Curse Headquarters
|source = [[User:Encredechine{{!}}Encredechine]]
|related = Fun
}}
In this case, we have a definite clue because the first thing after the name other than just space is a pipe character: (|). This is definitely a template. If it were a colon instead, (:), then it would not be a template, but some kind of magic word.
{{Example}}
Unfortunately, this one doesn't offer any definite clues right off the bat. If you aren't sure, there are a few ways to make a pretty good guess:
- One clue is that it is a template is that isn't in all capital letters. Virtually all magic words that don't require a colon are typed in all caps.
- To be sure, when editing a page, you should see "Templates used on this page" at the bottom of the screen under the "Save Page" and other buttons. If it's listed there, it's definitely a template.
- If it isn't a documented magic word, it's almost certainly a template.
Basic transclusion
Transclusion is by far the most common way to use templates.
{{Name}}— as described above, this link will be dynamically replaced by the current content of [[Template:Name]] at the time the page with the template link is loaded. The page's source will be unchanged.
In fact, an ordinary wiki page can also be used as a template, simply by specifying the namespace in which it resides, so:
{{Template:Pagename}}includes[[Template:Pagename]]{{Foo:Pagename}}includes[[Foo:Pagename]]{{:Pagename}}includes[[Pagename]]{{SUBST::Pagename}}replaces itself with the contents of[[Pagename]]
If no such namespace exists, the full title is assumed to be a template:
{{Foo:Bar}}includes[[Template:Foo:Bar]]
There are other ways of using templates, but these are useful only in special situations. Most editors will never have any use for these special functions, so they are explained only at the bottom of this page.
Template documentation
Many template authors provide documentation for how to use specific templates. This can usually be found on the template page itself. If you are editing a page using a particular template, one way you can usually get to the template page quickly is by using the "Templates used on this page" section at the bottom of the edit page.
Unfortunately, many templates are not documented. In this case, you can try looking for examples of the template being used on other pages. From the template page, try clicking "What links here" in the "Tools" menu in the sidebar to find other pages where the template is used. If it's not documented, consider writing your own template documentation.
It can help to understand how to write templates. Once you do, you may be able to figure out a template simply by opening it for editing and looking at its source, but templates can be very complex and may use advanced wiki features or specific extensions, like any other wiki page. If all else fails, never hesitate to ask for assistance from the wiki community.
Alternate ways to use templates
In addition to standard transclusion, templates can be used in other pages in these ways:
{{subst:Name}}— when this template link is used, it will be replaced once and for all with the content of [[Template:Name]] as of the time the page with the link is saved; a copy of the contents of [[Template:Name]] will be substituted for the template link. The contents are then a part of the including page, and can be edited normally, separately from the original. Changes to the source template page will not be propagated to the page with the template link.{{safesubst:Name}}— this is for special cases where a template may be designed to work both through transclusion and substitution. For example, say you used a template {{Firstname}} within [[Template:Name]]. If you use {{subst:Name}}, the {{Firstname}} will be saved on the page. If you try to change it to {{subst:Firstname}} inside [[Template:Name]], then it'd be substituted inside the template.safesubst:doesn't substitute until the template containing it is used withsubst:.{{msgnw:Name}}includes the template in a form that displays it as raw wiki syntax (the way<nowiki>does) when the page containing it is fetched.