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 template doesnot display in the mobile view of Wikipedia; it isdesktop only. SeeTemplate:Navbox visibility for a brief explanation.
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 thepage 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).| skin-invert = Sets the `skin-invert` CSS class (which inverts the value of colors when viewed in dark mode) on the image. Intended for default-black icons or others that require this for dark mode visibility.
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.
The following parameters are obsolete and no longer functional:|number=,|icon_nr=,|offset=,|extra-offset=,|class= and|style=.
The page to link to. This is where you will be taken when clicking the icon. 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, as that is likely to violate the license
Example
User:Anomie/Penguin Cabal
Page name
suggested
Description
descriptiontext3
Text displayed in a tooltip when hovering over the icon
Example
This user is in the Penguin Cabal
String
suggested
Id
idname
A unique id, required when using different top icons on the same page
Example
penguin-cabal-topicon
String
optional
Alternative text
alt
The alternative text for the image
String
optional
Sort key
sortkey
Allows ordering the icons according to the sort key given
Example
2
String
optional
Width
width
Sets a different width for the images
Default
20
Number
optional
Height
height
Sets a different height for the images
Default
20
Number
optional
Category in userspace
usercat
Adds a category to be included in userspace
Example
[[Category:Penguins]]
Page name
optional
Category in the article mainspace
maincat
Adds a category to be included in the article mainspace
Example
[[Category:Penguins]]
Page name
optional
Subpage category
subpage
For categorization on subpages
Default
no
String
optional
Disable all categories
nocat
Disables the automatically added category
Default
no
String
optional
Invert brightness in dark mode
skin-invert
Inverts the icon's brightness when using dark mode
