Template:Hidden archive top/doc
 | This is a documentation subpage for Template:Hidden archive top It contains usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 11,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This is the {{hidden archive top}} or {{hat}} template.
Usage
This template is placed at the top of a discussion (and {{hidden archive bottom}} or {{hab}} at the bottom), and is used to close a discussion and discourage further editing without removing it completely from the page.
This template should only be used by uninvolved editors in conjunction with the talk page guidelines and relevant advice at refactoring. It should not be used by involved parties to end a discussion over the objections of other editors.
The reason for closing can be changed with the |reason= parameter which defaults to "This discussion has been closed. Please do not modify it." Be sure to sign the closure statement. If the default statement is to be left, you may use the |closer= parameter to indicate which user closed the discussion.
Alternatively, the |result= a.k.a. |outcome= parameter can be used to provide a concise, signed summary of why the discussion was "hatted"; it works like the corresponding parameter in the {{Archive}} template, and puts this closure note in a right-hand sidebar box above the closed discussion.
The subtext that appears upon expansion can also be modified, with the |2= parameter, which defaults to the same, but with red text.
|expand=yesor|collapse=no- Will leave the material uncollapsed with the border and coloring. Default is to collapse the material. Any value will have this effect (i.e.
|expand=noand|collapse=yeswill not work as expected). If either of these two parameters are set, it will allow text within the template to be seen when the section in which it resides is placed into an archive (as described in help:archive).
TemplateData
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| 1 | 1 | no description | Unknown | optional |
| 2 | 2 | no description | Unknown | optional |
| no description | Unknown | optional | |
| expand | expand | no description | Unknown | optional |
| collapse | collapse | no description | Unknown | optional |
| reason | reason | no description | Unknown | optional |
| result | result | no description | Unknown | optional |
| closer | closer | no description | Unknown | optional |
Examples
{{hat}}
| This discussion has been closed. Please do not modify it. |
|---|
| The following discussion has been closed. Please do not modify it. |
| Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. |
This is the default template without any additional parameters.
{{hat|reason=Please don't use the talk page for general discussion. See [[WP:TALK]] for more information.}}
| Please don't use the talk page for general discussion. See WP:TALK for more information. |
|---|
| The following discussion has been closed. Please do not modify it. |
| Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. |
This example uses the reason parameter to replace the default text in the header.
{{hat|2=Please don't use the talk page for general discussion. See [[WP:TALK]] for more information.}}
| This discussion has been closed. Please do not modify it. |
|---|
| Please don't use the talk page for general discussion. See WP:TALK for more information. |
| Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. |
Alternatively, you can use the 2 parameter to change the default subtext inside the template instead of changing the default text in the header.
{{hat|closer=ExampleUser}}
| This discussion has been closed by ExampleUser. Please do not modify it. |
|---|
| The following discussion has been closed by ExampleUser. Please do not modify it. |
| Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. |
This example uses the closer parameter to sign the template without changing the default text of the header.
See also
- {{Collapse top}}, collapses discussion without advisement not to modify
- {{Discussion top}}, does not collapse discussion but advises not to modify
- {{Archive top}}, does not collapse discussion, but advises not to modify (usually used in the Wikipedia name space).
