We relaunched the TWiki.org project with an expanded TWiki charter, and we invite you to participate! The TWiki.org Code of Conduct agreement took effect on 27 Oct 2008. We ask existing twiki.org users to opt-in. You need to opt-in to participate in the Blog, Codev, Plugins and TWiki webs. -- PeterThoeny - 27 Oct 2008
You are here: TWiki> Plugins Web>PageStatsPlugin (19 Jul 2005, WillNorris)
Tags:
statistics1Add my vote for this tag create new tag
, view all tags

PageStatsPlugin

Displays page statistics log (viewing and saving the page)

Syntax Rules

Write %PAGESTATS% or %PAGESTATS{ parameters }% to display the statistics of topics for the current month.

Parameters

Name Description Default
web Web name %WEB%
topic Topic name %TOPIC%
max Limit the number of entries shown all entries of the current month

Examples

Example Description
%PAGESTATS% All stats of the current topic for the current month
%PAGESTATS{ max="10" }% The 10 latest stats of the current topic for the current month
%PAGESTATS{ web="%INCLUDINGWEB%" topic="%INCLUDINGTOPIC%" }% All stats of the included topic; useful to include a generic statistics page

Sample Output

timestamp user action page ? ip address
25 Oct 2003 - 16:12 TWikiGuest view PageStatsPlugin   10.10.10.60
25 Oct 2003 - 16:27 TWikiGuest view PageStatsPlugin   10.10.10.60

Demos

feel free to improve the examples by editing TWiki:Plugins/PageStatsPlugin

PageStatsPlugin Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %PAGESTATSPLUGIN_SHORTDESCRIPTION%

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Displays page statistics logs

  • Debug plugin: (See output in data/debug.txt)
    • Set DEBUG = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

  • Download the ZIP file from the Plugin web (see below)
  • Unzip PageStatsPlugin.zip in your twiki installation directory. Content:
File: Description:
data/TWiki/PageStatsPlugin.txt Plugin topic
data/TWiki/PageStatsPlugin.txt,v Plugin topic repository
lib/TWiki/Plugins/OoPlugin.pm OoPlugin? Perl module base class
lib/TWiki/Plugins/PageStatsPlugin.pm Plugin Perl module
data/Sandbox/TestTopicPageStatsPlugin.txt Plugin topic test
  • Test if the installation was successful:
    • Sandbox.TestTopicPageStatsPlugin?

Plugin Info

Plugin Author: TWiki:Main/WillNorris
Plugin Version: 25 Oct 2003 (V1.000)
Change History:  
25 Oct 2003: Initial version
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/PageStatsPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/PageStatsPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main/WillNorris - 25 Oct 2003

Topic attachments
I Attachment Action Size Date Who Comment
zipzip PageStatsPlugin.zip manage 6.2 K 25 Oct 2003 - 09:12 WillNorris  
Topic revision: r6 - 19 Jul 2005 - 05:39:38 - WillNorris
 
TWIKI.NET
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback