Moved into the code repository (svn)

TopicStatsPlugin

Description

This Plugin returns a list of users who have viewed or edited to wiki topic. This plugin can be combined with the TagCloud Plugin to get a tag-cloud of the users.

Syntax Rules

Syntax:

%TOPICSTATS{attributes}%

renders a list of users who have viewed or saved a wiki topic.

Parameters:

• logdate: the month for which you want the data, specified as yyyymm (default: current month)
• web: the web which has the topic (default: current web)
• topic: the topic whose stats will be displayed (default: current topic)
• script: the action whose stats you want to capture, can be one of view, save or all (default: all)

Example

Users who have viewed the current topic (combined with the TagCloud Plugin):

You type:

%TAGCLOUD{%TOPICSTATS{script="view"}%}%

You get: %TAGCLOUD{%TOPICSTATS{script="view"}%}%

Plugin Preferences

Settings specific to your plugin can be stored as preference settings. Default values for these preferences can be set in plugin topics; for example:

• One line description, used by other tools:
  • Set SHORTDESCRIPTION = TopicStats plugin used to display the users who have viewed or edited a wiki topic

This is then referenced using %TOPICSTATSPLUGIN_SHORTDESCRIPTION%.

Known Issues

This plugin will not respect access restrictions set in the wiki. For e.g. you can see a list of users who have edited a wiki topic even if you do not have view access to that page.

Performance Issues

Use of this plugin in a topic will slow down the rendering of this page considerably, so please use it sparingly. Do not put in every topic of your Web.

Installation

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select FoswikiHelp.

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Plugin Info

Author	GuruprasadIyer
Copyright	© 2010, Guruprasad Iyer (guruprasad_iyer@infosys.com)
License	GPL (GNU General Public License)
Version
Release	$Date: 2010/07/25 15:20:19 $
Home
Support

---

This topic: Sandbox > TopicStatsPlugin
Topic revision: 30 Nov 2011, MansoorKhan

---