Template:Reflist-talk/doc

From "PTTLink Wiki"
< Template:Reflist-talk
Revision as of 21:12, 19 September 2021 by Mediawiki>Jack who built the house (+{{Uses TemplateStyles}})
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This template is a version of {{Reflist}} designed for sections of talk pages and other, non-article sections (e.g. blocks of example text with citations in a guideline, a how-to essay, or a template's documentation page).

{{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}}<!-- Template:Reflist-talk creates a section-level reference list box. Please add comments and references for this section's discussion above this template. When a new discussion begins, the new section will be added below this template. Add a new {{Reflist-talk}} at the end of that section if needed. -->

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 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

  1. 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: [1]

References

  1. Correctly boxed example reference

Redirect from deleted template

{{Section references}} now redirects here to {{Reflist-talk}}. However, previously it was a different template that was deleted, with the existence of this template as part of the justification. See Wikipedia:Templates for discussion/Log/2015 March 2#Template:Section references for details.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Reflist-talk

This template creates a list of references for a talk page discussion within a particular section.

Template parameters

ParameterDescriptionTypeStatus
Section titletitle

The title to display before the references

Default
References
Stringoptional
Columns / Column widthcolwidth 1

Passed to {{reflist}}. Two modes supported. First mode (deprecated): integer number of fixed columns into which the reference list is to be rendered. Second mode: typographic unit of measurement such as 'em', specifying the width for the reference list columns, e.g. '33em'; spaced '33&nbsp;em' will not be recognized

Default
1 if < 11 references; otherwise 30em
Stringoptional
Groupgroup

Passed to {{reflist}}. Group is an identifier which restricts the references that are shown. Without this parameter, this template only shows references with no group identifier. With a group identifier specified, only references with a matching group identifier are handled. The rest are left alone.

Stringoptional
List of referencesrefs

Passed to {{reflist}}. Provides a space to define named references for use in the article. References defined in this space are not shown unless used somewhere in the article.

Stringoptional
Extra CSSstyle

Additional CSS to apply

Unknownoptional

See also