@database SortIcons.guide
@master test:SortIcons.guide
@Remark: $VER: SortIcons.guide 1.0 (13.06.2000)
@author "Christoph Gutjahr, Tom 'Neo' Granger"
@index "Index"

@node "Main" "IconLink documentation"
@next "COPY"


  ********************************
  *                              *
  *      @{b}IconLink.rexx v1.0@{ub}      *
  *                              *
  *  (c) 2000 Christoph Gutjahr  *
  *                              *
  ********************************


  @{" Copyright and disclaimer " link "COPY" }  - Legal stuff
  @{" Requirements             " link "REQS" }  - System requirements

  @{" Description              " link "DESC" }  - What is it?
  @{" Installation             " link "INST" }  - How to install IconLink?
  @{" Usage                    " link "USAG" }  - How to use it?

  @{" Thank yous               " link "THXS" }  - The contributors
  @{" The author               " link "ME" }  - That's me :-)

  @{" The ARexx Server         " link "AREX" }  - ARexx for Dummies ;)...


@endnode

@node "COPY" "Copyright and disclaimer"
@prev "Main"
@next "REQS"
@toc "Main"


 @{b}COPYRIGHT AND DISCLAIMER@{ub}


 This program distributed under the GNU Public License. Do with it whatever
 you want.

 Use this at your own risk. No warranties of any kind are made as to the
 functionality of this program.

 @{b}Note:@{ub}

 The programs that can be found in the 'C' drawer of this archive are
 written by other authors and are distributed with kind permission. Please
 refer to their original documentations for more information about their
 Copright license.

@endnode

@node "REQS" "Requirements"
@prev "COPY"
@next "DESC"
@toc "Main"


 @{b}REQUIREMENTS@{ub}


 - Any Amiga computer with at least AmigaOS 3.5

 - 'CopyIcon44' (Copyright 1999 Stephan Rupprecht): 

   Included in this archive. Please read the the documentation of this
   program (can be found in the 'C' drawer of this distribution) for more
   informations about Copyright and additional functionality

 - 'WBRun' (Copyright 1993 Sylvain Rouger and Pierre Carette):

   Included in this archive. Please read the documentation of this program
   (can be found in the 'C' drawer of this distribution) for more
   informations about Copyright and additional functionality

 @{b}Recommended@{ub}

 - T.H.E. (Copyright 1999/2000 Nils Goers)

   Provides the easiest way to start this script along with a load of other
   useful functions.

@endnode

@node "DESC" "Description"
@prev "REQS"
@next "INST"
@toc "Main"


 @{b}DESCRIPTION@{ub}


 IconLink.rexx is a ARexx-script that replaces the standard WB function
 'Leave out', which places icons on the Workbench root window for easier
 starting. The original function has some (minor) disadvantages:

 - The icons are MOVED to the Workbench root window, so they 'disappear' in
   their original drawer
 
 - Icons that are 'left out' retain their original name. This can cause
   problems if you want to arrange your icons in a Toolmanager-like manner
   - i.e. with my script 'SortIcons' (Aminet:util/wb/sorticons.lha) - and
   some icons have long filenames

 'IconLink' creates a link to the original icon and places this link on the
 WB root window. The link can have any name, and the original drawer is left
 unchanged (all links are stored in one directory).

 Of course a function to remove links from the Workbench window is also
 included.

@endnode

@node "INST" "Installation"
@prev "DESC"
@next "USAG"
@toc "Main"


 @{b}INSTALLATION@{ub}


 1. Just use the supplied install script to install 'IconLink.rexx'.

    During the installation process you will be asked if 'Linkstarter'
    should be copied to your 'WBStartup' drawer. This programm adds two new
    menu items to Workbench's 'Tools' menu, which allow you to start
    'IconLink.rexx'.

    You don't need 'Linkstarter' if you have 'T.H.E' installed
    (recommended)!

 2. Make sure that your ARexx-Server is running (see final chapter - 
    @{" The ARexx-Server " link "AREX" } - if you don't know what I'm talking about)

 3. If you have 'T.H.E' installed, start the T.H.E preferences editor and add
    two new menu items to WB's 'Tools' menue:

     NAME "Create Icon-link" COMMAND "REXX:IconLink.rexx"
     NAME "Delete Icon-link" COMMAND "REXX:IconLink.rexx REMOVE"

@endnode

@node "USAG" "Usage"
@prev "INST"
@next "THXS"
@toc "Main"


 @{b}USAGE@{ub}


 To create a link for one or more icons:

   - select the icon(s)

   - invoke the menu item 'Tools/Create Icon-Link'

   - a requester will pop up, asking for a new name for the link

   - the link(s) will be created and placed on your Workbench screen

 To remove a link from the desktop:

   - select the link(s) you want to remove

   - invoke the menu item 'Tools/Remove Icon-Link'

   - the link (s) will be removed from the Workbench window and deleted
     (you can't harm normal icons with this function)


 @{b}Notes:@{ub}


 - By default, all links are stored in 'SYS:Prefs/Presets/linkstorage/'. If
   you don't like that, move the directory 'linkstorage' to any place you
   like and change line 6 of 'Iconlink.rexx':

     linkpath=<enter the path where links should be stored>

   But do so BEFORE you create any links! 

 - Both 'WBRun' and 'CopyIcon' are third party programs. Please have a look
   at their manuals for infos about their original purpose, distribution
   terms etc.


@endnode

@node "THXS" "Greetings"
@prev "USAG"
@next "ME"
@toc "Main"


 @{b}THANK YOUS@{ub}


 Thanks to Tom 'Neo' Granger for the idea, motivation (??), the install-
 script and this Amigaguide...


@endnode

@node "ME" "The Author"
@prev "THXS"
@next "AREX"
@toc "Main"


 @{b}AUTHOR@{ub}


 Christoph Gutjahr
 Hermannstr. 41
 12049 Berlin
 Germany

 Korodny@gmx.net


@endnode

@node "AREX" "The AREXX Server"
@prev "ME"
@toc "Main"


 @{b}THE AREXX SERVER@{ub}


 To run ARexx-programs such as "IconLink.rexx", the ARexx-Server must be
 active. This can be achieved by different methods:

 - Double click on the "Rexxmast" Icon in your "SYS:System/" drawer. This
   will activate Rexxmast immidiately (until the next reboot).

 - add the following line:

     RUN >NIL: SYS:System/Rexxmast

   to your Startup-sequence. This will make the ARexx-Server active when
   your machine is booting. ARexx won't eat up much memory or
   CPU-Ressources, so this is the recommended method.


@endnode
