View source for Template:Yearly archive list/doc

{{Documentation subpage}}
<!-- Categories and interwikis go at the bottom of this page. -->
This template returns a list of existing [[Help:Archiving a talk page|archive]] sub-pages with names that end in a four-digit year (starting at '''2006'''). The list is in short format, i.e. just the four-digit years, separated by commas or {{{para|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 ==
<syntaxhighlight lang="wikitext">
{{ Yearly archive list 
| root   = 
| prefix = 
| sep = 
}}
</syntaxhighlight>
{{para|root}}
:''Default'' = <code>{{((}}FULLPAGENAME}}/.</code>
: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.
{{para|prefix}}
:''Default'' = "Archive " (No quotes, but note trailing space.)
:Specify a base that will be inserted between '''root''' and the four-digit year. Use <code>&amp;#32;</code> 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.
{{para|sep}}
:''Default'' = ", " (No quotes, but note trailing space.)
:Specify the separator between each year. Use <code>&amp;#32;</code> to represent a whitespace between each year/

== Examples ==
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:Deadfire/Archives/2020]] then this:
<syntaxhighlight lang="wikitext">
{{ Yearly archive list
| root   = User talk:Deadfire/Archives
| prefix = 
}}
</syntaxhighlight>
or if placed directly on [[User talk:Deadfire]] this:
<syntaxhighlight lang="wikitext">
{{ Yearly archive list
| prefix = /Archives/
}}
</syntaxhighlight>
will return {{Yearly archive list
| root   = User talk:Deadfire/Archives
| prefix = 
}}.

==Limitations==
<big>The first year must be '''2006''', 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.</big>

== See also ==
*[[Template:Yearly archive list/display]] called by this template

<includeonly>{{Sandbox other||
<!-- Categories and interwikis go here: -->
[[Category:Archival templates]]
}}</includeonly>