home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / utilities / utilsd / examine / !Examine / !Help next >
Encoding:
Text File  |  1993-04-22  |  11.4 KB  |  308 lines
  1. Help and information on !Examine   (Copyright © Erik de Kort)
  2. =============================================================
  3.  
  4. !Examine is a multitasking magnifier to be used on the desktop.
  5. It consists of one main window (the display), plus a toolwindow
  6. at the bottom of the display. The display shows the area around
  7. your mousepointer (or around the caret) magnified.
  8.  
  9.  
  10. The display
  11. -----------
  12. The main part of this application is ofcourse the display, that will show
  13. the magnified screenarea. To keep the display is as small as possible, it
  14. has no titlebar or scrollbars.
  15. You can, however, move and resize it as shown below:
  16.  
  17.   +---+--------+---+
  18.   | R/          \R |
  19.   | /            \ |
  20.   |/              \|
  21.   |      MOVE      |
  22.   |\              /|
  23.   | \            / |
  24.   | R\          /R |
  25.   +---+--------+---+
  26.  
  27. In any of the corners, indicated with an 'R', the pointer will change
  28. into an arrow with four directions. You can now resize the display by
  29. depressing the select or the adjust button on your mouse.
  30.  
  31. Over the middle area the pointer will have the shape of a hand, meaning
  32. that you can pickup the display (again by depressing the select or
  33. the adjust button on your mouse) and move it around the screen.
  34.  
  35. You stop resizing or moving when you release the mousebutton.
  36. Remember that pressing select will also bring the display window to
  37. the front (adjust will not do that).
  38.  
  39. In the display area you may press menu, which will popup a .... menu!
  40. This menu has the following layout:
  41.  
  42.   +--------------+
  43.   | Info        ⇨| -> Show application info
  44.   | Options     ⇨| -> Show the options box
  45.   | Save Options | -> Save all options set in the Options box
  46.   +--------------+
  47.   | Back         | -> Display to the bottom of the window stack.
  48.   | Front        | -> Display to the top of the window stack.
  49.   | Close        | -> Close displaywindow
  50.   +--------------+
  51.   | Quit         | -> Quit application
  52.   +--------------+
  53.  
  54. Entries "Info" and "Quit" speak for themselves, but the "Options"
  55. need a little explanation.
  56. I will refer to the display window as "display".
  57.  
  58. The Options Box
  59. ---------------
  60. This box contains some buttons, plus a zoom section.
  61.  
  62. Buttons:
  63.  "Show Pane"     -- Enable/disable the toolwindow below the bottom left
  64.                     corner of the display.
  65.  
  66.  "Show Pointer"  -- Enable/disable a pointer indication in the display.
  67.  "Cross"         -- Select crosshair, or normal pointer indication.
  68.                     This is only visible with "Show Pointer" enabled.
  69.  
  70.  "Follow Caret"  -- Enable/disable the follow-caret mode. (See below)
  71.  "Always"        -- Stick with caret, regardless. (See below)
  72.  
  73.  "Blank Display" -- If enabled, display window will show up as a
  74.                     white/gray checkered pattern.
  75.  
  76.  
  77. The zoom section provides a (sort of) standard zoom panel.
  78.  
  79. In the follow-caret mode, the area around the caret is displayed.
  80. However, when you move the mousepointer outside the window that contains
  81. the caret, the display will switch to the mousepointer. You can make
  82. the display stay with the caret, if you select the "Always" option.
  83. Also, the follow-caret mode is disabled while you hold down a mousebutton.
  84. Remember that popping up a menu will also move the mousepointer outside
  85. the window that contains the caret (but inside the menu!).
  86. If you happen to lose track of the caret, you can get it back by using
  87. the Shift-TAB hotkey (as in MENON, which is © Joris RÖling).
  88.  
  89. If you select the options box by clicking on the menu entry,
  90. rather than moving right, the options box will not disappear
  91. until you specifically close it.
  92.  
  93.  
  94. The Toolwindow
  95. --------------
  96. ... has the following layout:
  97.  
  98.   +---+---+---+---+---+
  99.   |UDL| m |   | d |UDR|
  100.   +---+---+---+---+---+
  101.  
  102. The locations 'm' and 'd' display the multiplication and division factors,
  103. that means that the area around the mousepointer is enlarged or reduced
  104. by the factor m/d. For instance m=2 and d=1 will enlarge by 2.
  105.  
  106. On the left and the right we have two locations 'UDL' and 'UDR'.
  107. These locations contain sprites with arrows up and down, and
  108. correspond to 'm' and 'r' respectively.
  109. Clicking on one with select will add 1 to the corresponding factor,
  110. adjust will subtract 1.
  111.  
  112. You can disable the display of this toolwindow in the options box.
  113.  
  114.  
  115. Command line options:
  116. ---------------------
  117. You may use the following options for controlling the defaults of !Examine:
  118.  
  119. Controlling the Options box: (replace '+' with '-' for the opposite effect)
  120.  "+pane"     set the "Show Pane" button (default on)
  121.  "+pointer"  set the "Show Pointer" button (default on)
  122.  "+cross"    set the "Cross" button (default on)
  123.  "+caret"    set the "Follow Caret" button (default off)
  124.  "+always"   set the "Always" button (default off)
  125.  "+blank"    set the "Blank Display" button (default on)
  126.  
  127.  "-width n"  will set the display width to n (default 300 OSunits)
  128.  "-height n" will set the display height to n (default 300 OSunits)
  129.  "-mul n"    will set the multiplication factor to n (default 3)
  130.  "-div n"    will set the division factor to n (default 1)
  131.  
  132. Ecample:
  133.   /<Examine$Dir>.!RunImage +pane +caret -pointer -blank -mul 5 -div 1
  134.  
  135. Command line options will take precedence over the saved options.
  136.  
  137.  
  138. Desktop boot:
  139. -------------
  140. From version 0.25 on !Examine will include itself in a desktop boot file.
  141.  
  142. Interactive help:
  143. -----------------
  144. Again from version 0.25 on there is full support for interactive help.
  145.  
  146. The iconbar:
  147. ------------
  148. Click on the iconbar icon to reopen the display if it was closed,
  149. and put it on top of the window stack.
  150.  
  151. Templates:
  152. ----------
  153. !Examine automaticly selects which set of templates should be used.
  154. On RiscOS 2 the 'TemplRO2' set will be used, and on RiscOS 3
  155. the 'TemplRO3' set will be used.
  156. I have not seen my templates on RiscOS 3.00, possibly the fancy
  157. borders need different validation strings.
  158. Should the templates give you problems, then copy the 'TemplRO2'
  159. file over the 'TemplRO3' one (but don't distribute it like that!).
  160. Please inform me if any template troubles occur. 
  161.  
  162.  
  163. And that's it!
  164.  
  165.  
  166. REMEMBER:
  167. This is only a Beta test version, it was written in 8 days
  168. and has therefore not undergone lengthy tests.
  169. I cannot guarantee this program to be bugfree, and despite the
  170. fact that I haven't encountered anything serious, you are well
  171. advised to save important data regularly when working with
  172. this application (you are well advised to do this *ALLWAYS* :-).
  173. It is up to you to determine how 'safe' this program is,
  174. afterall, that is what a Beta test is all about!
  175. I am also interested in what you think of the sprites (particularly
  176. the hand and the resizearrow), and how do you like the up/down
  177. sprite as compared to 2 sprites for up and down (in the pane) ?
  178. Have you noticed that the pointers "know" about letterbox/square pixel
  179. modes ?
  180. Please tell me if anything strange occurs, or if you have comments
  181. on the above. The address is shown at the end of this document.
  182.  
  183. Your magnificent programmer,
  184. Erik 'Hein' de Kort.
  185.  
  186.  
  187.  ---------------------------------------------------------------------------
  188.  
  189.  
  190. How to construct a crunched !RunImage:
  191. ______________________________________
  192.  
  193. I used Ragnar Hafstaðs BASIC cruncher (v1.02, frontend by Dick Alstein) with
  194. the following options enabled (others disabled):
  195.  - Discard REM linesD
  196.  - Discard empty lines
  197.  - Crunch variable names
  198.  - Crunch FN/PROC names
  199.  - Convert SWI names to numbers
  200.  - Build multiple-statement lines
  201. Exceptions to the above are listed in the textfile "DontCrunch".
  202.  
  203.  
  204.  ---------------------------------------------------------------------------
  205.  
  206.  
  207. Copyright conditions and disclaimer:
  208. ____________________________________
  209.  
  210. !Examine is FreeWare, which means the following:
  211.  - You should have obtained it free of charge.
  212.  - Copyright on all sources (including sprites and templates)
  213.    remains with me (Erik de Kort).
  214.  - You may use (parts of) the sources of !Examine for your own
  215.    applications if you meet the following conditions:
  216.     - Your application is FreeWare, and has the same copyright
  217.       conditions you are reading now. Ofcourse any sources you
  218.       create in addition to my sources are copyright you.
  219.     - All sources are provided in full.
  220.       This means that sources are available as readable sprites,
  221.       templates, BASIC, C, etc. Readable BASIC for instance means
  222.       that it has not been crunched or compacted.
  223.       You are ofcourse free to compact and crunch the actual
  224.       executable as much as you like, but then you are required
  225.       to state exactly how to construct such an executable from
  226.       the accompanying sources.
  227.     - You must state in the all files (except binary files such as
  228.       sprites and templates) the following message:
  229.       "Parts of this application are copyright © Erik de Kort"
  230.  - You may freely use and distribute this application, provided it is
  231.    complete with all original files.
  232.  - It may NOT be distributed by any person, PD library or any organisation
  233.    who will charge for it, without my written permission.
  234.  - It may NOT be distributed by any commercial organisation, without my
  235.    written permission.
  236.  - It may NOT be distributed if any part of that distribution is
  237.    not free of charge.
  238.    If you do wish to distibute this as part of, say, a discmag or as part
  239.    of another application, write to the address below.
  240. Some of the source code is actually © Jan Herman Buining.
  241. Also the WASP module is © Jan Herman Buining, read !ReadMe for copyright.
  242.  
  243. As stated, this application is FreeWare, but if you find it useful, you can
  244. show your appreciation by making a small donation.
  245. If you send me any amount in excess of 6 pounds (Brittish), I will send
  246. you the latest version of !Examine. Make sure you include your address
  247. and also the version number of !Examine that you have (no use sending
  248. you what you already have!).
  249.  
  250. Standard disclaimer:
  251. I do not claim that this application is usable for any purpose.
  252. Furthermore, I do not accept any liability or damages caused by
  253. (mis)use of this application. USE IT AT YOUR OWN RISK!
  254.  
  255.  
  256.  ---------------------------------------------------------------------------
  257.  
  258.  
  259. Plans for the future: (don't hold your breath)
  260. _____________________
  261.  
  262. * Replacing the OS_SpriteOps with an assembly algorithm for
  263.   the sprite display, to save memory and make it all faster.
  264. * Perhaps add a 'Fix to corner' button that lets you fix the display
  265.   window to the corner it is closest to ?
  266.   This could be nice of you changed mode a lot. Please comment on this.
  267. * Make a better sprite, or better still, you send me one (please?). 
  268. * Better "Blank Display".
  269.  
  270.  
  271.  ---------------------------------------------------------------------------
  272.  
  273.  
  274. Acknowledgments:
  275. ________________
  276.  
  277. Thanks to Jan-Herman Buining for supplying me with his excelent WASP module.
  278. Thanks to Dick Alstein for pointing out the difference between RO2 and RO3
  279. tasks (silly me, but *does* prove that a second opinion is useful).
  280. Credits to Ragnar Hafstað for writing BasCrunch (and to Dick Alstein again,
  281. for writing a frontend to it).
  282. I have taken a good look at the behaviour of following applications:
  283.  - !Microscope, by Alex Petrov.
  284.     Although a good application in its own right, it misses out on a some
  285.     critical points (IMHO), and that inspired me to write this application.
  286.  - !CloseUp, by Stuart Hickinbottom.
  287.     You will notice that I used his idea to follow the caret,
  288.     albeit in an expanded form.
  289.     
  290.  
  291.  ---------------------------------------------------------------------------
  292.  
  293.  
  294. About the author:
  295. _________________
  296.  
  297. If you have any questions, bug reports or suggestions for improvements,
  298. you can contact me at the following address:
  299.  
  300.   Erik de Kort
  301.   Melsbroekhof 3
  302.   5628 TJ Eindhoven
  303.   The Netherlands
  304.  
  305. or by e-mail: erikk@stack.urc.tue.nl
  306.  
  307.  
  308.