CounterPlugin

<--
  Contributions to this plugin are appreciated. Please update the plugin page at
  http://twiki.org/cgi-bin/view/Plugins/CounterPlugin or provide feedback at
  http://twiki.org/cgi-bin/view/Plugins/CounterPluginDev.
  If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Introduction

The CounterPlugin maintains the Visitor count. Right now it is in it's infant state shows the count in Text mode. Would be modified soon to show count in more graphical way.

Syntax Rules

• Edit the topic where you want to display the Visitor Count.
• Write the word %COUNTER_PLUGIN% in this Topic.
• You should see Visitor Counter in the Topic.

Examples

This text:

   * Counter: %COUNTER_PLUGIN%

Renders as follows:

• Counter: 1647

CounterPlugin Global Settings

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

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Show a site visit counter in a TWiki topic

• 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 CounterPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/CounterPlugin.txt	Plugin topic
  lib/TWiki/Plugins/CounterPlugin.pm	Plugin Perl module

• Enable the CounterPlugin in configure.
• Test if the installation was successful: See example above.

Plugin Info

Plugin Author:	TWiki:Main.RahulMundke
Copyright:	© 2003 TWiki:Main.RahulMundke © 2003-2010, TWiki:TWiki.TWikiContributor
License:	GPL (Gnu General Public License)
Plugin Version:	19433 (2010-09-04)
Change History:	<-- versions below in reverse order -->
2010-09-05:	TWikibug:Item6530: Doc improvements; changed TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny
20 Nov 2003:	Initial version
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/CounterPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/CounterPluginDev

Related Topics: TWikiPreferences, TWikiPlugins