View source for Template:UserStatus/doc

{{Documentation subpage}}
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]) -->
{{Substitution|not}}
{{tsh|Userstatus}}
__TOC__
== 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.
*[[User:Enterprisey|Enterprisey]]'s [[User:Enterprisey/StatusChanger.js|StatusChanger.js]] script is compatible with this template.
Default examples if used on a Jimbo Wales user or user talk page:
*<code><nowiki>{{UserStatus}}</nowiki></code> - will read from page - <code><nowiki>User:Jimbo_Wales/Status</nowiki></code>
Using page parameter:
*<code><nowiki>{{UserStatus|User:Jimbo Wales/Status}}</nowiki></code> - will read from page - <code><nowiki>User:Jimbo Wales/Status</nowiki></code>
*<code><nowiki>{{UserStatus|User:Jimbo Wales/My Status}}</nowiki></code> - will read from page - <code><nowiki>User:Jimbo Wales/My Status</nowiki></code>
*<code><nowiki>{{UserStatus|name=Jimbo}}</nowiki></code> - will show "Jimbo" instead of "Jimbo Wales"
*<code><nowiki>{{UserStatus|right=10}}</nowiki></code> - will put the readout 10 ems from the right instead of 3
*<code><nowiki>{{UserStatus|top=10}}</nowiki></code> - will put the readout 10 ems from the top instead of 0
*<code><nowiki>{{UserStatus|fsize=90}}</nowiki></code> - will make the font be 90% of the original 100% size
*<code><nowiki>{{UserStatus|isize=30}}</nowiki></code> - 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:
<pre>
{{UserStatus|User:Jimbo Wales/Status|name=Jimbo|fsize=95|isize=25}}
</pre>

==Trigger and display==
Create your status page with your user name as follows:
; Step one
: Create the [[wp:user subpage|user subpage]] {{code|<nowiki>[[User:(your user name here)/Status]]</nowiki>}}
; Step two
: The content of that page will be one of the triggers shown below, for example:
<pre>
away
</pre>
; 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. 

{| class="wikitable"
! Trigger !! Result
|-
|
|{{UserStatus|demo=}}
|-
|in
|{{UserStatus|demo=in}}
|-
|editing
|{{UserStatus|demo=editing}}
|-
|online
|{{UserStatus|demo=online}}
|-
|offline
|{{UserStatus|demo=offline}}
|-
|busy
|{{UserStatus|demo=busy}}
|-
|sleeping
|{{UserStatus|demo=sleeping}}
|-
|wikibreak
|{{UserStatus|demo=wikibreak}}
|-
|away
|{{UserStatus|demo=away}}
|-
|vandal
|{{UserStatus|demo=vandal}}
|-
|holiday
|{{UserStatus|demo=holiday}}
|-
|school
|{{UserStatus|demo=school}}
|-
|working
|{{UserStatus|demo=working}}
|-
|eating 
|{{UserStatus|demo=eating}} 
|-
|huggle
|{{UserStatus|demo=huggle}}
|-
|twinkle
|{{UserStatus|demo=twinkle}}
|-
|}

; Step four
: Place a [[WP:wikilink|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:
:: {{code|<nowiki>[[User:(your user name here)/Status]]</nowiki>}}
: If you use a pipe after "/Status", then you can make the link appear any way you wish:
:: {{code|<nowiki>[[User:(your user name here)/Status|Change my status]]</nowiki>}}
: That will look like:
:: {{color|#0044b1|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":
<pre>
{{UserStatus|purge=yes}}
</pre>
: 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!'''

==See also==
* {{tl|UserStatusShort}}, an inline version of this template
* {{tl|Statustop}}, <s>which uses the [[WP:QUI|Qui]] status system</s>
* {{tl|StatusTemplate}}, based on [[User:Hersfold/StatusTemplate|Hersfold's Status Template]], which is no longer updated. Most statuses used in ''StatusTemplate'' are compatible with {{tl|UserStatus}}
* [[User:Paine Ellsworth/UserStatus]], another user status option
*{{tlc|[[User:RhinosF1/Template/StatusMonitor]]}} By [[User:RhinosF1]], still in development, happy to take any suggestions. Compatible with Enterprisey's status changer script.

<includeonly>{{Sandbox other||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:User namespace templates]]

}}</includeonly>