Template:Talk header/doc

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.

This template employs intricate features of template syntax.

You are encouraged to familiarize yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly. Remember that you can conduct experiments, and should test all improvements, in either the general template sandbox or your user space before changing anything here.

This template should be used only when needed. There is no need to add this template to every talk page. Do not create a talk page just to add this template.

This template is a signpost. It is intended to be used on particularly active talk pages that attract commentary from inexperienced editors, and/or high levels of debate from everyone. It provides:

A short introduction and appropriate links for newcomers.
A reminder of policy to experienced Wikipedians.
A list of links to the current talk page's archives.
An optional archive search box.

Usage

{{talk header}}

To add this template to a talk page, just edit the talk page, and put {{talk header}} at the top of the page (above existing conversations).

Talk pages that attract frequent or perpetual debate, articles often subject controversy, and/or recent-and-highly-visible topics are usually appropriate for this template. Calm talk pages do not need this template.

This template should not be added to otherwise empty talk pages. That changes the "discussion" tab at the top of the page from a "red link" into a "blue link", which may mislead people into thinking there is discussion.

Parameters

Full syntax:

{{talk header|noarchive=no|search=yes|txtpol=no|wp=no|disclaimer=no|bottom=no|shortcut1|shortcut2|shortcut3|shortcut4|shortcut5}}

Up to five shortcuts can be added to the template, as unnamed parameters. For example, {{talk header|WB:SHOR|WB:TCUT}}. They will display similar to the {{shortcut}} template, but within the talk header message box.
A search bar can be displayed to allow editors to search the archives of a talk page by using the parameter |search=yes. For example: {{talk header|search=yes}}. To deactivate the search feature, simply do not add the field.
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.
When used on a talk page that has archives, links to those archives will be displayed automatically within this template. To switch this off, use the parameter |noarchive=yes. For example: {{talk header|noarchive=yes}}. In order 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.
On user talk pages, |disclaimer=yes adds an additional banner which identifies the page as being originally from Wikibooks (and modifies the width to suit), matching the style of {{userpage}}.
Additional policy content can be added to talk headers on textbook talk pages by adding |txtpol=yes.
To add an additional instructions to "please place new discussions at the bottom of the talk page", use |bottom=yes.

Hiding the template

If you would prefer not to see this template on any talk page, you can hide it from your view. You'll need to have an account to do this.

Edit your user style page.
Add a line: #talkheader {display:none;}
Save the change.
Bypass your cache.

Appearances variations

Be aware that this template will appear differently in different namespaces. In particular, in the main namespace, there is an additional box of "Textbook policies". That box does not appear when this template is used in any other namespace (including the template namespace) but may be optionally added with the |txtpol=yes parameter. Here is what the template looks like with the "Textbook policies" box:

This is the discussion page for discussing improvements to the Talk header/doc page.
Put new text under old text. Click here to start a new topic. Please sign and date your posts by typing four tildes (`~~~~`). New to Wikibooks? Welcome! Ask questions, get answers.	Be polite Assume good faith Avoid personal attacks Be welcoming	Textbook policies No original research Neutral point of view Stay in scope

Template editing notes

Please discuss before making changes to this template. Unannounced action tends to lead to a flurry of editing. Differences in personal taste have lead to "perpetual tweaking" in the past.

By design, this template appears differently depending on which namespace it is used in. One should remain conscious of how this will impact your changes. In particular, the number of columns can vary, affecting text width for line wrapping.