Template:Template reference list/doc

This is a documentation subpage for Template:Template reference list.
It may contain usage information, categories and other content that is not part of the original template page.

<translate> Shortcut</translate>:
{{Treflist}}

This template is used on approximately 5,900 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template is used to show the references used in a template on the main template page, only if there is no documentation (/doc) subpage to place the references in.

To use this template as an example of the relationship between a main template page and its documentation subpage:

Template:Template reference list/doc is the documentation subpage, whose saved, rendered categories and content become the
Template:Template reference list—the main template—page's categories and the content in the section with a green background that begins with Template documentation [view] [edit] [history] [purge]

Note that the categories should be placed in the <includeonly>...</includeonly> tags in the /doc subpage and, when saved, will appear in the expected area at the bottom of the template page.

Overview

{{Template reference list}} provides an explanatory list of references that are entered into the template in which Template reference list is inserted. The references appear in the article where the template is used if either {{Reflist}} or the <references /> tag is used in the article. By showing the references on the template page, the Cite error message is defeated, and it allows the template editor to verify those references.

Usage

Documentation page

If the template includes a documentation page, simply add a regular references section there.

Basic usage

If the template does not include a documentation page, add:

<noinclude>{{Template reference list}}</noinclude>

near the end of the template as in any article.

Grouped references

If one or more references of the template are grouped (like: <ref group="groupname">), you may use:

<noinclude>{{Template reference list|groupname1|groupname2|groupname3}}</noinclude>

It supports a maximum of 6 group names.

Important note

The article where the template is used must include a <references /> tag or the {{Reflist}} template.

If the references are grouped, the article must also include <references group="groupname" /> tags or the {{Reflist|group="groupname"}} templates.

Technical

This templates uses <h2>References</h2> instead of == References == to create the section header. The standard wikimarkup creates an edit link that when transcluded links back to the original template. Thus, an editor who clicked on the edit link on the References section would confusingly open this template for editing.