Template:Archive box
From Wikipedia, the free encyclopedia
 Archives |
Template documentation
Contents |
Alternative
The {{talkheader}} template automatically includes links to archive subpages, assuming the archive subpages are numbered in the standard manner (Archive 1, Archive 2, etc.). If the {{talkheader}} template is on a page, and archive subpages are named in the standard manner, then the talkheader template will display links to the archive pages much like Archive box when used with the Automatic links parameter. It is therefore recommended to use {{talkheader}} in order to reduce the number of templates transcluded on the talk page. Please note, however, that —unlike manually added links— automatic links cannot be pipe named to include e.g. the dates of each archive page.
Usage
Include the archive box in the talk page by adding
{{Archive box|[[/Archive]]}}
to where you want the archive box to appear. Substitute [[/Archive]] with the actual name(s) of the archive page(s) and make sure to add the forward slash '/'. How you present a list of archive pages is up to you. You can e.g. separate them with commas or format them as lists. You can also use [[WP:PIPE|piped links]]. See #Automatic links and #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.
(On some article or wikiproject talk pages, there is more than one right floating box. In that case, the edit links of the text sections next to those boxes often "bunch up". Template:FixBunching provides a solution for that problem.)
Box width
The box width can be set by using the box-width= parameter:
{{Archive box|box-width=13em|[[/Archive]]}}
{{Archive box|box-width=200px|[[/Archive]]}}
The standard width when this parameter is not used is 238px.
Image
For the standard image, the width can be adjusted by using the image-width= parameter:
{{Archive box|image-width=35px|[[/Archive]]}}
The image can also be changed from the default (see #Other icons for examples) using the image= parameter. Please note that if you're using a changed image, the width of that image can not be adjusted with image-width=. Instead, set the image width using normal image syntax, for example:
{{Archive box|image=[[Image:Crystal Clear app file-manager.png|35px]]}}
Automatic links
If all the archives of a talk page are named exactly /Archive 1, /Archive 2 etc. (it will not work with e.g. /Archive1, /Archive 01, or subpages of a subpage, e.g. /Archives/Archive 1), you can use the auto parameter to display links to them all automatically. The list will update itself when new archives are added. If there are also named archives, you can manually add links to those as well.
- Using
auto=yes
The links to the archive pages will appear as simple numbers, separated with commas (1, 2, 3, ...). Note: Archives numbered past 100 will be ignored.
{{archive box|auto=yes}}
The optional root=, links=, and nobr= parameters are passed to {{archive list}} when auto=yes. The following will look for a user's talk-page archives named /Archives/Archive 1, /Archives/Archive 2, etc., and list up to 5 archives per line:
{{archive box
|auto=yes
|root=User_Talk:{{PAGENAME}}/Archives
|links=5}}
- Using
auto=long
If there are no more than 36 archive pages, and you prefer a three-column output, set the auto parameter to "long". The links to the archive pages will appear as Archive 1, Archive 2, etc. The links will be put into lines with a line break after each third link, to create columns. (Re-arranging the columns, e.g. from top to bottom, is not possible with this parameter. However, manually added links can be arranged in columns with {{multicol}}. See the multicol example below.)
{{archive box|auto=long}}
The optional root= parameter is passed to {{archive list}} when auto=long. The following will look for a user's talk-page archives named /Archives/Archive 1, /Archives/Archive 2, etc.
{{archive box
|auto=long
|root=User_Talk:{{PAGENAME}}/Archives}}
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|image=[[Image:File-manager.svg|35px]]|
* [[/Archive 1|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]]}}
|
|
|||||
{{Archive box|
{{multicol}}
'''2006'''<br>
[[/Archive1|1]]<br>
[[/Archive2|2]]<br>
[[/Archive3|3]]<br>
[[/Archive4|4]]<br>
[[/Archive5|5]]<br>
{{multicol-break}}
'''2007'''<br>
[[/Archive6|6]]<br>
[[/Archive7|7]]<br>
[[/Archive8|8]]<br>
[[/Archive9|9]]<br>
[[/Archive10|10]]<br>
[[/Archive11|11]]<br>
{{multicol-break}}
'''2008'''<br>
[[/Archive12|12]]<br>
[[/Archive13|13]]<br>
{{multicol-end}}
}}
|
|
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 |
