home *** CD-ROM | disk | FTP | other *** search
/ Micro R&D 1 / MicroRD-CD-ROM-Vol1-1994.iso / os20 / wb / tsicon.lha / TSIcon.txt < prev    next >
Text File  |  1993-06-09  |  9KB  |  317 lines
  1. TSIcon is freely distributable.
  2.  
  3. TSIcon provides a simple way of getting AppIcons and animated AppWindows onto the 
  4. workbench.
  5.  
  6. Currently Tool, Project and Drawer Icons are catered for.
  7.  
  8.  
  9.  
  10.  
  11. Tool Icons
  12. ----------
  13.  
  14. Once a tool Icon is on the Workbench then dropping a file on the Icon should run the tool with 
  15. the file as a parameter.
  16.  
  17. For example if MEmacs is opened by TSIcon then dropping a text file on the Icon will execute 
  18. the command Run HardDisk:Tools/Memacs >NIL: <NIL: "filename". This should load 
  19. the file.
  20.  
  21. Double clicking the AppIcon removes it.
  22.  
  23. Dropping multiple files on a tool will run that tool multiple times.
  24.  
  25.  
  26.  
  27.  
  28. Project Icons
  29. -------------
  30.  
  31. Once a Project Icon is on the Workbench then dropping a file on it executes commands 
  32. specified in the original Icons tool types. The only relevant tool type is :-
  33.  
  34. COMMANDS=command     This may be specified multiple times.  Each line will be executed 
  35.                      consecutively.
  36.  
  37. Dropping multiple files on a project will execute the sequence of commands for each dropped 
  38. file.
  39.  
  40. Text substitution is used. $F or $f is replaced by the file part of the filename, $D or $d is 
  41. replaced by the directory part, and $H or $h is replaced by the fullname.
  42.  
  43. e.g. If the commands are:-
  44.  
  45. COMMANDS=Copy "$H" "ram:$f"
  46. COMMANDS=delete "$h"
  47.  
  48. then if the files df0:test and df1:pest are dropped on the project then the following 
  49. commands are executed:-
  50.  
  51. copy "df0:test" "ram:test"
  52. delete "df0:test"
  53. copy "df1:pest" "ram:pest"
  54. delete "df1:pest"
  55.  
  56. Note the use of " to cater for spaces in file names.
  57.  
  58. Double clicking a project removes it.
  59.  
  60. One use could be a printer icon. Just drop files on a printer Icon with the COMMANDS=run 
  61. copy "$h" to prt: will print the files.
  62.  
  63. Note run should generally be used since TSIcon will only run one program at once.
  64.  
  65.  
  66.  
  67.  
  68. Drawer Icons
  69. ------------
  70.  
  71. These are very similar to Project Icons. The drawer should contain Icons named Icon.01 to 
  72. Icon.nn (where nn is the number of Icons). These Icons will be displayed in an AppWindow 
  73. the correct size for the first Icon, one at a time. When disabled the animation is stopped. The 
  74. COMMANDS= tool types should be on Icon.01 as for project Icons. Other tool types are:-
  75.  
  76. On Icon.01
  77.  
  78. LEFT=number   Left edge of window
  79. TOP=number    Top edge of window
  80.  
  81. On all Icon.nn
  82.  
  83. WAIT=number   Number of 1/10s to wait after displaying icon.
  84.  
  85. Double clicking in the window removes it.
  86.  
  87.  
  88.  
  89.  
  90. CLI Usage
  91. ---------
  92.  
  93. To initially run TSIcon the following parameters can be used :-
  94.  
  95. TSIcon Show/s,Disable/s,Files/M
  96.  
  97. Show     Open the control window
  98. Disable  Start but disable all Icons
  99. Files    A list of Tools/Projects to initially load
  100.  
  101. TSIcon by itself will run it with no control window, enabled, and no Icons. It will not detach 
  102. from the CLI. If run then it will allow the CLI window to be closed.
  103.  
  104. TSIcon ? produces the usage help line.
  105.  
  106. Once TSIcon is running the following parameters can be used :-
  107.  
  108. TSIcon Quit/s, Add/s, Remove/s, Show/s, Hide/s, Enable/s, Disable/s, Files/m
  109.  
  110. Quit        Close any Icons and quit
  111. Add         Files gives a list of icons to add
  112. Remove      Files gives a list of icons to remove
  113. Show        Open the control window
  114. Hide        Close the control window
  115. Enable      Enable all Icons
  116. Disable     Disable all Icons
  117. Files       A list of files to process. If Add alone is specified then add, If Remove then 
  118.             remove, otherwise add if not present remove if present.
  119.  
  120. TSIcon or TSIcon ? produces the usage help line.
  121.  
  122. Version TSIcon and Version TSIcon full produce relevant version information.
  123.  
  124.  
  125.  
  126.  
  127. Workbench Usage
  128. ---------------
  129.  
  130. TSIcon may be started by double clicking by itself. The tool types available are :-
  131.  
  132. DONOTWAIT        Required to run from the WBStartup Drawer
  133. CX_POPUP=NO      If this is not specified then the Control window opens
  134. FILE=????        Multiple lines of this format can be used to specified which Icons to load.
  135. CX_PRIORITY=n    Exchange priority. Defaults to zero.
  136. CX_POPKEY=??     Hotkey to show control window on default public screen. Defaults 
  137.                  to left alt a.
  138. CX_WPOPKEY=??    Hotkey to open control window on workbench. Defaults to right alt a.
  139.  
  140.  
  141. Alternatively for Project Icons, TSIcon can be specified as the default tool, clicking on the 
  142. project will start TSIcon.
  143.  
  144. The third method is to click on TSIcon, Shift click the Icons to load, and the Shift Double 
  145. Clicking the last.
  146.  
  147. Once TSIcon is running, double clicking TSIcon by itself opens the Control Window.
  148.  
  149. Running it by either of the other two methods removes Icons which are already present, 
  150. adding those that are not.
  151.  
  152.  
  153.  
  154.  
  155. Tools Menu
  156. ----------
  157.  
  158. The menu option Add TSIcon is added to the Workbench Tools menu. Clicking on an Icon or 
  159. Icons then selecting this option adds/removes Icons from the workbench as appropriate.
  160.  
  161.  
  162.  
  163.  
  164. Exchange
  165. --------
  166.  
  167. The Commodities Exchange program can be used to Kill, Hide, Show, Disable and 
  168. Enable TSIcon.
  169.  
  170.  
  171.  
  172.  
  173. AREXX
  174. -----
  175.  
  176. The port name is TSICON. The following commands (case not significant) are available. On 
  177. error a result of 10 is returned.
  178.  
  179. Show           Open the control window on the default public screen.
  180. Wshow          Open the control window on the workbench.
  181. Hide           Close the control window.
  182. Add file       Add the Icon.
  183. Remove file    Remove the Icon.
  184. Quit           Quit the program.
  185. Enable         Enable the program.
  186. Disable        Disable the program.
  187. List filename  List the full name of all Icons to the named file.
  188. ?????          Any other command is taken as the name of an Icon to add (if not 
  189.                already present) or remove.
  190.  
  191.  
  192.  
  193.  
  194. Control Window
  195. --------------
  196.  
  197. The Control window may be opened by using TSIcon Show in a CLI,  Double clicking TSIcon 
  198. by itself, using Show from Exchange, or using the Arexx Show or Wshow commands.
  199.  
  200. The hot keys (default left alt a and right alt a) can be used to open the control 
  201. window on the default public screen and the workbench respectively.  They are only active if 
  202. TSIcon is not started from the CLI.
  203.  
  204.  
  205.  
  206.  
  207. Window
  208. ------
  209.  
  210. The whole window (even when shrunk to just a title) is an AppWindow. Dropping an Icon 
  211. (either a normal Icon or an AppIcon) anywhere in the window adds it to the open list if it is 
  212. not already there, removes it if it is. 
  213.  
  214. When a TSIcon program is running, all gadgets are disabled, all menus are ghosted, keyboard 
  215. equivalents are also ignored.  The control window has a wait pointer.  However all other 
  216. commands (from the CLI, Tools Menu, Running another copy of TSIcon [either directly or as a 
  217. default tool], dropping files on Icons, double clicking Icons) will be remembered when the 
  218. program finishes.
  219.  
  220.  
  221.  
  222.  
  223. Gadgets
  224. -------
  225.  
  226. The Control Window has the following gadgets.
  227.  
  228. Close             This closes the window but leaves the program running.
  229. Zoom              This reduces the window to just a title bar/zooms back to fullsize.
  230. Front/Back        Standard front/back gadget.
  231. Hide              This acts the same as the close window gadget.
  232. Quit              Closes all Icons and quits.
  233. Enable            Enables all Icons.
  234. Disable           Disables all Icons. One of Enable or Disable will always be ghosted.
  235. About...          Open a requester giving Version information.
  236. Available Icons   A read only list of Open Icons, the current selection being shown 
  237.                   below.
  238. Add...            Opens an ASL file requester to select a file. The file selected should 
  239.                   be without the .info. To add a drawer just select the drawer and 
  240.                   leave the file name blank.
  241. Delete            Removes the Icon shown in the list. Ghosted if no current Icon is shown.
  242.  
  243.  
  244.  
  245.  
  246. Keyboard Short-cuts
  247. -------------------
  248.  
  249. Keyboard short-cuts are available for all gadgets, the relevant key is underlined on the 
  250. gadget:-
  251.  
  252. H,h,Esc       Hide
  253. Q,q           Quit
  254. E,e           Enable
  255. S,s           Disable
  256. B,b,Help      About
  257. A,a           Add
  258. D,d           Delete
  259. i,Down arrow  Scroll down through list, looping to start at end
  260. I,Up arrow    Scroll up through list, looping to end at start
  261.  
  262.  
  263.  
  264.  
  265. Menus
  266. -----
  267.  
  268. The following menus are available :-
  269.  
  270. Project
  271.   Open...    RAmiga O   Same as Add gadget.
  272.   Close                 Same as Delete gadget - ghosted if no Icon is displayed as 
  273.                         current in the list window.
  274.   About...              Same as About gadget.
  275.   Hide                  Same as Hide gadget.
  276.   Quit       RAmiga Q   Same as Quit gadget.
  277. Settings
  278.   Enabled?              This is a toggled check menu, it replaces the Disable and Enable gadgets.
  279.  
  280.  
  281.  
  282.  
  283. Things to Note
  284. --------------
  285.  
  286. Icon names are unique just on the final part of the file name. Case is ignored.
  287.  
  288. i.e. TSIcon df0:test df1:test df0:Pest df0:pest will result in no Icons, since 
  289. df0:Pest will remove df0:pest, and df1:test will remove df0:test.
  290.  
  291.  
  292.  
  293.  
  294. Known Errors
  295. ------------
  296.  
  297. Huge workbench fonts are not checked against. The menus should be OK, but the wording 
  298. may fall off the edge of the gadgets. Fonts up to 48 point should be OK.
  299.  
  300. If a program running from TSIcon (not using Run) crashes then TSIcon is suspended.
  301.  
  302.  
  303.  
  304.  
  305. Future Enhancements (if I ever get around to it)
  306. ------------------------------------------------
  307.  
  308. 1)    Some action to be performed on Disk and Trash Icons.
  309.  
  310.  
  311.  
  312.  
  313. Contacting Me
  314. -------------
  315.  
  316. By EMail as mpaddock@cix.compulink.co.uk.
  317.