File: readme.txt
Script Name: vPoll 1.1
Author: Vincent Ryan Ong
Email: beans@runbox.com

Description:
vPoll is a poll/survey script which provides flexibility in 
administering the design and functionality of the poll.

This script is a freeware but if you want to give donations,
please send your checks (coz cash will probably be stolen in the
post office) them to:

Vincent Ryan Ong
Rm. 440 Wellington Bldg.
655 Condesa St. Binondo, Manila
Philippines, 1006



=======================
 vPoll 1.1 README FILE
=======================

Contents:
  * Introduction
  * Package content
  * Requirements
  * Installation
  * Administration
  * Usage
  * Update Listings

~~~~~~~~~~~~~~~~~~~~~~~

* INTRODUCTION

  vPoll 1.1 is a simple voting/poll script with flexible
  administration functions. The current version has these
  features:

    FEATURES:
    1. Single poll capability
	- Currently, vPoll 1.0 offers a one-poll-per-site
	  feature. A single poll though, can be deployed to 
	  any number of pages in the site.

    2. Maximum of 20 choices per question
	- vPoll offers a limit of 20 choices per question for
	  now.

    3. Results page pops a new window
	- This was implemented with regards to BIG sites using
	  vPoll. If results are to be shown on the same page as
	  the poll, considerable amount of tie would be used to
	  load the page.

    4. Changeable poll design
	- The administrative function can change the look and 
	  feel of the poll from its size and color to its 
	  question font and selection font.

    5. Fast and reliable
	- vPoll uses PHP and MySQL which is one of the best
	  combos in the web development field.

    6. Graphical results
	- vPoll generates graphical statistics for its results
	  page.


* PACKAGE CONTENT

  bardot.gif - a 1x1 image file used for generating graphs
  polladmin.php - admin home interface
  design.php - admin design interface
  content.php - admin content interface
  pollconfig.php - database configuration file
  poll.php - poll file 
  results.php - poll results file
  createdb.sql - database creation file
  readme.txt - this file


* REQUIREMENTS

  OS: Linux, Windows NT/2000/Whistler(XP) Server Family, Unix
  WEB SERVER: Apache (latest release)
  SCRIPTING: PHP 4 (latest stable release)
  DB: MySQL (latest stable release)
  DB MANAGEMENT: phpMyAdmin or any similar types of db manager

* INSTALLATION

  1. Edit pollconfig.php and set the values to reflect your host's
     configuration.

  2. Create a new directory on the server/host for vPoll.

  3. Edit poll.php and change the line:
	require("Poll/pollconfig.php"); 
     to reflect the new directory. If the new directory name is
     "NewDirectory" then, the above line should be:
	require("NewDirectory/pollconfig.php"); 

  4. Do the same to line 169:
	print "		.: <i><a href=\"Poll/results.php?num=$x\" target=\"_new\">";
     if we would follow the above example, this line should be changed to:
	print "		.: <i><a href=\"NewDirectory/results.php?num=$x\" target=\"_new\">";

  5. Upload bardot.gif to the new directory in BINARY MODE (Use an FTP
	client for transferring files. A good one is WSFTP or CuteFTP).

  6. Upload all other files to the new diirectory in ASCII MODE. Be sure
	NOT to separate bardot.gif from these files by creating a different
	directory for it. All of these files should exist in the same 
	directory.

  7. Create the necessary tables found in createdb.sql by executing it
	either in a database manager like phpMyAdmin or by using the 
	MySQL prompt. For details regarding the use of MySQL, please
	visit http://www.mysql.com

  * NOTE: phpMyAdmin has a bug in executing SQL scripts from external text
	files. If there is a problem in creating and populating the database
	during installation, try to copy and paste scripts from createdb.sql
	into the designated area all create statements first, then press GO. 
	After that, Do the same for the insertion of data in the pollcontent, 
	then that of polldesign, lastly, all of those for pollresult. This
	should create the tables and populate them.


* ADMINISTRATION

  After installation, you should have created a sample poll. Follow the
  instructions below to get the most out of your administration:

    CREATING NEW POLL:
    1. Go to polladmin.php using your browser and click on 
	CONTENT ADMINISTRATION

    2. Click on RE-CREATE POLL. (The form should now display a blank
	question field and 20 blank selection fields). vPoll would
	automatically sqitch to INACTIVE mode when you have 
	re-created a poll. 

    3. Type in your question and selection/choices for the poll.

    4. Be sure to fill the form in sequential order. The script would 
	get confused and display the poll in an unintended manner if
	the choice fields are not filled up in order. You can of course
	use less than 20 choices.

    5. Click on the Save Settings button. 

    MODIFYING EXISTING POLL
    1. Go to polladmin.php using your browser and click on 
	CONTENT ADMINISTRATION

    2. Click on the DISABLE POLL AND MODIFY button to set the poll as
	INACTIVE and thus would not allow your visitors to vote 
	temporarily.
       OR
       Edit the values and press Save Settings. This would create the same
	effect as that of above BUT would not set the poll status to 
	INACTIVE and still allow visitors to vote.

    3. If you chose the first option, click on the Save Settings button to
	save your changes and activate the poll again.

    MODIFYING DESIGN
    1. Go to polladmin.php using your browser and click on 
	DESIGN ADMINISTRATION

    2. Edit the values in the fields of your choice.

    3. The color fields accept a maximum of only 7 characters. This was
	intended to discourage using words like RED, BLUE, etc. in the
	color fields. Use the Hex value instead (#FF0000 for Red). 


* USAGE

  To include the poll in your existing webpage, use the include statement of php:
	<? include ("poll_directory/poll.php") ?>


* UPDATE LISTINGS

 \\ vPoll 1.0
  - Some bugs were found in vPoll 1.0. Bugs which were zapped are:
	= case sensitiveness of some MySQL databases. Poll table names were modified.
	= Poll name does not reflect on the header of the Poll. Fixed.
	= vPoll used to require that it resides on a separate database. Fixed.



***********************
P.S. : Thanks to all the people who sent bug reports.

THAT's IT!
email beans@runbox.com for support.
***********************
