Template:Userbox/doc

This template can be used to quickly create a userbox for display on a user's user page without having to know HTML or Wikitable syntax.

Nonfree images must not be displayed in userboxes, and are subject to summary removal by any editor without any notice being required.

Sandbox reminder

 * Always practice or experiment in the Template:Userbox/sandbox or Template:Userbox/testcases
 * Once you are satisfied: Copy your code!
 * In your Browser's address bar, change "sandbox" or "testcases" to the name of your new Userbox.
 * Example:
 * CHANGE [ http://en.wikipedia.org/wiki/Template:Userbox/sandbox]
 * TO [ https://en.wikipedia.org/wiki/Template:Userbox/WhateverYourNewBoxNameIs]
 * If the name of your new Userbox is taken, create a different name.
 * You will be prompted to Start or Create your new Template Userbox!
 * Paste your code into the space provided.

Usage

 * All parameters are optional.
 * Images should normally be scaled to x45px or less.

Most HTML-based tables use only a handful of these attributes. The following subset can be used to quickly convert an HTML userbox into the format used here:

Microformats

 * bodyclass : This parameter is inserted into the "class" attribute for the userbox as a whole.
 * info-class : This parameter is inserted into the "class" attribute for the info component.

This template supports the addition of microformat information. This is done by adding "class" attributes to various data cells, indicating what kind of information is contained within. To flag a userbox as containing hCard information about a person, for example, add the following parameter:

or

then (for example):

...and so forth.

Examples include:


 * - person
 * - group (WikiProject Microformats)
 * - place (Birmingham)

See WikiProject Microformats for more information on adding microformat information to Wikipedia.

Template Data
{ "description": "This template can be used to quickly create a userbox for display on a user's user page without having to know HTML or Wikitable syntax.", "params": { "bodyclass": { "label": "Body class", "description": "Adds an HTML class attribute to the entire template's HTML table, to allow for styling, emission of microformats, etc.", "type": "string", "required": false },		"border-c": { "label": "Border color", "description": "Color of the outer border", "type": "string", "default": "#999", "required": false, "aliases": [ "border-color" ]		},		"border-s": { "label": "Border width", "description": "border width in pixels", "type": "number", "default": "1", "required": false, "aliases": [ "border-width" ]		},		"float": { "label": "Float", "description": "left|right|none", "type": "string", "default": "left", "required": false, "suggestedvalues": [ "left", "right", "none" ]		},		"id": { "label": "Logo", "description": "id image or text", "type": "content", "required": false, "aliases": [ "3",				"logo" ],			"suggested": true },		"id-a": { "label": "Logo content horizontal alignment", "description": "Horizontal alignment of logo content; left/center/right/justify", "type": "string", "default": "center", "required": false, "suggestedvalues": [ "left", "center", "right", "justify" ]		},		"id-c": { "label": "id-c", "description": "Two-in-one alias for border color and logo background color. Lower priority than border-c and logo-background", "type": "string", "required": false, "aliases": [ "1"			],			"example": "#d0d0d0" },		"id-fc": { "label": "Logo font color", "description": "Logo font color; if not specified, defaults to info font color", "type": "string", "default": "black", "required": false, "aliases": [ "logo-color" ]		},		"id-h": { "label": "Logo height", "description": "Logo box height in pixels", "type": "number", "default": "45", "required": false, "aliases": [ "logo-height" ]		},		"id-lh": { "label": "Logo line height", "description": "Logo line height", "type": "string", "default": "1.25em", "required": false, "aliases": [ "logo-line-height" ]		},		"id-op": { "label": "Extra logo styling", "description": "Add additional arbitrary CSS styling to the logo", "type": "string", "required": false, "aliases": [ "logo-other-param" ],			"example": "opacity: 0.25" },		"id-p": { "label": "Logo padding", "description": "Logo cell padding", "type": "string", "default": "0 1px 0 0", "required": false, "aliases": [ "logo-padding" ]		},		"id-s": { "label": "Logo font size", "description": "Logo text size in points", "type": "string", "default": "14", "required": false, "aliases": [ "5",				"logo-size" ]		},		"id-w": { "label": "Logo width", "description": "id box width in pixels", "type": "number", "default": "45", "required": false, "aliases": [ "logo-width" ]		},		"info-class": { "label": "Info CSS classes", "description": "Adds an HTML class attribute to the \"info\" HTML table-row, to allow for styling, emission of microformats, etc.", "type": "string", "required": false },		"info": { "label": "Info", "description": "info text or image", "type": "content", "required": true, "aliases": [ "4"			]		},		"info-a": { "label": "Info content horizontal alignment", "description": "Horizontal alignment of info content; left/center/right/justify", "type": "string", "default": "left", "required": false, "suggestedvalues": [ "left", "center", "right", "justify" ]		},		"info-c": { "label": "Info background color", "description": "Info background color", "type": "string", "default": "#e0e0e0", "required": false, "aliases": [ "2",				"info-background" ]		},		"info-fc": { "label": "Info font color", "description": "info font color", "type": "string", "default": "black", "required": false, "aliases": [ "info-color" ]		},		"info-lh": { "label": "Info line height", "description": "Info line height", "type": "string", "default": "1.25em", "required": false, "aliases": [ "info-line-height" ]		},		"info-op": { "label": "Extra info styling", "description": "Add additional arbitrary CSS styling to the info", "type": "string", "required": false, "aliases": [ "info-other-param" ],			"example": "opacity: 0.25" },		"info-p": { "label": "Info padding", "description": "info padding", "type": "string", "default": "0 4px 0 4px", "required": false, "aliases": [ "info-padding" ]		},		"info-s": { "label": "Info font size", "description": "info text size in points", "type": "number", "default": "8", "required": false, "aliases": [ "info-size" ]		},		"nocat": { "label": "nocat", "description": "block page category declarations (see WP:NOCAT)", "type": "string", "default": "false", "required": false },		"usercategory": { "label": "usercategory", "description": "user category (optional)", "type": "string", "required": false },		"usercategory2": { "label": "usercategory2", "description": "user category (optional)", "type": "string", "required": false },		"usercategory3": { "label": "usercategory3", "description": "user category (optional)", "type": "string", "required": false },		"usercategory4": { "label": "usercategory4", "description": "user category (optional)", "type": "string", "required": false },		"usercategory5": { "label": "usercategory5", "description": "user category (optional)", "type": "string", "required": false },		"logo-background": { "label": "Logo background color", "description": "Background color of logo", "type": "string", "default": "#ddd" },		"id-class": { "label": "Logo CSS classes", "description": "CSS class or classes for the logo; optional", "type": "string", "default": "(none)" }	},	"format": "block", "paramOrder": [ "bodyclass", "float", "border-c", "border-s", "id", "id-a", "logo-background", "id-c", "id-fc", "id-h", "id-s", "id-lh", "id-p", "id-w", "id-class", "id-op", "info", "info-a", "info-c", "info-fc", "info-lh", "info-p", "info-s", "info-class", "info-op", "nocat", "usercategory", "usercategory2", "usercategory3", "usercategory4", "usercategory5" ] }