DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:whoisonline

whoisonline Plugin

Compatible with DokuWiki

  • 2017-02-19 "Frusterick Manners" unknown
  • 2016-06-26 "Elenor Of Tsort" unknown
  • 2015-08-10 "Detritus" unknown
  • 2014-09-29 "Hrun" yes

plugin Counts the users actively using the wiki site and can make a list of their locations

Last updated on
2013-06-20
Provides
Syntax
Repository
Source

Tagged with ajax, users

Installation

Copy the whoisonline folder into the /lib/plugins folder and that should do it. Please keep the name the same since the ajax portion is specifically looking for that location. The plugin uses a file to store the active users, no database necessary.

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.

Examples/Usage

For just a simple display of the online count add this:

~~whoisonline:NOLIST~~

If you want a popup list when you hover over the button just use this:

~~whoisonline~~

The popup list can be customized in the admin configuration. The default is {username}, but you can add all sorts of HTML to make it link to places. Here is what I use on my site…

<a href="/users:{username}">{fullname}</a> - <a href="/{pageid}">{pageid}</a>

This will make the popup list have their fullname that links to their user page on the wiki, and then the current page they are looking at which you can click to.

If you want to track the users but not show the count or the list just add the NOSHOW option on some footer to record their presence, then you can do the regular ~~whoisonline~~ on an admin page to view the results.

~~whoisonline:NOSHOW~~

Syntax

Basic syntax:

~~whoisonline~~
~~whoisonline:nolist~~
~~whoisonline:noshow~~

Configuration and Settings

By default the plugin only tracks users that are logged in. You can track anonymous users by IP address if you uncheck the IgnoreAnonymous option in the admin configuration screen.

By default the users are considered idle if they are not seen by the plugin for 5 minutes. You can change this setting in the admin configuration screen.

Check the styles.css to adjust any formatting. I use this in the sidebar so the width is set to 100% to fill the sidebar. That may not do in your situation.

Change Log

  • 2013-06-20
    • Initial release

Known Bugs and Issues

ToDo/Wish List

  • Tie into a sql database for large user bases
  • Make a buddy list option
  • Add more fields for display line
  • Add some grouping or sorting options
  • Add other languages

FAQ

The idea from this came from this link http://tutorialzine.com/2010/03/who-is-online-widget-php-mysql-jquery/ which had a great code example. I formatted it for my needs and made a Dokuwiki plugin out of it.

Discussion

plugin/whoisonline.txt · Last modified: 2015-02-25 22:22 by 80.12.35.13