Template:Being closed/doc
| This is a documentation subpage for Template:Being closed. It may contain usage information, categories and other content that is not part of the original template page. |
| This template should preferably be substituted. |
The notice is placed at the top of a deletion discussion sub-page or section when you are actively working on the close and intend to post the result as soon as possible. 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.
The tag informs people 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
[edit]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 without locking:
{{subst:Being closed|closer=[[User:{{subst:REVISIONUSER}}|{{subst:REVISIONUSER}}]]|lock=no}}
Transcluded with locking:
{{Being closed|closer=[[User:{{subst:REVISIONUSER}}|{{subst:REVISIONUSER}}]]|lock=yes}}
The Being closed template message is placed at the top of a deletion discussion sub-page or section when you are actively working on the close and intend to post the result as soon as possible. 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.
If substituted, the notice displays the user who added it along with a timestamp. If left as a live transclusion, it instructs readers to check the page history for that information instead.
Soft-resticting the discussion
[edit]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:
- When the template is substituted, locking is on by default. Set
|lock=noto substitute the notice without locking the page. - When the template is left as a live transclusion, locking is off by default. Set
|lock=yesto lock the page anyway. - 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.
TemplateData
[edit]TemplateData for Being closed
Notifies editors that a discussion is currently being closed, to reduce edit conflicts and duplicated effort.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Closer | closer | The editor, or group of editors, who is closing the discussion.
| String | 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').
| Boolean | optional |
| Estimate | estimate | The estimated time when the close will be complete.
| 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.
| String | optional |
| Lock discussion | lock restrict | Whether to disable replies, 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.
| Boolean | optional |
See also
[edit]- {{In use}}, similar template used to notify readers that a large edit is taking place
- Closure:
- WP:Closing discussions - information page regarding closing discussions