Template:Archive top/doc
{{Documentation subpage}}
{{High-use|demo={{ROOTPAGENAME}}}}
{{#ifeq:{{BASEPAGENAME}}|Archive top|{{template shortcut|atop}}|{{template shortcut|abtm|abot}}}}
{{Uses TemplateStyles|Template:Archive top/styles.css}}
{{redirect|Template:RMB|the renminbi currency template|Template:CNY}}
This template is used to close discussions on a talk page or a noticeboard.
When used on a talk page this template should only be used by uninvolved editors or administrators in conjunction with the talk page guidelines and relevant advice at Wikipedia:Refactoring talk pages. It should not be used by involved parties to end a discussion over the objections of other editors; see WP:SUPERHAT.
= Usage =
Place the {{tl|Archive top}} template below the header containing the discussion, then place {{tl|Archive bottom}} at the end of the discussion.
Do not include main section headers: including main headers will disrupt archiving bots.
= Parameters =
This template takes three optional parameters, used for creating a floating box for discussion results:
status:resolved,withdrawn,moved,none, or any short custom phrase. A brief header (uppercased) to indicate the status of the discussion. Another name for this parameter is "head".result: the result of the discussion. Another name for this parameter is "body".bg: the background color for the discussion box. Accepts any valid HTML color name or hex triplet. Default isEDEAFF.
These parameters are passed through to Template:Quote box to create the result box.
= Examples =
Plain archival
"1": { "aliases": [ "body", "outcome", "reason", "result" ], "description": "Body text of the box in the upper right for describing the close.", "label": "Body", "type": "content" }, "bg": { "label": "Background color", "description": "Color of the box", "default": "#EDEAFF" }, "status": { "label": "Status", "aliases": [ "head", "header", "heading", "2" ], "description": "Header of the box in the upper right for declaring the result of the discussion", "example": "none", "type": "string", "suggestedvalues": [ "resolved", "withdrawn", "moved", "none" ], "suggested": true }, "class": { "description": "A custom CSS class or classes (separated by spaces) that will apply to the entire template output. Mostly for child templates.", "type": "string" } }, "description": "Places a purple archive box around archived discussions" }
See also
- {{tl|Afd top}} "For closed AfD discussions"
- {{tl|Archive top green}} and {{tl|Archive top red}} – For archival templates in a color other than the default of blue
- {{tl|Collapse top}} – "Extended content" with a collapse box around the talk page discussion
- {{tl|Discussion top}} – "The following discussion is closed ..."
- {{tl|Hidden archive top}} – "This discussion has been closed ..." with a collapse box around the discussion
{{Templates for archiving}}
}}