Template:Being archived/doc
| This is a documentation subpage for Template:Being archived. It may contain usage information, categories and other content that is not part of the original template page. |
| This template should not be substituted – use {{Being archived}}. |
Usage
[edit source]Use this template on a talk page when you are archiving it, to prevent edit conflicts. Consider it a specialised version of {{in use}}: used only on talk pages, and only for manual archiving. This is not normally necessary; use it if you are doing something complicated, such as move archival or archiving multiple sections one at a time.
Basic usage, for archiving a whole page:
{{archiving}}
If archiving a single section, add section=yes so the banner refers to "this discussion" rather than "this talk page":
{{archiving|section=yes}}
Locking the page
[edit source]By default, this template also disables the reply button, the add-new-section link, and section-edit links on headings, for as long as the notice remains on the page. This is a technical enforcement of the request, on top of the wording of the banner itself, and is meant to stop new replies landing in a section that is about to be moved or removed.
The lock is on by default and applies automatically; nothing needs to be set to enable it. To transclude the banner without the lock, for example if you only want the wording and not the restriction, set |lock=no or its alias |restrict=no (also accepts n, false, off, or 0):
{{archiving|lock=no}}
The lock only affects the page the template is actually placed on. If that page is later transcluded elsewhere, the lock has no effect on the page doing the transcluding.
Removal
[edit source]This template is merely a polite request; if left in place for an extended period, other editors should feel free to remove it. The banner reports the time of the last edit to the page. If more than two hours have passed since that timestamp, you can safely assume the placing editor has forgotten to remove the notice, and you may remove it yourself. Removing the template also removes the lock along with it.
TemplateData
[edit source]TemplateData for Being archived
Inserts a banner asking users not to edit a discussion page for a short time while it is being archived, and by default disables replies, new sections, and section-edit links on that page.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Section | section | If nonempty, the banner refers to 'this discussion' instead of 'this talk page.' Use when archiving a single section rather than the whole page.
| String | optional |
| Lock page | lock restrict | Whether to disable replies, new sections, and section-edit links on the page this notice is placed on. On by default; set to no to transclude the banner without the restriction. Applies only to the page the notice is actually on, not to any page that transcludes it.
| Boolean | optional |
See also
[edit source]- {{In use}}
- {{Talk archive}}