Template:Statustop/doc

Description

 * This template can be used to display a status indicator along the top of your user page and/or user talk page.
 * It accepts five parameters that should be placed in Special:MyPage/Status: online, busy, around, offline, and sleep
 * It is compatible with the Qui status system developed by TheDJ
 * You can also import (or copy) statusChanger2.js (or just manually update your status)
 * Will only work in the user/user talk namespaces.

Usage

 * By default, the output will be as follows:
 * Status: Online Ledgreen.png - online
 * Status: Busy Ledorange.png - busy
 * Status: Around Ledblue.png - around
 * Status: Custom Ledblue.png - custom. (if sleep= is defined)
 * Status: Offline Nuvola apps krec.png – offline
 * Status: Sleeping Nuvola apps krec.png – sleep
 * Status: Unknown Ledgray.png – if your status is not being reported correctly or your status page is empty

Parameters
The first parameter is optional and may be used to point to a status page other than Special:MyPage/Status. Can also accept the following named parameters:


 * link : can be used to link the text to a page which explains the status terms (e.g., User:Briggs1/Status legend)


 * img_link : can be used to link the status image (e.g., User:Briggs1/Status legend)


 * offset : can be used to offset the status display further to the left


 * offsettop : can be used to offset further down


 * sleep : redefine the "sleep" parameter to anything you like


 * blink : will prevent flashing in "offline" and "sleep" status when set to any value (such as "no")


 * nocat : to remove a user from the category when they are online

Examples

 * &mdash; the offset parameter is in px units
 * &mdash; the offset parameter is in px units


 * &mdash; the default is to leave the text and image unlinked
 * &mdash; the default is to leave the text and image unlinked


 * &mdash; the img_link parameter accepts both wikipages and external URLs
 * &mdash; the img_link parameter accepts both wikipages and external URLs


 * &mdash; could be used on a bot page to display the bot-op's status.
 * &mdash; could be used on a bot page to display the bot-op's status.


 * &mdash; for setting the custom parameter
 * &mdash; for setting the custom parameter