Template:Being closed/sandbox

Template documentationviewedithistorypurge

The notice is placed at the top of a discussion section or sub-page when you are actively working on the close and intend to post the result as soon as possible, or in a few hours if the discussion is acrimonious. If substituted, it displays the user who added it along with a timestamp; otherwise, it instructs readers to check the page history for that information. It informs other editors that someone is currently working on the close, that discussion should end, and that other closers should not bother to work on the discussion. This helps reduce edit conflicts and avoid duplication of work.

Usage

• Basic usage:

{{subst:Being closed|closer=[[User:{{subst:REVISIONUSER}}|{{subst:REVISIONUSER}}]]}}

• With a closer's note:

{{subst:Being closed|closer=[[User:{{subst:REVISIONUSER}}|{{subst:REVISIONUSER}}]]|comment=I'm currently reading through the discussion and will close it within the next two hours.}}

• Substituted with locking:

{{subst:Being closed|closer=[[User:{{subst:REVISIONUSER}}|{{subst:REVISIONUSER}}]]|lock=yes}}

• Transcluded with locking:

{{Being closed|closer=[[User:{{subst:REVISIONUSER}}|{{subst:REVISIONUSER}}]]|lock=yes}}

• The |lock= parameter (alias |restrict=) controls whether the reply button, the add-new-section link, and section-edit links on headings are suppressed on the page the notice is placed on:
  • Whether it is substituted or left as a live transclusion, discussion locking is off by default. Set |lock=yes to use the notice without and hide the "Reply" button.
  • The lock only ever applies to the page the notice is actually on. If that page is later transcluded elsewhere, for example into a log page, the lock has no effect there.
  • Editors can still add comments or edit the page, but they can't use the "Reply" button. This is merely to disincentivise new comments and is not intended as a surefire way to stop editors from adding new comments while you're closing the discussion.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Being closed in articles based on its TemplateData.

TemplateData for Being closed

Notifies editors that a discussion is currently being closed, to reduce edit conflicts and duplicated effort.

Template parameters[Edit template data]

Parameter		Description	Type	Status
Closer	closer	The editor, or group of editors, who is closing the discussion. Example A group of highly trained orangutans Auto value [[User:{{subst:REVISIONUSER}}|{{subst:REVISIONUSER}}]]	String	optional
Lock discussion	lock restrict	Whether to temporarily disable the 'Reply', new sections, and section-edit links on the page this notice is placed on. Default is true when the template is substituted, and false when it is left as a live transclusion. Applies only to the page the notice is actually on, not to any page that transcludes it. Default no Example yes Auto value yes	Boolean	optional
Plural	plural	Set to true if there is more than one closer, so the notice uses plural wording (for example, 'are' instead of 'is'). Default false	Boolean	optional
Estimate	estimate	The estimated time when the close will be complete. Default shortly Example within an hour	String	optional
Closer's note	comment 1	An optional note from the closer, shown in a separate box below the main notice, for example to explain the closer's reasoning or expected timing. Can also be supplied as the first unnamed parameter. Example I'm currently reading through the discussion and will close it within the next two hours.	String	optional

See also

• {{In use}}, similar template used to notify readers that a large edit is taking place
• Closure:
  • WP:Closing discussions - information page regarding closing discussions

The above documentation is transcluded from Template:Being closed/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
Add categories to the /doc subpage. Subpages of this template.