home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 365.lha / Helper_v1.01 / Helper_E.doc < prev    next >
Encoding:
Text File  |  1990-04-11  |  5.7 KB  |  153 lines
  1. HELPER V1.01
  2. ============
  3.  
  4. The  Helper  is  an utility, which kicks the HELP-key out of his lazy life.
  5. Start  it  from  CLI  with »Run« or better »RunBack«.  Supplying a '?' will
  6. show  the  available options (for a detailed explanation:  see below).  The
  7. Helper  must have the "req.library" by Colin Fox and Bruce Dawson in LIBS:.
  8. (Great  work,  Colin  and Bruce!  I don't know, how I ever made ist without
  9. that masterpiece of Amiga-programming-art!)
  10.  
  11. The  program  installs  an  InputEventHandler  with a priority of 51, which
  12. signals the main program when the user presses HELP.  The main program then
  13. produces a requester which looks like this:
  14.  
  15.           +---------------------------------------------------+
  16.           |   How can I help you?                             |
  17.           | +------------+ +---------------+ +--------------+ |
  18.           | |  Notepad   | | Change colors | |   Show Text  | |
  19.           | +------------+ +---------------+ +--------------+ |
  20.           +---------------------------------------------------+
  21.  
  22. Clicking  on one of the three gadgets means activating that function of the
  23. Helper.
  24.  
  25.  
  26. Change colors:
  27. ==============
  28.  
  29. Not much to say about that.  You get that ColorRequester of the req.library
  30. on  your  actual  screen.  So you can change the screencolors even in those
  31. programs, that don't give you this feature.
  32.  
  33.  
  34. Notepad:
  35. ========
  36.  
  37. It  certainly  isn't  necessary to discuss the need of a notepad.  For this
  38. notepad, a 640 by 200 window will appear, if possible, on the actual screen
  39. (like  all the requesters appear - if possible - on the actual screen).  If
  40. the  actual  screen isn't large enough for this window, it will open on the
  41. workbenchscreen  and  put  the  wb to front.  The notepad in fact gives you
  42. rather  a  "notesheet"  than  a  notepad, you can only write on the visible
  43. area.   You close the notepad quite normally via the CloseGadget on the top
  44. left.  The contents of the notepad remains intact.
  45.  
  46. The following functions are implemented:
  47.  
  48.  - CURSOR, BACKSPACE, DELETE and RETURN: standard
  49.  
  50.  - SHIFT-CURSOR: Begin/End of actual row, top/bottom of current collumn.
  51.  
  52.  - CTRL-K: Clear line
  53.  - CTRL-L: Clear whole text
  54.  - CTRL-E: Insert character
  55.  - CTRL-S: Save note
  56.  - CTRL-Z: Load note
  57.  - CTRL-U: Insert time
  58.  - CTRL-D: Insert date
  59.  
  60. Notepadfiles go into "T:" (only default) and have the extension ".note".
  61.  
  62. Show text:
  63. ==========
  64.  
  65. This  is  the  true  and  original  function I thought of when writing the
  66. Helper.  Who hasn't experienced yet the situation of having to drop a quick
  67. look  into some documentation file or manual?  Up to now, the procedure for
  68. sure  was  of  the  type:   start  shell - search file - show it (editor or
  69. more).  That is undoubtedly a very inefficient and annoying procedure.
  70.  
  71. The  Helper  can  do  the  following, to let you forget about that:  If you
  72. activate  the  function  "Show  text",  the Helper produces a FileRequester
  73. (also  from  the req.library), whose default directory is "HELP:".  You can
  74. now   choose   a   file   (maybe   out   of   some   subdirectories,   e.g.
  75. "HELP:ARP_Docs").   This  file  goes  to  a  predefined  program,  normally
  76. "SYS:Utilities/More", and in case you were on another screen, the workbench
  77. comes to front.
  78.  
  79. To  give  this function more flexibility, you can define (on startup of the
  80. Helper), which program to use for showing the text ("-mPRG") and whether to
  81. put  the  workbenchscreen  to front ("-f0/1").  In fact, you can define ANY
  82. program which accepts a filename as its first CLI-argument.  You could call
  83. an  editor  for example.  Or Delete ;-).  The "-f" option would be set to 0
  84. if the program opened its own screen.
  85.  
  86. So  you  can  create  a  directory on your harddisk, which contains all the
  87. often-used  documents  and helpfiles.  Then this directory gets the logical
  88. name  "HELP:"  (via assign).  The non-harddisk-users format a disk and name
  89. it  "HELP".  That disk then has to be inserted whenever some help is needed
  90. (the comp will ask for that disk).
  91. And you programmers out there:  Don't mess around with extra-menus for help
  92. on your program's topics, just add a copy of the Helper!
  93.  
  94.  
  95. startup-sequence:
  96. =================
  97.  
  98. The startup-sequence would look like:
  99. ...
  100. assign HELP: DH0:Documents
  101. runback Utilities/Helper -mSYS:Tools/Less -f0
  102. ...
  103.  
  104.  
  105. BREAK_CTRL_C:
  106. =============
  107.  
  108. You  can  terminate  the  Helper  when it's waiting for the HELP-key with a
  109. normal break class C.  For example:
  110.  
  111. 1> status
  112. Process  2: Loaded as command: status
  113. Process  3: Loaded as command: C:Helper
  114. 1> break 3
  115. 1> status
  116. Process  2: Loaded as command: status
  117. 1>
  118.  
  119.  
  120. Warning:
  121. ========
  122.  
  123. On  hotkeying,  the Helper sticks to the first window on the actual screen.
  124. That  means,  all  during  that session following requesters belong to that
  125. window.   That means also, that closing that window certainly will teleport
  126. your Amiga to India, as long as the Helper is somehow visible.
  127.  
  128.  
  129. General Info:
  130. =============
  131.  
  132. The  Helper  (Version  1.01)  is in the Public Domain, it may be copied and
  133. distributed  free,  as  long, as the executable, this documentation and the
  134. source  remain  unchanged  and  together.  The Helper was developed on Manx
  135. Aztec C with 16 bit integers and small code/data.
  136.  
  137. The  Helper  MUST  NOT  be  used  by  any  military organization or for any
  138. military purpose.
  139.  
  140. For  commercial  use:   If  you  want  to add the Helper to your commercial
  141. program, you have to pay a ONE TIME license fee of 50 dollars.  There is no
  142. problem  about the req.library, because it is FreeWare and everyone may use
  143. it in commercial products.
  144.  
  145. Send bug reports and suggestions to:
  146.  
  147.                               Michael Balzer
  148.                             Wildermuthstraße 18
  149.                              5828 Ennepetal 14
  150.                                  W-GERMANY
  151.  
  152. Happy Programming!
  153.