View source for Template:User rights/doc

{{Documentation subpage}}
<!-- Categories go at the bottom of this page and interwikis go in Bharatdata. -->
<noinclude>
This is a shared documentation page.
</noinclude>
{{#ifeq:{{#invoke:High-use|num|x}}|many||{{High-use}}}}
==Template parameters==
{{#ifeq:{{ROOTPAGENAME}}|User rights
|{{TemplateData header}}
<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": "Bharatpedia 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": "BP: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": "[[Bharatpedia:User access levels#Administrators|admin]]",
   "type": "string",
   "required": true
  },
  "where": {
   "label": "where",
   "description": "name of the project",
   "example": "English Bharatpedia",
   "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 BP:NOCAT)",
   "example": "true",
   "type": "string"
  },
  "category": {
   "label": "category",
   "description": "category to place the user page in",
   "example": "Bharatpedia 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
|<nowiki>{{User rights|rights=[[Bharatpedia:User access levels#Administrators|admin]]|where=English Bharatpedia}}</nowiki>
|{{User rights|rights=[[Bharatpedia:User access levels#Administrators|admin]]|where=English Bharatpedia|nocat=true}}
|<nowiki>{{User rights
|image=Bharatpedia Administrator.svg
|rights=administrator
|where=[[Russian Bharatpedia]]
|group=sysop
|lang_code=ru}}</nowiki>
|{{User rights|image=Bharatpedia Administrator.svg|rights=administrator|where=[[Russian Bharatpedia]]|group=sysop|lang_code=ru|nocat=true}}
|<nowiki>{{User rights
|image=Bharatpedia Administrator.svg
|RFA={{{RFA|}}}
|rights=[[Bharatpedia:User access levels#Administrators|admin]]
|where=[[English Bharatpedia]]
|lang_code={{{lang_code|}}}
|username={{{username|}}}
|group=sysop
|nocat={{{nocat|}}}
|category=Bharatpediaadministrators}}</nowiki>
|{{User rights|image=Wikipedia Administrator.svg|rights=[[Bharatpedia:User access levels#Administrators|admin]]|where=[[English Bharatpedia]]|group=sysop|nocat=true}}
}}

== See also ==
* [[Help:Interwiki linking]] – for setting correct {{param|lang_code}}
|== Usage == 
{{markup
|{{((}}{{PAGENAME}}{{))}}
|{{ {{PAGENAME}} |nocat=true}}
|{{((}}{{PAGENAME}}<nowiki>|[[Russian Bharatpedia]]|lang_code=ru</nowiki>{{))}}
|{{ {{PAGENAME}}|[[Russian Bharatpedia]]|lang_code=ru |nocat=true}}
|{{((}}{{PAGENAME}}<nowiki>|RFA=BP:USER</nowiki>{{))}}
|{{ {{PAGENAME}}|RFA=WP:USER |nocat=true}}
}}
}}

{{User rights templates}}

<includeonly>{{Sandbox other||
{{#ifeq:{{ROOTPAGENAME}}|User rights
|[[Category:User namespace templates|{{SUBPAGENAME}}]]}}
[[Category:User rights templates]]
<!-- Categories go here, and interwikis go in Bharatdata -->
}}</includeonly><noinclude>
[[Category:Documentation shared content templates]]
</noinclude>