Wiki source for WikkaActivitySummaryAction


Show raw source

=====Activity Summary Action=====
ProjectWikka
http://wikkawiki.org/ActivitySummaryAction

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 Active Pages, as in the [[http://klenwell.com/is/WikkaActivitySummaryAction#output section below]]. 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 address.

A package including all the necessary files is available here:
http://code.google.com/p/klenwell/downloads/detail?name=wikka_action_activitysummary-v0.9.1.tgz

To install, download the package and copy the files into your wikka root.

====Requirements====
PHP 5.1+
Activity Summary Action ([[http://code.google.com/p/klenwell/source/browse/trunk/projects/php/wikka/plugins/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]])
[[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)
[[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.1.tgz
$ cp -Rf wikka_action_activitysummary/* /PATH/TO/wikka/
%%

====Usage====
===Wikka Page Code===
%%
{{activitysummary interval="24" activepages="10" emailto="admin@example.com"}}
%%
==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)

==Cron Settings for This Site==
%%
10 0 * * * php /var/www/wikka/cli.php AdminActivity
%%

====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>""

====Output====""<div id="output"> </div>""
{{activitysummary activepages="10"}}
Valid XHTML 1.0 TransitionalValid CSSWikkaWiki