Template:User rights/doc

This is a shared documentation page.

Template parameters

This is the TemplateData documentation for this template used by VisualEditor and other tools.

User rights

[[Category:TemplateData documentation{{#translation:}}]]

<templatedata> {

"description": "Use this to create a userbox about user rights.",
"params": {
 "image": {
  "label": "image",
  "description": "File name image to show, excluding the prefix File:",
  "example": "Wikipedia Administrator.svg",
  "type": "wiki-file-name"
 },
 "logo-size": {
  "label": "logo size",
  "description": "width of image",
  "example": "35px",
  "default": "40px",
  "type": "string"
 },
 "RFA": {
  "label": "RFA",
  "description": "page to link to",
  "example": "WP:USER",
  "type": "wiki-page-name"
 },
 "temporary": {
  "label": "temporary",
  "description": "includes 'temporary' before rights",
  "example": "temporary=yes, or temporary=y",
  "type": "string",
  "required": true
 },
 "rights": {
  "label": "rights",
  "description": "name of the user rights",
  "example": "admin",
  "type": "string",
  "required": true
 },
 "where": {
  "label": "where",
  "description": "name of the project",
  "example": "English Wikipedia",
  "type": "string",
  "required": true
 },
 "lang_code": {
  "label": "language code",
  "description": "2 letter language code used in URL to verify rights",
  "example": "ru",
  "default": "en",
  "type": "string"
 },
 "username": {
  "label": "username",
  "description": "username used in URL to verify rights",
  "example": "UPX",
  "default": "BASEPAGENAME",
  "type": "wiki-user-name"
 },
 "group": {
  "label": "group",
  "description": "user right name used in URL to verify rights",
  "example": "sysop",
  "type": "string"
 },
 "info-s": {
  "label": "info size",
  "description": "info box text size",
  "example": "7",
  "default": "8",
  "type": "number",
  "aliases": ["info-size"]
 },
 "nocat": {
  "label": "nocat",
  "description": "disable automatic page category declarations (see WP:NOCAT)",
  "example": "true",
  "type": "string"
 },
 "category": {
  "label": "category",
  "description": "category to place the user page in",
  "example": "Wikipedia administrators",
  "type": "string"
 },
 "id-c": {
  "label": "logo color",
  "description": "Left box background color",
  "example": "#D0D0D0",
  "default": "#DDD",
  "type": "string"
 }
}

}</templatedata>

Usage

This template shows that a user has the account creator right.

Markup	Renders as
{{User rights|rights=[[Wikipedia:User access levels#Administrators|admin]]|where=English Wikipedia}}
{{User rights |image=Wikipedia Administrator.svg |rights=administrator |where=[[Russian Wikipedia]] |group=sysop |lang_code=ru}}
{{User rights |image=Wikipedia Administrator.svg |RFA={{{RFA|}}} |rights=[[Wikipedia:User access levels#Administrators|admin]] |where=[[English Wikipedia]] |lang_code={{{lang_code|}}} |username={{{username|}}} |group=sysop |nocat={{{nocat|}}} |category=Wikipedia administrators}}

See also

• Help:Interwiki linking – for setting correct Template:Param