Mongwell International Crosswords
Version 1.5
Created by Gurmukh Mongia
of Mongwell
Copyright 2004

Thank you for downloading Mongwell International Crosswords.
This application will allow you to create crosswords in any 
language. It's ideal as a tool to create exercises for students 
learning another language.


INSTALLATION
------------
1. Open the file "config.pl".  Here you will be able to set a number
of key factors necessary to run the program.  Most of it is already 
explained in the file.  A couple of points:

- The $config{'alphabet'} variable points to the default alphabet file.
Only 3 alphabets are included with the Mongwell International Crosswords
package: Greek, English, and Esperanto.  You may create your own alphabet
file easily.  All you need to do is create a list of the HTML codes necessary to display the language's alphabet.

The lines of the file need to be set into a key=value format.  The key
is an alphanumeric representation of the letter (it doesn't matter what
you use here, just as long as you don't use the same one twice).  The
value is the HTML code that displays that character.  For example, here
are a few lines from the Greek alphabet:

Alpha=&Alpha;
Beta=&Beta;
Gamma=&Gamma;

- The $config{'docpath'} variable can usually be left as is unless you
either make it so that the name of the directory is not "crosswords" right underneath the base HTML directory, or your server is set up in such a way that the cgi-bin directory is not directly underneath the base HTML 
directory.  You can either change it to point to the absolute path to
the directory or modify the relative directory to fit your directory
structure.

2. Upload viewer.cgi, maker.cgi, config.pl, and the alphabet file that
you will be using to your directory under cgi-bin.  We recommend using
cgi-bin/cwords, however you may use any directory name you wish.  Make
sure to set the attributes of maker.cgi and viewer.cgi to 755.

3. Create your document path directory structure under the base HTML
directory.  We recommend using the directory "/crosswords".  The name
may be whatever you like, however, it's path must be properly set in
the config.pl file.

4. Upload the spacer.gif file to your document path directory.

5. Create a directory under your document path directory named "temp"


Now you're ready to start creating crosswords.  Open the maker.cgi file
in your web browser.  The URL should be something like:

http://www.yourserver.com/cgi-bin/cwords/maker.cgi

Creating a new crossword is self explanatory.  Choose a name for your
crossword, and it's length and width in squares.  Then click on "Begin"
and you will be taken to a screen where the letters of your chosen
alphabet are listed on the top and a crossword grid is displayed
below that.

Simply click on a letter, then click on a square to place that letter.
Click on "Erase" to erase a letter, then click on the letter you want
to erase.

After you're done, the words of your crossword will be numbered and you
will be taken to a screen where you can write out the hints for each.
Once that's done your crossword will be created and you will be given 
a link to access it.

Enjoy!