CounterPlugin < TWiki

---+ <nop>%TOPIC%
<!--
  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.
--> 
%SHORTDESCRIPTION%
<sticky><div style="float:right; background-color:#eeeeee; margin:0 0 20px 20px; padding: 0 10px 0 10px">
%TOC{title="Page contents"}%
</div></sticky>

---++ Introduction

The <nop>%TOPIC% 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 =%<nop>COUNTER_PLUGIN%= in this Topic.
   * You should see Visitor Counter in the Topic.

---++ Examples

This text:
<verbatim>
   * Counter: %COUNTER_PLUGIN%
</verbatim>

Renders as follows:
   * Counter: %COUNTER_PLUGIN%

---++ <nop>%TOPIC% Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>COUNTERPLUGIN_SHORTDESCRIPTION%==

   * One line description, is shown in the %SYSTEMWEB%.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 ==%TOPIC%.zip== in your twiki installation directory. Content:
     | *File:* | *Description:* |
     | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
     | ==lib/TWiki/Plugins/%TOPIC%.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: | &copy; 2003 TWiki:Main.RahulMundke %BR% &copy; 2003-2010, TWiki:TWiki.TWikiContributor |
|  License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
|  Plugin Version: | 19433 (2010-09-04) |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  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/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |

__Related Topics:__ %SYSTEMWEB%.TWikiPreferences, %SYSTEMWEB%.TWikiPlugins

This topic: TWiki > CounterPlugin
Topic revision: r2 - 2019-01-03 - TWikiAdminUser

Copyright &© 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.CounterPlugin.