Template:Top icon/doc
 |
This is a  documentation subpage for Template:Top icon.It contains usage information, categories and other content or metadata that is not part of the original template. |
Please discuss proposed changes on the talk page first.
Editing a template causes all pages that use the template to be re-rendered. If the Template is used often, this can put a lot of load on the servers since it fills up the job queue. [statistics]
 |
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 does not display in the mobile view of Wikipedia; it is desktop only. Read the documentation for an 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 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. 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.
Example
{{Accountcreator topicon}}
{{Rollback topicon}}
{{Autopatrolled topicon}}
Example with blank space
{{Admin topicon|sortkey=1}}
{{Top icon|imagename=Blank 50px.png|sortkey=2}}
{{Oversighter topicon|sortkey=3}}
{{Checkuser topicon|sortkey=4}}
Tracking category
- Category:Pages using Top icon with unknown parameters (0)
- The following parameters are obsolete, "unknown", and no longer functional: |number, |icon_nr, |offset, |extra-offset, |class and |style.
See also