Template:Yearly archive list/doc
 | This is a documentation subpage for Template:Yearly archive list. It may contain usage information, categories and other content that is not part of the original template page. |
| Warning | This template is used on approximately 823,000 pages, or roughly 1% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
This template returns a list of existing archive sub-pages with names that end in a four-digit year (starting at 2003). The list is in short format, i.e. just the four-digit years, separated by commas or sep. Each year is linked to the matching archive. All entries are on a single line with no line breaks, in a format suitable to pass to parameter list of Template:archives. Makes use of Template:Yearly archive list/display, Template:For loop and Module:string.
Usage
[edit source]{{ Yearly archive list
| root =
| prefix =
| sep =
}}
|root=
- Default =
{{FULLPAGENAME}}/. - Can be used to specify which page is searched. The default is the page where the template is placed. Use prefix for anything that belongs between the trailing slash and the year number.
|prefix=
- Default = "Archive " (No quotes, but note trailing space.)
- Specify a base that will be inserted between root and the four-digit year. Use
 to represent a whitespace between the prefix and the year, since leading trailing spaces are stripped from named parameters before being passed. Quotes don't help.
|sep=
- Default = ", " (No quotes, but note trailing space.)
- Specify the separator between each year. Use
 to represent a whitespace between each year.
Examples
[edit source]{{ Yearly archive list
| root = Talk:Ionizing radiation
| prefix = Archive 
}}
will find all the archives of Talk:Ionizing radiation and return
Using the defaults, {{Yearly archive list}}, if placed on Talk:Ionizing radiation, would also return
If the archives are named by year only, immediately preceded by a '/' (slash), then the default prefix must be overwritten. For example, if an archive is of the form User talk:Ytrottier/Archives/2005 then this:
{{ Yearly archive list
| root = User talk:Ytrottier/Archives
| prefix =
}}
or if placed directly on User talk:Ytrottier this:
{{ Yearly archive list
| prefix = /Archives/
}}
will return .
Limitations
[edit source]The first year must be 2003, the final year can not be more than one year in the future. These limitations are to limit the number of expensive parser function calls.
Template data
[edit source]TemplateData for Yearly archive list
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| prefix | prefix | no description | Unknown | optional |
| root | root | no description | Unknown | optional |
| sep | sep | no description | Unknown | optional |
| noredir | noredir | no description | Unknown | optional |
See also
[edit source]- Template:Yearly archive list/display called by this template
- Template:MonthlyArchive Monthly archive template
- Template:Month-year archive nav Monthly archive navigation template
