Help:Template namespace
- This page not to be confused with Template:Namespaces
 | This page in a nutshell:
|
| Namespaces | |||
|---|---|---|---|
| Subject namespaces | Talk namespaces | ||
| 0 | (Main/Article) | Talk | 1 |
| 2 | User | User talk | 3 |
| 4 | AARoads | AARoads talk | 5 |
| 6 | File | File talk | 7 |
| 8 | MediaWiki | MediaWiki talk | 9 |
| 10 | Template | Template talk | 11 |
| 12 | Help | Help talk | 13 |
| 14 | Category | Category talk | 15 |
| 100 | Annex | Annex talk | 101 |
| 828 | Module | Module talk | 829 |
| Deprecated | |||
| 2300 | Gadget | Gadget talk | 2301 |
| 2302 | Gadget definition | Gadget definition talk | 2303 |
| Virtual namespaces | |||
| -1 | Special | ||
| -2 | Media | ||
| Current list (API call) | |||
The Template namespace on the AARoads Wiki is used to store templates, which contain Wiki markup intended for inclusion on multiple pages, usually via transclusion. Although the Template namespace is used for storing most templates, it is possible to transclude and substitute from other namespaces,[1] and so some template pages are placed in other namespaces, such as the User namespace.
Templates help maintain consistent formatting and aid navigation between articles. They often include optional and/or variable elements controlled by parameters to allow for specialized use. Templates are also used to assist in a large variety of Wikipedia maintenance tasks. Each template has a matching Template talk: page where editors can discuss the design and implementation of the associated template (see Help:Using talk pages for how to participate in talk page discussions).
A template is transcluded into another page by including a template tag in that page's content. A template tag contains the template page name surrounded by double curly braces, e.g. {{Disambiguation}}. If the template's page name does not begin with a namespace and colon, it is assumed to be in the Template namespace.
Internal links to template pages may be made by using the Template: prefix, e.g. [[Template:Disambiguation]]. These links go to a page that directly contains a base template and often documentation.
Guidelines
- Templates should not normally be used to store article text, as this makes it more difficult to edit the content. They should also not be used to "collapse" or "hide" content from the reader.
- Templates used in articles are designed to provide information to assist readers, such as navigation aids, formatting, or warnings that content is sub-standard. Templates that provide information only of service to editors should not appear on article pages – use the article's talk page or other non-article namespaces.
- Template function should be clear from the template name, but redirects can be created to assist everyday use of very popular templates.
- High-risk templates should be semi-protected, template protected, or fully protected as appropriate. This applies also to any high-use template redirects.
- Templates should be clearly documented as to their usage and scope.
- Templates should not be used to create lists of links to other articles when a category, list page, or "See also" section list can perform the same function.
- Templates for short, temporary messages that will be removed quickly (such as on User_talk: pages) or that contain text which is not likely to ever be changed should be invoked with substitution (subst:). Typical templates that are intended for long-term use and are likely to require changes should be transcluded for easy future updates.
- Templates that violate the guidelines on this page, have poorly defined function, are redundant, become orphaned or used on only one page, or violate any Wikipedia policies may be nominated for deletion at AARoads:Deletion requests.
Suggested practices
Referencing templates
Sometimes you will want to refer to a template, rather than actually invoking it. An easy way to do this is to call Template:Tl (short for "template link"). For example, to reference the Cleanup template, typing {{tl|Cleanup}} results in {{Cleanup}}. You can also add parameters using Template:Tlp; for example, {{tlp|Convert|1|m}} displays as {{Convert|1|m}}.
Check the template documentation on Template:Tl for other options, such as {{tlb}} (bold), {{tlx}} (code), {{tlxi|param1|param2}} (italic parameters), and many more.
Template names
Template names can be made of one or more words, such as {{Train topics}}. The first character is not case-sensitive, so {{cleanup}} and {{Cleanup}} are the same template. All other characters are case sensitive, so {{cfd}} and {{cfD}} are not the same. Template names are easiest to remember if they follow standard English spelling, spacing, and capitalization (also see the naming conventions for articles). Avoid having templates whose names differ only in case, spacing, or punctuation.
Sandbox for experiments
If you wish to experiment with templates (and not have your experiments deleted before you are done with them), you may do so in the Template sandbox. You may also use the templates X1, X2, X3, X4, X5, X6, X7, X8, X9, X10, X11, and X12 for experimental purposes. To include a test template, use the form {{X1}} for template X1, {{X2}} for template X2, etc.
Existing templates often each have their own sandbox and test case pages (especially those that use {{Documentation}}). Changes should be thoroughly tested there before being applied to the main template, in order to prevent unintentional damage to many pages.
Readability
For templates that use a large number of parameters, it can be helpful to place each parameter on a separate line and align the equals signs. This helps future editors to more easily read the wikicode.
{{Example template name
| first_parameter = Text of first_value
| second_parameter = Text of second_value
| third_parameter = Text of third_parameter
| etc = etc
}}
Line breaks
Some templates may accidentally cause extra line breaks in the rendered articles. This is especially true of infobox templates and other template boxes that usually float on the right side of an article, since the additional lines will not be seen on the template page.
As a general guideline, avoid two line breaks together in your template. These may "add up" with other line breaks in the article and be displayed as unwanted white space.
Substitution
Invoking a template using the form
{{subst:name of template (|parameters |...)}}
(that is, inserting subst: immediately after the opening pair of curly brackets)
will make a copy of the template text and place it on the page, where it will be viewable in the source. The template is no longer transcluded and future changes to the template will not change the text. As a guideline, this method should be used for any short, temporary messages which are removed quickly, such as on User_talk: pages. The standard new user {{Welcome}} message is a good example.
Use subst: also if you need to edit the message after including it on the page. If you don't need to edit it, and would rather the message is automatically updated along with changes made to the template, don't use subst:.
Documentation
Because templates represent a step up in difficulty for the novice editor, documentation should be provided which describes its usage (optional parameters) and scope (where it should be used). There are two different ways to do this:
One alternative is to use <noinclude> to add a minor description direct into the template, for example:
'''This is a {{{1}}} article.'''<noinclude>
Place this template on any article that requires description. It
takes one parameter, an adjective used to describe the article.
For example, {{article-describe|bad}} produces the text,
'''This is a bad article.'''
</noinclude>
Another alternative is to create a formal /doc subpage for the documentation (preferred for templates with multiple parameters, etc.) and add <noinclude>{{Documentation}}</noinclude> after the actual template. The first "noinclude" tag should normally be placed on the same line as the last characters of the actual template, in the following manner:
{{(template name)
(piped parameters)
}}<noinclude>...
If the "noinclude" tag starts on the line below the template's final characters, unwanted whitespace may be introduced at the bottom of the template when it is used in articles and on other pages.
Modules
Lua modules are sometimes used instead of templates to store reusable material. Reasons for this include usage of module-specific features such as loops or stored values, and complex code is often easier to read and maintain in a module. If a module is easily implementable in a template it generally should be, since there are more users with experience editing templates.
If a module is intended to be used in articles or talk pages, a template wrapper should generally be created to simplify usage without directly requiring the #invoke parser function. Documentation is then mostly located on the template's /doc page, with the module's documentation pointing to the template and/or explaining further technical details that are unnecessary at the primary template documentation.
A template wrapper uses more of the post-expand include size limit than calling the module directly, therefore it may be necessary to avoid using one in articles that are near the limit.
Searching for templates
Use this form to search in the Template: or Template_talk: namespaces. See Help:Searching for more information.
If you're unable to find an existing template for your situation, but don't feel comfortable creating one yourself, you can ask for help at The Interchange.
See also
- Help:Template for information on developing templates and syntax details
- Help:Magic words for all template modifiers
- Help:Conditional tables
Notes
- ^ Namespaces from which transclusion is not allowed are specified on a wiki by the variable $wgNonincludableNamespaces