Editing BattleTechWiki:Template namespace

<noinclude>{{pp-vand|small=yes}}{{pp-move-indef}}</noinclude>
{{for|learning how templates work|Help:A quick guide to templates|Help:Template}}
{{Subcat guideline|project content guideline||BTW:TMP|BTW:NS10}}
{{Nutshell| 
* The Template: namespace on BattleTechWiki contains templates created for consistent formatting, maintenance, and navigation.
* Templates should not normally be used to store [[BattleTechWiki:What is an article?|article text]]. Such content belongs in the article pages themselves.
}}
{{namespaces}}
The '''Template namespace''' on BattleTechWiki is used to store [[Help:Template|templates]], which contain [[Help:Wiki markup|Wiki markup]] intended for inclusion on multiple pages, usually via [[BattleTechWiki:Transclusion|transclusion]]. Although the Template namespace is used for storing most templates, it is possible to transclude and substitute from other namespaces,<ref>Namespaces from which transclusion is not allowed are specified on a wiki by the variable [[mw:Manual:$wgNonincludableNamespaces|$wgNonincludableNamespaces]]</ref> and so some template pages are placed in other namespaces, such as the [[BTW:User namespace|User namespace]].

Templates help maintain consistent formatting and aid navigation between articles. They often include optional and/or variable elements controlled by [[Help:Template#Parameters|parameters]] to allow for specialized use. Templates are also used to assist in a large variety of [[BattleTechWiki:Project Maintenance|BattleTechWiki maintenance]] tasks. Each template has a matching <code>Template talk:</code> 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 [[BTW:page name|page name]] surrounded by double curly braces, e.g. {{tlc|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 <code>Template:</code> prefix, e.g. <code><nowiki>[[Template:Disambiguation]]</nowiki></code>. These links go to a page that directly contains a base template and often [[BTW:Template namespace#Documentation|documentation]].

== Guidelines ==
{{shortcut|BTW:TG|BTW:TMPG}}
* Templates should not normally be used to store [[BattleTechWiki:What is an article?|article text]], as this makes it more difficult to edit the content. They should also [[BattleTechWiki:Manual of Style#Scrolling lists and collapsible content|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{{snd}}use the article's talk page or other non-article namespaces.
* Template function should be clear from the [[#Template names|template name]], but [[Help:Redirect|redirects]] can be created to assist everyday use of very popular templates.
* Templates should be clearly [[#Documentation|documented]] as to their usage and scope.
* 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|substitution]] (subst:). Typical templates that are intended for long-term use and are likely to require changes should be transcluded for easy future updates.

== 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 <code><nowiki>{{tl|Cleanup}}</nowiki></code> results in {{tl|Cleanup}}. You can also add parameters using [[Template:Tlp]]; for example, <code><nowiki>{{tlp|Convert|1|m}}</nowiki></code> displays as {{tlp|Convert|1|m}}.

Check the template documentation on [[Template:Tl]] for other options, such as {{tlb|tlb}} (bold), {{tlx|tlx}} (code), {{tlxi|tlxi|param1|param2}} (italic parameters), and many more.

=== Template names ===
{{shortcut|BTW:TPN}}
Template names can be made of one or more words, such as {{tlc|Train topics}}. The first character (only) is not case-sensitive, so {{tlc|cleanup}} and {{tlc|Cleanup}} are the same template, but {{tlc|cfd}} and {{tlc|cfD}} are not. Template names are easiest to remember if they follow standard English spelling, spacing, and capitalization (also see the [[BattleTechWiki:Naming conventions|naming conventions]] for articles). Avoid having templates whose names differ only in case, spacing, or punctuation.

=== Sandbox for experiments ===
{{main|BattleTechWiki:Template sandbox and test cases}}
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:Template sandbox|Template sandbox]]. You may also use the templates [[Template:X1|X1]], [[Template:X2|X2]], [[Template:X3|X3]], [[Template:X4|X4]], [[Template:X5|X5]], [[Template:X6|X6]], [[Template:X7|X7]], [[Template:X8|X8]], [[Template:X9|X9]], [[Template:X10|X10]], [[Template:X11|X11]], and [[Template:X12|X12]] for experimental purposes. To include a test template, use the form {{tlc|X1}} for template X1, {{tlc|X2}} for template X2, etc.

Existing templates often each have their own [[BattleTechWiki:Template sandbox and test cases|sandbox and test case]] pages (especially those that use {{tl|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.

<pre><nowiki>{{Example template name
| first_parameter  = Text of first_value
| second_parameter = Text of second_value
| third_parameter  = Text of third_parameter
| etc              = etc
}}</nowiki></pre>

=== Line breaks ===
Some templates may accidentally cause extra line breaks in the rendered articles. This is especially true of [[BattleTechWiki:Manual of Style/Infoboxes|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. For more information, see [[BattleTechWiki:Line-break handling]].

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 ===
{{main|BattleTechWiki:Substitution}}
Invoking a template using the form 
: '''<code>{{<span style="color:red;">subst:</span>name of template ''(|parameters |...)''}}</code>''' 
(that is, inserting '''<code>subst:</code>''' 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 [[w:transclusion|transcluded]] and future changes to the template will not change the text. As a [[#Guideline|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 {{tlx|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 ===
{{main|BattleTechWiki:Template 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 &lt;noinclude&gt; to add a minor description direct into the template, for example:
<pre>'''This is a {{{1}}} article.'''&lt;noinclude&gt;
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.'''
&lt;/noinclude&gt;
</pre>

Another alternative is to create a formal [[BattleTechWiki:DOC|/doc subpage]] for the documentation (preferred for templates with multiple parameters, etc.) and add <code>&lt;noinclude&gt;{{tl|Documentation}}&lt;/noinclude&gt;</code> after the actual template. The first "noinclude" tag should be placed on the same line as the end braces of the actual template in the following manner:
<pre>
{{(template name)
(piped parameters)
}}<noinclude>...
</pre>
If the "noinclude" tag starts on the line below the template's closing braces, then unwanted whitespace is introduced at the bottom of the template when it is used in articles and on other pages.

===Modules===
[[BTW:Lua|Lua]] modules are sometimes used instead of templates to store reusable material. Reasons for this include usage of module-specific features such as [[w:loop (programming)|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 <code>#invoke</code> 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.

There are sometimes reasons not to use a template wrapper, however, such as causing potential issues with [[w:Help:Template limits|template limits]]; a template wrapper that passes too many parameters to a module is much less efficient compared to a direct invocation. Additionally, it is generally not desirable to use template wrappers in other templates.

== Searching for templates ==
Pages which contain information on commonly used templates:
* [[BattleTechWiki:Template index]] for an index of text-based templates.
* [[BattleTechWiki:Categorization]] for templates used for [[Help:Category|categories]]
* [[BattleTechWiki:Citation templates]] for templates used to format article [[BattleTechWiki:Citing sources|references and citations]]

==See also==
* [[Help:Template]] for information on developing templates and syntax details
* [[Help:Magic words]] for all template modifiers
* [[Help:Conditional tables]]

==Notes==
{{Reflist}}

{{BattleTechWiki policies and guidelines}}
{{BattleTechWiki templates|state=collapsed}}

[[Category:Template administration|Namespace]]
[[Category:BattleTechWiki features|{{PAGENAME}}]]
[[Category:Template guidelines|namespace]]
[[Category:Template help]]