@DATABASE "IntuiCookie.guide" @AUTHOR "Christian Kemp" @(C) "Copyright ©1995 Christian Kemp" @$VER: IntuiCookie.guide 2.95 (12.12.95) @WORDWRAP @FONT courier.font 13 @INDEX Main @NODE Main "Contents" @{b}IntuiCookie 2.95@{ub} by @{b}@{"USELESS software" LINK Useless.pic/main}@{ub} Click @{"here" LINK Preview.IFF/main} for a preview of how IntuiCookie could look on your Amiga. _______________________________________________________________________________ @{b} This version is a late BETA of v3.0. There shouldn't be any bugs left. IntuiCookie 2.95 was released to make some publicity for v3.0 and to remind you that E-Mailing me is very important for IntuiCookie's future.@{ub} ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ I. Introduction 1.1 @{"Preface" LINK Preface} 1.2 @{"Why should I use IntuiCookie?" LINK Features} II. Legal crap 2.1 @{"Copyright" LINK Copyright} 2.2 @{"About MUI" LINK MUI} III. Before you use IntuiCookie... 3.1 @{"Requirements" LINK Requirements} 3.2 @{"Installation" LINK Installation} IV. How to use IntuiCookie 4.1 @{"Usage" LINK Usage} 4.2 @{"Menus" LINK Menus} V. How to configure IntuiCookie 5.1 @{"Tooltypes" LINK Tooltypes} 5.2 @{"MUI preferences" LINK MUI-prefs} 5.3 @{"File format" LINK CookieFileFormat} 5.4 @{"CookHash" LINK CookHash} VI. Glossary 6.1 @{"What is a fortune cookie?" LINK FortuneCookie} 6.2 @{"What is a cookie file?" LINK Cookiefile} 6.3 @{"What is a hash file" LINK HashFile} VII. Misc texts 7.1 @{"Contact address" LINK Address} 7.2 @{"About the author" LINK AboutMe} 7.3 @{"Thanks to..." LINK Thanks} VIII. Past, Present and Future 8.1 @{"Past" LINK History} 8.2 @{"Present" LINK Present} 8.3 @{"Future" LINK Future} @ENDNODE @NODE Preface "1.1 Preface" @{u}@{b}1.1 Preface@{uu}@{ub} IntuiCookie is a program that will display fortune cookies. "Why another fortune cookie program?" I hear you scream in agony. And, I guess, you're right. The world doesn't need 14¹ implementations of the same basic program engine. So why did I write another fortune cookie program? Speed? Size of the database? Compatibility with entirely obsolete Amigas? Or did I 'just' want to write the best-looking, easiest to use and most configurable fortune cookie program for the Amiga? Well, I want you to decide. Install IntuiCookie *now*. I am sure you won't be disappointed. Unless you hate MUI. ______________ ¹ according to an "Aminet-Search" on the Aminet 7 CD, not including doors for BBS programs. @ENDNODE @NODE Features "1.2 Why should I use IntuiCookie?" @{u}@{b}1.2 Why should I use IntuiCookie?@{uu}@{ub} I could bore you for minutes enumerating all those nice features IntuiCookie offers. But I'm no vapourware programmer and I prefer short feature-lists. 1. IntuiCookie uses a (highly-configurable) MUI window to display the cookie. 2. IntuiCookie can be configured via tooltypes and menus. 3. It comes with CookHash, a MUI hash file program. 4. IntuiCookie and CookHash are localized. @ENDNODE @NODE Copyright "2.1 Copyright" @{u}@{b}2.1 Copyright@{uu}@{ub} IntuiCookie and all accompagnying files are (C)1995 Christian Kemp, except the guide icons, which are (C) Tom Ekström. All Rights Reserved. IntuiCookie requires and uses @{"MUI" LINK MUI} © Stefan Stuntz. @{b}This software is subject to the "Standart Amiga-FD-Software Copyright Note" It is Giftware as defined in paragraph 4g. For more information please read @{"AFD-COPYRIGHT" LINK AFD-Copyright/Main} (Version 1 or higher).@{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 Requirements" @{u}@{b}3.1 Requirements@{uu}@{ub} · Kickstart and Workbench V37 or later. Workbench 2.1 (V38) is required for localization. · MUI v8 or later. (Developed and tested on v10.0) · Memory usage depends on your configuration, for example whether you want IntuiCookie to have a background pattern. · ±300 kilobytes on your HD. (Only ±20 kilobytes have to reside on your boot partition.) @ENDNODE @NODE Installation "3.2 Installation" @{u}@{b}3.2 Installation@{uu}@{ub} Installation is accomplished through an Installer¹ script. Simply double-click on the Install icon and follow the on-screen instructions. Please do not install IntuiCookie by hand, it only causes unnecessary trouble. __________ ¹ Installer is © Commodore/Escom? and not included in this archive. @ENDNODE @NODE Usage "4.1 Usage" @{u}@{b}4.1 Usage@{uu}@{ub} Simply start it by clicking on its icon. A window will be opened, click on "Continue" to close it, or take a look at the @{"menus" LINK Menu} IntuiCookie can be customised via @{"tooltypes" LINK Tooltypes} and the MUI prefs program. @ENDNODE @NODE History @{b}@{u}History@{uu}@{ub} @{u}New in v2.95 (12.12.95)@{uu} · Obsolete CENTERED tooltype is replaced by COOKIE_PREPARSE and ORIGIN_PREPARSE. Possible arguments : CENTERED, BOLD, UNDERLINED (and combinations) Suggested by Stephan Grossien. · Full localisation for IntuiCookie. · Supports wordwrapping (optional, only if cookies are larger than 3 lines or if any line is longer than 80 characters). Wordwrapping suggested by Aristotelis Grypas. @{u}New in v2.91 (06.12.95)@{uu} · Basically only updates CookHash from v0.9 to v0.91. CookHash now supports localisation. @{u}New in v2.9 (28.11.95)@{uu} · Now requires MUI (Magic User Interface). Intuition and/or ReqTools support is obsolete. · 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. · Now also includes French and German docs · Localized button text @{u}New in v1.2 / v2.0 (27.08.95)@{uu} · Supports datafiles. · New REQPOS tooltype. Suggested by Stephan Grossien. · New documentation. · New MagicWB-WBStartup-look icon. @{u}New in v1.1 (19.08.95)@{uu} · Now supports ReqTools.library. Still works without Intuition. · New COOKIEFONT and COOKIEFONTSIZE tooltypes (ReqTools only). Suggested by Stephan Grossien. · 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 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 Menus @{b}@{u}Project menu@{uu}@{ub} @{u}About@{uu} · A requester with the version number, a giftware notice and my contact address will appear. Click on Continue to close the requester. @{u}Quit@{uu} · Will do the same as clicking on the close or Continue gadget : Close the window and quit. @{b}@{u}Show menu@{uu}@{ub} @{u}Origin@{uu} · Hide/unhide the Origin display, where the origin (= author, inventor) of a quote is displayed. If there is no origin the menu will appear ghosted. @{u}Button@{uu} · Hide/unhide the Continue gadget. @{u}Cookiefile Info@{uu} · Will display informations about the cookiefile. This data can be found in the first lines of the cookiefiles, everything before the first '%%' is considered as Info text. @{u}Cookie Info@{uu} · Will display the number of cookies in the file, the number of the current cookie and the size in bytes, including and excluding the size of the origin text (if any). IntuiCookie will not save any modification made through the menu options yet, you must change the @{"tooltypes" LINK Tooltypes} if you want a permanent change. @ENDNODE @NODE Tooltypes @{b}@{u}Tooltypes@{uu}@{ub} Using tooltypes is described in-depth in your Workbench manual. @{u}· The COOKIEFILE tooltype@{uu} Used to specify the location and name of the @{"cookie file" LINK CookieFile}. Example: @{u}· The HASHFILE tooltype@{uu} Used to specify the location and name of the @{"hash file" LINK HashFile} Example: @{u}· The COOKIE_PREPARSE tooltype@{uu} Used to specify the look of the cookie text. Possible options are CENTERED, BOLD, UNDERLINED. Two or three options can be combined. Example: =BOLD|CENTERED @{u}· The ORIGIN_PREPARSE tooltype@{uu} Used to specify the look of the origin text. Possible options are CENTERED, BOLD, UNDERLINED. Two or three options can be combined. Example: =UNDERLINED @{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: @{u}· The BUTTON tooltype@{uu} Used to specify if the Continue button will be displayed or not. Example: @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 "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 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. "@n" - Switch back to normal text. If you want wordwrapping, then simply use the same method for imputing cookies as in a word processor : press Return only when you want to have a new paragraph. Note that all text before the first '%%' is considered as Info Text, which can be displayed using the "Cookiefile Info" @{"tooltype" LINK Tooltypes}. @ENDNODE @NODE Future "Future" @{b}@{u}Future@{uu}@{ub} The following features are planned for future versions and will be implemented @{b}if I get some gifts or mails to motivate me@{ub}: (SORTED BY PRIORITY) · Prefs program · Support for multiple cookie files. · Copy a cookie to the clipboard or to a file. · Versions for other GUI libraries. (Probably ReqTools and BGUI). Version for CLI/Shell. · Support for command line arguments. · And, of course, your suggestions! The following features were planned, but will propably not be implemented: · Support for XPK'ed cookie files. I don't think this feature is that useful, as someone who wants to crunch datafiles will probably use XFH on a whole partition and not only XPK one file. · German and/or French docs, unless someboody requests them. @ENDNODE @NODE Thanks "Thanks" @{b}@{u}Thanks@{uu}@{ub} Thanks go to: Stephan Grossien from Germany, who has been an IntuiCookie user since 1.0 and who made a lot of suggestions. Aristotelis Grypas from Greece, who has written a @{b}very@{ub} long feature list. Olav Mueller for writing an E-Mail and reminding me that CLI compatibility is useful too. Martin Schulze for uploading IntuiCookie v1.0 and v1.2 (2.0) to the Aminet. Yes, ONLY THREE people actually wrote :-( @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 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