README.txt

 1: ========================================
 2: DRBPoll
 3: http://www.dbscripts.net/poll/
 4: 
 5: By Don B
 6: 
 7: Version 1.7
 8: ========================================
 9: 
10: Requirements
11: ------------
12: 
13: PHP 4.4 or higher
14: Apache HTTP Server (recommended)
15: 
16:     * It is strongly recommended that register_globals be set to off
17:       in your php.ini file.
18:     * AllowOverride must be enabled for the directory where the poll
19:       script is installed in your Apache httpd.config file.
20: 
21: Installation
22: ------------
23: 
24: 1) Extract the ZIP file into the desired destination folder on your website.
25:    Optionally, you may rename the "poll" folder to whatever name is
26:    desired; you will need to change the POLL_URL variable in config.php,
27:    and the include path in example.php to reflect this change.
28: 
29: 2) Modify the settings in config.php to match your environment and desired
30:    configuration.  This is where you will define your polls; some example
31:    polls are included for reference.  Detailed descriptions of the settings
32:    are included in the comments within that file.
33: 
34: 3) Confirm that the "/data" subfolder has write permissions enabled.
35: 
36: 4) Add the poll code to the desired PHP pages on your website.  The included
37:    example.php file demonstrates how to do this.
38: 
39: Upgrade
40: -------
41: 
42: If you are already running DRBPoll and need to upgrade to the latest
43: version, you must perform the following steps.
44: 
45: 1) Backup your config.php file, the contents of your "data" folder, and any
46:    files in the "template" directory that you have customized.
47: 
48: 2) Extract the ZIP file into the desired destination folder on your website,
49:    overwriting the existing files.  If you renamed the "poll" folder,
50:    you may need to copy the files into the correctly named folder.
51: 
52: 3) Replace your config.php file, "data" folder contents, and any customized
53:    template files that you backed up.
54: 
55: Uninstall
56: ---------
57: 
58: You can uninstall DRBPoll by following the steps below.
59: 
60: Please note that ALL DATA WILL BE LOST if you uninstall!
61: 
62: 1) Delete the subfolder where you put the DRBPoll
63:    files from your webserver.
64: 
65: 2) Remove any references to DRBPoll from the pages in your website.
66: 
67: Customization
68: -------------
69: 
70: The included example.php file demonstrates how to add a poll form to almost
71: any ordinary PHP page.  See config.php for the available customization
72: options.  Also, you are free to customize the files in the template folder.
73: These files control what is displayed after the rating form is submitted, and
74: when the "current results" link is clicked.
75: 
76: Modifying the PHP files other than config.php, and those inside the template
77: folder is not recommended, as this may make it difficult or impossible to
78: upgrade to newer versions of DRBPoll in the future.
79: 
80: Flat File Database
81: ------------------
82: 
83: DRBPoll stores its data in a flat file database (i.e. text files).
84: It is highly recommended that you make back up copies of these files
85: on a frequent basis.  These files can be found in the "data" folder.
86: 
87: License
88: -------
89: 
90: To use DRBPoll free of charge, all that I ask is that the "Powered by..." and
91: links at the bottom of the results page not be removed or altered.
92: 
93: You may not distribute code modifications to DRBPoll without permission from
94: the author.
95: 
96: DRBPoll is provided "as is", without warrant of any kind, either
97: expressed or implied.
98: 
99: The author is not liable for anything that results from your use of this code.