Template:UserArchiveSort/doc

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

Usage

This template may be used as a header on the talk page archives of Wikipedia users. It provides an easy to navigate template, fully customizable and easy to add. The only restriction for the template is that it only works when users organize their archives the following way: User talk:Example/Year/Number of archive. In a future, it may be used with different paths.

Fields

Mandatory parameters

The first three fields in the template are introduced without a name, only writing the correspontent value.

(User name): The first parameter to be introduced is the username. it may be written without the User: prefix. As an example, instead of writing {{ArchiveSort|User:Example}}, you must only write {{ArchiveSort|Example}}.
(Year) the second parameter is the year. Easy: just add the year (2012, as an example) after your username. Example:{{ArchiveSort|Example|2006}}
(Archive page number): Add the number of the archive page as the third parameter. As an example, of the path to the third archive talk of 2012 is User:Example/2012/3 (which is the only way the template will work, by now), then write {{ArchiveSort|Example|2012|3}}

Optional parameters

nopastarchive: When added with parameter =yes it deactivates the link to the previous archive page. Useful in cases when the previous archive page doesn't exist. Example: User:Example/2012/0.
nonextarchive:When added with parameter =yes it deactivates the link to the next archive page. Useful in cases when the next archive page doesn't exist. Example: User:Example/2012/last number.
nonextyear:When added with parameter =yes it deactivates the link to the previous archive page. Useful in cases when the next archive year doesn't exist.
nopastyear:When added with parameter =yes it deactivates the link to the previous archive page. Useful in cases when the previous archive year doesn't exist.
background: This parameter gives the user the possibility to change the background color of the template. Always use adding the # followed by the color code. Example: #99FF99.

Example

Adding:

{{UserArchiveSort|Hahc21|2012|1|nopastarchive=yes}}

Returns:

Hahc21's archives	Current discussion	Go to 2011	2012 ← previous year ♦ next archive →	Go to 2013