View source for Template:User WP/doc

{{High-use}}
This [[Help:Template|template]] creates a [[Wikipedia:Userboxes|userbox]] that identifies and [[Wikipedia:User categories|categorizes]] a [[Wikipedia:Wikipedians|user]] as actively participating in a [[Wikipedia:WikiProject|Wikipedia project]], for example:<br/>
{{User WP|Americas|center}}
{{clear}}

== Usage ==
This template invokes {{tln|Userbox}}, automatically adding multiple parameters, including appropriate text, links and categories.
If the project name is listed in the [[Template:User WP/id|switch subtemplate]], this template will also automatically display the right image and colors for the given project, otherwise you can set them using the [[#Named parameters|named parameters]].

The code is formatted according to recommendations in {{section link|Wikipedia:Manual of Style/Accessibility|Color|Animations, video, and audio content}}.

For help with this template, please post a comment on the [[Template_talk:{{ROOTPAGENAME}}|template talk page]] with a {{tl2|reply to}} one or more of the {{history||previous editors}}.

== Parameters ==
=== Unnamed parameters ===
To use this userbox template, place the following line of [[Help:Wikitext|Wikitext]] on [[Special:MyPage|your user&nbsp;page]]:
 '''<code><nowiki>{{User WP|1|2|3}}</nowiki></code>'''
where:
*<code>1</code> is the '''required''' project base name (without the "Wikipedia:WikiProject" prefix, nor the "work&nbsp;group" or "task&nbsp;force" postfix)
*<code>2</code> the optional text alignment:
**<code>center</code> or <code>left</code> (default).
*<code>3</code> for additional parameters:
**<code>break</code> to display a line break between the "WikiProject" prefix and the base name;
**<code>list</code> to display additional links to the project talk, articles and stubs, if the appropriate categories exist.
For examples, see the [[#Examples|appropriate section]] below.

=== Named parameters ===
*<code>{{bg|lightgreen|image}}</code> the optional image base name (without the "File:" prefix).
*<code>{{bg|lightgreen|size}}</code> the optional image size (without the "px" suffix): default is <code>size=39x39</code>.
*<code>{{bg|lightgreen|id-c}}</code> the optional background color for the image: default is <code>id-c={{bg|#DEF|<nowiki>#DEF</nowiki>}}</code>.
*<code>{{bg|lightgreen|info-c}}</code> the optional background color for the info: default is <code>info-c={{bg|#FFFFFD|<nowiki>#FFFFFD</nowiki>}}</code>.
*<code>{{bg|lightgreen|info-fc}}</code> the optional font color for the info, including links.
*<code>{{bg|lightgreen|border-c}}</code> the optional border color: default is <code>border-c={{color|gray|gray}}</code>.
*<code>{{bg|lightgreen|ucat}}</code> the optional user category (without the "Category:" prefix).
*<code>{{bg|lightgreen|nocat}}</code> the optional user category inhibitor:
**<code>nocat=true</code> do not declare the membership category;
**<code>nocat=false</code> declare the membership category (default in User namespace).

==== Other parameters ====
Other optional parameters for userboxes with text instead of the image:
* <code>{{bg|lightgreen|id}}</code>: the id text;
* <code>{{bg|lightgreen|id-fc}}</code>: the id text font color;
* <code>{{bg|lightgreen|id-op}}</code>: the id text other CSS parameters;
* <code>{{bg|lightgreen|id-s}}</code>: the id text size in points (default=14).

== Examples ==
{{flexbox wrap|start}}
* {{temt|User WP|A-League}}
{{User WP|A-League}}{{clear}}
{{flexbox wrap|break}}
* {{temt|User WP|A-League|center}}
{{User WP|A-League|center}}{{clear}}
{{flexbox wrap|end}}{{flexbox wrap|start}}
* {{temt|User WP|Americas}}
{{User WP|Americas}}{{clear}}
{{flexbox wrap|break}}
* {{temt|User WP|Americas|center}}
{{User WP|Americas|center}}{{clear}}
{{flexbox wrap|end}}{{flexbox wrap|start}}
* {{temt|User WP|Disambiguation}}
{{User WP|Disambiguation}}{{clear}}
{{flexbox wrap|break}}
* {{temt|User WP|Disambiguation|center}}
{{User WP|Disambiguation|center}}{{clear}}
{{flexbox wrap|end}}

;Examples with three parameters
{{flexbox wrap|start}}
* {{temt|User WP|Abkhazia|left|list}}
{{User WP|Abkhazia|left|list}}{{clear}}
{{flexbox wrap|break}}
* {{temt|User WP|Abkhazia|center|list}}
{{User WP|Abkhazia|center|list}}{{clear}}
{{flexbox wrap|end}}{{flexbox wrap|start}}
* {{temt|User WP|Canadian sport|left|list}}
{{User WP|Canadian sport|left|list}}{{clear}}
{{flexbox wrap|break}}
* {{temt|User WP|Canadian sport|center|list}}
{{User WP|Canadian sport|center|list}}{{clear}}
{{flexbox wrap|end}}{{flexbox wrap|start}}
* {{temt|User WP|European Union|left|list}}
{{User WP|European Union|left|list}}{{clear}}
{{flexbox wrap|break}}
* {{temt|User WP|European Union|center|list}}
{{User WP|European Union|center|list}}{{clear}}
{{flexbox wrap|end}}

== TemplateData ==
{{Format TemplateData|<templatedata>{
  "description": "This template creates a userbox that identifies you as a member of a Wikipedia project.",
  "params": {
    "1": {
      "label": "WikiProject base name",
      "description": "WikiProject base name, without the 'Wikipedia:WikiProject' prefix, nor the 'work group' or 'task force' postfix",
      "type": "string",
      "default": "Example",
      "required": true
    },
    "2": {
      "label": "Text alignment",
      "description": "Text alignment (center or left)",
      "type": "string",
      "default": "left",
      "example": "center",
      "required": false
    },
    "image": {
      "label": "Id image base name",
      "description": "Image base name, without the 'File:' prefix",
      "type": "wiki-file-name",
      "default": "{{#invoke:Portal|image|{{{1|}}}}}",
      "example": "Portal-puzzle.svg",
      "required": false
    },
    "size": {
      "label": "Id image size",
      "description": "Image size, without the 'px' postfix",
      "type": "string",
      "default": "39x39",
      "required": false
    },
    "id": {
      "description": "Id text, alternative to the image",
      "label": "Id text",
      "type": "string",
      "required": false
    },
    "id-c": {
      "label": "Id image or text background color",
      "type": "string",
      "default": "#DEF",
      "required": false
    },
    "id-fc": {
      "label": "Id text font color",
      "type": "string",
      "default": "black",
      "required": false
    },
    "id-op": {
      "label": "Id text other CSS parameters",
      "type": "string",
      "required": false
    },
    "id-s": {
      "label": "Id text size in points",
      "type": "string",
      "default": "14",
      "required": false
    },
    "info-c": {
      "label": "Info background color",
      "type": "string",
      "default": "#FFFFFD",
      "required": false
    },
    "info-fc": {
      "description": "Info font color, including links",
      "label": "Info font color",
      "type": "string",
      "required": false
    },
    "border-c": {
      "label": "Border color",
      "type": "string",
      "default": "gray",
      "required": false
    },
    "ucat": {
      "label": "User category",
      "description": "User category, without the 'Category:' prefix",
      "type": "wiki-page-name",
      "default": "{{Resolve category redirect|{{#ifexist:Category:WikiProject {{{1}}} participants|WikiProject {{{1}}} participants|{{#ifexist:Category:WikiProject {{{1}}} members|WikiProject {{{1}}} members}}}}}}",
      "example": "WikiProject Italy participants",
      "required": false
    },
    "nocat": {
      "label": "User category inhibitor",
      "description": "User category inhibitor to not declare the WikiProject membership (true or false)",
      "type": "string",
      "default": "false",
      "example": "true",
      "required": false
    }
  }
}</templatedata>
}}

== Redirects ==
* {{tln|User WikiProject}}
* {{tln|User participant}}
* {{tln|Participant}}
* {{tln|Participants}}
* {{tln|Members}}

== See also ==
* [[WP:UBX]]
* [[WP:COLOR]]
* [[HELP:COLOR]]
* {{tln|Userbox}}
* {{tln|Userbox-2}}

View related userboxes at:
* [[Wikipedia:Userboxes/WikiProjects]]
* [[:Category:WikiProject user templates]]
<includeonly>{{Sandbox other||
[[Category:WikiProject userboxes| ]]
}}</includeonly>