Template:Archive top/doc
This is a documentation subpage for Template:Archive top. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on many 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 template uses TemplateStyles: |
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
{{Archive top|status=|result=}}
Place the {{Archive top}} template below the header containing the discussion, then place {{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
{{Archive top}}
{{lorem ipsum}}
{{Archive bottom}}
The following discussion is closed. Please do not modify it. Subsequent comments should be made on the appropriate discussion page. No further edits should be made to this discussion.
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.
Result box
{{Archive top
|status = none
|result = Twas brillig, and the slithy toves / Did gyre and gimble in the wabe: / All mimsy were the borogoves, / And the mome raths outgrabe.
}}
{{lorem ipsum}}
{{Archive bottom}}
The following discussion is closed. Please do not modify it. Subsequent comments should be made on the appropriate discussion page. No further edits should be made to this discussion.
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.
Result box, no header, bulleted list
{{Archive top
|result = <nowiki/>
* Twas brillig, and the slithy toves
* Did gyre and gimble in the wabe:
* All mimsy were the borogoves,
* And the mome raths outgrabe. }}
{{lorem ipsum}}
{{Archive bottom}}
The following discussion is closed. Please do not modify it. Subsequent comments should be made on the appropriate discussion page. No further edits should be made to this discussion.
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.
TemplateData
<templatedata> { "params": { "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 } }, "description": "Places a purple archive box around archived discussions" } </templatedata>
See also
- {{Archive top green}} and {{Archive top red}} – For archival templates in a color other than the default of blue
- {{Collapse top}} – "Extended content" with a collapse box around the talk page discussion
- {{Discussion top}} – "The following discussion is closed ..."
- {{Hidden archive top}} – "This discussion has been closed ..." with a collapse box around the discussion