Template:Archive list/doc

This is a documentation subpage for Template:Archive list. It contains usage information, categories, and other content that is not part of the original template page.

Usage

This template puts a list of page archives at the top of a page in a small table. It automatically adds links to the list as they are created. It also provides a link at the bottom for creating the next archive. It is important to use this link, because if the archive name is not in a standard format, [page]/Archive [number], the archive will not be detected and added to the list. Archives must also be sequential. If Archive 5 is not detected, Archive 6 and after will not be detected either. Many formatting options are available but archives that are not in the userspace should only use a few of these, to encourage uniformity. Currently 500 archives are supported (the limits of a single Dynamic Pages List), and archives after 500 will not be searched for or listed.

Syntax

{{Archive list
|pagename=
|title=
|align=
|alink=
|nlink=
|preload=
|width=
|image=
|border=
|background=
|talign=
|lstyle=
|bstyle=
}}

Pagename

If the archive list appears anywhere besides the page being archived, for example a list of other archives on each archive, the full pagename must be specified, including the namespace, or else the archive links will point to "Page name/Archive 1/Archive 1". It has no default value and may be deleted if it is not needed.

Title

The title will be displayed in bold centered text above the archive list. In the userspace, styles may be applied to the title by putting span tags around it. Defaults to "Archives". It may be deleted if this is the title you want.

Align

Specifies where the archive box floats. Text will wrap around the box. Values can be left, right, or center. It defaults to right and can be deleted if a right-align is what is desired.

Alink

Adds a link which will edit the current archive, creating a new section with no header so the additions go to the bottom of the page. It is useful for things such as requests for deletions and featured images nominations since sections are archived as they are completed. Sets alink equal to yes to turn it on. It is turned off by default, and if you want it off, the field can be deleted.

Nlink

Adds a link which will create the next archive in the sequence. It supports preloading and by default it preloads Template:Archive list/Preload. Set nlink to no to turn it off. It is turned on by default and can be deleted if you want it on.

Preload

Sets which page to preload when a new archive is created with nlink. The default is Template:Archive list/Preload.

Date

The date range of the archive. The value date1 refers to the date range of Archive 1. The date range will be displayed in hover text on the link to Archive 1. The text is displayed exactly as it is input, so values other than a date range may be used, however this should only be done in the userspace. The default value of date1 is "Archive 1", and so forth. The fields may be deleted if they are not used.

Userspace Only

The following fields should only be used in the Userspace, since archives outside the userspace should have a uniform appearance. All values can be deleted if no change from default is wanted.

Width

The width of the archive box. The text will wrap if the box is not wide enough, but it looks better if the box is wide enough to accommodate the preset line breaks. As such it may be necessary to increase the width of the box depending on the settings you apply. The default width is 120px.

Image

The image to be displayed above the title. It can be any image on the wiki, or an image hosted on an external host. No formatting is applied by default, the full image link is required. The default is File:Replacement filing cabinet.svg.

Border

CSS code that is used to determine the border, in the format style width color. Note that there are no quotes surrounding the input, and that it is not followed by a semicolon. Defaults to solid 1px #CCC.

Background

The background color. It can be a hexadecimal code (including the #) a color name, or color coordinates. It is not followed by a semicolon. Defaults to #FCFCFC.

Talign

The alignment of the archive list within the box. Defaults to center.

Lstyle

The styles applied to every link in the archive box, including the archive creation link. Its default value is the default link style of your current skin.

Bstyle

The styles applied to the bullets that separate the archive links. Its default value is the default plain text style of your current skin.