User:Acagastya/talk archive navigation/doc

This is the  template. This template displays the talk archive navigation box which is much similar to the talk archive navigation. This template is intended to be used at the top of numbered talk page archives.

Usage
Add  to the top of an archive.

Do not use the Wiki-code substitute for this template.

Who can use it?
This template can be used by editors who manually archive their talk pages. For those who use a bot, the can be used. The bot systematically archives the talk page in a numerical order.

Parameters
This template has three parameters.

Icon Parameter
The icon parameter is used to change the icon for the archive.

Enter the name of the image. I strongly suggest that you only choose an image depicting an arcive.

If you wish to use something other than the default icon, there's a gallery of available icons at commons:Category:Archive icons.
 * The default icon in this template is  Vista-file-manager.png
 * This feature is available in the original template too. DO NOT use any file other than the listed ones to avoid confusion. This parameter is not important, as a default is set as for the template.

Icon Size
The icon size parameter is used to vary the size of the icon used. Please do not make the icon too large or too small. The default value of this parameter is 50px. This parameter is added only in case the icon you choose is bigger than expected to make its size more normal.

If you are using any of the following icons: the size limit should be in the range of 45-55px. Not even an bit greater/smaller than that.

Username
This is the most important parameter which links to the talk page in question place your username in that parameter.

Note that you should use the parameter to fill your username as it was registered, and not change the way capital letters or lowercase were used.

Function
The function of the talk archive navigation is to hide the [edit] link at each section.

This is the only function of the.

Difference between this and the original template
The deviations from original template are:
 * The solid boundary is not present. Instead a 3-dimensional effect is added. (Reason: To have a better look!)
 * Option to change logo size. (Reason: Some icons may be larger than expected, so for making the size normal, use this parameter. DO NOT misuse.)
 * Font. (The font may be different depending on if the device you are using to view the template has that specific font installed.)
 * Link. (Reason: Due to some unknown problems, the link was not functioning. Here it is explicitly linked to the intended talk page.)

Do's and Don'ts
Please follow the rules for this template very thoroughly.
 * Do fill in the parameter  as it is the important part of this template.
 * Do enjoy the freedom of choosing icons from the list (preferably using a .png or .svg file as it is transparent at edges).
 * Do Not misuse the option to change the size of logo.
 * Do Not link someone elses' user talk page to your archive. This will be considered as disruption.

Without entering any options for the parameters in the template
This will be the outcome if you do not fill in any of the parameters. Since  and   have a default value assigned, both will function, BUT …

… NEVER forget to enter the parameter and enter it correctly!