***************************************************************************
                               JMK Guestbook
                            -------------------
   begin                : Somewhere in time
   copyright            : (C) 1999 by Dimitris Batis
   email                : bat_geor@mail.hol.gr
***************************************************************************

	TABLE OF CONTENTS:

	1. What is JMK Guestbook?
	2. Features
	3. Availability
	4. System Requirements
	5. Installing and using
	6. Customizing
		6.1 The layout
		6.2 Bad words blocking
		6.3 Allowing HTML tags
		6.4 The fields
	7. License
	8. Credits
	9. Authors & Contact information

===========================================================================

1. What is JMK Guestbook?
-------------------------
JMK Guestbook is a Perl-based script that can be freely used by anyone to
create guestbooks in their web sites.

There is no fee in using JMK Guestbook, but a link to
http://www.ravencrypt.com/scripts/ would be greatly appreciated. The program
uses the GPL license, which means you are allowed to modify it in any way
you want, as long as your version of the program also uses the same license
and my name is mentioned on the script.

JMK Guestbook was made in a way so that it is easily modified to fit your
web page. It stores the name, e-mail, homepage, city and country (and of
course the comments) of the visitor, it can block bad words, and many more
features which you can see later on.

2. Features
-----------
 - Easily and fully customized. You can change every screen that appears in
   the visitor.
 - Can hold the name, e-mail adress, homepage, city, country and comments
   of the visitor, forcing him to put his name and e-mail adress.
 - You can easily add more fields for the visitor to complete.
 - It blocks 'bad words' (like fuck, ass, etc.) as an optional feature.
 - You can set it to accept or not HTML tags in the comments of the visitor.
 - Easily set the layout of the site.
 - It is GPLd, so you can re-distribute it and modify it in any way.
 - It's FREE!!!

3. Availability
---------------
You can find information and download JMK Guestbook from the following Web
site:

http://www.ravencrypt.com/scripts/

4. System Requirements
----------------------
All that the script really needs is a Perl processor of version 4 and up.
Of course, you also need a web account and a cgi bin directory.

5. Installing and using
-----------------------
For this information, look file INSTALL.

6. Customizing
--------------

6.1 The layout
--------------
The layout is held in the file called template.htm. Whatever is written
before <---# Sep #---> (WHICH SHOULD ALWAYS BE PLACED IN AN EMPTY LINE)
will be printed on the screen before the script shows anything else.

Everything below <---# Sep #---> will be shown just after the script has
finished (so, it shows the end of the document).

6.2 Bad words blocking
----------------------
The words to be blocked are found at badwords.txt of your datadir directory.
Each word must be in its own line, so to add new words, simply add them
at the end of badwords.txt, one word at each line.

To set bad word blocking on, you need to set the $blockbadwords variable
to 1. So, simply find the line
$blockbadwords = 0; and set it to 1.

By default, this feature is set ON.

6.3 Allowing HTML Tags
----------------------
You can allow or disallow the visitor from using HTML tags for the comments
section. If you disallow their usage, no HTML tags will be accepted, and
the comments will appear with everything except the tags.

To allow HTML tags, set $allow_tags to 1. If it is set to 0, no HTML tags
will be allowed.

By default, $allow_tags is set to 0, so no HTML tags are allowed.

6.4 The fields
--------------
At this time, you have to edit much in the script to achieve this, but
forthcoming versions will make this much much easier.

Take a look at sumbitform, processform and signform functions to see
what is needed to be changed.

7. License
----------
Look at LICENSE. If you use JMK Guestbook, you are bound by the GPL license
agreement. If you do not accept the agreement or you're not following it,
you are not allowed to use JMK Guestbook.

8. Credits
----------
Thanks to the creators of Vizbook for inspiration about the disallowing of
HTML tags and the creators of Tectonic Designs' Guestbook for the same reason.

Also, thanks to Jochen Wilhelmy (for KWrite), the KDE developing team, Helio
Teles and George Sidiropoulos for their support.

9. Authors & Contact Information
--------------------------------

Jim JMK Batis is behind the whole thing so far. You are welcome to send me
your patches, bugfixes or ideas for the program and your name will appear
here as well.

You can contact me at:
45 Thoukididou St.,
163 43 Ilioupolis,
Athens,
GREECE

E-mail: bat_geor@mail.hol.gr
WWW: http://www.ravencrypt.com/