
  GuestController mk2 Lite
  Guestbook CGI Script

I N S T R U C T I O N   M A N U A L

  1st June, 2001

  Uplink Productions
  www.uplink.com.au
  andrew@uplink.com.au


  
  
* Licence and Copyright Notice
- You are licenced to use this CGI script on any non-commercial web site for free.
- There is no time of licence expiry.
- Uplink Productions may not support this software after a long period of time, in favour of new versions.
- This script is Copyright (C) 2001, Uplink Productions.
- Do not edit the code of this script other than to change the setup variables outlined in later sections of this readme file.
- Editing the code in this script can cause problems with your other scripts installed on your server.
- We can not be held liable for any loss or damage to your system caused by this script.
- This script has been extensively tested and debugged on a Unix and a Windows 2000 system running PERL 5.




* System Requirements
  Server:
- WinNT / 2K, Unix, Linux.
- PERL 5 / ActiveState PERL.
- Netscape / MS Internet Explorer v4+ browsers with Javascript enabled.

  User:
- Netscape / MS Internet Explorer v4+ browsers with Javascript enabled.




* Files
- guestmk2l.cgi - PERL CGI script.
- guestmk2l.txt - this readme file.
- guestc.txt - guestbook database.




* Features
- Customisable HTML colours and table attributes.
- Header info includes entries total display.
- Average web site rating displayed in header.
- Users can add guestbook entries.
- Entries are displayed in partitioned page blocks (ie: next 20 / prev 20).
- Entries include email, web site, comments, date, site rating, location, how web site was found.
- Entries include up to 5 extra editable questions.
- User email syntax verifying.




* Setup of GuestController mk2 Script
- Locate variables section in script between ****** BEGIN SETUP HERE ****** and ****** END SETUP HERE ******.
- All variables except @questions are text strings or numbers.
- Text strings are contained inside quotemarks (").
- Numbers have no quotemarks (").
- Arrays are contained with brackets and each element of the array is inside quotemarks, like this: @array = ("a","b","c").
- Change $td1 to preferred outer table border HTML colour.
- Change $td2 to preferred left table cell HTML colour.
- Change $td3 to preferred right table cell HTML colour.
- Leave all table cell colours blank as "" if you want table cells to be transparent / clear.
- Change $hr to preferred horizontal rule line HTML colour.
- Change $tcw to left table cell width.
- Change $partition to how many entries per page you wish to see.
- Change $American to 1 if you want the date to be recorded in American format (MM/DD/YY).
- Change $ViewEntry to your welcome text.  Remember to include a link to: guestmk2l.cgi?action=add so a user can add an entry.
- Change $AddEntry to your instructional text when a user is adding an entry.
- Change $html to your preferred HTML header (including <title>, <head>, <body> and <style> tags, etc.
- Change $comWidth to the size in pixels across you want the comments cell to wrap text by.
- Change @questions to your preferred questions (@questions is an array), maximum of 5.
- When you have completed all the above steps, go to the next section to install the script on your web site.




* Installation of GuestController mk2
- Log into your server using FTP.
- Locate your CGI-BIN directory.
- Work out whether you want to:
    a) install GCmk2 into this directory or;
    b) make a new directory and install GCmk2 into there.
- Upload all files into same chosen directory.
- CHMOD (set file permission of) guestmk2l.cgi to 755.
- CHMOD the text files to 640.
- If you created a new directory, CHMOD the directory to 751.




* Technical Support
- Please visit our CGI scripts web site at:
    http://www.uplink.com.au/scripts

- You can email us at:
    andrew@uplink.com.au




[end of doc file]
