UserInfoPlugin
This plugin analyses the log files of your twiki-engine and extracts usefull
information to be displayed on your site.
Warning: please respect the privacy of your users and don't display too much information.
Syntax Rules
Tag | Description |
%VISITORS{format="..." max="..." sep="..." header="..." footer="..."}% | list of users currently logged in defaults: format="\t* $wikiusername" sep="$n" max="unlimited" |
%NRVISITORS% | number of users currently online |
%LASTVISITORS{format="..." max="..." sep="..." days="..." header="..." footer="..."}% | list of users that recently visited the site defaults: format="\t* $date: $wikiusername" sep="$n" max="unlimited" days="1" |
%NRLASTVISITORS{days="..."}% | list of users that recently visited the site defaults: days="1" |
%NRUSERS% | number of registered users |
%NRGUESTS% | number of guest users currently online |
%NEWUSERS{format="..." max="..." sep="..." header="..." footer="..."}% | list of users that recently registerd defaults: format="\t* date: $wikiusername" sep="$n" max="10" |
The format parameter might containt the following variables:
Variable | Description | Valid in |
$counter | enumeration | %VISITORS%, %LASTVISITORS%, %NEWUSERS% |
$wikiname | wikiname of the visitor | %VISITORS%, %LASTVISITORS%, %NEWUSERS% |
$username | username of the visitor | %VISITORS%, %LASTVISITORS%, %NEWUSERS% |
$wikiusername | wikiusername of the visitor | %VISITORS%, %LASTVISITORS%, %NEWUSERS% |
$date | date of last visit/registration | %VISITORS%, %LASTVISITORS%, %NEWUSERS% |
$time | time of last visit | %VISITORS%, %LASTVISITORS% |
$host | host of visitor | %VISITORS%, %LASTVISITORS% |
$topic | topic that a visitor viewed last | %VISITORS%, %LASTVISITORS% |
$n | newline | %VISITORS%, %LASTVISITORS%, %NEWUSERS% |
$quot | double-quote sign | %VISITORS%, %LASTVISITORS%, %NEWUSERS% |
$percnt | percentage sign | %VISITORS%, %LASTVISITORS%, %NEWUSERS% |
$dollar | dollar sign | %VISITORS%, %LASTVISITORS%, %NEWUSERS% |
Plugin Settings
- Set SHORTDESCRIPTION = Render information about users on your TWikiSite
- add a list of host addresses to ignore users comming from them
- add a list of users to ignore
- Set IGNORE_USERS = TestUser?
Plugin Installation Instructions
This plugin has been tested on TWiki/Beijing, TWiki/Cairo and TWiki/Dakar.
If you are installing it on TWiki/Cairo you need the
TWiki:Plugins/SessionPlugin.
TWiki/Dakar has build-in support for cgi sessions.
- Download the ZIP file
- Unzip it in your twiki installation directory. Content:
File: | Description: |
data/TWiki/UserInfoPlugin.txt | Plugin topic |
lib/TWiki/Plugins/UserInfoPlugin.pm | Plugin Perl module |
lib/TWiki/Plugins/UserInfoPlugin/Core.pm | Plugin Perl module |
- (Dakar) Visit
configure
in your TWiki installation, and enable the plugin in the {Plugins} section.
Test
If the plugin is installed correctly then you should get valid output for the tags below:
%NRVISITORS% of %NRUSERS% registered user(s), %NRGUESTS% guest(s) currently online:
%VISITORS%
|
%NRLASTVISITORS{days="1"}% visitor(s) today (09 Dec 2019):
%LASTVISITORS{days="1" format=" * $wikiusername"}%
|
Recently registered users:
%NEWUSERS{max="20"}%
|
Plugin Info
--
TWiki:Main/MichaelDaum - 09 June 2006