diff --git a/data/System/TopicStatsPlugin.txt b/data/System/TopicStatsPlugin.txt index 1634b05..eb2a817 100644 --- a/data/System/TopicStatsPlugin.txt +++ b/data/System/TopicStatsPlugin.txt @@ -1,36 +1,79 @@ ----+!! !TopicStatsPlugin -%SHORTDESCRIPTION% + PLEASE DO NOT EDIT THIS TOPIC + + It is automatically generated from the subversion repository, and any changes + you make will simply be overwritten the next time a release is generated. + + Instead, you could check your fix in, raise a bug in the Bugs web, or mail the author. +--> +---+!! %TOPIC% %TOC% ----++ Usage +---++ Description + +This Plugin returns a list of users who have viewed or edited to wiki topic. This plugin can be combined with the [[Extensions/TagCloudPlugin][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 [[Extensions/TagCloudPlugin][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 [[%SYSTEMWEB%.PreferenceSettings][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. ----++ Examples +---++ 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. ----++ Installation Instructions +Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install". -%$INSTALL_INSTRUCTIONS% +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. ----++ Info -Many thanks to the following sponsors for supporting this work: - * Acknowledge any sponsors here +---++ Plugin Info -| Author(s): | | -| Copyright: | © | -| License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] | -| Release: | %$RELEASE% | -| Version: | %$VERSION% | -| Change History: |   | -| Dependencies: | %$DEPENDENCIES% | -| Home page: | http://foswiki.org/bin/view/Extensions/TopicStatsPlugin | -| Support: | http://foswiki.org/bin/view/Support/TopicStatsPlugin | +| Author | Main.GuruprasadIyer| +| Copyright | © 2010, Guruprasad Iyer (guruprasad_iyer@infosys.com) | +| License | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) | +| Version | | +| Release | $Date: 2010/07/20 04:31:12 $ | +| Home | | +| Support | | -