##########################################################################
#                                                                        #
#	Cyclonic Web-Mail Engine V4.0    				 #
#                                                                        #
#	Copyright (c) 1998-2001 STALLION Networking.                     #
#       All Rights Reserved.                                             #
#                                                                        #
#	Version Information:	4.0                                      #
#                                                                        #
##########################################################################


The following documentation contains information about modifying your
installation of the Cyclonic WebMail Engine to suit your Server or Web
Identity or to add extra languages etc...


Modifying the Cyclonic Page Templates:
--------------------------------------

All of the Page templates can be found in the /require directory. There
are also other files contained in this directory which must not be
modified - doing so could ruin the Cyclonic Software.

Files that can be modified:

 - startpage.dat
 
   This file contains the HTML Code for the Cyclonic Login Page along with
   some special scripting tags that Cyclonic requires to generate the page.

 - header.dat

   This file contains the HTML Code for the top (or header) sections of
   each of Cyclonics internal Pages. This code also contains some special
   scripting tags that Cyclonic uses to insert menu buttons etc..

 - footer.dat

   This file contains the HTML Code for the bottom (or footer) sections of
   each of Cyclonics internal Pages.


To make Modifications to these three (3) pages we recommend backing up the
initial templates that come with Cyclonic - just in case you run into
trouble.

There are some special Scripting tags required inside the
header.dat, startpage.dat and footer.dat files - these must 
be included in the code that you insert into each of these files -
Cyclonic will NOT RUN if you forget any of these.

The easiest way to modify each of the files is to simply modify the
existing code in each file. This avoids a loss of the required scripting
tags. However if you wish to create new files for each we have listed out
all of the required tags for each file and what each tag does.


--------------------------------------
startpage.dat:
--------------------------------------

<--! STARTFORM --> = Cyclonic inserts required Start of Form information

<--! BUTTON --> = Cyclonic inserts the "login" Button

<--! ERROR --> = Cyclonic will print Login Errors here should it need to

<--! ENDFORM --> = Cyclonic adds the required end of form information.



--------------------------------------
header.dat:
--------------------------------------

<--! STARTFORM --> = Cyclonic inserts required Start of Form information

<--! SESSIONID --> = Cyclonic inserts required SessionID information

<--! INBOX --> = Cyclonic inserts the Menu Link to the Inbox

<--! COMPOSE --> = Cyclonic inserts the Menu Link to the Compose Screen

<--! PROFILE --> = Cyclonic inserts the Menu Link to the Profile Screen

<--! HELP --> = Cyclonic inserts the Menu Link to the help Screen

<--! LOGOUT --> = Cyclonic inserts the Menu Link to the Logout Screen


--------------------------------------
footer.dat:
--------------------------------------

<--! ENDFORM --> = Cyclonic adds the required end of form information.



Adding New Language Dictionaries:
---------------------------------

To add a new language dictionary simply go into the languages directory
and copy the template file (language-temp.dat) to the name of the language
you are adding (eg. Arabic.dat). It is important to name it correctly with
only starting capital letter etc...

Go through the new file (Arabic.dat) and replace each phrase listed in
english with its translation into the language you are adding. Be sure to
only replace the english phrase and not any of the other comments and text
around the phrase. This file is similar in scripting terms to the
Cyclonic.conf file.

Once you have created your new dictionary file you will need to add that
language option to your start page language selector. Be sure to make the
input text match the name of the language. (eg: If you called the new
language dictionary file Arabic.dat the the new language input would be
Arabic - this input is case sensitive)