Template:Uir/adoc

The following documentation is used by userbox templates of the form Template:User in Region  

This | userbox template will display a userbox describing your association with and will declare your membership in the appropriate user categories when placed on your user page.

Use
The complete syntax for this template is:

 

where:
 * option is the template option number (default=1, see the Options table below)


 * color= an optional userbox background color (default= , see web colors)
 * float= an optional horizontal float of the userbox:
 * float=left (default)
 * float=right</tt>
 * float=none</tt>
 * align=</tt> an optional horizontal alignment of the userbox text:
 * align=left</tt>
 * align=center</tt> (default)
 * align=right</tt>
 * align=justify</tt>
 * nocat=</tt> an optional user category inhibitor:
 * nocat=true</tt> do not declare any user categories
 * nocat=false</tt> declare user categories (default)

Restrictions

 * This template should be invoked from your user page. This template will declare user categories from the user namespace only.

Example
Placing the following Wikitext on your user page:
 *  </tt>

creates the following userbox:

and adds your user page to the following :