Template:Top icon/doc

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

Usage


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

The following parameters are obsolete and no longer functional: undefined, undefined, undefined, undefined, undefined and undefined.