@DATABASE "IntuiCookie.guide"


@AUTHOR "Christian Kemp"
@(c) "Copyright ©1995 Christian Kemp"

@$VER: IntuiCookie.guide 1.2 (27.08.95)

@WORDWRAP

@INDEX Main


@NODE Main "IntuiCookie Hypertext Manual - Index"

      @{b}I  N  T  U  I  C  O  O  K  I  E    1  .  2@{ub}
Probably the best fortune cookie program in the world!


 Informations for users of IntuiCookie v1.0:
 @{"History" LINK Changes}

 General information:
 @{"Introduction" LINK Intro}
 @{"Copyright" LINK Copyright}
 @{"Contact address" LINK Address}
 @{"Requirements" LINK Requirements}

 Installation:
 @{"Installation" LINK Installation}

 Usage:
 @{"Usage" LINK Usage}

 How to customize IntuiCookie:
 @{"Tooltypes"  LINK Tooltypes}
 @{"What is a cookie file?" LINK CookieFile}
 @{"What is a hash file?" LINK HashFile}
 @{"Format of the cookie files" LINK CookieFileFormat}
 @{"About OneCookie" LINK OneCookie}
 @{"About CookHash" LINK CookHash}

 Error messages:
 @{"Errors and bugs" LINK Errors}

 Misc texts:
 @{"Planned for future versions" LINK Future}
 @{"Thanks" LINK Thanks}

@ENDNODE

@REM ==========================================================================

@NODE Changes "IntuiCookie Hypertext Manual - History"

@{b}@{u}History@{uu}@{ub}

@{u}New in v1.2@{uu}
@{b}·@{ub} Supports datafiles.
@{b}·@{ub} New REQPOS tooltype.
@{b}·@{ub} New documentation.
@{b}·@{ub} New MagicWB-WBStartup-look icon.

@{u}New in v1.1@{uu}
@{b}·@{ub} Now supports ReqTools.library.  Still works without Intuition.
@{b}·@{ub} New COOKIEFONT and COOKIEFONTSIZE tooltypes.  (ReqTools only)
@{b}·@{ub} New program & doc icons.

@{u}v1.0@{uu}
@{b}·@{ub} Initial release with 875 built-in cookies and no support for datafiles.

@ENDNODE

@REM ==========================================================================

@NODE Intro "IntuiCookie Hypertext Manual - Introduction"

@{b}@{u}Introduction: What is IntuiCookie@{uu}@{ub}

IntuiCookie is a program that displays @{"fortune cookies" LINK FortuneCookie}.

So why @{b}another@{ub} fortune cookie program?

The major advantage of IntuiCookie is that it uses Intuition to show a Cookie: it opens a requester and waits until you click on "Continue".  This is very useful if, for example, you wish to copy IntuiCookie to your WBStartup.

IntuiCookie comes with a small @{"cookie file" LINK CookieFile} which includes ±30 fortune cookies, more can easily be added.


IntuiCookie: Probably the best fortune program in the world!

@ENDNODE

@REM ==========================================================================

@NODE Copyright "IntuiCookie Hypertext Manual - Copyright"

@{b}@{u}Copyright@{uu}@{ub}

IntuiCookie is @{"Postcard-Ware" LINK PostCard-Ware}.
Copyright ©1995 @{"Christian Kemp" LINK AboutMe}.

IntuiCookie supports @{"reqtools.library" LINK AboutReqTools}, which is Copyright (c) Nico Francois.

IntuiCookie uses the same datafile and random number generator as @{"Cookie20" LINK AboutCookie}, which is Copyright (c) Karl Lehenbauer.
IntuiCookie comes with @{"CookHash" LINK CookHash} and @{"OneCookie" LINK OneCookie}, which are Copyright (c) Karl Lehenbauer.

@{u}Disclaimer@{uu}
IntuiCookie has been extensively tested and should not contain any bugs.
As IntuiCookie is free software, I cannot be made responsible for any kind of damage resulting from the direct or indirect usage of IntuiCookie.

@ENDNODE

@REM ==========================================================================

@NODE PostCard-Ware "IntuiCookie Hypertext Manual - About Postcard-Ware"

@{b}@{u}About Postcard-Ware@{uu}@{ub}

Postcard-Ware is freely distributable software.  You are not forced to pay a Shareware fee to use it, but you should send a postcard of your hometown or a letter to the @{"author" LINK Address} if you like and use the program.

@ENDNODE

@REM ==========================================================================

@NODE Address "IntuiCookie Hypertext Manual - Contact Address"

@{b}@{u}Contact address@{uu}@{ub}

Send @{"postcards" LINK Postcard-Ware}, long letters, bug reports, @{"suggestions" LINK Future} or gifts to:

@{"Kemp Christian" LINK AboutMe}
52, BD Patton
L-2316 Luxembourg
- Europe -

Sorry, only snailmail, I haven't got access to EMail @{b}yet@{ub}.

You can write in German, English, or French.

@ENDNODE

@REM ==========================================================================

@NODE Requirements "IntuiCookie Hypertext Manual - Requirements"

@{b}@{u}Requirements@{uu}@{ub}

@{u}Workbench 2.04@{uu}
Running IntuiCookie on an Amiga without reqtools.library limits the advanced options of IntuiCookie.  You will not be able to use the COOKIEFONT and REQPOS @{"tooltypes" LINK Tooltypes}.

@{u}Workbench 2.04 & reqtools.library@{uu}
This is the optimal configuration for IntuiCookie.  @{"Reqtools.library" LINK AboutReqtools} is required in your LIBS: drawer.  You will be able to benefit from all the features IntuiCookie offers.
@ENDNODE

@REM ==========================================================================

@NODE Installation "IntuiCookie Hypertext Manual - Installation"

@{b}@{u}Installation@{uu}@{ub}

To install IntuiCookie in your WBStartup drawer, simply drag its icon in the WBStartup drawer.  You will also need to adjust the @{"tooltypes" LINK Tooltypes} to point to the directory where your @{"cookie file" LINK CookieFile} resides.

@ENDNODE

@REM ==========================================================================

@NODE Usage "IntuiCookie Hypertext Manual - Usage"

@{b}@{u}Usage@{uu}@{ub}

Using IntuiCookie is really easy!  Start it by clicking on its icon, or alternatively enter its name in a Shell.  Command line arguments are not supported.
A requester with a random cookie will appear.  Click on "Continue" to close the requester.

See @{"Errors and bugs" LINK Errors} now if an error encountered.

@ENDNODE

@REM ==========================================================================

@NODE Tooltypes "IntuiCookie Hypertext Manual - Tooltypes"

@{b}@{u}Tooltypes@{uu}@{ub}

Using tooltypes is described in-depth in your Workbench manual.

@{u}@{b}·@{ub} The COOKIEFONT tooltype@{uu}
Set this to the font you want IntuiCookie to use.
Example: <COOKIEFONT=helvetica.font>

@{u}@{b}·@{ub} The COOKIEFONTSIZE tooltype@{uu}
Set this to the font size you want IntuiCookie to use.
Example: <COOKIEFONTSIZE=15>

@{u}@{b}·@{ub} The REQPOS tooltype@{uu}
The REQPOS tooltype specifies the position where IntuiCookie will appear:
· CENTER  : Centered on the visible part of the screen.
· POINTER : Under the mouse pointer.
· TOPLEFT : On the top left of the visible part of the screen.
Example: <REQPOS=CENTER>

@{u}@{b}·@{ub} The COOKIEFILE tooltype@{uu}
Used to specify the location and name of the @{"cookie file" LINK CookieFile}.
Example: <COOKIEFILE=Work:Cookies/Cookie>

@{u}@{b}·@{ub} The HASHFILE tooltype@{uu}
Used to specify the location and name of the @{"hash file" LINK HashFile}
Example: <HASHFILE=Work:Cookies/Cookie.hash>

@ENDNODE

@REM ==========================================================================

@NODE CookieFile "IntuiCookie Hypertext Manual - What is a cookie file?"

@{b}@{u}What is a cookie file?@{uu}@{ub}

A cookie file is a collection of @{"fortune cookies" LINK FortuneCookie} in a format that facilitates retrieval by a fortune program.
There are several different cookie files in public distribution, and site administrators often assemble their own from various sources.
(Quoted from Jargon 3.0.0)

@ENDNODE

@REM ==========================================================================

@NODE HashFile "IntuiCookie Hypertext Manual - What is a hash file?"

@{b}@{u}What is a hash file?@{uu}@{ub}

A hash file is a file containing nothing but hexadecimal numbers (the "coordinates" where a new cookie begins and where it ends) used for amazingly fast access of @{"fortune cookies" LINK FortuneCookie}, even in large files.

@ENDNODE

@REM ==========================================================================

@NODE CookieFileFormat "IntuiCookie Hypertext Manual - Format of the cookie files"

@{b}@{u}Format of the cookie files@{uu}@{ub}
The cookie file is a plain ASCII text file which can be read and modified by any text editor.  Individual cookies can occupy up to 2048 bytes (±25 lines) and are separated by a line containing nothing but two percent singns.

Example:

---BEGIN OF FILE---
First Cookie
%%
Second
cookie!
%%
This
is the
third cookie
---END OF FILE---

Note that there's no %% before the first and after the last cookie!

@ENDNODE

@REM ==========================================================================

@NODE OneCookie "IntuiCookie Hypertext Manual - About OneCookie"

@{b}@{u}About OneCookie@{uu}@{ub}
OneCookie is located in the <additional> drawer.  It is used to eliminate double cookies in @{"cookie files" LINK CookieFile}.

@{b}@{u}Usage@{uu}@{ub}
OneCookie <from_file >to_file
 where from_file is the raw file with (possibly) double cookies and to_file is the new (shorter) file.


OneCookie is part of the @{"Cookie20" LINK AboutCookie} distribution.

@ENDNODE

@REM ==========================================================================

@NODE CookHash "IntuiCookie Hypertext Manual - About CookHash"

@{b}@{u}About CookHash@{uu}@{ub}
CookHash is located in the <additional> drawer.  It is used to generate a @{"hash file" LINK HashFile}.

@{b}@{u}Usage@{uu}@{ub}
CookHash <cookiefile >hashfile
 where cookiefile is the @{"cookie file" LINK CookieFile} and hashfile is the @{"hash file" LINK HashFile}.


OneCookie is part of the @{"Cookie20" LINK AboutCookie} distribution.

@ENDNODE

@REM ==========================================================================

@NODE Errors "IntuiCookie Hypertext Manual - Errors and bugs"

@{b}@{u}Errors and bugs@{uu}@{ub}

If an error occurs an appropriate error-message will be output.  Please re-check the @{"tooltypes" LINK tooltypes} and/or use DosTrace or a similar program to find out if IntuiCookie finds all files.

Q: IntuiCookie won't let me use the REQPOS and COOKIEFONT tooltypes.
A: Install @{"Reqtools.library" LINK ReqTools}

Q: IntuiCookie won't use the font I specified in the tooltypes.
A: Check if the font is spelled correctly and if you included the .font suffix.
   (for example <COOKIEFONT=topaz.font> instead of <COOKIEFONT=topaz>.

Q: IntuiCookie will crash my system or exit without displaying an error message.
A: Send @{"me" LINK Address} a bug-report please, including detailed information about your computer setup.

@ENDNODE

@REM ==========================================================================

@NODE Future "IntuiCookie Hypertext Manual - Future"

@{b}@{u}Future@{uu}@{ub}

The following features @{b}may@{ub} be included later, @{i}if I get some nice letters to motivate me@{ui}:

@{b}·@{ub} Support for powerpacked or XPK'ed cookie files.
@{b}·@{ub} Support for multiple cookie files.
@{b}·@{ub} Support for public screens.
@{b}·@{ub} MUI support instead of (or in addition to) Intuition and ReqTools requesters.
@{b}·@{ub} Modify or delete unwanted cookies via menu options.  (MUI only)
@{b}·@{ub} Support @{"hash files" LINK HashFile} for crunched @{"cookie files" LINK CookieFile}.  (Is this possible?)
@{b}·@{ub} Easy installation via an Installer script.
@{b}·@{ub} Localized error messages.

@{b}·@{ub} And, of course, your suggestions!

@ENDNODE

@REM ==========================================================================

@NODE Thanks "IntuiCookie Hypertext Manual - Thanks"

@{b}@{u}Thanks@{uu}@{ub}

Thanks to Stephan Grossien from Germany who was the only one to send me a letter.  He was also the one who suggested that IntuiCookie should be able to support different fonts and to appear centered on the screen.

Thanks to Roger E. Nedel for BadLinks.

@ENDNODE

@REM ==========================================================================

@NODE AboutMe "IntuiCookie Hypertext Manual - About the author"

@{b}@{u}About the author@{uu}@{ub}

I'm 17 years old and I'm currently going to secondary school (high-school).
I've been using Amigas for over five years and my current setup includes an A1200 with DKB 1240 accelerator, Microvitec monitor, 250 MB hard disk and a Tandem1200 CD-ROM.
@ENDNODE

@REM **************************************************************************

@NODE AboutCookie "IntuiCookie Hypertext Manual - About Cookie"

@{b}@{u}About Cookie@{uu}@{ub}

Cookie is a freely distributable cookie program for Unix, which is Copyright ©1989 Karl Lehenbauer.  Cookie was ported to the Amiga by Andreas M. Kirchwitz and is also available on Aminet (util/misc/Cookie20).

IntuiCookie is a complete rewrite of Cookie, although the same random number generator and format of data files is used.  I didn't want to re-invent the wheel.

This archive also includes @{"CookHash" LINK CookHash}, a @{"hash file" LINK HashFile} generator and @{"OneCookie" LINK OneCookie} a program that eliminates double cookies in files.
CookieHash and OneCookie are Copyright @1989 Karl Lehenbauer and include C source code.

@ENDNODE

@REM ==========================================================================

@NODE FortuneCookie "IntuiCookie Hypertext Manual - What is a fortune cookie?"

@{b}@{u}What is a fortune cookie?@{uu}@{ub}

A fortune cookie is a random quote, item of trivia, joke or maxim printed to the users terminal at login time.
(Quoted from Jargon 3.0.0)

@ENDNODE

@REM ==========================================================================


@NODE AboutReqtools "IntuiCookie Hypertext Manual - About reqtools.library"

@{b}@{u}About reqtools.library@{uu}@{ub}

ReqTools is Copyright (c) Nico Francois.

ReqTools is a freely distributable package and is available on Aminet or from any good PD distributor.

@ENDNODE