SiteReport.pm
NAME
Communiware::Filter::SiteReport - filter to calculate some site month-advancement statistics.
SYNOPSIS
Simple mode:
::SiteReport(start_date,end_date,item_type,item_type,...)
Advanced mode: ::SiteReport(arg1=val1,arg2=val2,...)
DESCRIPTION
Count's per month activity of site community, i.e. number and total size of new items and number of active authors on site.
MODES
SiteReport filter can be invoked in two modes - simple and advansed. In simple mode it just counts number of new items of given types for given period, count their sizes and a number of active authors.
In advanced mode it receives a list of ``separate article types'', a list of ``book article types'' and ``linktypes joining parts to a book'' and some other customization options. It counts totals for given groups of items and, like in simple mode, counts total number of active authors on site.
A mode to run is determined by first parameter: in advanced mode it must be a name-and-value pair satisfying a regexp /\w+[=:].+/. Some of parameters in advanced mode could have no value but the first must have. Any parameter without value can have any true value (usually '1').
PARAMETERS IN ADVANCED MODE
books List types which are counted as books diveded by | (f.e. books=BOOK|MY_BOOK), by default is BOOK.
articles List types which are counted as articles, by default is ARTICLE.
noexternal If true, type EXTERNAL will not be counted
nofile If true, type BINARY will not be counted
ATTRIBUTES ADDED TO CONTEXT
TOTAL_AUTHORS (number, only in advanced mode)
Number of active authors for all period reported.
AUTHORS (number)
Number of active authors for one Month.
BOOK_I_N (number)
Number of books published for one Month.
BOOK_V_N (number)
Volume of materials which are part of books for one Month.
ARTICLE_I_N (number)
Number of articles which are not part of books for one Month.
ARTICLE_V_N (number)
Volume of of articles which are not part of books for one Month.
EXTERNAL_I_N (number)
Number of externals for one Month.
BINARY_I_N (number)
Number of binary files for one Month.
BINARY_V_N (number)
Volume of binary files for one Month.