home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 1 / GoldFishApril1994_CD2.img / d4xx / d439 / hdclick / hdclick.doc(e) < prev    next >
Text File  |  1991-01-17  |  14KB  |  353 lines
  1.  ----------------------------------------------------------------------
  2. |                                                                      |
  3. |                          ------------------                          |
  4. |                         · H D - C L I C K  ·                         |
  5. |                          ------------------                          |
  6. |                             Version 1.21                             |
  7. |                                                                      |
  8. |                       © 1990 by Claude Müller                        |
  9. |                                                                      |
  10.  ----------------------------------------------------------------------
  11.  
  12.                           Use of HDClick:
  13.                          -----------------
  14.  
  15. HDClick is a program-selector especially for Harddisk-users, but it can
  16. also be used on floppy disks. HDClick belongs into the startup-sequence
  17. as the first command.
  18.  
  19. ------------------------------------------------------------------------
  20.  
  21.                              Copyright:
  22.                              ---------
  23. HDClick is Shareware. If you like it, please pay the Shareware fee of...
  24.                        ---------------------------
  25.                      ·     SFr.5.- to SFr.10.-    ·
  26.                        ---------------------------
  27.                 ( or appropriate amount in other currency )
  28.                                                         ...to the author.
  29. 5 to 10 Swiss Francs means that it's up to you how much  you  pay, you can
  30. pay more than 10 Francs , of course ! If you're living outside Switzerland,
  31. please send me enough money for the porto. If you pay  the  Shareware  fee
  32. and send a blank disk to my address, it'll be filled
  33.  
  34.                          !!    F R E E   !!
  35.  
  36. with PD-programs and sent back to you . The money is claimed for the Share-
  37. ware fee, copying is free !
  38.  
  39.                               Address:
  40.                        ------------------------
  41.  
  42.                              Claude Müller
  43.                              Auf den Hallen 32
  44.                           CH-4104 Oberwil (BL)
  45.                              SWITZERLAND
  46.  
  47.                        ------------------------
  48.  
  49. -----------------------------------------------------------------------
  50.                        D O C U M E N T A T I O N
  51. -----------------------------------------------------------------------
  52.                                   ***
  53.  
  54.                             C O N T E N T S
  55.                             ---------------
  56.  
  57.                            (1) Start the program
  58.                            (2) The program
  59.                            (3) The configfile
  60.                                (3.1) Mode
  61.                                (3.2) Column-titles
  62.                                (3.3) Important
  63.                            (4) The EDIT-Gadget
  64.                            (5) Errors
  65.                            (6) Examples
  66.  
  67.                                   ***
  68.  
  69. First  I'd like to say that this documentation was written with the Ger-
  70. man-English dictionary next to me, I can't write a correct documentation
  71. with the English I'm learning at school.
  72. So if there are any faults (fault, defect, blemish, flaw, mistake, error
  73. blunder - I should buy me a smaller dictionary...) please perceive them.
  74.  
  75.  
  76.                          (1) Start the program:
  77.                              -----------------
  78.  
  79. Shell:                 "HDClick Configfile"
  80.                 or     "HDClick"
  81.  
  82. "Configfile"  = Filename of the ASCII configuration-file. If no filename
  83. is given, HDClick looks for a file named 'HDCConfig' in the actual
  84. drawer.
  85.  
  86.  
  87. Workbench:
  88.  
  89. If HDClick is started from Workbench, it looks for a file named
  90. 'HDCConfig' in the actual drawer. Attention: If HDClick was started on
  91. Workbench and a file with option "r" or "e" is selected , the program
  92. could crash because the command "run" doesn't function correct on Work-
  93. bench. HDClick should not be started from Workbench !
  94.  
  95.                          (2) The program :
  96.                              ------------
  97.  
  98. HDClick is a file-selector. When HDClick is started it looks for the con-
  99. fig file. If found, it opens a screen with gadgets. The user can click
  100. on a gadget, and a user-defined program is started. Along the normal
  101. gadgets there's a QUIT-gadget to quit HDClick and an EDIT-gadget (see
  102. later).
  103.  
  104. The options "r" and "e" require the command "run" on Disk.
  105.  
  106. Iconify:
  107. --------
  108.  
  109. If the right mousebutton is pressed, the screen closes and a small window
  110. opens. You can get back to the main screen by pressing the right mousebut-
  111. ton while the small window is activated.
  112.  
  113.                          (3) The configfile:
  114.                              --------------
  115.  
  116. In the configfile, each of the 55 gadgets is declared a program which is
  117. started by clicking on the gadget. The following can be defined :
  118.  
  119.    1. The program
  120.    2. The gadget-title
  121.    3. The program start-mode.
  122.    4. The titles above the gadget columns
  123.  
  124. The configfile it should look like that:
  125. ----------------------------------------------------------------------
  126.  
  127. Program,Gadgettitle,l       or
  128. Program,Gadgettitle,r       or
  129. Program,Gadgettitle,e       or
  130. Program,Gadgettitle,o       or
  131.  ,,
  132.  
  133.     ... All in all 56 Gadgets an 4 column-titles (see also under (3.2))
  134. ----------------------------------------------------------------------
  135.  
  136.                        Commas between the three entries
  137.                                       |
  138.                                  -------------
  139.                                  |           |
  140.                           Program,Gadgettitle,x
  141.                             |         |       |
  142.            -----------------          |        ------------------
  143.            |                          |                         |
  144. Exact path and filename of   Title-string of the       Program start-mode
  145. the program to be started    gadget(max. 16 chars)          (-> 3.1 )
  146. to.
  147.  
  148.  
  149.                             (3.1) Mode :
  150. Mode "l":                        ----
  151. ---------
  152.             If the mode ,l  is indicated after the gadgettitle, the
  153.             program will be started normally and HDClick quits.
  154.  
  155. Mode "r":
  156. ---------
  157.             If the mode ,r  is indicated after the gadgettitle, the
  158.             program will be started with RUN. HDClick closes the
  159.             screen and opens the small window. For this mode, the
  160.             command RUN must be on Disk.
  161.  
  162. Mode "e":
  163. ---------
  164.  
  165.             If the mode ,e  is indicated after the gadgettitle, the
  166.             program will be started with RUN. The HDClick-screen stays
  167.             open, other programs can be started by clicking on gadgets.
  168.  
  169. Mode "o":
  170. ---------
  171.  
  172.             If the mode ,o  is indicated after the gadgettitle, a win-
  173.             dow with five gadgets opens:
  174.  
  175. The stringgadget:
  176.  
  177.             The text which is typed in there will be received as an
  178.             argument by the declared program. Example:
  179.  
  180.             Entry in the configfile:          Text in the stringgadget:
  181.                       |                                   |
  182.              "dh0:c/Ed,Editor,o"               "dh0:s/startup-sequence"
  183.                       |                                   |
  184.                        \_______________   ______________ /
  185.                                        \ /
  186.                                         |
  187.                            Following will be executed:
  188.                                         |
  189.                          "dh0:c/Ed dh0:s/startup-sequence"
  190.  
  191.             The editor "ed" loads the text-file "dh0:s/startup-
  192.             sequence".
  193.  
  194.             When one of the following gadgets is clicked on, the
  195.             defined program will be started (see above) with one
  196.             of the three modes , depending on what gadget you click:
  197.  
  198. The Launch-gadget:
  199.             After clicking on this gadget, the program will be started
  200.             with mode "l" (see 'Mode "l"').
  201.  
  202. The Run-gadget:
  203.             After clicking on this gadget, the program will be started
  204.             with mode "r" (see 'Mode "r"').
  205.  
  206.  
  207. The Execute-gadget:
  208.             After clicking on this gadget, the program will be started
  209.             with mode "e" (see 'Mode "e"').
  210.  
  211.                                     ***
  212.  
  213. The "Cancel"-gadget:
  214.             The requestor-window closes, you can make an other try.
  215.  
  216.                                     ***
  217.  
  218. Between the entries program,gadgettitle and program-mode there must
  219. always be a comma. If a gadget should  have  NO  function, just enter two
  220. commas ",," in the configfile.
  221.  
  222.  
  223.                           (3.2) Column-titles:
  224.                                 -------------
  225.  
  226. At the end of the configfile, the four titles above the gadget-columns
  227. have to be defined.
  228.  
  229.  
  230.                             (3.3) Important:
  231.                                   ---------
  232.             The configfile must consist of exactly 60 rows !
  233.             (56 gadgets + 4 titles). If this isn't so, HDClick
  234.             makes a confusion of the entries.
  235.  
  236.  
  237.                            (4) The EDIT-gadget:
  238.                                ---------------
  239.  
  240. The edit gadget works like a normal gadget, but it's thought for something
  241. special: When you click on this gadget, a text-editor is loaded which
  242. loads the HDClick-Configfile so that you can edit it directly. The entry
  243. in the configfile looks the same like an entrie of the other 55 gadgets.
  244. The only difference is that the gadget-title (EDIT) is predefined and
  245. can't be changed. The entry for this gadget is the 56th, direct before
  246. the column-titles. An entry for the EDIT-Gadget looks like this:
  247.  
  248.                         dh0:c/ed dh0:s/HDCConfig,,r
  249.                                   |             |
  250.          The editor ED loads the configfile    No title here because
  251.                                                it's not noticed.
  252.  
  253.  
  254.                               (5) Errors:
  255.                                   ------
  256.  
  257. If HDClick is started with wrong arguments or the configfile was not
  258. found, a error message will be returned.
  259.  
  260.   Error:                                   Error in configfile:
  261.   -----                                    --------------------
  262.  
  263. - Titles cross themselves                - One of the gadgettitles is
  264.                                            longer than 16 chars.
  265. - In the gadgettitle stands the          - A comma was forgotten .
  266.   string which was declared as a
  267.   program or a mode (for Example
  268.   ",r" as title)
  269. - One ore more column-titles don't       - Not enough entries in the
  270.   appear                                   configfile
  271. - After clicking on a gadget, the        - Not enough entries in the
  272.   wrong programs are executed.             configfile or a comma was left
  273.                                            out.
  274. - After HDClick was started by           - Dos received an error
  275.   Workbench, the selected program          (for example File not found)
  276.   doesn't start.
  277. - HDClick doesn't start after            - The Configfile "HDCConfig"
  278.   clicking on its icon                     wasn't found. It should be
  279.   (on Workbench).                          in the actual drawer.
  280.  
  281. If a filename or a gadget-title contains a comma, there'll be an error,too.
  282.  
  283.                               (6) Examples:
  284.                                   ---------
  285.  
  286. Here a few examples for entries in the configfile.
  287.  
  288. dh0:c/execute s/WB-Batch,Workbench,l    -> The script s/WB-batch is execu-
  289.                                            ted. HDClick quits.
  290.                                            Gadgettitle "Workbench".
  291.  
  292. disktools/Filemaster,Filemaster,r       -> The program "Filemaster" in
  293.                                            the "disktools" drawer is
  294.                                            started , the iconify-window
  295.                                            opens.
  296.                                            Gadgettitle "Filemaster".
  297.  
  298. tools/Viruskill,V-Killer,e              -> The program "Viruskill" in
  299.                                            the "tools" drawer is star-
  300.                                            ted, the HDClick screen stays
  301.                                            open.
  302.                                            Gadgettitle "V-Killer"                                           Gadgettitel "V-Killer"
  303.  
  304. graphik/Paint,Photolab,o                -> First, the requestor with
  305.                                            stringgadget appears. If one
  306.                                            of the three gadgets is se-
  307.                                            lected, the program "paint"
  308.                                            starts. It will display
  309.                                            the picture typed into the
  310.                                            stringgadget (for example:
  311.                                            "pictures/pic").
  312.                                            Gadgettitle: "Photolab".
  313.  
  314. "Special" example:
  315.  
  316.  ,Execute Command,o
  317. |                 |
  318. |                 |
  319. No entry!    Requestor opens
  320.  
  321. -> A special but very useful example. After this gadget was selected,
  322.    the following happens: The Requestor opens. Now, type a filename of
  323.    a program you want to be startet into the stringgadget. After clicking
  324.    on one of the three mode-gadgets (Launch,Run,Execute), the text in
  325.    the stringgadget is attached to the specified program-name in the
  326.    configfile. In this case, there's no entry for a program, so the
  327.    filename typed into the stringgadget will be executed.
  328.  
  329. The best is when you edit the example-configfile (HDCConfig) in this
  330. drawer and enter your own data.
  331.  
  332. -------------------------------------------------------------------------
  333.  
  334.                                  Disclaimer
  335.                                  ----------
  336. HDClick may be free copied, as long as this documentation and the program
  337. itself is left intact.
  338.  
  339. HDClick may not be used or copied commercially without a written authority
  340. of the author.
  341.  
  342. HDClick may not be taken into a PD-serie or simular without a written
  343. authority of the author.
  344.  
  345. HDClick is Shareware. If you like this program and/or if you use it often
  346. you should read the text "Copyright".
  347.  
  348. HDClick is Copyright by Claude Müller , all rights are reserved to
  349. the author.
  350. -------------------------------------------------------------------------
  351.  
  352. 1.1.1991                                                  Claude Müller
  353.