Misplaced Pages

Template:Talk header/doc

Article snapshot taken from Wikipedia with creative commons attribution-sharealike license. Give it a read and then ask your questions in the chat. We can research this topic together.
< Template:Talk header

This is an old revision of this page, as edited by Mathglot (talk | contribs) at 23:09, 6 November 2021 (Search box: Fix search root for working example.). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

Revision as of 23:09, 6 November 2021 by Mathglot (talk | contribs) (Search box: Fix search root for working example.)(diff) ← Previous revision | Latest revision (diff) | Newer revision → (diff)
This is a documentation subpage for Template:Talk header.
It may contain usage information, categories and other content that is not part of the original template page.
WarningThis template is used on approximately 738,000 pages, or roughly 1% of all pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.
This template should not be substituted.
This template should be used only when a talk page requires it. There is no need to add this template to every talk page. Do not create a talk page that contains only this template.
CSSThis template uses TemplateStyles:
Shortcut

This template is a signpost. It may be used on talk pages to attract commentary from inexperienced editors, or where there are high levels of debate from everyone. It provides:

  • Intro – a short introduction and appropriate links for newcomers
  • Policies – a reminder of important policies for experienced Wikipedians
  • Archives – a list of links to the current talk page's archives, and a search box
  • Find sources links – a set of links to aid in finding reliable sources for the article topic

Usage

Basic
{{Talk header}}

To add this template to a talk page, just open an edit of the talk page, and put {{Talk header}} at the top of the page.

This template should be placed only where it's needed. Don't visit talk pages just to add this template, and don't place it on the talk pages of new articles. Talk pages that are frequently misused, that attract frequent or perpetual debate, articles often subject to controversy, and highly-visible or popular topics may be appropriate for this template.

By convention, this template goes at the very top of the talk page, above WikiProject templates and other talk-page banners. However, this is not an absolute rule, and editors should use common sense when deciding its placement. See also: WP:Talk page layout § Lead (bannerspace).

In accordance with talk page guidelines, this template should not be added to otherwise empty talk pages. That changes the "discussion" tab at the top of the page from a "redlink" into a "bluelink", which may mislead people into thinking there is discussion.

For more information on this topic, see the talk page for this template, including the talk archives and the TfD logs.

Parameters

Full syntax – Vertical

{{talk header |bottom= |disclaimer= |custom_header= |wp= |display_title= |arpol= |sc1= |sc2= |sc3= |sc4= |sc5= |demospace= |hide_find_sources= |search= |search_term1= |search_term2= |search_term3= |search_term4= |noarchive= |age= |bot= |units= |minthreadsleft= }}

Horizontal

{{talk header |bottom= |disclaimer= |custom_header= |wp= |display_title= |arpol= |sc1= |sc2= |sc3= |sc4= |sc5= |demospace= |hide_find_sources= |search= |search_term1= |search_term2= |search_term3= |search_term4= |noarchive= |age= |bot= |units= |minthreadsleft= }}

Hiding the template

If you would prefer not to see this template on any talk page, you can hide it from your view. Note that this will hide page archive links and the archive search box as well if they are configured to be shown through this template. You'll need to have a named account to do this.

  1. Edit your user style page at Special:Mypage/common.css.
  2. Add a line: #talkheader {display:none;}
  3. Save the change.
  4. Bypass your cache.

Parameters by functionality group

This section describes parameters according to which functionality group they belong to. Each subsection below corresponds to one of the four main areas of functionality listed in the bullet items at the top.

Intro and newcomer links

Basic tips for newcomers are boxed with a white background and appear top left, and includes starting a new section, using tildes to sign their posts, and how to get help.

Article policies

In the article namespace only, a box of "Article policies" is included by default.

In non-article namespaces, the "Article policies" box can be added via |arpol=yes. For example:

{{talk header|arpol=yes|noarchive=yes|search=yes|User:$1|User:$2}}

Note: |arpol=no is an invalid setting, and has no effect on header display in any namespace.

Archives

Links to archives

If present, archive index and links to archives look like this (example shown is for Talk:Europe):

Auto-archiving period 180 days  Archives: Index, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11

Bot notice

If the page is auto-archived by a bot, the bot notice appears flush right, as in the example shown above.

The following parameters contribute to a small notification that the talk page is archived by a bot (typically by Lowercase sigmabot III or ClueBot III). The template will include a tooltip informing readers of the amount of time before discussions are archived. This tooltip will not be shown if there are no archives to be listed.

{{talk header|bot=lowercase sigmabot III|age=30|units=days}}

This informs the user the lowercase sigmabot III bot will autoarchive talk page sections that are older than 30 days. (See #Examples.)

{{talk header|bot=lowercase sigmabot III|age=6|units=months|minthreadsleft=4}}

This informs the user the lowercase sigmabot III bot will autoarchive talk page sections that are older than 6 months, as long as at least 4 sections remain. (See #Examples.)

These parameters are for informational purposes, not to actually set up archiving. Please see WP:AUTOARCHIVE for instructions. For an alternative template to inform readers of automatic archiving settings, see {{Archives}}.

|bot= The bot used to archive the page, unwikilinked.

|age= Enter a number to convey the amount of time the bot is set to wait for until archiving a discussion as expressed as a number of time units, as set by the units parameter.

|units= Enter a string to convey the unit the age parameter refers to. Useful examples include days, month, months etc

|minthreadsleft= The amount of threads the bot will leave. The tooltip will include a message telling the reader that after minthreadsleft threads, threads older than age will be archived.

Search box

If present, the search box appears below the Archiving links:

In this working example, entering search terms searches the talk page archives of the article Europe.

"Find sources" links

For article Talk pages, a set of "find sources" links appears by default in the Talk header box. The default links correspond to the output of Template:Find sources; see Talk:Europe for an example.

In article Talk space, the "find sources" links may be suppressed by setting the |hide_find_sources=yes parameter. These links do not appear outside of Talk space.

Testing issues

Namespace testing

For testing and demonstration purposes, this template can take a parameter named demospace which enables testing of the find sources opt-out parameter |hide_find_sources= from other namespaces.

  • If demospace has the value main or the value 1 it returns the findsources text it would normally return when transcluded from mainspace.
  • It demospace any other value such as the name of some other namespace it returns the text it would if transcluded outside of mainspace.
  • If the parameter is empty or undefined, the actual page type determines the result.

Examples

Archiving notice

The following parameters contribute to a small notification that the talk page is archived by a bot (typically by Lowercase sigmabot III or ClueBot III). The template will include a tooltip informing readers of the amount of time before discussions are archived. This tooltip will not be shown if there are no archives to be listed.

{{talk header|bot=lowercase sigmabot III|age=30|units=days}}
This is the talk page for discussing improvements to the Talk header/doc template.
Archives: 1

This informs the user the lowercase sigmabot III bot will autoarchive talk page sections that are older than 30 days.

{{talk header|bot=lowercase sigmabot III|age=6|units=months|minthreadsleft=4}}
This is the talk page for discussing improvements to the Talk header/doc template.
Archives: 1

This informs the user the lowercase sigmabot III bot will autoarchive talk page sections that are older than 6 months, as long as at least 4 sections remain.

TemplateData

A signpost for the top of talk pages

Template parameters

ParameterDescriptionTypeStatus
Shortcut1 shortcut shortcut1 sc sc1

Shortcut that will display similar to the {{shortcut}} template, but within the Talk header message box

Example
WP:SHOR
Page namesuggested
Shortcut 22 shortcut2 sc2

A second shortcut

Page nameoptional
Shortcut 33 shortcut3 sc3

A third shortcut

Page nameoptional
Shortcut 44 shortcut4 sc4

A fourth shortcut

Page nameoptional
Shortcut 55 shortcut5 sc5

A fifth shortcut

Page nameoptional
bottombottom

Set to "yes" to add additional instructions at the top to "please place new discussions at the bottom of the talk page"

Suggested values
yes
Booleanoptional
smallsmall

no description

Unknownoptional
disclaimerdisclaimer

Set to "yes" to add an additional banner which identifies the page as being originally from Misplaced Pages (and modify the width to suit), matching the style of {{User page}}.

Booleanoptional
Custom headercustom_header

Replaces the entire header with customized text

Lineoptional
WikiProject?wp

For use on WikiProject talk pages; set to "yes" to add "and anything related to its purposes and tasks" to the header

Booleanoptional
Display titledisplay_title

Displays a custom page title

Stringoptional
Article policiesarpol

Adds a link to the article policy pages

Default
On for article talk pages, off otherwise
Booleanoptional
demospacedemospace

no description

Unknownoptional
Hide find sources?hide_find_sources

Set to "yes" to hide the find sources banner on article talk pages

Booleanoptional
Search termsearch_term search_term1

Changes the search term used in the {{find sources}} module

Stringoptional
search_term2search_term2

no description

Unknownoptional
search_term3search_term3

no description

Unknownoptional
search_term4search_term4

no description

Unknownoptional
No archives?noarchive noarchives archives

Set to "yes" to hide the archives links

Booleanoptional
Archive agearchive_age age

Amount of time, by default in days, before discussions will be automatically archived. Note: Does not actually trigger automatic archiving; see ].

Numbersuggested
Archive botarchive_bot bot

The bot used to archive the page. Note: Does not actually trigger automatic archiving; see ].

Suggested values
Lowercase sigmabot III ClueBot III
Stringsuggested
Archive unitsarchive_units units

The units for archive_age

Suggested values
hours days months years
Default
days
Stringoptional
Minimum threads leftminthreadsleft

The number of threads the archiving bot will leave. Currently affects only the tooltip.

Numbersuggested
searchsearch

Set to "no" to override the default behavior for the search box appearance

Booleanoptional

Tracking categories

See also

Notes

  1. To add additional instructions at the top to "please place new discussions at the bottom of the talk page", use |bottom=yes.
  2. On user talk pages, |disclaimer=yes adds an additional banner which identifies the page as being originally from Misplaced Pages (and modifies the width to suit), matching the style of {{User page}}.
  3. To replace the entire header with customized text, use |custom_header=Custom header text goes here
  4. For use on WikiProject talk pages, the parameter |wp=yes can be included to add "and anything related to its purposes and tasks." to the top line of the banner.
  5. To display a custom page title, use |display_title=custom page title
  6. "Article policies" can be added to talk headers in non-article namespaces by adding |arpol=yes. (See below in #Appearance variations for an example)
  7. Up to five shortcuts can be added to the template, as unnamed parameters, or as named ones (any of |1=, |sc=, |sc1=, |shortcut= or |shortcut1=, then |2=, |sc2= or |shortcut2=, etc., will work). For example, {{Talk header|WP:SHOR|WP:TCUT}}. They will display similar to the {{shortcut}} template, but within the Talk header message box.
  8. To hide "Find sources" on article talk pages, use |hide_find_sources=yes
  9. To override the default behaviour for the search box appearance, use |search=no. The default is yes, when archive subpages exist.
  10. To change the search term from the page name, use |search_term=new search term
  11. When used on a talk page that has archives, links to those archives and a search box will be displayed automatically within this template. To switch the archive links off, use the parameter |noarchive=yes. For example: {{Talk header|noarchive=yes}}. For automatic archive links to be displayed, archives must be named in the standard way. A link to the archive index is also displayed, if it is named "/Archive index". If no archives exist for the current talk page, or if archives exist but possess non-standard names, no archive links will be displayed.
Userspace messages and disclaimers
User pages
User talk pages
Editnotices
Drafts and sandboxes
Blanking
Templates for archiving
Recommended
Side box
Headers
With
navigation
Without
navigation
With
search
  • {{Talk header}} (contains an automatically appearing archive search box and nav)
Content
formatting
Lists
Discussion
Automatic
archiving
systems