View source for Template:Archive box/doc

{{documentation subpage}}

== Usage ==
Include the archive box in the article by adding
<pre>{{Archive box non-auto|[[/Archive]]}}</pre>
to where you want the archive box to appear. Make sure to add the forward slash '/' to the archive name to make it a subpage of the page where the archive box is placed. How you present a list of archive pages is up to you. You can separate them with commas, pipes (vertical lines: '|') or as lists. See [[#Examples]] below.

=== Placement ===
The box uses a style that makes it float to the right. This means that where it appears in the page it will be aligned to the right edge of the page (more accurately: the containing box, but that is an unnecessary detail) and all following content will flow around it.

=== Automatic links ===
If all the archives of a talk page are numbered (like <tt>/Archive 1</tt> or <tt>/Archive 2</tt>) or dated (like <tt>/{{#time:Y| - 1 year}}</tt> or <tt>/{{#time:Y}}</tt>), you can use {{tim|archive box auto}} to display links to them all automatically. The list will update itself when new archives are added.
<pre>
 {{archive box auto}}
 -or-
 {{archive box auto|auto=dated}}
</pre>

If there are also named archives, you can add links to these as well:
<pre>
 {{archive box auto|auto=dated|
* [[/Some archive/]]}}
</pre>

When using numbered archives with less than 20 archive pages, you can generate a larger two-column output with <tt>auto=long</tt>.

=== Box width and image ===
The box and image widths can be set by passing their widths as parameters:
<pre>{{Archive box non-auto|box-width=13em|image-width=35px|[[/Archive]]}}</pre>

The image can also be changed from the default, [[:File:Filing cabinet icon.svg]], for example:
<pre>{{Archive box non-auto|image=Breathe-system-file-manager.svg}}</pre>

=== Examples ===
For actual examples of the use of these template, use the "what links here" links [[Special:Whatlinkshere/Template:Archive box non-auto]] and [[Special:Whatlinkshere/Template:Archive box]] in the toolbox on the sidebar, near the top on the left side of this page (unless you are using an unconventional skin … in which case you probably know what you are doing).

{| class="wikitable"
! Wikitext !! Appearance
|-
|<pre>{{archive box auto|auto=dated}}</pre>
| {{archive box auto|auto=dated|base=Talk:Stewards policy}}
|-
|<pre>{{Archive box non-auto|
[[/Archive 1]],
[[/Archive 2]],
[[/December 2005 - January 2006]] and
[[/Deletion discussion]]}}</pre>
|{{Archive box non-auto|
[[/Archive 1]],
[[/Archive 2]],
[[/December 2005 - January 2006]] and
[[/Deletion discussion]]}}
|-
|<pre>{{Archive box non-auto|
[[/Archive 1]]<br />
[[/Archive 2]]<br />
[[/December 2005 - January 2006]]<br />
[[/Deletion discussion]]}}</pre>
|{{Archive box non-auto|
[[/Archive 1]]<br />
[[/Archive 2]]<br />
[[/December 2005 - January 2006]]<br />
[[/Deletion discussion]]}}
|-
|<pre>{{Archive box non-auto|
: [[/Archive 1]]
: [[/Archive 2]]
: [[/December 2005 - January 2006]]
: [[/Deletion discussion]]}}</pre>
|{{Archive box non-auto|
: [[/Archive 1]]
: [[/Archive 2]]
: [[/December 2005 - January 2006]]
: [[/Deletion discussion]]}}
|-
|<pre>{{Archive box non-auto|
* [[/Archive 1]]
* [[/Archive 2]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}</pre>
|{{Archive box non-auto|
* [[/Archive 1]]
* [[/Archive 2]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}
|-
|<pre>{{Archive box non-auto|
# [[/Archive 1]]
# [[/Archive 2]]
# [[/December 2005 - January 2006]]
# [[/Deletion discussion]]}}</pre>
|{{Archive box non-auto|
# [[/Archive 1]]
# [[/Archive 2]]
# [[/December 2005 - January 2006]]
# [[/Deletion discussion]]}}
|-
|<pre>{{Archive box non-auto|box-width=14em|image-width=20px|
* [[/Archive 1]]
* [[/Archive 2]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}</pre>
|{{Archive box non-auto|box-width=14em|image-width=20px|
* [[/Archive 1]]
* [[/Archive 2]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}
|}
<templatedata>
{
	"params": {
		"1": {},
		"translated": {
			"type": "unbalanced-wikitext"
		},
		"uselang": {},
		"auto": {},
		"box-width": {},
		"image": {},
		"image-width": {},
		"base": {},
		"title": {
			"description": "Changing the title of box.",
			"type": "unbalanced-wikitext",
			"default": "Archives"
		}
	},
	"format": "inline"
}
</templatedata>

===Other icons===
If you wish to use something other than the default icon, here is a gallery of available icons:

<gallery>
Breathe-system-file-manager.svg|Breathe-system-file-manager.svg
Dolphin-icon.svg|Dolphin-icon.svg
Faenza-system-file-manager.svg|Faenza-system-file-manager.svg
Filing cabinet icon.svg|Filing cabinet icon.svg
Fxemoji u1F5C4.svg|Fxemoji u1F5C4.svg
Gnome-system-file-manager.svg|Gnome-system-file-manager.svg
Noto Emoji Pie 1f5c4.svg|Noto Emoji Pie 1f5c4.svg
Replacement filing cabinet.svg|Replacement filing cabinet.svg
Twemoji2 1f5c4.svg|Twemoji2 1f5c4.svg
Crystal Clear app ark.png|Crystal Clear app ark.png
</gallery>

==See also==
*{{tl|archives}}