Template:Archive box
 Archives |
|---|
|
|
Template documentationNote to editors: Please don't categorize this template by editing it directly. Instead, place the category in its documentation page, in its "includeonly" section.
.svg){kind=icon}
This template can be used to display archives of a page in a floating box.
Usage
Include the archive box on the talk page by adding:
Basic syntax
{{Archive box | [[Archive <#>]] }}
Full syntax
{{Archive box
| archivelist = /archivelist
| auto = <short|long|yes|no>
| index = /Archive index
| links = <#>
| search = <yes|no>
| collapsible = <yes|no>
| collapsed = <yes|no>
| box-width = <#px or #em>
| root = Wikipedia_talk:{{PAGENAME}}
| style = <CSS values>
| title = <Alt. title>
| image = [[File:Foo.png|35px]]
| bot = <name of bot>
| units = <time units (defaults to days)>
| age = <#> (defaults to days) |
[[/Archive <#>]], [[/Archive <#>]], [[/Archive <#>]], etc.
}}
Substitute [[/Archive <#>]] with the actual name(s) of the archive page(s). In the above replace each value enclosed inside < and > with an actual value or leave it empty. Replace the File:Foo.png with an actual image or remove that field entirely. Remember to remove the explanation "(defaults to days)". How you present a list of archive pages is up to you. You can separate them with commas or format them as lists. You can also use piped links, see the #Automatic links and #Examples sections below.
Parameters
Placement
The box uses a style that makes it float to the right. In other words, it will be aligned to the right edge of the page and all content following it will flow around the box. (On some article and 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". Use the {{Stack}} template to provide 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.
Search
A search bar which will search the archives of the current page can be added to the bottom of the box by using the |search=yes parameter. Other parameters can adjust the search bar.
- |root= can be used to change the prefix of pages which are searched. The default is the current page name. Example: |root=User talk:Example/Archives will search in pages starting with User talk:Example/Archives/.
- |search-width= can be used to change the width of the text field, in characters. The default is 22, which fits the search bar with the default box width. Note: unlike |box-width=, this is a bare number with no units.
- |search-break=yes will insert a break between the search bar and search button. The default is no.
- |button-label= can be used to change the text on the search button. The default is Search.
{{Archive box | search=yes | [[/Archive <#>]] }}
Image
The image can be changed from the default using the |image = parameter. For example:
{{Archive box | image= [[Image:Crystal Clear app file-manager.png|35px]] | [[/Archive <#>]] }}
Other icons
If you wish to use something other than the default icon, there's a gallery of available icons at Commons:Category:Archive icons.
Style
{{Archive box | style= CSS values | [[/Archive <#>]] }}
Examples of CSS values:
- Talk page colors on non-talk pages
background-color:#F8EABA; border-color:#C0C090;- Other page colors on talk pages
background-color:#F9F9F9; border-color:#AAAAAA;- Font size unchanged
font-size:1em;- Specific example, changing the background color to white
{{archive box | auto=yes | style=background-color:#FFFFFF }}
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, use |auto=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|search=yes|
[[/Archive 1]],
[[/Archive 2]],
[[/January 2008 - December 2008]] and
[[/Deletion discussion]]
}}
|
| ||||
{{archive box| {{plainlist|indent=1|
*[[/Archive 1]]
*[[/Archive 2]]
*[[/January 2008 - December 2008]]
*[[/Deletion discussion]]
}}}}
|
| ||||
{{archive box|
: [[/Archive 1]]
: [[/Archive 2]]
: [[/January 2008 - December 2008]]
: [[/Deletion discussion]]
}}
|
| ||||
{{archive box|image=[[Image:File-manager.svg|35px]]|
* [[/Archive 1|Archive 1]]
* [[/Archive 2|Archive 2]]
* [[/January 2008 - December 2008|January 2008 - December 2008]]
* [[/Deletion discussion|Deletion discussion]]
}}
|
| ||||
{{archive box|index=/Archive index|search=yes|bot=FooArchiveBot|age=90|
# [[/Archive 1]]
# [[/Archive 2]]
# [[/January 2008 - December 2008]]
# [[/Deletion discussion]]
}}
|
| ||||
{{archive box|box-width=10em|
* [[/Archive 1|Archive 1]]
* [[/Archive 2|Archive 2]]
* [[/January 2008 - December 2008|January 2008 – December 2008]]
}}
|
| ||||
{{Archive box|
{{flatlist|
;2007
:[[/Archive1|1]]
:[[/Archive2|2]]
:[[/Archive3|3]]
:[[/Archive4|4]]
:[[/Archive5|5]]
}}{{flatlist|
;2008
:[[/Archive6|6]]
:[[/Archive7|7]]
:[[/Archive8|8]]
:[[/Archive9|9]]
:[[/Archive10|10]]
:[[/Archive11|11]]
}}{{flatlist|
;2009
:[[/Archive12|12]]
:[[/Archive13|13]]
}}
}}
|
| ||||
{{archive box|search=yes|
<center>'''Sorted by date:'''</center>
:#[[/Archive1|August–October 2008]]: Discussion with User.
:#[[/Archive2|August–November 2008]]: Discussion of rewrite.
::[[/Subpage 1]], [[/Subpage 2|2]], [[/Subpage 3|3]]
}}
|
|
See also
- Template:Archived proposal - for replacing page of archive proposal and but keeping it accessible
- Template:Historic artifact start Template:Historic artifact end - for marking historical concepts, issues, or ideas.
- {{Archives}} - automatic listing of archived discussion subpages
- Help:Archiving a talk page