This README file relates to ToonKit v1.0
(c) 1999, 2000 John G. Keating & Gerard P. O'Grady

*********************************************************************
1. WHAT IS TOONKIT CARTOON CREATOR & COMMUNICATOR?

ToonKit is a distributable graphics application which allows users to quickly and easily create totally unique cartoon caricatures, complete with their own individual expressions. The integrated ToonKard application enables users to send the cartoon anywhere on the Internet, complete with their own message contained in a speech bubble. Sending a ToonKard is as easy as sending email but a lot
more effective - especially for personalized communication.

To find out more, please go to http://www.toonkit.com/wtoonkit.html


*********************************************************************
2. INSTALLATION

Installation is not neccessary to use ToonKit; simply go to http://www.toonkit.com and enjoy! However, the sophisticated software is free for you to put on your site. So why not simply put it there - for you and your visitor's convenience....


Instructions For Installing ToonKit On Your website. 
----------------------------------------------------
Installing ToonKit Cartoon Builder on your website is a fairly straightforward task. There are four basic steps which are outlined in this section. These steps assume that your website is referenced using the URL "http://www.mysite.com/" and that the root directory for your website is just "/". The library provided contains all of the required code and automatically generates the Dynamic HTML required to place ToonKit Cartoon Builder on the web document. The four installation steps are outlined below: 

1.  Create a directory in your webspace called toonkit which is used to hold ToonKit Cartoon Builder library files and graphics. For example, use the command "mkdir toonkit" (UNIX systems) or "MKDIR toonkit" (DOS or Windows 95/NT) if you are in the root directory. 


2.  If you are reading this file you may have extracted the file from the zipped archive. All files from the archive should be put into the newly created "/toonkit" directory. Do not change the names of any of these files. All of the graphics files (.GIF format) should be in uppercase. All other files should be in lowercase (.html and .js files). Currently both gzip (UNIX) and WinZip (Windows 95/NT) format archives are avaialble from the ToonKit website: www.toonkit.com. 


3.  You must now modify all web documents which will contain a 	copy of ToonKit Cartoon Builder. These files may be anywhere in your webspace. It is recommended that you do not place these files in the newly created "/toonkit" directory. For example, if you wish to place a ToonKit Cartoon Builder in a file called "index.html" which resides in your root directory, then open the file with your favorite text editor (for example notepad in Windows 95/NT or vi in UNIX), and insert the following lines of HTML into the document: 


In the <HEAD> section of the document insert the following line of HTML (note the the SRC attribute points to the "toonkit.js" library now residing in the newly created "/toonkit" directory in your webspace): 

	<SCRIPT LANGUAGE="JavaScript1.2" SRC="
	http://www.mysite.com/toonkit/toonkit.js">
	</SCRIPT> 


In the <BODY> section of the document insert the following line of HTML (note the the parameters passed to the "StartToonKit()" function shown declared in the "toonkit.js" specify the top-left location of ToonKit Cartoon Builder in the document, and to start with the bigger logo specified by the parameter "bigLogo"): 

	<SCRIPT LANGUAGE="JavaScript1.2">
	StartToonKit(100,100,bigLogo);</SCRIPT> 

It is also possible to set the third parameter to "smlLogo" if you wish to use the smaller startup logo. The top-left positioning is absolute - it is not possible to place ToonKit Cartoon Builder in the flow of the HTML.


Insert the following fragment of HTML/JavaScript in the <BODY> tag of the document: 

	onLoad="toonkitLoaded();" 

Here are examples of before and after <BODY> tags 

	before: <BODY BGCOLOR="BLACK"> 

	after: <BODY BGCOLOR="BLACK" onLoad="toonkitLoaded();"> 



4.  Copy the file "resource.js" from the newly created "/toonkit" directory into the same directory as the documents containing ToonKit Cartoon Builder (in this example in the file would be copied to the root directory). Open the "resource.js" file with your favorite editor and make the following changes: 

	Locate the following line of the file 

	var myToonkit=
	"http://www.toonkit.com/index.html"; 

This line gives the name of the document containing ToonKit Cartoon Builder. When you send a ToonKard electronic postcard to a friend, the recipient is informed that they may use this document to launch the ToonView electronic postcard viewer. If you leave this line unchanged the recipient will be informed that they may view their electronic postcard at the ToonKit website. To change the document replace the URL between the quotes with the URL of your document, for example, 

	var myToonkit=
	"http://www.mysite.com/index.html"; 

Locate the following line line of the file 

	var myLibrary=
	"http://www.toonkit.com/toonkit/"; 

This line gives the location of ToonKit Cartoon Builder library. It is extremely important that the location of the library is correctly specified otherwise the software will not work. The location is specified as the URL of the newly created "/toonkit" directory in your webspace. To change the library location replace the URL between the quotes with the URL of the newly created library, for example, 

	var myLibrary=
	"http://www.mysite.com/toonkit/"; 

In order to use ToonKit Cartoon Builder all the viewer has to do is load the document (index.html) with their favorite DHTML enabled browser (either Microsoft Internet Explorer 4.0+ or Netscape Navigator 4.0+). If you wish to put a ToonKit Cartoon Builder on another document, for example, "other.html" then it is only necessary to repeat step 3 above if "other.html " resides in the same directory as "resource.js". If "other.html" is in a directory which does not already contain a "resource.js" file, for example "/otherdir", then steps 3 - 4 must be completed. 


Congratulations! You've just installed ToonKit on your Web site!

Please see the file install.html for further information, as well as how to customise your personal copy of ToonKit Cartoon Creator & Communicator. 


*********************************************************************
3. STATUS OF THE TOONKIT SOFTWARE

ToonKit is Freeware - however, you must read the legal document before installing the software onto your own site.


*********************************************************************
4. DISTRIBUTION STATUS OF THE TOONKIT SOFTWARE

ToonKit is freely distributable.


*********************************************************************
5. CONTACT DETAILS

In the event of questions or problems please send an email to:
support@toonkit.com

