Module:Archive list/doc

This is the documentation page for Module:Archive list

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

This module can be applied to any talk page or discussion archive, and will return links to all the numbered archives of that page or its parent page. By default the module uses the naming convention specified at WP:ARCHIVE, Talk:PAGENAME/Archive 1, with a capital A, a space before the number, and no leading zeros. This module should not usually be substituted – that way, the list of links will update itself whenever a new numbered archive is added.

This module can be used with {{archive box}} to produce a box of numbered archive links without entering them all manually. To do this, use {{archive box|auto=yes}}.

The module is a replacement for the old {{archive list}} template.

Usage

Main

The main function. Returns a list of archive links.

{{#invoke:Archive list|main
| root            = 
| links           = 
| nobr            = 
| prefix          = 
| prefixspace     = 
| linkprefix      = 
| linkprefixspace = 
}}

Count

The count function. Returns the number of the most recent archive.

{{#invoke:Archive list|count
| root            = 
| prefix          = 
| prefixspace     = 
}}

Parameters

Valid parameters are:

root = <root> - use this to specify a root other than that of the page from which the template is transcluded.
links = # - the number of links to display per line. The default is 10.
nobr = yes - set this to yes to remove all line breaks. This parameter cannot be used in conjunction with |links=.
prefix = <prefix> - a custom prefix for the archives, without the number. The default is "Archive ".
prefixspace = yes - adds a space between the prefix and the archive number for prefixes specified with |prefix=.
linkprefix = <linkprefix> - a custom prefix for the display links, without the number. The default is blank.
prefixspace = yes - adds a space between the link prefix and the archive number for prefixes specified with |linkprefix=.

Limitations

The old {{archive list}} template was limited to detecting 200 archives. This module has no such limitation. However, at very high numbers of archives this module might reach the expensive function call limit. On a page with no other templates that call expensive functions, this module should be able to output 400,000+ archive links. On pages with other templates that make expensive function calls, the module may fail sooner.