Template:Monthly archive list/sandbox

This is the template sandbox page for Template:Monthly archive list (diff).

Template documentation[view] [edit] [history] [purge]

This template is used on approximately 4,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

Function

Creates links to any archives located under the /YYYY/Month schema.

Usage

{{Monthly archive list
| startyear           = <!-- required -->
| monthformat         = <!-- required -->
| root                = 
| auto                = 
| list                = 
| image               = 
| link                = 
| alt                 = 
| search              = 
| search-break        = 
| search-width        = 
| search-button-label = 
| target              = 
| bot                 = 
| age                 = 
| index               = 
| collapsible         = 
| collapsed           = 
| style               = 
| title               = 
| editbox             = 
}}

startyear – first year that has an archive. Should always be specified as it cuts down the number of expensive parser functions (too many of these will break the display of the page)
monthformat – format used for months in the naming scheme. Should almost always be specified with one of the following values: (it also cuts down the number of expensive parser functions)
- m – numerical, single digits for 1 to 9
- mm – numerical, double digits for 01 to 09
- mmm or shortname – short names (Jan, Feb, etc)
- mmmm or longname or name – long names (January, February, etc)
- If omitted or set to anything else, the default is to check for numerical (either single or double digits) and long names. This involves around three times as many expensive parser functions, and should be avoided if possible
root - should be used to specify the root of the archive structure (./Archives for example). Defaults to current page
Also allows through most of the other parameters of {{Archives}} (note that, for this template, the default for title is Archives)

Tracking categories

Category:MonthlyArchive without startyear (3,769)
Category:MonthlyArchive without monthformat (3,772)

Related templates

Template:MonthlyLinks

The above documentation is transcluded from Template:Monthly archive list/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.