Template:Top icon/doc

This is a documentation subpage for Template:Top icon.
Don't forget to purge the contents of the base page upon creating or editing this subpage.  

Purge base's cache

This template was ported from a template from Wikipedia, then modified. It was originally at Template:Top icon/doc. The original authors of this template are shown on the template's edit history page.
This template's documentation was also ported from Wikipedia, originally from Template:Top icon/doc/doc. The original authors of the documentation are shown on the documentation's edit history page.
Wikipedia's text is available under the Creative Commons Attribution-ShareAlike 3.0 Unported License.

Do not use images with licenses requiring attribution in a top icon if you are going to link to somewhere other than the image description page. Not linking to the image is likely to violate the license.

This is a metatemplate used to help build top icons, the little (usually 24x24 pixels) icons in the top-right area of user pages or articles. The template uses the page status indicator system.

For the list of topicon templates, see this page.

Usage

{{Top icon
| imagename    = Image file to use as icon. Use only the name of the file, not the [[File]] link.
| wikilink     = The page to link to. This is where you will be taken when clicking the icon.
| description  = The tooltip will display this text when the mouse pointer hovers over the icon.
| id           = A unique id is required when using different top icons on the same page.
}}

Extra options:

| sortkey      = Allows ordering the icons according to the sortkey given.
| width        = Uses a different width for the images. Default is 20.
| height       = Uses a different height for the images. Default is 20.
| usercat      = Adds a category to be added in userspace.
| maincat      = Adds a category to be added in article mainspace.
| subpage      = For categorization on subpages (default = no).
| nocat        = Disables the automatically added category (default = no).

Top icons are automatically sorted for consistency in articles. For that reason, |sortkey= should only be used in user top icons. Sort keys are sorted alphabetically, so, for example, "19" will sort before "2". If you want to use numbers as sort keys, and you have more than 10 top icons on a page, you must add leading zeroes, e.g. |sortkey=01, |sortkey=02, etc.

|width= and |height= are restrictive, meaning when one parameter is not set explicitly, the default acts as a maximum, even if the other parameter is set higher. To increase the overall size, both must be specified.