Extension:OnlineStatus

From MediaWiki.org

Jump to: navigation, search
Manual on MediaWiki Extensions
List of MediaWiki Extensions
OnlineStatus

Release status: beta
Implementation Variable, Parser function, Hook
Description add a preference to show if the user is currently present or not on the wiki
Author(s) IAlex Talk
MediaWiki 1.11.0
License GPLv2 or higher
Download svn (browse)
Parameters $wgAllowAnyUserOnlineStatusFunction
Hooks used

ParserFirstCallInit
MagicWordwgVariableIDs
LanguageGetMagic
ParserGetVariableValueSwitch
InitPreferencesForm
PreferencesUserInformationPanel
ResetPreferences
SavePreferences
BeforePageDisplay

This extension adds a preference to allow each user to select his status and show it on his user (talk) page. The user can use {{ONLINESTATUS}} or {{RAWONLINESTATUS}} to show it. It will also add a subtitle on the page if he checked the check box in his preferences.

Contents

[edit] Installation

  • Download OnlineStatus.php and OnlineStatus.i18n.php.
  • Put them in extensions/OnlineStatus directory of your MediaWiki installation, then edit LocalSettings.php and add the following line :
require_once( "$IP/extensions/OnlineStatus/OnlineStatus.php" );

[edit] Running it

After installing the extension, there will be a new preference that will allow users to select his status and a check box to select if the status should also be displayed with a subtitle. You can display it using:

  • {{ONLINESTATUS}}: a formatted (and translated) string describing the status (exactly the same you can see near the radio boxes in Special:Preferences).
  • {{RAWONLINESTATUS}}: the internal name of the level.
  • {{#anyuseronlinestatus:}}: get online status of any user on any page, if you want the raw version, pass a non empty second parameter.

Note that {{ONLINESTATUS}} and {{RAWONLINESTATUS}} can only be used on user (talk) pages and subpages.
The status can be set in MediaWiki:Onlinestatus-levels, one status per line and each line containing a status has to begin with *. If you add new status, you'll have to create two new messages per status:

  • MediaWiki:Onlinestatus-toggle-name: will appear on Special:Preferences and {{ONLINESTATUS}} magic word
  • MediaWiki:Onlinestatus-subtitle-name: will be the subtitle of user page if he select this status.

[edit] Configuration

The extension also add {{#anyuseronlinestatus:}} parser function that allows to fetch status of any user in the wiki. If you don't want this feature, set $wgAllowAnyUserOnlineStatusFunction to false in LocalSettings.php file.

[edit] See also

Retrieved from "http://www.mediawiki.org/wiki/Extension:OnlineStatus"
Personal tools