Improved the script for visits generation => now handles partner/newsletter/campaign generation, and also download/outlink fake generation.

Update config file with documentation.


git-svn-id: http://dev.piwik.org/svn/trunk@29 59fd770c-687e-43c8-a1e3-f5a4ff64c105

1 files changed, 25 insertions, 0 deletions

diff --git a/config/config.ini.php b/config/config.ini.php
index bc4aeef7d5..cb2556f9c2 100755
--- a/config/config.ini.php
+++ b/config/config.ini.php
@@ -19,16 +19,41 @@ tables_prefix	= piwiktests_
 ; set to 0 if you want to stop tracking the visitors. Useful if you need to stop all the connections on the DB.
 record_statistics			= 1
 
+; this action name is used when the javascript variable piwik_action_name is not specified in the piwik javascript code, and when the URL has no path.
 default_action_name 		= index
+
+; visitors that stay on the website and view only one page will be considered staying 10 seconds
 default_time_one_page_visit = 10
+
+; variable name used to specify a download link
+; Example: '/piwik.php?idsite=1&download=http://piwik.org/piwik.zip' will redirect to 'http://piwik.org/piwik.zip'
 download_url_var_name 		= download
+
+; variable name used to specify a link to an external website
+; Example: '/piwik.php?idsite=1&link=http://piwik.org/' will redirect to 'http://piwik.org/'
 outlink_url_var_name		= link
+
+; variable that contains the name of the download or the outlink to redirect to
+; Example: '/piwik.php?idsite=1&download=http://piwik.org/piwik.zip&name=Piwik last version'
 download_outlink_name_var   = name
+
+; variable name to track a newsletter campaign. 
+; Example: If a visitor first visits 'index.php?piwik_nl=Great offer' then it will be counted as a newsletter referer for the newsletter 'Great offer'  
 newsletter_var_name			= piwik_nl
+
+; variable name to track a referer coming from a partner website. 
+; Example: If a visitor first visits 'index.php?piwik_partner=Amazon' then it will be counted as a partner referer with the name 'Amazon'  
 partner_var_name			= piwik_partner
+
+; variable name to track any campaign, for example CPC campaign
+; Example: If a visitor first visits 'index.php?piwik_campaign=Adwords-CPC' then it will be counted as a campaign referer named 'Adwords-CPC'
 campaign_var_name			= piwik_campaign
+
+; variable name to track any campaign keyword
+; Example: If a visitor first visits 'index.php?piwik_campaign=Adwords-CPC&piwik_kwd=My killer keyword' then it will be counted as a campaign referer named 'Adwords-CPC' with the keyword 'My killer keyword'
 campaign_keyword_var_name	= piwik_kwd
 
+; name of the cookie used to store the visitor information
 cookie_name	= piwik_visitor
 
 [log]