@DATABASE "IntuiCookie.guide"

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

@$VER: IntuiCookie.guide 2.96 (01.01.96)

@WORDWRAP

@FONT helvetica.font 13

@INDEX Main


@NODE Main "Contents"

@{b}IntuiCookie 2.96@{ub}

von @{b}@{"USELESS software" LINK Useless.GIF/main}@{ub}

@{"Hier" LINK Preview.GIF/main} ist Beispiel, wie IntuiCookie auf Ihrem Amiga aussehen könnte.



I. Einleitung
      1.1    @{"Einleitung" LINK Preface}
      1.2    @{"Wieso sollte ich IntuiCookie benutzen?" LINK Features}

II. Legal Scheiße
      2.1    @{"Copyright" LINK Copyright}
      2.2    @{"Über MUI" LINK MUI}
      
III. Bevor Sie IntuiCookie benutzen...
      3.1    @{"Voraussetzungen" LINK Requirements}
      3.2    @{"Installation" LINK Installation}
      
IV. Wie Sie IntuiCookie benutzen
      4.1    @{"Benutzung" LINK Usage}
      4.2    @{"Menüs" LINK Menus}

V. Wie Sie IntuiCookie konfigurieren
      5.1    @{"Tooltypes" LINK Tooltypes}
      5.2    @{"Dateiformat" LINK CookieFileFormat}
      5.3    @{"CookHash" LINK CookHash}

VI. Glossar
      6.1    @{"Was ist ein Fortune Cookie?" LINK FortuneCookie}
      6.2    @{"Was ist eine Cookie-Datei?" LINK Cookiefile}
      6.3    @{"Was ist eine Hash-Datei?" LINK HashFile}

VII. Verschiedene Texte
      7.1    @{"Kontaktadresse" LINK Address}
      7.2    @{"Über mich" LINK AboutMe}
      7.3    @{"Danksagungen" LINK Thanks}
      
VIII. Past, Present and Future
      8.1    @{"Past" LINK Past}
      8.2    @{"Present" LINK Present}
      8.3    @{"Future" LINK Future}
@ENDNODE





@NODE Preface "1.1  Einleitung"
@{u}@{b}1.1  Einleitung@{uu}@{ub}

IntuiCookie ist ein Programm zum Anzeigen von Fortune Cookies.

Verschiedene Leute denken vielleicht daß ein MUI Fortune Cookie Programm zuviel des Guten ist.  Ich bin nicht der Meinung.

@{"Installieren" LINK Installation} Sie einfach IntuiCookie und ziehen Sie Ihre eigenen Schlüsse.

Wenn Sie MUI nicht mögen, gibt es auch noch eine Reqtools-Version.  Ich bin auch bereit den Quellcode an jeden weiterzugeben, der am Entwickeln und Unterstützen von Versionen für andere GUI-Libraries interessiert ist.


__________
@{i}Pohls' Law:
Nothing is so good that somebody, somewhere, will not hate it.@{ui}
@ENDNODE





@NODE Features "1.2  Wieso sollte ich IntuiCookie benutzen?"
@{u}@{b}1.2  Wieso sollte ich IntuiCookie benutzen?@{uu}@{ub}

· IntuiCookie benutzt ein (extrem konfigurierbares) MUI-Fenster zum Darstellen der Cookies.
· IntuiCookie kann über Menüs und Tooltypes konfiguriert werden.
· Es gibt viele Tooltypes zum Konfigurieren des Aussehens und Benehmens von IntuiCookie, mehr als das MUI Prefs Programm erlaubt.
· IntuiCookie kommt mit CookHash, einem MUI Hash-Datei Programm.
· IntuiCookie und CookHash sind lokalisiert.
· Formatierungszeichen werden unterstützt.

@ENDNODE





@NODE Copyright "2.1  Copyright"
@{u}@{b}2.1  Copyright@{uu}@{ub}

IntuiCookie und alle dazugehörigen Dateien sind (C)1995, 1996 Christian Kemp,
außer den Guide und Install Icons, die (C) Tom Ekström sind.

Alle Rechte vorbehalten.

IntuiCookie benötigt und benutzt @{"MUI" LINK MUI} © Stefan Stuntz.



@{b}Diese Software unterliegt der "Standard Amiga-FD-Software Copyright Note".
Sie ist Giftware, wie definiert in Absatz 4g.
Für mehr Informationen lies bitte @{"AFD-COPYRIGHT" LINK AFD-Copyright/Main} (Version 1 oder höher).@{ub}

@ENDNODE





@NODE MUI "2.2  MUI"
                          This application uses


                        MUI - MagicUserInterface

                (c) Copyright 1993/94 by Stefan Stuntz


MUI is a system to generate and maintain graphical user interfaces. With
the  aid  of  a  preferences program, the user of an application has the
ability to customize the outfit according to his personal taste.

MUI is distributed as shareware. To obtain a complete package containing
lots of examples and more information about registration please look for
a  file  called  "muiXXusr.lha"  (XX means the latest version number) on
your local bulletin boards or on public domain disks.

          If you want to register directly, feel free to send


                         DM 30.-  or  US$ 20.-

                                  to

                             Stefan Stuntz
                        Eduard-Spranger-Straße 7
                             80935 München
                                GERMANY
@ENDNODE





@NODE Requirements "3.1  Voraussetzungen"
@{u}@{b}3.1 Voraussetzungen@{uu}@{ub}

· Kickstart und Workbench V37 oder besser.
  Workbench 2.1 (V38) wird für die Lokalisierung benötigt.
· MUI v8 oder besser.  (Entwickelt und getestet wurde unter der v10.0)
· Der Bedarf an Speicherplatz variiert mit Ihrer Konfiguration, z.B ob Sie
  einen Hintergrund wollen, sollte aber 300k nicht überschreiten.
· ±300 Kilobytes auf Ihrer Festplatte.  (Nur ±25 k auf der Bootpartition)
@ENDNODE





@NODE Installation "3.2  Installation"
@{u}@{b}3.2  Installation@{uu}@{ub}
Die Installation wird von einem Installer¹-Skript durchgeführt.  Klicken Sie einfach auf das Install icon und folgen Sie den dann erscheinenden Anweisungen.
Bitte installieren Sie IntuiCookie nicht per Hand, dies verursacht nur unnötige Probleme.


__________
¹ Installer ist © Escom AG und ist nicht in diesem Archiv enthalten.
@ENDNODE





@NODE Usage "4.1  Benutzung"
@{u}@{b}4.1  Benutzung@{uu}@{ub}

Starten Sie es einfach durch Klicken auf das Icon.
Ein Fenster wird geöffnet, klicken Sie auf "Weiter" zum Schließen, oder schauen Sie sich die @{"Menüs" LINK Menu} an.
Wenn ein Textfield-Gadget zum Darstellen des Textes benutzt wird (wenn Scrollbars auf der rechten Seite sind), dann können Sie durch Klicken au die Pfeile rauf und runter scrollen, oder durch drücken von [TAB] und anschließend [Cursor Up] oder [Cursor Down].
IntuiCookie kann durch @{"Tooltypes" LINK Tooltypes} und das MUI Prefs-Programm eingestellt werden.

@ENDNODE





@NODE Menus "4.2 Menüs"
@{b}@{u}4.2 Menüs@{ub}@{un}


@{b}@{u}Prokect Menü@{uu}@{ub}

@{u}Über@{uu}
· Ein requester mit der Versionsnummer, einer Giftware-Notiz und meiner Kontaktadresse wird angezeigt.  Klicken Sie auf Weiter um fortzufahren.

@{u}Ende@{uu}
· Hat den gleichen Effekt als auf das Close- oder Continue-Gadget zu drücken: Das Fenster schließen und das Programm beenden.


@{b}@{u}Show Menü@{uu}@{ub}

@{u}Ursprung@{uu}
· Zeigt oder versteckt den Ursprung-Display, wo der Ursprung (Urheber, Erfinder) eines Zitats angezeigt wird.  Wenn kein Ursprung angegeben wurde, erscheint dieses Menü grau.

@{u}Button@{uu}
· Zeigt oder versteckt das Weiter Gadget.

@{u}Cookiefile Info@{uu}
· Zeigt Informationen über die Cookie-Datei an.
  Diese Daten befinden sich in den ersten Reihen einer Cookie-Datei,
  alles vor den ersten '%%' wird als Info-Text angesehen.
  
@{u}Cookie Info@{uu}
· Zeigt die Anzahl von Cookies in der Datei, die Nummer des aktiven
  Cookie und die Größe in Bytes, inklusiv und exklusiv die Größe
  des Ursprung-Textes.


WICHTIG: IntuiCookie speichert keine Änderungen, die durch die Menü-Optionen festgelegt wurden, Sie müssen die @{"Tooltypes" LINK Tooltypes} manuell einstellen um permanente Änderungen zu machen.
@ENDNODE





@NODE Address "Contact Address"
@{b}@{u}Contact address@{uu}@{ub}

It is very important to motivate me with long letters, E-Mails, bug-reports, suggestions and gifts.
Send them to:

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

E-Mail : ckemp@innet.lu

You can write in German, English, or French.

@ENDNODE





@NODE Tooltypes "5.1 Tooltypes"
@{b}@{u}5.1 Tooltypes@{uu}@{ub}

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

Boolean tooltypes (which accept a TRUE or FALSE as answer) can also be shortened by just writing the name of the tooltype, which is the same as if you had written <tooltype>=TRUE.  If you don't specify the tooltype at all, IntuiCookie reacts as if you had written <tooltype>=FALSE.


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

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

@{u}· The COOKIE_PREPARSE tooltype@{uu}
Used to specify the look of the cookie text.
Possible options are BOLD, CENTER, HIGHLIGHT, ITALIC, LEFT, RIGHT, UNDERLINE, they can also be combined.
Example: <COOKIE_PREPARSE>=BOLD|CENTER>

@{u}· The COOKIEFONT tooltype@{uu}
Used to specify the font in which the cookie text will be written.
Example: <helvetica.font>

@{u}· The COOKIEFONTSIZE tooltype@{uu}
Used to specify the size of the COOKIEFONT.
Example: <15>

@{u}· The ORIGINFONT tooltype@{uu}
Used to specify the font in which the origin text will be written.
Example: <helvetica.font>

@{u}· The ORIGINFONTSIZE tooltype@{uu}
Used to specify the size of the ORIGINFONT.
Example: <11>

@{u}· The ORIGIN_PREPARSE tooltype@{uu}
Used to specify the look of the origin text.
Possible options are BOLD, CENTER, HIGHLIGHT, ITALIC, LEFT, RIGHT, UNDERLINE, they can also be combined.
Example: <ORIGIN_PREPARSE>=ITALIC|BOLD>

@{u}· The LINESIZE tooltype@{uu}
If the number of characters in a line exceeds the number given in this tooltype, IntuiCookie will use a textfield are instead of a text area to display the cookie.
Example: <90>

@{u}· The LINENUMBER tooltype@{uu}
If the number of lines exceeds the number given in this tooltype, IntuiCookie will use a textfield are instead of a text area to display the cookie.
Example: <5>

@{u}· The ORIGIN tooltype@{uu}
Used to determine whether the origin of the quote (the person that invented it) is displayed or not.  Note that a lot of quotes are unacknowledged.
Example: <ORIGIN=TRUE>.  Set this to FALSE if you don't want to see any origin.
You can also specify TITLE, if you want to display the origin of the quote in the title of the window.
<ORIGIN=TITLE>

@{u}· The BUTTON tooltype@{uu}
Used to specify if the Continue button will be displayed or not.
Example: <BUTTON=FALSE>

@ENDNODE





@NODE CookieFile "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





@NODE HashFile "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) used for amazingly fast access of @{"fortune cookies" LINK FortuneCookie}, even in large files.

@ENDNODE





@NODE CookieFileFormat "5.2 Format of the cookie files"
@{b}@{u}5.2 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 signs.

Example:

---BEGIN OF FILE---
About the cookie 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!

@{u}Formatting characters@{uu}
"@b" - Print the following characters in bold.
"@i" - Print the following characters in italics.
"@u" - Underline the following characters.
"@c" - Center the following lines.
"@l" - Align the following lines to the left.
"@r" - Align the following lines to the right.
"@2" to "@8" - Use color X for the following characters.  This has something to do with the colors you set in the MUI prefs, but I am not sure at the moment.  Maybe somebody can help me?
"@n" - Switch back to normal text.

If you want wordwrapping, then simply use the same method for inputing cookies as in a word processor: press Return only when you want to have a new paragraph.
Note that the Reqtools version doesn't support wordwrapping.

The cookie mustn't be longer than 4096 characters.

Note that all text before the first '%%' is considered as Info Text, which can be displayed using the "Cookiefile Info" @{"menu" LINK Menus}.

When adding cookies that come with an origin, please use the following format for the origin:
- The name has to be on his own line.
- It must be preceeded by two hyphens and one space ("-- ").
- It must not be longer than 255 characters.
If you don't follow these conventions, IntuiCookie may have problems recognising origins.
@ENDNODE





@NODE Past "8.1 Past"
@{b}@{u}8.1 Past@{uu}@{ub}

Please only read the history if you have used a previous version and if you want to know what has changed since then.  Otherwise this might appear a bit confusing.

@{u}New in v2.96  (01.01.96)@{uu}
· (FEATURE) Added support for more formatting characters.
· (FEATURE) COOKIEFONT and ORIGINFONT tooltypes added.
· (FEATURE) New ORIGIN=TITLE tooltype.
· (ENHANCEMENT) COOKIE_PREPARSE and ORIGIN_PREPARSE support more options.
· (ENHANCEMENT) Speeded up the handling of formatting characters.
· (ENHANCEMENT) Now also supports NO and OFF instead if FALSE for tooltypes.
· (ENHANCEMENT) If BUTTON or ORIGIN tooltypes are specified without TRUE or FALSE, they will be treated as TRUE.
· (ENHANCEMENT) If no BUTTON or ORIGIN tooltype is found the relevant gadgets won't be displayed.
· (ENHANCEMENT) The name of the program is now also displayed in the screentitle.
· (ENHANCEMENT) A window will only have a size gadget when the textfield gadget is used.
· (ENHANCEMENT) New LINESIZE and LINENUMBER tooltypes.
· (ENHANCEMENT) Error messages and requesters are now also localised.
· (BUGFIX) In previous version the last cookie of a file would never be displayed.  This is now fixed.
· (BUGFIX) The Installer script will no longer overwrite an existing cookie file.

@{u}New in v2.95 (12.12.95)@{uu}
· Obsolete CENTERED tooltype is replaced by COOKIE_PREPARSE and ORIGIN_PREPARSE.
· Full localisation for IntuiCookie.
· Supports wordwrapping (optional, only if cookies are larger than 3 lines or if any line is longer than 80 characters).

@{u}New in v2.91 (06.12.95)@{uu}
· Basically only updates CookHash from v0.9 to v0.91.  It supports localisation now.

@{u}New in v2.9 (28.11.95)@{uu}
· Now requires MUI (Magic User Interface).  Intuition and/or ReqTools support is obsolete, but there are still versions for Reqtools on Aminet.
· Includes menus:  About, Quit, Show/Origin, Show/Button, Show/Cookiefile_Info and Show/Cookie_Info.
· Show/Origin menu : show/hide the author (origin) of the quote.
· Show/Button menu : show/hide the "Continue" gadget.
· ORIGIN tooltype : Same as "Show/Origin" menu.
· BUTTON tooltype : Same as "Show/Button" menu.
· CENTERED tooltype : Cookies can appear centered.
· Supports formatting characters in cookie files.
· MUI CookHash program with progress indicator.
· Documentation revised once more.
· Localized button text.

@{u}New in v1.2 / v2.0 (27.08.95)@{uu}
· Supports datafiles.
· New REQPOS tooltype.
· New documentation.
· New MagicWB-WBStartup-look icon.

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

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

@ENDNODE





@NODE Present "8.2 Present"
@{b}@{u}8.2 Present@{uu}@{ub}

The following bugs ("features") and inconveniences exist in this version of IntuiCookie:

- COOKIEFILE and HASHFILE must be preceeded by "PROGDIR:" when the files are in local directory.
- The handling of the checkmarks and the disabling of menu items doesn't work.
- The Guide may not work on Amigas with OS3.1.
@ENDNODE





@NODE Future "8.3 Future"
@{b}@{u}8.3 Future@{uu}@{ub}

Release date for IntuiCookie 3.0 is January/February 1996.

The following features are planned:

· Minor bug-fixing.
· Prefs program instead of setting tooltypes.
· Support for multiple cookie files.
· Copy a cookie to the clipboard or to a file.

· And, of course, your suggestions


@{b}I have made an important decision:
I won't write versions for Reqtools and/or BGUI anymore.  I will hand over the source code to anybody who is interested in doing conversions for these GUI libraries.  Just send me an E-Mail for more information.@{ub}
@ENDNODE





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

Thanks go to all the people who sent me suggestions and/or bug-reports

- Stephan Grossien (IntuiCookie user since v1.0, lots of suggestions)
- Aristotelis Grypas (a very long suggestion-list)
- Olav Mueller (wants a CLI version)
- Kenneth Fribert (reported Enforcer hits in v2.90)
- Michael-W. Hohmann (suggestions)
- Eric Gerard (French catalog and doc translations)
- Dietmar Knoll (corrections in the doc and AFD licence)

@ENDNODE





@NODE AboutMe "About the author"
@{b}@{u}About the author@{uu}@{ub}

I'm 18 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.

@{"Don't click here." LINK me/main}
@ENDNODE





@NODE FortuneCookie "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


@NODE CookHash "5.3 CookHash"
@{b}@{u}5.3 CookHash@{ub}@{uu}

This part of the doc is still under construction.

CookHash is used to create @{"hash files" LINK Hashfile}.
Simply click on its icon, fill in the source and destination files by clicking on the images near the text areas (a file req will pop up) and click on "Create hash file".  The progress indicator will show when CookHash has finished creating the file.

@ENDNODE