Template:Reflist-talk/doc

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

Shortcut

{{tref}}

This template is used on approximately 56,000 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 a version of {{Reflist}} designed for sections of talk pages and other, non-article sections.

{{Reflist-talk}} creates a list of references for a talk page discussion within a particular section. The list has the default title: References. To distinguish it from an article's References section, it appears within a bordered box.

This template could also be useful on other types of non-mainspace pages structured with section headers, e.g., for a section in a user's sandbox.

Usage

To create a section-level reference box in a section containing references within <ref></ref> tags, add the following wikitext to the end of a section:

{{Reflist-talk}}

When having a discussion with new editors or others who might not know how to work with this template, add the following wikitext to the section's end to create a section-level reference box plus task-oriented instructions in a hidden comment:

{{Reflist-talk}}

This hidden comment has instructions designed to keep the wikitext in the right order.

Redirects

Redirect list is from here. {{Inlineref}} {{Ref-talk}} {{Reflist-quote}} {{Reflist-talk}} {{Reflisttalk}} {{Reftalk}} {{REftalk}} {{Section references}} {{Talk-reflist}} {{Talk-refs}} {{Talk page-reflist}} {{Talk page ref}} {{Talk page reference}} {{Talk page reflist}} {{Talk ref}} {{Talk reference}} {{Talk references}} {{Talk reflist}} {{Talk refs}} {{Talkref}} {{Tref}} {{TREF}}

Optional parameters

There are no required parameters. When using all parameters, the basic syntax is:
{{Reflist-talk|colwidth=|title=|group=|refs=}}

|title= specifies the box title, which defaults to References if this parameter is omitted. The box title will be blank if this parameter is included without an argument (that is, without any text after the equal sign).

The template recognizes these features of {{Reflist}}:

|colwidth=: state in ems, a typographic unit of measurement.
|refs=: used with List-defined references.
|group=: identifies by name the subset of references to be rendered; the value should correspond to that used inline, e.g., {{Reflist-talk|group=groupname}} renders all references with groupname as the group name (<ref group=groupname>). There are five predefined group names that style the list differently. See Reflist § Grouped references

The template should be placed after the discussion that includes the references, as it will include all references before the template that haven't been claimed by a previous template.

Obsolete parameter

This parameter is no longer in use:

close: Until 2014, the parameter |close=1 was used to work around a bug. When the bug was fixed, this was removed.

Limitations

Do not indent this template

This template does not work correctly if indented with colons as is usual with talk page discussions.

Indenting also is unnecessary, because indentation is irrelevant to it: the reference box contains all the references from all posts in the section from all editors. Plus, it is set apart from other text through its own style, including a light, boxed outline. See this discussion (permalink) for further details about this limitation.

Incorrectly boxed example

If you add : before it, the references do not appear inside the box as expected, but rather you get an indented empty dashed box, followed by the references, which are not indented:^[1]

References

↑ Incorrectly boxed example reference

Correctly boxed example

If this is fixed, the above example would display inside a correctly-indented box, which would look like the following except correctly indented: ^[1]