DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:onlinenumber

The Number of Online Plugin

Compatible with DokuWiki

  • 2018-04-22 "Greebo" yes
  • 2017-02-19 "Frusterick Manners" unknown
  • 2016-06-26 "Elenor Of Tsort" unknown
  • 2015-08-10 "Detritus" unknown

plugin Export the current number of those who is browsing your wiki, in plain text. This plugin is ported from that of PukiWiki (with some customizing).

Last updated on
2018-08-29
Provides
Syntax
Repository
Source

Similar to whoisonline

Tagged with online, statistics, users

:!: このページを日本語でご覧頂けます。(This page is also available in Japanese.)
:!: I’m not a native English speaker, so this page may contain some mistakes in English sentences.

Summary

This plugin shows the current number of people who are browsing your wiki.

I know that there is whoisonline plugin already, but I wanted simpler one, so I ported Online plugin of PukiWiki1) (also, I wanted to practice porting plugins because I'll add some more plugins by porting from PukiWiki).

How Judged as Online

When this plugin is called, it will internally record your IP address (not showed) and the time.
Also, this plugin reads the recorded data, and if there is/are the access(es) in last 10 minutes (the length of time can be changed), the plugin judges that he/she/they is(are) online.

Installation

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Examples/Usage

:!: I changed partitions from “:” to “|”, because I thought that “|” is a less common character than “:”.
:!: Please add ~~NOCACHE~~ macro to the page you'll use this plugin, because the data will be changed in real time and the page shouldn't be cached.
:!: Users will be regarded as online ONLY WHEN this plugin is called (for example, if you use this plugin only in the top page, users in the other pages won't be recognized. Maybe, using this plugin in sidebars or templates is the best way.)

The most simple example is:

{{onlinenumber}} person(s) started to browse this website in the last 10 minutes.

Then exported like 3 person(s) started to browse this website in the last 10 minutes. (if there are 3 visitors online).

Also, you can enter like this:

{{onlinenumber| visitor is online.| visitors are online.}}

Then exported like 1 visitor is online. (if there is 1 user online), and 4 visitors are online. (if there are 4 users online).

See the plugin in action here (sorry but this page is available only in Japanese).

Error

If the plugin couldn't write the file, you'll see this message:

An error on Onlinenumber plugin: "(The place of the file)" is not writable.

This message can be localized (currently available in English and Japanese).

Syntax

{{onlinenumber|message A|message B}}
  • message A: texts following the number of online (when the number is 1)
  • message B: texts following the number of online (when the number is 2 or more)

Configuration and Settings

You can change the following setting by using the Configuration Manager.

OptionDescriptionValue TypeDefault Value
onlinesecondsSeconds judging as online (Access within this number of seconds will be judged as online)numeric60 * 102)

The description of configuration can be shown in:

  • English
  • Japanese

Development

Change Log

  • 2018-05-15
    • Initial release
  • 2018-05-22
    • Little change
  • 2018-06-18
    • Updating with some improvement. Allowed the localization of the error message.
  • 2018-08-29
    • Added a htaccess file

Known Bugs and Issues

Currently none

Contact Me

If you find some problems in this plugin, you can make issue topics on the GitHub page, or if you wanna contact me for other things, you can contact me by:

Discussion

1)
according to the license of the original plugin
2)
10 minutes
plugin/onlinenumber.txt · Last modified: 2018-08-29 17:30 by hokkaidoperson