Template:Archive box collapsible/doc

Documentation for Template:Archive box collapsible. The green text contains advanced tips which you may ignore or apply at your own leisure.

Usage

Include the collapsible archive box in the talk page by adding

{{Archive box collapsible|[[/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

This template uses two different visual styles.

Standard style

The standard style makes the box float to the right. This means that where it appears in the page it will be aligned to the right edge of the page and all following content will flow around it.

Large style

Using large=yes as a parameter produces a center-aligned box at 80% page width, which is the standard for talk page templates. If you're using the archive box on an article or wikiproject talk page, you may want to use this to make the box blend in with the rest of the page. Using this parameter disables the box-width option.

{{Archive box collapsible|large=yes|[[/Archive]]}}

Box width

The box width can be set by using the box-width= parameter, with em or px as the unit of measurement:

{{Archive box collapsible|box-width=13em|[[/Archive]]}}

{{Archive box collapsible|box-width=200px|[[/Archive]]}}

The standard width when this parameter is not used is 238px.

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 or /Archive 01), 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 differently named archives, you can still manually add links to those. Note the root= option below in case the archive pages are not direct subpages of the talk page.

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 collapsible|auto=yes|
*[[/manually added example link]]}}

• The optional parameters root=, links=, and nobr= can be used with auto=yes (learn more).
  root= determines the archive root page. The root defaults to the page where the template is transcluded (the talk page itself); thus, where the archive pages are subpages of a different page, it can be specified using root=.
  links= determines the maximum number of links per line, while nobr=yes disables arbitrary linebreaks.
  The following example 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 collapsible
|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.

{{Archive box collapsible|auto=long|
*[[/manually added example link]]}}

• Re-arranging the columns, e.g. from top to bottom, is not possible with auto=long. However, manually added links can be arranged in columns with {{multicol}}. See the multicol example below.
• The optional parameter root= is available with auto=long (see above).

Examples

For actual examples of the use of this template, see the pages that link here.

Wikitext	Appearance
{{archive box collapsible| [[/Archive 1]], [[/Archive 2]], [[/December 2005 - January 2006]] and [[/Deletion discussion]]}}
{{archive box collapsible|box-width=200px| [[/Archive 1]]<br /> [[/Archive 2]]<br /> [[/December 2005 - January 2006]]<br /> [[/Deletion discussion]]}}
{{archive box collapsible| : [[/Archive 1]] : [[/Archive 2]] : [[/December 2005 - January 2006]] : [[/Deletion discussion]]}}
{{archive box collapsible| * [[/Archive 1|Archive 1]] * [[/Archive 2]] * [[/December 2005 - January 2006]] * [[/Deletion discussion]]}}
{{archive box collapsible| # [[/Archive 1]] # [[/Archive 2]] # [[/December 2005 - January 2006]] # [[/Deletion discussion]]}}
{{archive box collapsible|box-width=10em| * [[/Archive 1]] * [[/Archive 2]] * [[/December 2005 - January 2006]] * [[/Deletion discussion]]}}
{{archive box collapsible| {{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}} }}

The below example combines the large=yes parameter with {{multicol}}:

{{archive box collapsible|large=yes|
{{multicol}}
'''2006'''<br>
[[/Archive1|January - March]]<br>
[[/Archive2|April - May]]<br>
[[/Archive3|June - August]]<br>
[[/Archive4|September - October]]<br>
[[/Archive5|November - December]]<br>
{{multicol-break}}
'''2007'''<br>
[[/Archive6|January - February]]<br>
[[/Archive7|March - May]]<br>
[[/Archive8|June - July]]<br>
[[/Archive9|August]]<br>
[[/Archive10|September - October]]<br>
[[/Archive11|November - December]]<br>
{{multicol-break}}
'''2008'''<br>
[[/Archive12|January]]<br>
[[/Archive13|February - March]]<br>
{{multicol-end}}
}}

See also