DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:onlinenumber

This is an old revision of the document!


The Number of Online Plugin

Compatible with DokuWiki

Greebo, 2018-04-22

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-05-22
Provides
Syntax
Repository
Source

This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.

Similar to whoisonline

Tagged with online, statistics

:!: このページを日本語でご覧頂けます。(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

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

:!: 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.

The most simple example is:

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

Then exported like 3 person(s) started to browse this website in 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).

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

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.1527001235.txt.gz · Last modified: 2018-05-22 17:00 by hokkaidoperson

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki