Template:UserStatus/doc

This is a documentation subpage for Template:UserStatus.
It may contain usage information, categories and other content that is not part of the original template page.

This template should not be substituted nor used to tag soft redirects.

Shortcut

{{Userstatus}}

Usage

This template can be used to display a status indicator along the top of your user page and/or user talk page or any subpage of them.
Enterprisey's StatusChanger.js script is compatible with this template.

Default examples if used on a Jimbo Wales user or user talk page:

{{UserStatus}} - will read from page - User:Jimbo_Wales/Status

Using page parameter:

{{UserStatus|User:Jimbo Wales/Status}} - will read from page - User:Jimbo Wales/Status
{{UserStatus|User:Jimbo Wales/My Status}} - will read from page - User:Jimbo Wales/My Status
{{UserStatus|name=Jimbo}} - will show "Jimbo" instead of "Jimbo Wales"
{{UserStatus|right=10}} - will put the readout 10 ems from the right instead of 3
{{UserStatus|top=10}} - will put the readout 10 ems from the top instead of 0
{{UserStatus|fsize=90}} - will make the font be 90% of the original 100% size
{{UserStatus|isize=30}} - will make the image size be 30 pixels rather than 20

Remember that these parameters may be combined in any way you like by use of the pipe symbol ( | ) between parameters. For example:

{{UserStatus|User:Jimbo Wales/Status|name=Jimbo|fsize=95|isize=25}}

Trigger and display

Create your status page with your user name as follows:

Step one: Create the user subpage [[User:(your user name here)/Status]]
Step two: The content of that page will be one of the triggers shown below, for example:

away

Step three: Save the page. That will make your status "away" on the page(s) where you've installed this template. You place only the word "away" on your /Status page to indicate that you are away. To show that you are back, just edit your /Status page and erase "away", then type "in" or "online" or "editing" in place of "away", then save the page. Your status will change wherever you've installed this template to whatever result in the table below that matches its "trigger" that you've used on your /Status page.

Trigger	Result
	UserStatus is Somewhere
in	UserStatus is IN
editing	UserStatus is editing
online	UserStatus is online
offline	UserStatus is offline
busy	UserStatus is busy
sleeping	UserStatus is sleeping
wikibreak	UserStatus is on a wikibreak
away	UserStatus is away
vandal	UserStatus is fighting vandalism
holiday	UserStatus is on holiday
school	UserStatus is at school
working	UserStatus is at work
eating	UserStatus is eating
huggle	UserStatus is huggling
twinkle	UserStatus is twinkling

Step four

Place a wikilink to your /Status page in any convenient place in your user space. You can use that link to quickly change your status anytime. The link will look something like this:

[[User:(your user name here)/Status]]

If you use a pipe after "/Status", then you can make the link appear any way you wish:

[[User:(your user name here)/Status|Change my status]]

That will look like:

Change my status

and will link to your /Status page.

Note: "Somewhere" is the default for this template, which means that if you place this template on your user page or talk page and you haven't created your /Status page, or if you've created your /Status page and left it blank, then your status will appear as "Somewhere" on the page where you've installed this template.

Page refresher link (optional): A link to purge/refresh the page appears below the user status if the "purge" parameter is set equal to "yes":

{{UserStatus|purge=yes}}

If you've changed your status and it still appears as something else, set the purge parameter to yes and click that refreshing link. This will also help those who come to your page, as they can click the refreshing link to make sure they see your updated status.

Enjoy!

Usage

Trigger and display

See also