View source for Template:Hidden archive top/doc

{{documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

{{Redirect|{{tl|hat}}|the template concerning [[Wikipedia:hatnote|hatnote]]s|Template:Hatnote}}
{{template shortcut|hat}}
{{high use}}
This is the {{tlx|hidden archive top}} or {{tlx|hat}} template.
{{Template:Collapse Templates}}

=== Usage ===
This template is placed at the top of a discussion (and {{tlx|hidden archive bottom}} or {{tlx|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 [[Wikipedia:talk page guidelines|talk page guidelines]] and relevant advice at [[wp:refactoring|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 {{para|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 {{para|closer}} parameter to indicate which user closed the discussion.

Alternatively, the {{para|result}} a.k.a. {{para|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 {{tlx|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 {{para|2}} parameter, which defaults to the same, but with red text.

;{{para|expand|yes}} <span style="font-weight: normal;">or</span> {{para|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. {{para|expand|{{!mxt|no}}}} and {{para|collapse|{{!mxt|yes}}}} will 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===
<templatedata>
{
	"params": {
		"1": {},
		"2": {},
		"": {},
		"expand": {},
		"collapse": {},
		"reason": {},
		"result": {},
		"closer": {}
	}
}
</templatedata>

===Examples===
{{hat}}
{{lorem ipsum}}
{{hab}}
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.}}
{{lorem ipsum}}
{{hab}}
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.}}
{{lorem ipsum}}
{{hab}}
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}}
{{lorem ipsum}}
{{hab}}
This example uses the '''closer''' parameter to sign the template without changing the default text of the header.

=== See also ===
* {{tl|Collapse top}}, collapses discussion without advisement not to modify
* {{tl|Discussion top}}, does not collapse discussion but advises not to modify
* {{tl|Archive top}}, does not collapse discussion, but advises not to modify (usually used in the Wikipedia name space).

{{Warchivenav|state=uncollapsed}}

<includeonly>{{Sandbox other|
|<!----Categories below this line, please; interwikis to Wikidata.---->
[[Category:Archival templates]]
[[Category:Collapse templates]]
}}</includeonly>