This is the install file for the Survey extension.
	
Extension page on mediawiki.org: http://www.mediawiki.org/wiki/Extension:Survey
Latest version of the install file: https://gerrit.wikimedia.org/r/gitweb?p=mediawiki/extensions/Survey.git;a=blob;f=INSTALL


== Requirements ==

Survey requires:

* MediaWiki 1.18 or above (Use Survey 0.1.2 if you are running MediaWiki 1.17.x and cannot upgrade to 1.18 or later.)
* PHP 5.3 or above

== Download ==

You can find the current version of Survey on the [https://code.google.com/p/mwsuvey/downloads/list Google Code download page],
as well as a [https://code.google.com/p/mwsuvey/downloads/list?can=1 list of legacy downloads].

You can also get the code directly from SVN. Tags can be obtained via

 svn checkout http://svn.wikimedia.org/svnroot/mediawiki/tags/extensions/Survey/REL_version

Where 'version' is the version number of the tag, such as 0_1 (see the [http://svn.wikimedia.org/svnroot/mediawiki/tags/extensions/Survey/ available tags]).
The latest code can be obtained from trunk:

 svn checkout http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/Survey/

== Installation ==

Once you have downloaded the code, place the ''Survey'' directory within your MediaWiki
'extensions' directory. Then add the following code to your [[Manual:LocalSettings.php|LocalSettings.php]] file:

# Survey
require_once( "$IP/extensions/Survey/Survey.php" );

== Configuration ==

Configuration of Survey is done by assigning to $egSurveySettings in your
[[Manual:LocalSettings.php|LocalSettings.php]] file, AFTER the inlcusion of the
extension. The options are listed below and their default is set in the Survey settings file:
http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/Survey/Survey.settings.php?view=markup
You should NOT modify the settings file, but can have a look at it to get an idea of
how to use the  settings, in case the below descriptions do not suffice.

{| class="wikitable sortable"
! Name
! Type
! Default
! Description
|-
| defaultEnabled
| boolean
| false
| If surveys should be enabled by default
|-
| defaultUserType
| Survey::$USER_
| Survey::$USER_ALL
| The default type of users a survey is shown to
|-
| defaultNamespaces
| array
| array()
| The default namespaces in which surveys should be shown. Empty list for no namespace restrictions
|-
| defaultRatio
| integer
| 100
| The default percentage of users the surveys should be shown to
|-
| defaultExpiry
| integer
| 60 * 60 * 24 * 30
| The default expiry of cookies used to track survey completion of users, in seconds
|-
| defaultMinPages
| integer
| 0
| The default minimum amount of pages users should visit before getting a survey
| -
| JSDebug
| boolean
| false
| Indicates if JavaScript debugging should be on or not. Should be false on production environments.
|}