@DATABASE SortIcons.guide
@$VER: SortIcons.guide 1.1 (05.09.2000)
@AUTHOR "Christoph Gutjahr, Tom 'Neo' Granger"
@SMARTWRAP

@node "Main" "IconLink 2.0 Manual"
@{lindent 2}


@{fg highlight}IconLink 2.0 Manual@{fg text}@{PAR}

Written by Christoph Gutjahr and Tom Granger@{PAR}
(c) 1999-2002 Christoph Gutjahr@{PAR}


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

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

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

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


@endnode

@node "COPY" "Copyright and disclaimer"
@{lindent 1}

@{b}COPYRIGHT AND DISCLAIMER@{ub}@{PAR}

IconLink is distributed under the GNU Public License. Use it at your own risk. No warranties of any kind
are made as to the functionality of this program.@{PAR}

@{b}Note:@{ub}@{PAR}

The programs 'CopyIcon' and 'WBRun' that can be found in the 'C' drawer of this archive are
written by Stephan Rupprecht are distributed with kind permission. Please refer to their original
documentation for more information about their Copyright license.@{PAR}

@endnode

@node "REQS" "Requirements"
@{lindent 1}

@{b}REQUIREMENTS@{ub}@{PAR}

- Any Amiga computer with at least AmigaOS 3.5@{PAR}

- 'CopyIcon44' (Copyright 1999 Stephan Rupprecht):@{PAR}

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

- 'WBRun' (Copyright 1999 Stephan Rupprecht):@{PAR}

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

@{b}OPTIONAL@{ub}@{PAR}

- reqtools.library and rexxreqtools.library@{PAR}

You'll need a tool that lets you add further entries to your Workbench's "Tools" menu, like T.H.E., Toolmanager
or Toolsdaemon. There's a small utility included with this distribution ("Linkstarter.rexx") which does the
job aswell - but it's not as powerful as the other options.@{PAR}

@endnode

@node "DESC" "Description"
@{lindent 1}

@{b}DESCRIPTION@{ub}@{PAR}

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:@{PAR}

 - The icons are MOVED to the Workbench root window, so they 'disappear' in@{PAR}
   their original drawer@{PAR}

 - Icons that are 'left out' retain their original name. This can cause@{PAR}
   problems if you want to arrange your icons in a Toolmanager-like manner@{PAR}
   - i.e. with my script 'SortIcons' (Aminet:util/wb/sorticons.lha) - and@{PAR}
   some icons have long filenames@{PAR}

'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).@{PAR}

Of course a function to remove links from the Workbench window is also included.@{PAR}

@endnode

@node "INST" "Installation"
@{lindent 1}

@{b}INSTALLATION@{ub}@{PAR}

Just use the supplied install script to install IconLink. Some important notes regarding the
installation process:@{PAR}

@{fg highlight}There are three versions of IconLink:@{fg text}@{PAR}
@{lindent 4}

A. The OS 3.5 version@{PAR}

This version does @{b}only@{ub} work with OS 3.5. Do no use it with OS 3.9 or higher! This version does
not support links for 'Project' icons.@{PAR}

B. The OS 3.9 version@{PAR}

This version will work @{b}only@{ub} with OS 3.9 or higher. Due to the way the script invokes various
Workbench functions, it does not work with asynchronous requesters enabled. You either have to disable
asynchronous requesters (set the "NOTEXTINPUT" tooltype in AsyncWB) or use the Reqtools version instead
(see below).@{PAR}

C. The OS 3.9 + reqtools.library version@{PAR}

This version is basically the same as the standard OS 3.9 version, but it requires reqtools.library and
rexxreqtools.library. The advantage of this version is that you don't have to disable asynchronous
requesters as with the normal version.@{PAR}
@{lindent 1}

@{fg highlight}What is Linkstarter.rexx's purpose?@{fg text}@{PAR}

The install script will ask you if you want to install 'Linkstarter.rexx'. IconLink needs to be started
from Workbench's 'Tools' menu, so you need a way to add new items to this menu. Linkstarter.rexx will
automatically do this for you.@{PAR}

If you have a tool like Toolmanager, ToolsDaemon or T.H.E installed, you don't need Linkstarter.rexx.
Just use your existing software to add two new items to your Workbench's "Tools" menu:@{PAR}
@{lindent 4}

   NAME "Create Icon-link" COMMAND "REXX:IconLink.rexx"@{PAR}
   NAME "Delete Icon-link" COMMAND "REXX:IconLink.rexx REMOVE"@{PAR}
@{lindent 1}

@{fg highlight}Make sure your ARexx server is up and running@{fg text}@{PAR}

(see final chapter - @{" The ARexx-Server " link "AREX" } - if you don't know what I'm talking about)@{PAR}

@endnode

@node "USAG" "Usage"
@{lindent 1}

@{b}USAGE@{ub}@{PAR}

To create a link for one or more icons:@{PAR}

   - select the icon(s)@{PAR}

   - invoke the menu item 'Tools/Create Icon-Link'@{PAR}

   - a requester will pop up, asking for a new name for the link@{PAR}

   - the link(s) will be created and placed on your Workbench screen@{PAR}

To remove a link from the desktop:@{PAR}

   - select the link(s) you want to remove@{PAR}

   - invoke the menu item 'Tools/Remove Icon-Link'@{PAR}

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

@endnode

@node "HIST" "History"
@{lindent 1}

@{fg highlight}v 2.0@{fg text}@{PAR}

- updated to work with OS3.9@{PAR}
- now there are three versions of the script@{PAR}

@{fg highlight}v 1.0@{fg text}@{PAR}

- initial public release@{PAR}

@endnode

@node "THXS" "Greetings"
@{lindent 1}

@{b}THANK YOUS@{ub}@{PAR}

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

Thanks to Stephan Rupprecht for the kind permission to include his software in this archive.@{PAR}

@endnode

@node "ME" "The Author"
@{lindent 1}

@{b}AUTHOR@{ub}@{PAR}

Christoph Gutjahr@{PAR}
Hermannstr. 41@{PAR}
12049 Berlin@{PAR}
Germany@{PAR}

c.gutjahr\@gmx.net@{PAR}

http:\//www.8ung.at/gutjahr@{PAR}

@endnode

@node "AREX" "The AREXX Server"
@{lindent 1}

@{b}THE AREXX SERVER@{ub}@{PAR}

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

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

 - add the following line:@{PAR}

     RUN >NIL: SYS:System/Rexxmast@{PAR}

   to your Startup-sequence, just before the line containing the "LoadWB"@{PAR}
   command. This activates the ARexx-Server each time your machine is@{PAR}
   booting. ARexx won't eat up much memory or CPU-Ressources, so this is@{PAR}
   the recommended method.@{PAR}

@endnode