@DATABASE SmartIcons.guide
@AUTHOR "Marko Nippula & Harry Sintonen"
@(c) "Copyright © PitPlane Productions"
@$VER: SmartIcons.guide 2.0a (1.2.96)
@MASTER SmartIcons.guide
@INDEX Main
@REMARK ***************************************************************
@REMARK
@REMARK This documentation was originally created by Marko Nippula
@REMARK but it has changed a lot since, so blame me for spelling/
@REMARK grammar erors... ;-D
@REMARK
@REMARK ***************************************************************
@REMARK
@REMARK___________________________________________________________________________
@REMARK¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
@REMARK ¯ ¯¯~~¨°¤¤©®  speed optimized -- ASM & E -- size optimized  ®©¤¤°¨~~¯¯ ¯
@REMARK
@REMARK    @©¤°¨~°¤ø.  ø    ©    @©¤°¨~°¤ø.  ø
@REMARK    ©        ¾       ®    ©        ¾  ®             _
@REMARK    ®       .©  ©  ¾©®©@² ®       .©  ®    ¤°~~°¤.  ©¤°~°¤ø.  .ø¤°~°¤ø.
@REMARK    ®_     .ø~  ®    ©    ®_     .ø~  ®          @  ®      @  @       ¾
@REMARK    ®~°¨°¤°'    ®    ©    ®~°¨°¤°'    ©   ¸ø¤°¨~°©  ®      ©  ©~¨°°°¨~~
@REMARK    ©           ©    ©    ©           ©   ©      ®  ©      ®  ¾.
@REMARK    ©           ©    ¤ø·  ©           ¤ø· ~¤øø¼½¤©ø ©      ©   °¤øø¼ø¤  [D]
@REMARK
@REMARK  ¯ ¯¯~~¨°¤¤©®  high quality ·· low price ·· no guarantine  ®©¤¤°¨~~¯¯ ¯
@REMARK
@REMARK                        ···p·r·o·d·u·c·t·i·o·n·s·· ·
@REMARK___________________________________________________________________________
@REMARK¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
@REMARK
@REMARK         _¦____    _  _.___  _.____  _.___
@REMARK          |    \  (_)  |   |  |    \  |   |   ____  .____   _____
@REMARK          |   O } ___ |_   _| |   O } |   |  |__  | |    | |  _  |
@REMARK          |    / |   | |   |` |    /  |   | |¯ _  | |  | | | ____|
@REMARK          |___|` |___| |___|  |___|`  |___| |_____| |__|_| |____|`
@REMARK          `   `  `   ` `   `  `   `   `   ` `     ` `  ` ` `    ` [D]
@REMARK                        rullaa... muut syÖ pullaa ¡
@REMARK
@REMARK
@node Main "SmartIcons Guide"

     @{b}SmartIcons 2.0a@{ub} --- Great standard icons to Amiga

          @{b}FreeWare     Copyright © 1996 PitPlane Productions@{ub}

             @{"  SmartIcons rel 2 -- 1996 Harry Sintonen  " link About}

       @{"   Introduction     " link Introduction 0}     What's this?
       @{"   About            " link About        0}     Some words about SmartIcons.
       @{"   Features         " link Features     0}     What can it do?
       @{"   Requirements     " link Requirements 0}     Do I need to upgrade?
       @{"   Installing       " link Installing   0}     How can I do it?
       @{"   Package          " link ThePackage   0}     What's included?
       @{"   SIPatch          " link SIPatch      0}     Is this a hack or something?
       @{"   SIC              " link SIC          0}     SIC? What's that!?
       @{"   Tips             " link Tips         0}     Some tips.
       @{"   Important notes  " link Notes        0}     Please read.
       @{"   License          " link License      0}     FreeWare!
       @{"   Disclaimer       " link Disclaimer   0}     Kaboom!!
       @{"   History          " link History      0}     What has happened.
@endnode

@node Introduction "Introduction -- What's this?"
@TOC Main

     @{b}INTRODUCTION@{ub}

     SmartIcons is a program package which will allow you to use
     "standard icons". Instead of having big .info files which contain
     a lot of graphical data, you may now have tiny .info files, whose
     doesn't contain image-data, instead they contain reference to file
     where image-data will be gotten.

     If you have a harddisk, you often have a lot of of similar
     looking icons on it. You may have sometimes thought that it would
     be nice if those icons would use the same image instead of they
     all having their own. This is where SmartIcons comes in. But
     SmartIcons does much much more. It, for example, could speed up
     Workbench a bit, and reduce Workbench's memory usage.

     @{b}Technical introduction:@{ub}

     SmartIcons reduces both disk and memory usage of icons. This has
     been achieved by patching functions that OS and applications use
     for icon processing. The identical image (SmartIcon Image) of
     Smarticons is kept in memory only once. This way you can easily
     have thousands of icons open on Workbench. Smarticon on disk
     usually take only few hundred bytes (two disk blocks). As icon
     files are short loading them speeds up drasticly.
@endnode

@node Features "Features -- What can it do?"
@TOC Main

     @{b}ADVANTAGES@{ub}

     o You can save a lot of HD space.
     o SmartIcons helps you to standardize your icons (eg. it won't
       look very nice to have dozens of different kinds of doc-icons
       on your HD), you can make different kind of icons, which all
       are for similar files, have the same image very easily.
     o If you are using MagicWB (© Martin Huttenloher)
       you may easily convert some of your KS 2.0 or 1.3 colored icons
       into MagicWB ones.
     o You can make loading long drawers (C, Libs, etc.) a lot faster
       by simply converting EnvArc:Sys/Def_Project.info and
       EnvArc:Sys/Def_Tool.info into Smarticons.
     o Caches SmartIcon Images into memory.
     o Cleans up memory wasted by unused SmartIcon Images whenever 
       memory is needed for any other purpose.
     o On-line help.
     o Much more...

     @{b}RESTRICTIONS@{ub}

     o There is no easy way to make your whole HD use Smarticons 
       instead of normal icons. (YET!)
     o There is no easy way to convert all Smarticons from a disk or a
       HD back to normal. (YET!)
     o If you haven't run @{"SmartIconsPatch" link SIPatch}, Smarticons look a little
       bit strange. Your friends might complain about strange icon
       images on disks you've send to them, but then, give'em
       SmartIcons!!
     o SIPatch cannot be removed from memory (there isn't any reason to
       do so, anyway).
     o None of these programs is commodity. (YET!)
     o Needs @{"'SmartIcons:'" link SmartIconsAssign} -assign.
@endnode

@node Requirements "Requirements to run SmartIcons -- Do I need to upgrade?"
@TOC Main

     @{b}REQUIREMENTS@{ub}

     SmartIcons requires an Amiga :), OS 2.x or higher. Under newer
     kickstart (OS 3.x+) SmartIcons has some additional features.

     SmartIcons has been developed and tested (actually I use
     SmartIcons all the time) on @{"Amiga 1200" link ItIsMineMineMine}.
@endnode

@node Installing "Installing SmartIcons -- How can I do it?"
@TOC Main

     @{b}INSTALLING@{ub}

     Installing SmartIcons is (relatively?) easy; just drag (copy)
     SmartIcons drawer icon into your disk and add @{"'SmartIcons:'" link SmartIconsAssign}
     -assign.

     After adding SmartIcons: -assign you should drag SIPatch into
     WBStartUp drawer or make it run any other way everytime you boot
     up.

     Now, reboot and see the documentation of @{"SIC" link SIC}.
@endnode

@node ThePackage "Contents of SmartIcons package -- What's included?"
@TOC Main

     @{b}THE PACKAGE@{ub}

     SmartIcons currently consists of three programs:
     o @{b}SIPatch@{ub}          - SmartIconsPatch
     o @{b}SIC@{ub}              - SmartIcons Converter
     o @{b}IcoMe@{ub}            - Display SmartIcon Images in memory

     All programs can be run from both CLI and Workbench.

     And some other files:
     o @{b}SmartIcons.guide@{ub} - AmigaGuide document file
     o @{b}SmartIconImages@{ub}  - Drawer containg SmartIcon Images

     + Bunch of icons.

     @{b}NOTE:@{ub} Some of these programs can't be used without
     @{"'SmartIcons:'" link SmartIconsAssign} -assign.

     @{"SIPatch" link SIPatch} must be run before any program which uses icons, or the
     program may have problems handling Smarticons.

     @{"SIC" link SIC} is a program which allows you to convert some icons into
     Smarticons and opposite too. SIC has currently only graphics
     interface, CLI tools for converting icons are coming soon.

     @{b}IcoMe@{ub} is a small program which allows you to see which SmartIcon
     Images are currently in memory and how many Smarticons are using
     each Image. Currently it has no parameters.
@endnode

@node SIPatch "SmartIconsPatch -- Heart of SmartIcons"

     @{b}SMARTICONSPATCH@{ub}

     SmartIconsPatch is the heart of SmartIcons. It handles image
     loading, caching, flushing and all compability with Workbench and
     other applications.

     SIPatch must be run before any program which uses icons, or the
     program may have problems handling Smarticons. Often a good place
     for SIPatch is in StartUp-Sequence just before LoadWB-command.
     You might also replace LoadWB with script, which first runs
     SIPatch and then original LoadWB, which is renamed to some other
     name. If you won't convert icons which appear when Workbench has
     been loaded, you may drag SIPatch into WBStartUp-drawer.

     @{"      If you feel confused click this link...      " link Phil}

     @{"      CLI and WB arguments of SmartIconsPatch      " link SIPatchArgs}

     SIPatch tries to be as OS compatible as possible. It can be said
     that if problems occur, they aren't because of SIPatch. SIPatch
     isn't a hack or a kludge and there can't be any problems removing
     it as this isn't possible... ;-)

     @{b}Error conditions:@{ub}

     If your SmartIcons: -drawer doesn't contain image which is
     referenced in some Smarticon you'll get error message. With
     @{"ERRORMODE" link SIPatchArgs}=REQUESTER you get this error requester:
            _______________________________________________
            |SmartIconsPatch                            [_]
            ||¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯||
            ||   Cannot load Image                       ||
            ||   'XXXX.info'.                            ||
            ||___________________________________________||
            |.-------..---------..-------------..--------.|
            || Retry || Use def || Use def all || Cancel ||
            |`-------'`---------'`-------------'`--------'|
            ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
     (XXXX is the ID of the missing SmartIcon Image.)

     .-------.
     | Retry |            Retry will try to load Image again.
     `-------'

     .---------.          Use default will cause SmartIcons to create
     | Use def |          pseudo Image for ID in question. Image will
     `---------'          contain system default icon image accordinly
                          to icon's type. There might arise a problem
                          if you have converted this system default
                          icon into Smarticon and its Image is missing
                          too. (See Cancel.)

     .-------------.      This is same as previous, with one exception:
     | Use def all |      All possibly missing Images to come will get
     `-------------'      pseudo Images created for them. This is useful
                          if you find dozens of Images missing and
                          don't want to hit 'Use def' all the time.
                          @{b}NOTE:@{ub} After pressing this button you'll never
                          (before next reboot) see this requester again.

     .--------.           In some cases even system default image isn't
     | Cancel |           accessable (I've never seen this happen
     `--------'           though). In this case this requester will pop
                          up asking same ID again and again. Then you
                          have to select Cancel.

     @{b}NOTE:@{ub} All SmartIcon activity is disabled until you select one of
     the buttons.
@endnode

@node SIPatchArgs "CLI and WB arguments of SmartIconsPatch"

     @{b}SMARTICONSPATCH ARGUMENTS@{ub}

     SIPatch can be run from both CLI and Workbench. It supports two
     parameters which act similariry in both environments.

     @{b}ERRORMODE@{ub}          -- This describes the mode to be used in error
                           conditions (Image is missing). By default
                           SIPatch will only display beep on screen and
                           proceed as Cancel had been pressed on error
                           requester. If you specify ERRORMODE=
                           REQUESTER error requester will pop up. If
                           you don't want to see any visual
                           presentation on error conditions set
                           ERRORMODE=NONE. If you want pseudo Images to
                           be created for all missing Images set
                           ERRORMODE=PSEUDOALL.

     @{b}QUIET@{ub}              -- If this switch is specified SIPatch will not
                           output anything on console or Workbench
                           screen on it's failure conditions. Normally
                           SIPatch displays error message if it
                           couldn't get run or it was already active.
@endnode

@node SmartIconsAssign "SmartIcons: -assign"

     @{b}SMARTICONS: -ASSIGN@{ub}

     @{b}WARNIGN:@{ub} Be aware that this assign is @{b}not@{ub} intended to point to
     SmartIcons drawer, but SmartIcon Images drawer!!

     To make these programs work, you must first assign 'SmartIcons:'
     to SmartIcon Image drawer. Initially this image drawer lies on
     SmartIcons drawer as name SmartIconImages, but it can be moved
     elsewhere on your disk. 'SmartIcons:' is where these programs keep
     SmartIcon Image icons for Smarticons.

     You can simply add similar line as follows to your S:User-Startup
     file:

     @{b}Assign SmartIcons: "foo:bar/burb"@{ub}

     ...where foo:bar/burb is the path for SmartIcon Image drawer. For
     example if you had simply copied SmartIcons drawer to 'Work:Util/'
     drawer the line would be

     @{b}Assign SmartIcons: "Work:Util/SmartIcons/SmartIconImages"@{ub}
@endnode

@node Tips "Tips on using SmartIcons"
@TOC Main

     @{b}SOME TIPS@{ub}


     o Convert ENVARC:Sys/def_xxxx icons into Smarticons. If the images
       of these icons aren't found from SmartIcon Image list add them
       as SmartIcon Images first. Workbench pseudo icon
       (Window/Show/All Files) handling speeds up drasticly and memory
       usage will drop.


     o Use 'Change default tool' and 'Change tool types' modes when
       needed, they make your life a lot easier. For example, if you
       have 100 doc files using XYZView as their default tool and the
       doc icon as awfully looking then pick some ReadMe image from
       SIC's image list and check 'Change default tool' and 'Change
       tool types'. Then drop all these doc files at once into SIC's
       window and life is again little easier.


     o If you have some text/pictures/modules/whatever drawer containg
       loads of similar files you can check 'Whole directory' and drag
       the drawer icon into SIC's window and the whole directory will
       be processed...


     o 'Whole directory' works on all operations: Smarting, Un-smarting
       and when adding SmartIcon Images.


     o If you use for example ViewTek display program as your default
       tool for your picture files and you get new and better display
       program (how about Visage) and you decide to change default tool
       for all those files then you can simply change SmartIcon Image's
       default tool [from WB (V37) or from 'Special/SmartIcon Image
       Info...' -menu selection (V39)] and drop all your picture files
       into SIC's window. That's it.


     o You can use this kind of script replacing LoadWB or by name
       LoadSWB instead of LoadWB in your S:startup-sequence file:

     ---- LoadSWB script file ---- cut --------------------------------
     .KEY PARAMS/F
     .BRA {
     .KET }
     
     ;
     ; LoadSWB 2.0 (25.12.95)
     ;
     ; Script for SmartIcons loadwb
     ;

     ; Run SmartIconsPatch:

     SIPatch ERRORMODE=REQUESTER QUIET
     
     ; You can, of course, use whatever parameters you like with
     ; SIPatch.
     
     ; Now, run the original LoadWB with params given to this script:

     LoadWB {PARAMS}

     ; If you use this script replacing original LoadWB you must rename
     ; LoadWB (for name LWB for example) and modify line above
     ; accordingly.
     ---- LoadSWB script file ---- cut --------------------------------


     o There's no color limitation: you can use 2 to 256 color icons as
       you wish. If fact, SmartIcons should be able to handle even all
       the future icons to come!


     o If you decide that you've found better imaginary for some
       SmartIcon Image you can simply modify the SmartIcon Image icon
       (located to SmartIcons: -assign) with some icon editor (@{"Iconian" link Iconian}
       is a good one). To see the change on screen you (might) have to
       reboot.


     o @{i} Still a bit under construction, sorry...@{ui}
@endnode

@node Notes "Some notes considering SmartIcons"
@TOC Main

     @{b}IMPORTANT NOTES@{ub}


     o If decide to use SmartIcons in everyday life you should be
       prepared to encount some complaints from your friends and swap
       contacts: If you send some stuff to others you should remember
       to Un-smart icons of those files you're sending. The easiest way
       is to Un-smart all the files you're going to send as it doesn't
       matter whether the icon is smart or not, only smarticons will be
       un-smarted. The other solution is to spread SmartIcons package
       all over the world!  ;-)


     o Although the SmartIcon Image icons in SmartIconImages -drawer
       are MagicWB style they can also be any style you like. You're of
       course allowed to create your own versions of the icons (4
       colored version? NewIcons?) and spread them as PD. It would be
       nice if you'd send your brand new collection to @{"me" link About 18} too. Thank
       you already...


     o You can completely destroy your unique icon imaginery by
       converting them into Smarticons (dropping them into SIC's
       window) so be careful!

       Only convert icons you know you won't be needing anymore!

       I've warned you!


     o If you look carefully into SmartIconImages -drawer you can see
       that each SmartIcon Image .info file has its description as
       comment (Type "List SmartIcons:" to see them). You may modify
       these comments by hand, but you're adviced to use SIC (Special/
       Rename SmartIcon Image -menu selection). There's one other thing
       too: you must be careful not to do such operation that thouches
       file comments!! This is very important as you can easily discard
       all your SmartIcon Image descriptions (I've managed to do this
       once and I can tell you it wasn't fun at all!). So always
       remember to use "Copy CLONE" when copying SmartIcon Image files
       within Shells and CLIs etc.


     o The only thing really smartened about icons is their imaginary.
       Default tool and tool types aren't taken from SmartIcon Image
       but from the icon itself. What this really means is that if you,
       for example, change SmartIcon Image default tool the change
       won't take place on converted icons. The check boxes about
       default tool and tool types in SIC main window mean only whether
       they should be preserved as in the original icon (not checked)
       or copied from the SmartIcon Image (checked).

       This may change in the future. I've planned to include smart
       default tool and tool types too.
@endnode

@node SIC "SIC -- SmartIcons Converter"
@TOC Main

     @{b}SMARTICONS CONVERTER@{ub}

     SIC is the most complex part of the SmartIcons package. SIC is a
     program which allows you to convert some @{"icons into Smarticons" link Smarting},
     @{"Smarticons into normal icons" link UnSm} and @{"add new SmartIcon Images" link Addi}. You
     may also manipulate SmartIcon Images a bit using SIC.

     @{b}Running SIC:@{ub}

     If you have @{"Installed SmartIcons" link Installing 0} correctly then you should be able
     to run SIC instantly. If you haven't done installation (at all/
     correctly) you should @{"prepare some things" link Preparation 0} for SIC.

     Running SIC is easy: Just type SIC <return> in CLI or double-click
     its icon in Workbench.

     While you're using SIC and you begin to feel uncertain how things
     work, feel free to hit HELP-key at any time. You'll get
     instructions on @{"How to use SIC" link SHMW 0}.
@endnode

@node Preparation "What need to be done to get SIC running"
@TOC SIC

     @{b}PREPRATIONS@{ub}

     You must have directory for SmartIcon Images and assign
     @{"'SmartIcons:'" link SmartIconsAssign} to it.

     If @{"SIPatch" link SIPatch} hasn't been run, run it now. (However, sometimes it
     could be better not to run SIPatch as this is the only easy way
     to know which icon is a Smarticon and which isn't. PLEASE NOTE:
     You can only convert icons if SIPatch is running.)

     Then you may run SIC.
@endnode

@node SHMW "How to use SmartIcons Converter"
@TOC SIC

     @{b}HOW TO USE SMARTICONS CONVERTER@{ub}

     @{"                       SmartIcons' philosophy      " link Phil}

     @{" CLI and WB arguments of SmartIcons Converter      " link SICArgs}

     @{"             Adding some new SmartIcon Images      " link Addi}
     @{"          Converting an icon into a Smarticon      " link Smarting}
     @{"      Converting a Smarticon into normal icon      " link UnSm}
     @{"                 SmartIcons Converter's menus      " link Menus}

     If you check 'Whole directory', and drop a drawer into SIC's main
     window, drawer icon will not be affected in any way, but all files
     in it will be processed. @{b}NOTE:@{ub} This operation isn't recursive.
@endnode

@node Phil "SmartIcons' philosophy -- What is what"
@TOC SHMW

     @{b}SMARTICONS' PHILOSOPHY@{ub}

     You might be little confused. That's ok, as this isn't the most
     self explonary program in the world. Some terms should be
     explained, I think...

     @{b}Smarticon@{ub}          -- This is an converted icon which lies
                           on your disk as any other icon.

     @{b}Converting,@{ub}
     @{b}Smarting@{ub}           -- Operation where bulky, ugly, terribly
                           looking, or otherwise unwanted icon is
                           converted into Smarticon.

     @{b}Un-smarting@{ub}        -- Operation in which you convert Smarticon
                           into normal icon. This is usually done when
                           you want to release some stuff with real
                           icons. @{b}Please note:@{ub} Un-smarting does @{b}not@{ub}
                           restore the original imaginary of the icon
                           (the icon you Smartened), but converts
                           Smarticon into "real" icon.

     @{b}SmartIcon Image@{ub}    -- This is an image which is displayed on a
                           converted icon (Smarticon). These image
                           icons reside only in @{"SmartIcons:" link SmartIconsAssign} -drawer.
                           When you run SIC the list of available
                           SmartIcon Images is shown on right side of
                           the window.

     @{b}Adding SmartIcon@{ub}
     @{b}Images@{ub}             -- Operation where you add new SmartIcon
                           Images.
@endnode

@node SICArgs "CLI and WB arguments of SmartIcons Converter"
@TOC SHMW

     @{b}SMARTICONS CONVERTERS' ARGUMENTS@{ub}

     SIC can be run from both CLI and Workbench. It supports three
     parameters which act similariry in both environments.

     @{b}CONFIG@{ub}             -- This is the full path of the config file.
                           In WB you can also have several
                           configurations as project files and SIC as
                           their Default Tool. By default config file
                           is 'PROGDIR:SIC.config'.

     @{b}HELP@{ub}               -- This is the full path of the on-line help
                           AmigaGuide file (This document, in fact!).
                           By default it is 'PROGDIR:SmartIcons.guide'. If
                           the document can't be found from this location
                           'S:SmartIcons.guide' (V37) or
                           'HELP:SmartIcons.guide' (V39+) will be tried
                           last. This is useful if you have some special
                           location for storing document files and you
                           want to move SmartIcons' document there.

     @{b}ICONSTART@{ub}          -- Request SIC to start as iconified.
@endnode

@node Addi "Adding new SmartIcon Images"
@TOC SHMW

     @{b}ADDING SMARTICON IMAGES@{ub}

     Although loads of SmartIcon Images are shipped among this package,
     you might want to add some new ones to SmartIcons. You can add new
     images any time you want to. Images can also be manipulated with
     @{"'Special'" link Menus 13} -menu.

     If you want to add SmartIcon Images then first check the "Add
     SmartIcon Image" -checkbox. If you drag any icon using Workbench
     to SIC's window, it'll be added to @{"SmartIcons:" link SmartIconsAssign} -drawer. When you
     have dropped an icon, a requester appears, which prompts a @{b}ID and@{ub}
     @{"Description" link Desc} for Image. ID can only contain four letters and it
     MUST be unique. Description is description of image which you'll
     see on listview at right side of SIC's main window. If you select
     Cancel gadget in add-requester operation is cancelled and no new
     SmartIcon Image is added to SmartIcons: -drawer.

     See @{"SmartIcon Image ID selecting policy" link Politics}.

     @{b}NOTE:@{ub} If you are going to add an drawer icon to SmartIcons,
     drawer icon must have curresponding directory.
@endnode

@node Politics "Politics: How do I select ID for SmartIcon Image then?"
@TOC SHMW

     @{b}POLITICS ;-)@{ub}

     Selecting ID for image is simple: It must have 1 to 4 characters
     and it must be unique, that is, the ID hasn't be used by any other
     SmartIcon Image previsously. Note that if given ID is used
     previously by some image it will not be accepted and new ID is
     asked.

     There's a problem, though. If all users add new SmartIcon Images
     and give IDs to them somewhat randomly, the icons aren't
     compatible with each other. This could be prevented by strict
     rules about icon IDs, but I don't want do it. The truth is
     that people mostly use SmartIcons privately, and don't spread
     stuff with Smarten icons. Or this should be the case, at least.
     Well, anyway, if you ran into problems because of missing images
     then calmly convert those icons with SIC into @{b}your@{ub} settings.
     Your personal taste counts.

     Maybe in the future all Amiga user around the world use
     SmartIcons and compatibility problems may occur... Or maybe not!
     ;-)
@endnode

@node Smarting "Converting an icon into a Smarticon"
@TOC SHMW

     @{b}SMARTING, CONVERTING@{ub}

     @{b}PLEASE NOTE:@{ub} You will lose the original image of the icon you're
     about to convert into Smarticon. Note also, that @{"Un-smarting" link UnSm} does
     @{b}not@{ub} restore the original image!

     First make sure that both, 'Add SmartIcon Images' and 'Un-smart
     Smarticon' checkbox aren't checked.

     Then drag an icon (or even several icons) into SIC's main window.
     The icon/icons will be converted into currently selected
     SmartIcon Image. (The current image is shown in a box on left top
     of the SIC's main window.)

     Conversion can be controlled using several settings. If 'Change
     icon type' is checked, then icon's type will be changed to
     reflect SmartIcon Image's type. If 'Change default tool' is
     checked, then icon's default tool will be changed. (This checkbox
     has no effect if icon type isn't project.) If 'Change tool types'
     is checked, then icon's tool type -array will be changed. If file
     has no previous icon (it was pseudo-icon), it will be handled as
     if 'Change icon type', 'Change default tool' and 'Change tool
     types' all were on.

     @{b}NOTE:@{ub} If you are going to convert an drawer icon into a Smarticon,
     drawer icon must have curresponding directory.
@endnode

@node UnSm "Converting a Smarticon into normal icon"
@TOC SHMW

     @{b}UN-SMARTING@{ub}

     First uncheck 'Add SmartIcon Image' and check 'Un-smart
     Smarticon'. Then drop an icon (or many icons) into SIC's main
     window and they'll be converted into normal icons.

     If you drop normal icons to SIC's window when Un-smarting is on
     they aren't touched in any way.

     Converting a Smarticon into a normal one also often works, if you
     load a Smarticon into some icon editor (@{"Iconian" link Iconian} does fine,
     @{"IconEdit" link IconEdit} doesn't) and then save it back without changing it.
@endnode

@node Iconian "The best icon editor for Amiga: Iconian"

     @{b}ICONIAN@{ub}

     Iconian (Copyright © 1993-1995 Chad Randall) is the best icon
     editor for Amiga. Its feature list is so long that I won't even
     try to memberize it here. If you're still using pathetic IconEdit
     get Iconian NOW!

     Iconian is a stabil, well behaving program and it also works with
     Smarticons perfectly.
@endnode

@node IconEdit "The not so good icon editor for Amiga: IconEdit"

     @{b}ICONEDIT@{ub}

     Workbench 2.x/3.x introduced new icon editor: IconEdit. It was
     nice, but not best possible. It for example does some of its
     handling directly to DiskObject's image. For example, Extras/
     Recolor function does it's job by flipping two first planes! This
     is done directly to DiskObject. These kind of direct DiskObject
     image changes aren't nice thing to do. You can get strange effects
     if you edit Smarticons with IconEdit.

     If you're serious artist get @{"Iconian" link Iconian}.
@endnode

@node Menus "SmartIcons Converter's menus"
@TOC SHMW
@NEXT Desc

     @{b}SMARTICONS CONVERTER'S MENUS@{ub}

     @{b}Project-menu:@{ub}

       @{b}Open...@{ub}      /| O    These are used to load or save
       @{b}Save@{ub}         /| S    configuration.
       @{b}Save as...@{ub}   /| A
       @{b}About...@{ub}     /| ?    This gives some information about SIC.
       @{b}Help...@{ub}      /| H    Gives help about using SIC.

       @{b}Quit@{ub}         /| Q    Quits SIC, note that this is the only way
                            to really exit SIC, close gadget just
                            @{"iconifies" link Iconify} SIC.

     @{b}Special-menu:@{ub}

       @{b}Rename SmartIcon Image...@{ub}  /| R   Allows you to give a
                                         new @{"description" link Desc} for a SmartIcon
                                         Image.

       @{b}Remove SmartIcon Image...@{ub}  /| D   Allows you to remove a
                                         SmartIcon Image.
                                NOTE: Never remove SmartIcon Image
                                before you are sure that no icon uses
                                it.

       @{b}SmartIcon Info...@{ub}          /| I   Under KS 3.x or better:
                                         Gives similar info requester
                                         as in Workbench. With this
                                         you can easily change default
                                         tool and tooltypes of
                                         SmartIcon Image icon.

       @{b}Rescan SmartIcons@{ub}                 Re-reads list of SmartIcons
                                         displayed at the right
                                         side of SIC's display. Please
                                         select this menu-item every time
                                         you have made any changes to
                                         @{"SmartIcons:" link SmartIconsAssign} -drawer "by hand".
@endnode

@node RenS "Renaming SmartIcon Image"

     @{b}RENAMING SMARTICON IMAGE@{ub}

     This rename operation only changes description of the SmartIcon
     image. See @{"ID and Description of SmartIcon Image" link Desc}.
@endnode

@node Desc "ID and Description of SmartIcon Image"
@TOC SHMW
@PREV Menus

     @{b}ID AND DESCRIPTION OF SMARTICON IMAGE@{ub}

     @{b}ID@{ub} is a maximum four characters long identification for SmartIcon
     Image. See @{"SmartIcon Image ID selecting policy" link Politics}.

     @{b}Description@{ub} is a description of SmartIcon Image which you'll see
     on listview at right side of SIC's main window. It's often used
     simply to describe the Image. The name should be informative and
     simple, you should also follow some kind of a standard when you
     describe your SmartIcon Images.
@endnode

@node Iconify "Iconify"

     @{b}ICONIFY@{ub}

     Just press the close gadget of SIC and it'll be iconified.
     @{b}NOTE:@{ub} If an icon 'SIC_Iconify.info' is in SmartIcons:, it'll be
     used when SIC is iconified, else SIC's own icon.
@endnode

@node License "License"
@TOC Main

     @{b}LICENSE@{ub}

1.   This license applies to the product called "SmartIcons", a program for
     the Amiga computer, published by PitPlane Productions under the concepts
     of FreeWare, and the accompanying documentation. The terms "Program" and
     "SmartIcons" below, refer to this product. The licensee is addressed
     as "you".

2.   You may copy and distribute verbatim copies of the program's
     executable code and documentation as you receive it, in any medium,
     provided that you conspicuously and appropriately publish only the
     original, unmodified program, with all copyright notices and
     disclaimers of warranty intact and including all the accompanying
     documentation, example files and anything else that came with the
     original.

3.   You may not copy and/or distribute this program without the
     accompanying documentation and other additional files that came with
     the original. You may not copy and/or distribute modified versions of
     this program.

4.   You may not copy, modify, sublicense, distribute or transfer the
     program except as expressly provided under this license. Any attempt
     otherwise to copy, modify, sublicense, distribute or transfer the
     program is void, and will automatically terminate your rights to use
     the program under this license. However, parties who have received
     copies, or rights to use copies, from you under this license will not
     have their licenses terminated so long as such parties remain in full
     compliance.

5.   By copying, distributing and/or using the program you indicate your
     acceptance of this license to do so, and all its terms and conditions.

6.   Each time you redistribute the program, the recipient automatically
     receives a license from the original licensor to copy, distribute
     and/or use the program subject to these terms and conditions. You may
     not impose any further restrictions on the recipients' exercise of the
     rights granted herein.

7.   You may not disassemble, decompile, re-source or otherwise reverse
     engineer the program.

8.   If you wish to incorporate parts of the program into other programs,
     write to the @{"author" link About 18} to ask for permission.

9.   You agree to cease distributing the program and data involved if
     requested to do so by the author.

10.  You may charge a fee to recover distribution costs. The fee for
     diskette distribution may not be more than the cost to obtain a public
     domain diskette from Fred Fish.
@endnode

@node Disclaimer "Disclaimer"
@TOC Main

     @{b}DISCLAIMER@{ub}

     NO GUARANTEE IS GIVEN NOR IMPLIED THAT THIS PROGRAM IS FIT FOR ANY
     USE. THIS PROGRAM AND THE INFORMATION WITHIN THIS TEXT IS PROVIDED ON
     "AS IS" BASIS. THE ENTIRE RISK AS TO ITS QUALITY AND PERFORMANCE IS
     WITH THE USER. SHOULD THE PROGRAM PROVE DEFECTIVE, THE USER (AND NOT
     THE AUTHOR) ASSUMES THE ENTIRE COST OF ALL NECCESSARY DAMAGES. IN NO
     EVENT WILL THE AUTHOR BE LIABLE FOR DIRECT, INDIRECT, INCIDENTAL OR
     CONSEQUENTIAL DAMAGES RESULTING FROM ANY DEFECT IN THE PROGRAM. THE
     AUTHOR RESERVES THE RIGHT TO MAKE CHANGES TO THE SOFTWARE OR
     DOCUMENTATION WITHOUT NOTICE.
@endnode

@node About "About SmartIcons -- Some words about SmartIcons"
@TOC Main

     @{b}ABOUT SMARTICONS@{ub}

     @{b}SmartIcons software and documentation are Copyright © 1996 PitPlane
     Productions. All Rights Reserved.@{ub}

     SmartIcons has been created using @{b}CygnusEd by CygnusSoft Software@{ub},
     @{b}Devpac by HiSoft@{ub} and @{b}AmigaE by Wouter van Oortmerssen@{ub} on an
     @{"accelerated Amiga 1200" link ItIsMineMineMine}.

     SmartIcons release 1 created by @{"Marko Nippula" link MarkoRulezOrWhat}.
     SmartIcons release 2 created by Harry Sintonen.

     If you haven't yet discovered, SmartIcons is FreeWare.

     If you have any suggestions or remarks about this program, or if you
     find any bugs, please let me know.

     Write to the following address (for @{"bug-reports" link BugReports}, comments etc.):

             @{b}SnailMail:@{ub} Harry Sintonen
                        Kotipolku 30
                        48710  KARHULA
                        Finland - Europe

             @{b}Phone:@{ub} +358-52-609-049
             (voice only, in English or Finnish, please!)
@endnode

@node BugReports "About bug reports"
@TOC Main

     @{b}ABOUT BUG REPORTS@{ub}

     When sending in bug reports, please state exactly under what 
     circumstances the bug occurred, what equipment was used and what 
     happened. If possible also try to give me enough information to 
     reproduce the bug. Dumps produced by common debugging tools are
     welcome. It is very difficult to find bugs when you don't know 
     exactly what happened.

     You are strongly encouriged to use included @{"bug-report -form" link BugForm} to
     report bugs.
@endnode

@node BugForm "Form for sending bug reports"
@TOC Main

     @{b}BUG-REPORT@{ub}

     I HAVE FOUND BUG(S) FROM SmartIcons. I HAVE VERSION ________.

     NAME:__________________________________________________________________


     ADDRESS:_______________________________________________________________


             _______________________________________________________________


             _______________________________________________________________

     ELECTRONIC ADDRESSES: (if any, ie. Internet Email, FidoNet Netmail etc.)


             _______________________________________________________________

     MACHINE CONFIGURATION:
     (ie. 500, 600, 1000, 1200, 1400, 1500, 2000, 2500, 3000, 4000...)


     _______________________________________________________________________


     _______________________________________________________________________

     DETAILED DESCRIPTION OF BUG (ENVIRONMENT, ANY DEBUGGING INFORMATION
     RECEIVED FROM YOUR FAVORITE DEBUGGING TOOLS (ENFORCER etc.), WHAT YOU
     WERE DOING WHEN BUG OCCURED OR SIMILAR STUFF:


     _______________________________________________________________________


     _______________________________________________________________________


     _______________________________________________________________________


     _______________________________________________________________________


     _______________________________________________________________________


     _______________________________________________________________________


     _______________________________________________________________________


     _______________________________________________________________________




     ______________________   ______________________________________________
            (Date)                               (Signature)
@endnode

@node History "Program History"
@TOC Main

     @{b}PROGRAM HISTORY@{ub}

     ==== Version 2.0a ==== February 1st, 1996 =============================

     - Second public release
     - Developer changed to Harry Sintonen, thanks to @{"Marko" link MarkoRulezOrWhat 0}!
     - SIPatch rewritten.
     - SIC partly rewritten.
     - This document almost fully rewritten.
     - Loads of new and missing features added, and features that weren't
       suppose to exist (bugs ;^) removed. Lotsa weird bahavior
       cured.

     ==== Version 1.0a ==== April 20th, 1995 ===============================

     - First public release, ten or less (?) known users
     - All original versions of SmartIcons package were developed by
       Marko Nippula.
@endnode

@node MarkoRulezOrWhat "Marko Nippula"

     @{b}MARKO NIPPULA@{ub}

     Marko is a good friend of mine and the best coder I know
     (personally B-). He studies lots of weird stuff (that no man can
     understand) at some wicked place called Otaniemi... :-P


     If you wanna tease him, send lotsa stupid mail to this address:

          E-Mail: Marko.Nippula@hut.fi

                  (or if I didn't get it right above try:
                   mnippula@vipunen.hut.fi)

     If you wanna have good laugh then peek Marko's homepage!

     WWW homepage: http://www.hut.fi/~mnippula


     (Seriously, this homepage is really quality one, just go and see!)
@endnode

@node ItIsMineMineMine "My Amiga -- I see, you're curious..."
@NEXT Null

     @{b}IT'S MINE MINE MINE...@{ub}

     I have an Amiga 1200 with 10 Megs of memory, 540 MB harddisk and
     50 MHz 68030 Blizzard turbo.

     By the time this program is released, I'll probably own 68060
     accelerator, Microvitec multisync monitor and more than 1 Gig
     harddisk space.

     But seriously... :-)

     I'll probably only buy V.34 modem. [how poor!]
@endnode

@node Null ""
@NEXT Null2
@PREV Main
@endnode
@node Null2 ""
@NEXT Null
@PREV Reward
@endnode
@node Reward "Congratulations!! You made it! This is the Secret Page ;^)"
@NEXT Null
@PREV 
@TOC Main

     @{b}THE SECRET PAGE@{ub}@{i}


     Now the world has gone to bed,
     Darkness won't engulf my head,
     I can see by infra-red,
     How I hate the night.

     Now I lay me down to sleep,
     Try to count electric sheep,
     Sweet dream wishes you can keep,
     How I hate the night.

                           Marvin@{ui}


     Douglas Adams:

     Life, the Universe and Everything

@endnode
