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

From blackwiki
Jump to navigation Jump to search
imported>SMcCandlish
(→‎Usage: typo)
imported>SMcCandlish
m (typo, consistency)
Line 3: Line 3:
  
 
{{template shortcut|hat}}
 
{{template shortcut|hat}}
This is the {{tl|hidden archive top}} or {{tl|hat}} template.
+
This is the {{tlx|hidden archive top}} or {{tlx|hat}} template.
 
{{Template:Collapse Templates}}
 
{{Template:Collapse Templates}}
  
 
=== Usage ===
 
=== Usage ===
This template is placed at the top of a discussion (and {{tl|hidden archive bottom}} or {{tl|hab}} at the bottom), and is used to close a discussion and discourage further editing without removing it completely from the page.
+
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.
 
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.
Line 18: Line 18:
  
 
=== See also ===
 
=== See also ===
* {{tl|collapse top}}, collapses discussion without advisement not to modify
+
* {{tl|Collapse top}}, collapses discussion without advisement not to modify
* {{tl|discussion top}}, does not collapse discussion but advises not to modify
+
* {{tl|Discussion top}}, does not collapse discussion but advises not to modify
* {{tl |Archive top}}, does not collapse discussion, but advertises not to modify (usually used in the Wikipedia name space).
+
* {{tl|Archive top}}, does not collapse discussion, but advises not to modify (usually used in the Wikipedia name space).
  
 
{{Warchivenav|state=uncollapsed}}
 
{{Warchivenav|state=uncollapsed}}

Revision as of 09:11, 16 September 2017

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.

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