Difference between revisions of "Template:Hidden archive top/doc"

From blackwiki
Jump to navigation Jump to search
imported>DePiep
imported>DePiep
Line 20: Line 20:
  
 
===TemplateData===
 
===TemplateData===
 +
<templatedata>
 +
{
 +
"params": {
 +
"1": {},
 +
"2": {},
 +
"": {},
 +
"expand": {},
 +
"collapse": {},
 +
"reason": {},
 +
"result": {},
 +
"closer": {}
 +
}
 +
}
 +
</templatedata>
  
 
=== See also ===
 
=== See also ===

Revision as of 20:37, 25 April 2018

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=yes or |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=no and |collapse=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

No description.

Template parameters

ParameterDescriptionTypeStatus
11

no description

Unknownoptional
22

no description

Unknownoptional

no description

Unknownoptional
Expandexpand

no description

Unknownoptional
Collapsecollapse

no description

Unknownoptional
Reasonreason

no description

Unknownoptional
Resultresult

no description

Unknownoptional
Closercloser

no description

Unknownoptional

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).

Template:Warchivenav