Added Awstats XML database schema and a data and style sheet demo file.

diff --git a/README.TXT b/README.TXT
index 4d8ff901b9ba6bd147aeb4343198803fd4e5191e..807818529fafa397b595c497e4651aff68cd64db 100644 (file)
--- a/README.TXT
+++ b/README.TXT
@@ -3,11 +3,11 @@
         Advanced Web Statistics
 ------------------------------------
 
-AWStats (Advanced Web Statistics) is a powerful, full-featured web server\r
-logfile analyzer which shows you all your Web statistics including: visitors,\r
+AWStats (Advanced Web Statistics) is a powerful, full-featured web server
+logfile analyzer which shows you all your Web statistics including: visitors,
 pages, hits, hours, search engines, keywords used to find your site, broken
-links, robots and many more...\r
-\r
+links, robots and many more...
+
 It works with IIS 5.0+, Apache and all major web, wap, proxy, streaming
 server log files (and even ftp servers or mail logs) on all Operating Systems.
 
@@ -35,53 +35,54 @@ I - FEATURES AND REQUIREMENTS
 I - 1) Features
 
        A full log analysis enables AWStats to show you the following information:
-       * Number of VISITS and UNIQUE VISITORS\r
-       * Visits duration and last visits\r
-       * Authenticated users, and last authenticated visits\r
-       * Days of week and rush hours (pages, hits, KB for each day and hour)\r
-       * Domains/countries of hosts visitors (pages, hits, KB)\r
-       * Hosts list, last visits and unresolved IP addresses list\r
-       * Most viewed, entry and exit pages\r
-       * File types\r
-       * Web compression statistics (for mod_gzip or mod_deflate)\r
-       * Browsers used (pages, hits, kb for each browser)\r
-       * OS used (pages, hits, KB for each OS)\r
-       * Robot visits\r
-       * Worm attacks\r
-       * Search engines, keyphrases and keywords used to find your site\r
-       * HTTP errors (Page not found with last referer, etc,)\r
-       * Screen size report\r
-       * Number of times your site is "added to favourites bookmarks"\r\r
+       * Number of VISITS and UNIQUE VISITORS
+       * Visits duration and last visits
+       * Authenticated users, and last authenticated visits
+       * Days of week and rush hours (pages, hits, KB for each day and hour)
+       * Domains/countries of hosts visitors (pages, hits, KB)
+       * Hosts list, last visits and unresolved IP addresses list
+       * Most viewed, entry and exit pages
+       * File types
+       * Web compression statistics (for mod_gzip or mod_deflate)
+       * Browsers used (pages, hits, kb for each browser)
+       * OS used (pages, hits, KB for each OS)
+       * Robot visits
+       * Worm attacks
+       * Search engines, keyphrases and keywords used to find your site
+       * HTTP errors (Page not found with last referer, etc,)
+       * Screen size report
+       * Number of times your site is "added to favourites bookmarks"
        * Ratio of Browsers that support: Java, Flash, RealG2 reader,
          Quicktime reader, WMA reader, PDF reader
-       * Cluster report for load balanced servers ratio\r
-       * Other personalized reports...\r
+       * Cluster report for load balanced servers ratio
+       * Other personalized reports...
 
        It supports the following features as well:
-       * Can analyze all log formats\r
+       * Can analyze all log formats
        * Works from command line and from a browser as a CGI (with dynamic
-         filters capabilities for some charts)\r
+         filters capabilities for some charts)
        * Update of statistics can be made on demand from the web interface and
-         not only from your scheduler\r
-       * Unlimited log file size, support split log files (load balancing system)\r
-       * Support 'nearly sorted' log files even for entry and exit pages\r
-       * Reverse DNS lookup before or during analysis, supports DNS cache files\r
-       * Country detection from IP location or domain name\r
-       * WhoIS links\r
-       * A lot of options/filters and plugins can be used\r
-       * Multi-named web sites supported (virtual servers)\r
-       * Cross Site Scripting Attacks protection\r
-       * Several languages\r
-       * No need of rare perl libraries\r
-       * Dynamic reports as CGI output\r
-       * Static reports in one or framed HTML/XML pages, experimental PDF export\r
-       * Look and colors can match your site design (CSS)\r
-       * Help and tooltips on HTML reported pages\r
-       * Experimental PDF export\r
-       * Easy to use (Just one configuration file to edit)\r
-       * Free (GNU GPL) with sources (perl scripts)\r
-       * A Webmin module\r
-       * Available on all platforms\r
+         not only from your scheduler
+       * Unlimited log file size, support split log files (load balancing system)
+       * Support 'nearly sorted' log files even for entry and exit pages
+       * Reverse DNS lookup before or during analysis, supports DNS cache files
+       * Country detection from IP location or domain name
+       * WhoIS links
+       * A lot of options/filters and plugins can be used
+       * Multi-named web sites supported (virtual servers)
+       * Cross Site Scripting Attacks protection
+       * Several languages
+       * No need of rare perl libraries
+       * Dynamic reports as CGI output
+       * Static reports in one or framed HTML/XHTML pages
+       * Experimental PDF export
+       * Look and colors can match your site design (CSS)
+       * Help and tooltips on HTML reported pages
+       * Easy to use (Just one configuration file to edit)
+       * Analysis database can be stored in XML format for XSLT processing
+       * A Webmin module
+       * Free (GNU GPL) with sources (perl scripts)
+       * Available on all platforms
 
 
 I - 2) Requirements
@@ -89,8 +90,8 @@ I - 2) Requirements
        To use AWStats CGI script, you need the following requirements:
        * Your server must log web access in a log file you can read.
        * To run awstats, from command line, your operating system must be able
-         to run perl scripts (.pl files).\r
-         \r
+         to run perl scripts (.pl files).
+         
        To run awstats as a CGI (for real-time
          statistics), your web server must also be able to run such scripts.
          If not, you can solve this by downloading last Perl version at:
@@ -105,31 +106,32 @@ I - 3) Files
        docs/LICENSE                        GNU General Public Licence
        docs/*                              AWStats documentation (setup/usage...)
        wwwroot/cgi-bin/awstats.pl          THE MAIN AWSTATS PROGRAM (CLI/CGI)
-       wwwroot/cgi-bin/awredir.pl          A tool to track exit clicks\r
-       wwwroot/cgi-bin/awstats.model.conf  An model configuration file\r
+       wwwroot/cgi-bin/awredir.pl          A tool to track exit clicks
+       wwwroot/cgi-bin/awstats.model.conf  An model configuration file
        wwwroot/cgi-bin/lang                Directory with languages files
        wwwroot/cgi-bin/lib                 Directory with awstats reference info
        wwwroot/cgi-bin/plugins             Directory with optional plugins
        wwwroot/icon/browser                Directory with browsers icons
-       wwwroot/icon/clock                  Directory with clock icons\r
+       wwwroot/icon/clock                  Directory with clock icons
        wwwroot/icon/cpu                    Directory with cpu icons
-       wwwroot/icon/flags                  Directory with country flag icons\r
-       wwwroot/icon/os                     Directory with OS icons\r
+       wwwroot/icon/flags                  Directory with country flag icons
+       wwwroot/icon/os                     Directory with OS icons
        wwwroot/icon/other                  Directory with all others icons
        wwwroot/classes                     Java applet for graphapplet plugin
        wwwroot/css                         Samples of CSS files
        wwwroot/js                          Javascript sources for "Misc" feature
        tools/*                             Other provided tools
-       tools/webmin/awstats-x.x.wbm        A Webmin module for AWStats\r
+       tools/xslt/*                        Demo to manipulate AWStats XML database
+       tools/webmin/awstats-x.x.wbm        A Webmin module for AWStats
 
 
 
 II - INSTALL, SETUP AND USE AWSTATS
 -----------------------------------
 
-The documentation available for this release in HTML format is\r
-in the docs/ directory.\r
-\r
+The documentation available for this release in HTML format is
+in the docs/ directory.
+
 You can find a most up-to-date documentation at:
 http://awstats.sourceforge.net
 

diff --git a/docs/awstats_what.html b/docs/awstats_what.html
index a642ba681d32ca1066eef2e84739a5977067674b..f9c17c3c3f23bf59e33c107de572c29eaa81372e 100644 (file)
--- a/docs/awstats_what.html
+++ b/docs/awstats_what.html
@@ -86,13 +86,16 @@ As AWStats works from the command line but also as a CGI, it can work with major
        * Cross Site Scripting Attacks protection,<br>
        * Several languages. See <a href="awstats_faq.html#LANG">AWStats F.A.Q.</a> for full list.<br>
        * No need of rare perl libraries. All basic perl interpreters can make AWStats working,<br>
-       * Graphical and framed reports,<br>
+       * Dynamic reports as CGI output.<br>
+       * Static reports in one or framed HTML/XHTML pages, experimental PDF export,<br>
        * Look and colors can match your site design, can use CSS,<br>
        * Help and tooltips on HTML reported pages,<br>
        * Easy to use (Just one configuration file to edit),<br>
-    * Absolutely free (even for web hosting providers), with sources (<a href="awstats_license.html">GNU General Public License</a>)<br>
+       * Analysis database can be stored in XML format for XSLT processing,<br>
+       * A Webmin module,<br>
+    * Absolutely free (even for web hosting providers), with sources (<a href="docs/awstats_license.html">GNU General Public License</a>),<br>
        * Available on all platforms,<br>
-       * AWStats has a <a href="pad_awstats.xml" target=_newawstats>XML Portable Application Description</a>.<br>
+       * AWStats has a <a href="docs/pad_awstats.xml" target=_newawstats>XML Portable Application Description</a>.<br>
 <br>
        <b>Requirements</b>:<br>
        To use AWStats, you need the following requirements:<br>

diff --git a/tools/xslt/README.txt b/tools/xslt/README.txt
new file mode 100644 (file)
index 0000000..fd69f56
--- /dev/null
+++ b/tools/xslt/README.txt
@@ -0,0 +1,22 @@
+This directory is absolutely not required to make AWStats working.
+All files here are demo files you can use if you want to manipulate AWStats XML
+database to build report by yourself and without using AWStats output features.
+
+
+The following file describe the structure of the AWStats XML database (built
+when BuildHistoryOutput is set to 'xml').
+* awstats61.xsd               File descriptor for AWStats xml database schema.
+
+
+The following two files can be used to test a xslt processing to
+transform an AWStats XML database (built when BuildHistoryOutput is set to 'xml').
+into a report.
+* awstats61.datademo1.xml     A xml data demo file to test xslt transform with style sheet.
+* awstats61.datademo1.xslt    A demo xsl style sheet to transform de xml data demo file.
+
+
+
+To build a report using this 2 files and a xslt processor, you must run the command:
+
+xsltproc  awstats61.datademo1.xslt  awstats61.datademo1.xml  > output.html
+