Template:Archive box/doc
 | This is a documentation subpage for Template:Archive box. It contains usage information, categories and other content that is not part of the original template page. |
Usage
Include the archive box in the article by adding
{{Archive box|[[/Archive]]}}
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 (/Archive 1, /Archive 2 etc.), you can use the auto parameter to display links to them all automatically:
{{archive box|auto=yes}}
The list will update itself when new archives are added. If there are also named archives, you can add links to these as well. Warning: archives numbered past 100 will be ignored.
If there are less than 20 archive pages, and you prefer a larger two-column output, set the auto parameter to "long", all other parameter values will trigger the above format, so if you want longer and more visible links, try:
{{archive box|auto=long}}
Box width and image
The box and image widths can be set by passing their widths as parameters:
{{Archive box|box-width=13em|image-width=35px|[[/Archive]]}}
The image can also be changed from the default, Image:Replacement filing cabinet.svg, for example:
{{Archive box|image=[[Image:Crystal Clear app file-manager.png]]}}
Heading text
Examples
For actual examples of the use of this template, use the what links here link 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).
| Wikitext | Appearance | |||||
|---|---|---|---|---|---|---|
{{archive box|
[[/Archive 1]],
[[/Archive 2]],
[[/December 2005 - January 2006]] and
[[/Deletion discussion]]}}
|
| |||||
{{archive box|
[[/Archive 1]]<br />
[[/Archive 2]]<br />
[[/December 2005 - January 2006]]<br />
[[/Deletion discussion]]}}
|
| |||||
{{archive box|
: [[/Archive 1]]
: [[/Archive 2]]
: [[/December 2005 - January 2006]]
: [[/Deletion discussion]]}}
|
| |||||
{{archive box|
* [[/Archive 1]]
* [[/Archive 2]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}
|
| |||||
{{archive box|
# [[/Archive 1]]
# [[/Archive 2]]
# [[/December 2005 - January 2006]]
# [[/Deletion discussion]]}}
|
| |||||
{{archive box|box-width=14em|image-width=20px|
* [[/Archive 1]]
* [[/Archive 2]]
* [[/December 2005 - January 2006]]
* [[/Deletion discussion]]}}
|
|
Other icons
If you wish to use something other than the default icon, here is a gallery of available icons:
Vista-file-manager.png
Crystal Clear app file-manager.png
system-file-manager.svg
Icon_file_cabinet.png
File-manager.svg
File.svg
golden_file_cabinet.png
Replacement filing cabinet.svg
Related pages
