Template:Top icon/doc

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

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

Usage

{{Top icon
| imagename    = Image file to use as icon.
| 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.

|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.