Wiki source for ActivitySummaryAction
=====Activity Summary Action=====
For latest information and updates, please see http://klenwell.com/is/WikkaActivitySummaryAction
====Overview====
The Activity Summary Action has three different modes: Viewer, Admin, and CLI. An ordinary viewer looking at it in a browser will see the most actively edited pages for the period, as demonstrated here: [[http://klenwell.com/is/WikkaActivitySummaryAction#output | klenwell.com]]. An admin will see that as well as a plain text report, as in the screenshot below. And in CLI mode, a plain text report will be emailed to a specified set of addresses.
The current release with all necessary files is available here:
http://code.google.com/p/klenwell/downloads/detail?name=wikka_action_activitysummary-v0.9.1.tgz
This release is still somewhat unstable. It has been well-tested, but only in a limited number of environments. There may still be some undiscovered minor issues. Constructive feedback is appreciated and will be used toward preparing the v1.0 release. Issues can be reported at my [[http://code.google.com/p/klenwell/issues/list | Google Code Issues page]] or in the comments below.
====Requirements====
PHP 5.1+
Activity Summary Action ([[http://code.google.com/p/klenwell/source/browse/trunk/projects/php/wikka/actions/activitysummary.php | source]])
Klenwell Wikka Action Class ([[http://code.google.com/p/klenwell/source/browse/trunk/projects/php/wikka/libs/action.class.php | source]])
[[http://klenwell.com/is/WikkaCommandLineInterface | Klenwell Wikka Command Line Interface]] with cli page handler
PhpMailer (in [[http://code.google.com/p/klenwell/source/browse/trunk/projects/php/#php/wikka/3rdparty/plugins/phpmailer | 3rdparty/plugins]] directory)
[[http://klenwell.com/is/WikkaConfiguration | Klenwell Wikka Config]] (for gmail integration) ([[http://code.google.com/p/klenwell/source/browse/trunk/projects/php/wikka/wikka.config.php.default | source]])
The files are all included in the download package.
====Installation====
Unzip the archive and copy the contents of this package to your wikkawiki root
directory:
%%
$ tar xf wikka_action_activitysummary-v0.9.tgz
$ cp -Rf wikka_action_activitysummary/* /PATH/TO/wikka/
%%
====Usage====
===Wikka Page Code===
%%
{{activitysummary interval="24" activepages="10" emailto="[email protected]"}}
%%
==Action Parameters==
~- **interval** : period in hours to report on (default: 24)
~- **activepages** : list length in the Active Pages section (default: 5)
~- **emailto** : email or comma-separated string of emails (default: admin_email from config file)
===From Command Line===
%%
php /var/www/wikka/cli.php -c klenwell.com ActionWikkaSummary
%%
== Command Line Options==
~- **-c** configuration file key (if no key, will use default config settings)
====Screenshots====
===Admin Browser View===
""<a href="http://imgur.com/RFUmI?full"><img src="http://i.imgur.com/RFUmIl.jpg" title="admin view" alt="admin view" /></a>""
For latest information and updates, please see http://klenwell.com/is/WikkaActivitySummaryAction
====Overview====
The Activity Summary Action has three different modes: Viewer, Admin, and CLI. An ordinary viewer looking at it in a browser will see the most actively edited pages for the period, as demonstrated here: [[http://klenwell.com/is/WikkaActivitySummaryAction#output | klenwell.com]]. An admin will see that as well as a plain text report, as in the screenshot below. And in CLI mode, a plain text report will be emailed to a specified set of addresses.
The current release with all necessary files is available here:
http://code.google.com/p/klenwell/downloads/detail?name=wikka_action_activitysummary-v0.9.1.tgz
This release is still somewhat unstable. It has been well-tested, but only in a limited number of environments. There may still be some undiscovered minor issues. Constructive feedback is appreciated and will be used toward preparing the v1.0 release. Issues can be reported at my [[http://code.google.com/p/klenwell/issues/list | Google Code Issues page]] or in the comments below.
====Requirements====
PHP 5.1+
Activity Summary Action ([[http://code.google.com/p/klenwell/source/browse/trunk/projects/php/wikka/actions/activitysummary.php | source]])
Klenwell Wikka Action Class ([[http://code.google.com/p/klenwell/source/browse/trunk/projects/php/wikka/libs/action.class.php | source]])
[[http://klenwell.com/is/WikkaCommandLineInterface | Klenwell Wikka Command Line Interface]] with cli page handler
PhpMailer (in [[http://code.google.com/p/klenwell/source/browse/trunk/projects/php/#php/wikka/3rdparty/plugins/phpmailer | 3rdparty/plugins]] directory)
[[http://klenwell.com/is/WikkaConfiguration | Klenwell Wikka Config]] (for gmail integration) ([[http://code.google.com/p/klenwell/source/browse/trunk/projects/php/wikka/wikka.config.php.default | source]])
The files are all included in the download package.
====Installation====
Unzip the archive and copy the contents of this package to your wikkawiki root
directory:
%%
$ tar xf wikka_action_activitysummary-v0.9.tgz
$ cp -Rf wikka_action_activitysummary/* /PATH/TO/wikka/
%%
====Usage====
===Wikka Page Code===
%%
{{activitysummary interval="24" activepages="10" emailto="[email protected]"}}
%%
==Action Parameters==
~- **interval** : period in hours to report on (default: 24)
~- **activepages** : list length in the Active Pages section (default: 5)
~- **emailto** : email or comma-separated string of emails (default: admin_email from config file)
===From Command Line===
%%
php /var/www/wikka/cli.php -c klenwell.com ActionWikkaSummary
%%
== Command Line Options==
~- **-c** configuration file key (if no key, will use default config settings)
====Screenshots====
===Admin Browser View===
""<a href="http://imgur.com/RFUmI?full"><img src="http://i.imgur.com/RFUmIl.jpg" title="admin view" alt="admin view" /></a>""
