Maian Survey - Documentation

Installation

Please read this page carefully as it contains important information about getting your survey system up and running:

Server Requirements

A server running 'PHP v5.5' or higher. Earlier versions may not be supported.

A 'MySQLi' supported database to hold the software tables. The MySQLi enhanced functions must be available.

GD Graphic Library support for single page display captcha display.

If you are unsure, don`t worry, the installer will check your configuration

Set Up (Auto Installer)

1 => Create a database to hold the software tables. If you are unsure of this procedure contact your web hosting company.

2 => Open up the 'inc/connect.php' file in a text editor and complete the options available, including the database connection.

Make sure you set unique values for 'COOKIE_NAME' and 'SECRET_KEY' for better security.
3 => Upload all the files/folders into a directory on your web server. Example: /survey/

4 => Chmod the following folders to make them world writeable:

admin/export/
logs/

Permissions can usually be set in your control panel or via FTP via the right click options.
5 => Access the 'install/index.php' file in your browser and follow the set up instructions to complete installation.Once completed REMOVE the install direcory.

Note that if you see an access denied message at this point, the connection information you have specified is incorrect as the software cannot connect to your database. Check and try again.
6 => If the setup was successful log in to your admin area with the default login: (Username/Password: admin)

PASSWORD SHOULD BE CHANGED IMMEDIATELY!
7 => Select 'Settings' from the system menu. Update the settings to your own preferences.

8 => To start creating surveys, view the create survey information.

9 => Thats it, all done. For software usage, see below.

Creating Surveys/Adding Questions

To learn how to create surveys, please click here.

Colour Schemes

To learn more about colour schemes, click here.

Templates/CSS Files

The templates for the software are in 'templates' directory.

Edit using a text editor, then re-upload. You must be careful NOT to remove any of the code between the PHP tags in the .tpl.php files, as some of these are important to the script. Others simply display language data. Unless you are an advanced user it is recommended you leave them all in place.

PHP and/or HTML may be used in the .tpl.php templates.

The templates in the 'templates/html/' folder are .tpl templates and can only include HTML or the system tags. Code in these files is to make the system easier to edit by removing the HTML from the PHP processing files. For more info see:

- templates/html/README.txt

The e-mail templates are in the 'templates/email/' directory. Edit using a text editor if necessary, then re-upload.

Most of the colours, font styles, borders etc are controlled by the CSS (Cascading Style Sheet). There are 5 main CSS files in the script. The admin CSS files probably won`t need changing unless you are adapting for a client:

- templates/header.tpl.php & templates/results_header.tpl.php' (Colour Scheme - Loaded via Template)
- templates/css/stylesheet.css (Other options not scheme based)
- admin/templates/css/stylesheet.css (Admin Interface)
- admin/templates/css/jquery-ui.css (jQuery UI CSS)
- admin/templates/css/picker.css (Admin Colour Picker)


Besides the CSS elements in the stylesheet, there may a few isolated inline style tags in the templates. None of these will be colour based.

Software Language

All the language can be found in the following file:

lang/english.php

Read the notes in this file carefully before changing text.

Upgrade Instructions

1 => Backup your existing survey system

2 => Delete ALL files from installation, except the root 'templates' and 'lang' folders.

3 => From your backup, add the root .css files to 'templates/css/' (create directory) and adjust paths to images to be relative so they load correctly.

4 => Upload all files from the latest version, omitting the root 'templates' and 'lang' folders and the 'install' folder.

5 => Give the 'logs' folder world writeable permissions. eg: 777 (755 if it works).

6 => From your backup, replace the following:

inc/connect.php

There are no database updates for the latest version.

Done, enjoy new version. :)