soutade/iwla
1
0
Fork 0
Code Issues Pull Requests Releases 2 Activity

Update documentation

Browse Source
This commit is contained in:
Gregory Soutade 2016-04-12 08:34:18 +02:00
parent 4baa0e6f5c
commit e3b0f914bd
2 changed files with 192 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

128
docs/index.md
View File

@ -103,12 +103,13 @@ Optional configuration values ends with *.
* plugins/display/browsers.py * plugins/display/browsers.py
* plugins/display/feeds.py * plugins/display/feeds.py
* plugins/display/hours_stats.py * plugins/display/hours_stats.py
* plugins/display/ip_to_geo.py
* plugins/display/istats_diff.py * plugins/display/istats_diff.py
* plugins/display/operating_systems.py * plugins/display/operating_systems.py
* plugins/display/referers.py
* plugins/display/referers_diff.py * plugins/display/referers_diff.py
* plugins/display/top_downloads.py * plugins/display/referers.py
* plugins/display/top_downloads_diff.py * plugins/display/top_downloads_diff.py
* plugins/display/top_downloads.py
* plugins/display/top_hits.py * plugins/display/top_hits.py
* plugins/display/top_pages.py * plugins/display/top_pages.py
* plugins/display/top_visitors.py * plugins/display/top_visitors.py
@ -116,6 +117,8 @@ Optional configuration values ends with *.
* plugins/post_analysis/browsers.py * plugins/post_analysis/browsers.py
* plugins/post_analysis/feeds.py * plugins/post_analysis/feeds.py
* plugins/post_analysis/hours_stats.py * plugins/post_analysis/hours_stats.py
* plugins/post_analysis/ip_to_geo.py
* plugins/post_analysis/iptogeo.py
* plugins/post_analysis/operating_systems.py * plugins/post_analysis/operating_systems.py
* plugins/post_analysis/referers.py * plugins/post_analysis/referers.py
* plugins/post_analysis/reverse_dns.py * plugins/post_analysis/reverse_dns.py
@ -323,6 +326,32 @@ plugins.display.hours_stats
None None
plugins.display.ip_to_geo
-------------------------
Display hook
Add geo statistics
Plugin requirements :
post_analysis/ip_to_geo
Conf values needed :
create_geo_page*
Output files :
OUTPUT_ROOT/year/month/index.html
Statistics creation :
None
Statistics update :
None
Statistics deletion :
None
plugins.display.istats_diff plugins.display.istats_diff
--------------------------- ---------------------------
@ -375,6 +404,32 @@ plugins.display.operating_systems
None None
plugins.display.referers_diff
-----------------------------
Display hook
Enlight new and updated key phrases in in all_key_phrases.html
Plugin requirements :
display/referers
Conf values needed :
None
Output files :
None
Statistics creation :
None
Statistics update :
None
Statistics deletion :
None
plugins.display.referers plugins.display.referers
------------------------ ------------------------
@ -406,15 +461,15 @@ plugins.display.referers
None None
plugins.display.referers_diff plugins.display.top_downloads_diff
----------------------------- ----------------------------------
Display hook Display hook
Enlight new and updated key phrases in in all_key_phrases.html Enlight new and updated downloads in in top_downloads.html
Plugin requirements : Plugin requirements :
display/referers display/top_downloads
Conf values needed : Conf values needed :
None None
@ -460,32 +515,6 @@ plugins.display.top_downloads
None None
plugins.display.top_downloads_diff
----------------------------------
Display hook
Enlight new and updated downloads in in top_downloads.html
Plugin requirements :
display/top_downloads
Conf values needed :
None
Output files :
None
Statistics creation :
None
Statistics update :
None
Statistics deletion :
None
plugins.display.top_hits plugins.display.top_hits
------------------------ ------------------------
@ -695,6 +724,41 @@ plugins.post_analysis.hours_stats
None None
plugins.post_analysis.ip_to_geo
-------------------------------
Post analysis hook
Get country code from IP address
Plugin requirements :
None
Conf values needed :
iptogeo_remote_addr*
iptogeo_remote_port*
Output files :
None
Statistics creation :
geo =>
country_code => count
None
Statistics update :
valid_visitors:
country_code
Statistics deletion :
None
plugins.post_analysis.iptogeo
-----------------------------
plugins.post_analysis.operating_systems plugins.post_analysis.operating_systems
--------------------------------------- ---------------------------------------

128
docs/modules.md
View File

@ -3,12 +3,13 @@
* plugins/display/browsers.py * plugins/display/browsers.py
* plugins/display/feeds.py * plugins/display/feeds.py
* plugins/display/hours_stats.py * plugins/display/hours_stats.py
* plugins/display/ip_to_geo.py
* plugins/display/istats_diff.py * plugins/display/istats_diff.py
* plugins/display/operating_systems.py * plugins/display/operating_systems.py
* plugins/display/referers.py
* plugins/display/referers_diff.py * plugins/display/referers_diff.py
* plugins/display/top_downloads.py * plugins/display/referers.py
* plugins/display/top_downloads_diff.py * plugins/display/top_downloads_diff.py
* plugins/display/top_downloads.py
* plugins/display/top_hits.py * plugins/display/top_hits.py
* plugins/display/top_pages.py * plugins/display/top_pages.py
* plugins/display/top_visitors.py * plugins/display/top_visitors.py
@ -16,6 +17,8 @@
* plugins/post_analysis/browsers.py * plugins/post_analysis/browsers.py
* plugins/post_analysis/feeds.py * plugins/post_analysis/feeds.py
* plugins/post_analysis/hours_stats.py * plugins/post_analysis/hours_stats.py
* plugins/post_analysis/ip_to_geo.py
* plugins/post_analysis/iptogeo.py
* plugins/post_analysis/operating_systems.py * plugins/post_analysis/operating_systems.py
* plugins/post_analysis/referers.py * plugins/post_analysis/referers.py
* plugins/post_analysis/reverse_dns.py * plugins/post_analysis/reverse_dns.py
@ -223,6 +226,32 @@ plugins.display.hours_stats
None None
plugins.display.ip_to_geo
-------------------------
Display hook
Add geo statistics
Plugin requirements :
post_analysis/ip_to_geo
Conf values needed :
create_geo_page*
Output files :
OUTPUT_ROOT/year/month/index.html
Statistics creation :
None
Statistics update :
None
Statistics deletion :
None
plugins.display.istats_diff plugins.display.istats_diff
--------------------------- ---------------------------
@ -275,6 +304,32 @@ plugins.display.operating_systems
None None
plugins.display.referers_diff
-----------------------------
Display hook
Enlight new and updated key phrases in in all_key_phrases.html
Plugin requirements :
display/referers
Conf values needed :
None
Output files :
None
Statistics creation :
None
Statistics update :
None
Statistics deletion :
None
plugins.display.referers plugins.display.referers
------------------------ ------------------------
@ -306,15 +361,15 @@ plugins.display.referers
None None
plugins.display.referers_diff plugins.display.top_downloads_diff
----------------------------- ----------------------------------
Display hook Display hook
Enlight new and updated key phrases in in all_key_phrases.html Enlight new and updated downloads in in top_downloads.html
Plugin requirements : Plugin requirements :
display/referers display/top_downloads
Conf values needed : Conf values needed :
None None
@ -360,32 +415,6 @@ plugins.display.top_downloads
None None
plugins.display.top_downloads_diff
----------------------------------
Display hook
Enlight new and updated downloads in in top_downloads.html
Plugin requirements :
display/top_downloads
Conf values needed :
None
Output files :
None
Statistics creation :
None
Statistics update :
None
Statistics deletion :
None
plugins.display.top_hits plugins.display.top_hits
------------------------ ------------------------
@ -595,6 +624,41 @@ plugins.post_analysis.hours_stats
None None
plugins.post_analysis.ip_to_geo
-------------------------------
Post analysis hook
Get country code from IP address
Plugin requirements :
None
Conf values needed :
iptogeo_remote_addr*
iptogeo_remote_port*
Output files :
None
Statistics creation :
geo =>
country_code => count
None
Statistics update :
valid_visitors:
country_code
Statistics deletion :
None
plugins.post_analysis.iptogeo
-----------------------------
plugins.post_analysis.operating_systems plugins.post_analysis.operating_systems
--------------------------------------- ---------------------------------------