View source for Template:Archive top/doc

{{Documentation subpage}}
{{redirect|Template:RMB|the [[renminbi]] currency template|Template:CNY}}
{{#ifeq:{{BASEPAGENAME}}|Archive top|{{template shortcut|atop}}|{{template shortcut|abtm|abot}}}}{{High-use}}

{{Uses TemplateStyles|Template:Archive top/styles.css}}

The pair of templates {{tl|Archive top}} and {{tl|Archive bottom}} is used to close discussions on a talk page or a noticeboard.

When used on a talk page, these templates should be used in conjunction with the [[Wikipedia:Talk page guidelines|talk page guidelines]] and relevant advice at [[Wikipedia:Refactoring talk pages]]. Based on the type of discussion, they can sometimes be used by involved parties to end a discussion.

=== Usage ===
<syntaxhighlight lang="wikitext">{{Archive top|status=|result=}}</syntaxhighlight>
<syntaxhighlight lang="wikitext">{{Archive bottom}}</syntaxhighlight>

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.

The templates have shorthand names: {{tl|atop}} and {{tl|abot}}.

=== Parameters ===
The template {{tl|Archive top}} takes three optional parameters, used for creating a floating box for discussion results:

* <code>status</code>: <code>resolved</code>, <code>withdrawn</code>, <code>moved</code>, <code>none</code>, or any short custom phrase.  A brief header (uppercased) to indicate the status of the discussion. Another name for this parameter is "head".
* <code>result</code>: the result of the discussion. Another name for this parameter is "body".
* <code>bg</code>: the background color for the discussion box. Accepts any valid [[Web colors#HTML color names|HTML color name]] or [[Web colors#Hex triplet|hex triplet]]. Default is <code>EDEAFF</code>.

These parameters are passed through to [[Template:Quote box]] to create the result box.

=== Examples ===
'''Plain archival'''
<syntaxhighlight lang="wikitext" style="width: 60%>{{Archive top}}
{{lorem ipsum}}
{{Archive bottom}}</syntaxhighlight>

{{Archive top}}
{{lorem ipsum}}
{{Archive bottom}}

'''Result box'''
<syntaxhighlight lang="wikitext" style="width: 60%>{{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}}</syntaxhighlight>

{{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}}

'''Result box, no header, bulleted list'''
<syntaxhighlight lang="wikitext" style="width: 60%>
{{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}}
</syntaxhighlight>
{{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}}

== Additional information ==
* For WikiProject proposal closures, see [[Template:REMOVE THIS TEMPLATE WHEN CLOSING THIS WIKIPROJECT PROPOSAL]].

==TemplateData==
<templatedata>
{
	"params": {
		"1": {
			"aliases": [
				"body",
				"outcome",
				"reason",
				"result"
			],
			"description": "Body text of the box in the upper right for describing the close.",
			"label": "Result",
			"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",
	"paramOrder": [
		"1",
		"status",
		"bg",
		"class"
	]
}
</templatedata>

== 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}}

<includeonly>{{sandbox other||
[[Category:Wikipedia archived wrapper templates| {{PAGENAME}}]]

}}</includeonly>