Template:WikiPuma topicon/doc

This is a documentation subpage for Template:WikiPuma topicon.
It may contain usage information, categories and other content that is not part of the original template page.

This template is not blank, it adds a little icon in the top-right corner. See?

This user is a member of the endangered WikiPuma species. Approach with caution and professional grammar.

The icon discretely identifies a user as a WikiPuma.
It is intended as a complement (or alternative) to the WikiPuma user box →

Usage

Icon style

Template icon themes
Default	Alternate

Template syntax

Note: This template is a wrapper for {{Top icon}} metatemplate.

Basic

Place {{WikiPuma topicon}} anywhere on your user page. That's it.

This template accepts one unnamed parameter which changes the tooltip seen when the mouse pointer hovers over the icon. The default is "This user is a WikiPuma" but if you wanted to be more creative, it's done like this:

{{WikiPuma topicon|Rawr! Don't you know better than to surprise a sleepy WikiPuma?}}

Advanced

The template is shown below with all available parameters. Both code layouts function identically, choose whichever suits your needs. It is WP:NOCAT-compliant, meaning you can control whether or not it adds your name to the WikiPuma category (in case you place a high premium on being able to successfully stalk your prey).

The width/height parameters are proportional, so setting just one of them will automatically adjust the other to keep the image in scale, but only for downscaling (shrinking) the icon. To enlarge/upscale you must set custom values for both and calculate the aspect ratio yourself. Width:height for the default icon is 1.7:1 and for the alt icon it's 3:2. Your ratio should be the same or very close, such as 44:25 or 50:29 for the default icon. (38:25 or 45:30 for alt)

Block format

{{WikiPuma topicon
 | alt         = <!-- This template offers two icons: a black puma silhouette by default or a color puma face rectangle if there is a 'yes' value here -->
 | tooltip     = <!-- Custom tooltip - this is an alternate method to the single unnamed parameter style above. Default is 'This user is a WikiPuma' -->
 | sortkey     = <!-- Custom sorting (alphabetical) - Assign a new name or number here to change its place in the lineup. Default is 'WikiPuma-icon' -->
 | nocategory  = <!-- Accepts yes/no values, yes stops your user page from being added to the Wikipedian WikiPumas category. Default is no. -->
 | width       = <!-- Icon width - specify a value in pixels here, don't add 'px' at the end. Default is 35, or 30 if using the alt style.-->
 | height      = <!-- Icon height - specify a value in pixels here, don't add 'px' at the end. Default is 20 for both styles. -->
}}

Inline format

{{WikiPuma topicon|alt=|tooltip=|sortkey=|nocat=|width=|height=}}

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:WikiPuma topicon in articles based on its TemplateData.

TemplateData for WikiPuma topicon

This template identifies a user as a WikiPuma when placed on their user page by adding a puma icon to the top right corner of and adding their name to the Wikipedian WikiPumas category

Template parameters
This template has custom formatting.
Parameter		Description	Type	Status
Icon style	`alt`	This template offers a color puma face icon as an alternative to the traditional black puma silhouette icon. Set this parameter to yes for the color icon. Example yes	String	optional
Tooltip	`1` `tooltip`	Set custom text to be displayed when the mouse pointer hovers over the icon. Can be a value for named parameters 'tooltip' or '1', or the sole unnamed parameter.	String	optional
Custom sorting	`sortkey` `icon_nr` `number`	This number determines the order topicons appear in if you have more than one. Icons are shown left-to-right alphabetically by default, this value overrides the icon name for sorting. Numbers work best, use 0–9 if you have ten topicons or fewer, 00–99 for more than ten. Example 02	String	optional
Exclude from category	`nocat` `nocategory`	This template automatically adds your user page to the Wikipedian WikiPumas category. Giving this parameter the value 'yes' will prevent that. Default no Example yes	String	optional
Icon width	`width`	Specify a custom width for the icon in pixels. Numeric values only, do not add 'px' at the end. Default 35 Example 25	Number	optional
Icon height	`height`	Specify a custom height for the icon in pixels. Numeric values only, do not add 'px' at the end. Default 20 Example 18	Number	optional