Template:User status/doc

From Wikipedia, the free encyclopedia

This is a documentation subpage for Template:User status (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

This template allows you to have a box indicating your current status on Wikipedia. It can be placed in the header of the page, have it float to the right, the left, or just normally in the page.

[edit] Usage

{{User status
 | status = 
 | user   = 
 | reason = 
 | position = 
 | float    = 
 | bt = 
 | br = 
 | bb = 
 | bl = 
 | useimage = 
 | images   = 
}}

[edit] Options

Parameter Name Parameter Description Required or

Optional

Status
Status can be anything
Value: Result:
"online"
Green colors
"offline"
Red colors
"busy"
Orange colors
Everything else
Blue colors
Required.
User Replaces default user setting of base page. Optional.
Reason If status is busy, this will set the reason to display of why you are away. Optional.
Position How to position the box. Options are float and top. Default is float.
Float Where the box is positioned. Options can be left, right or none. Default is left. Optional.
bt Top border width. Default is 1px. Optional.
br Right border width. Default is 1px. Optional.
bb Bottom border width. Default is 1px. Optional.
bl Left border width. Default is 1px. Optional.
useimage Set to "True" to have images corresponding to the setting status be displayed. Default is to display no images. Optional.
images Set to a page containing the code to display the images based on status to allow custom images to be used. Default is to use default images. Optional.

[edit] Examples

Status set to online, floating to the right, with no border on the right side.

Code:

{{User status
 | status = online
 | user   = 
 | reason = 
 | float = right
 | bt = 
 | br = 0px
 | bb = 
 | bl = 
}}

Output:

User status is online



Status set to offline, floating to the left, with no border on the top or bottom.

Code:

{{User status
 | status = offline
 | user   = 
 | reason = 
 | float = 
 | bt = 0px
 | br = 
 | bb = 0px
 | bl = 
}}

Output:

User status is offline



Status set to busy, floating to the left, with borders on all sides.

Code:

{{User status
 | status = busy
 | user   = 
 | reason = 
 | float = 
 | bt = 
 | br = 
 | bb = 
 | bl = 
}}

Output:

User status is busy