home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 2 / DATAFILE_PDCD2.iso / utilities3 / discindex / DiscIndex / !DiscIndex / !HelpMe / Help < prev    next >
Text File  |  1993-10-29  |  3KB  |  89 lines
  1. ----------------------------------------------------------------------------
  2. User Guide To HelpMe version 1.01 by (c) Neil A Carson
  3. ----------------------------------------------------------------------------
  4.  
  5. Legal
  6. ~~~~~
  7. Basically, you can do whatever you want with this program or source code, as
  8. long as I am sent any changes and am credited in any program this should be
  9. included in, either in source or object form. None of this documentation
  10. should be tampered with.
  11. For use in your own program, see the appropriate section.
  12.  
  13. Why this program
  14. ~~~ ~~~~ ~~~~~~~
  15. I wanted to try and write redraw loops in 'C'. I also wanted to find out if
  16. !Edit and txt really have to be as slow as they are. They don't. Unlike
  17. other such programs, the execution speed remains constant, no matter what
  18. the size of the text file.
  19.  
  20. Manual
  21. ~~~~~~
  22. When double clicked, the program will install itself on the icon bar. The
  23. tool bar and this window appear out of a puff of smoke. If Menu is clicked
  24. , a menu will appear with two options - Info-> and Quit. Clicking on the
  25. close box of the main window has the same effect as quit. The tool bar will
  26. show the current line and character AT THE TOP of the main window. Clicking
  27. home or end will scroll the window to the top or bottom. Clicking menu on
  28. 'Contents' will bring up a menu with sub-headings in - click on one of
  29. these to be taken to the relevant place in the text.
  30. The program has been written with an ARM-code redraw loop to allow for
  31. fast scrolling. See the source code for more information.
  32.  
  33. About Help Files
  34. ~~~~~ ~~~~ ~~~~~
  35. For the application to load a help file, it must be an ASCII text file
  36. inside the application directory, called 'Help.'
  37. Also contained in the same directory must be a file called 'HelpData.'
  38. The HelpData file contains textual descriptions of the contents entries,
  39. and the button details. There may be no more than 255 contents entries,
  40. or 4095 buttons.
  41. The format if the file goes:
  42.  
  43. < identifier > < integer(s) > <label>
  44.  
  45. Two identifiers are currently supported, 'button' an 'contents.'
  46. The syntax for a contents entry is as follows:
  47.  
  48.        contents line label
  49. (e.g.) contents 4 Legal
  50.  
  51. This would add 'Legal' to the contents menu, and when that menu option was
  52. clicked, the window would jump to line 4.
  53. In a contents entry, _ in the file will be changed to a space in the menu.
  54.  
  55. The syntax for a button is like this:
  56.  
  57.        button x,y,width line
  58. (e.g.) button 10,15,5 20
  59.  
  60. This would place a button on line 15, starting 10 characters from the left,
  61. and 5 characters in length. When clicked, it would go to line 20.
  62.  
  63. There may e no more than 255 contents entries, or 4095 buttons in any one
  64. helpdata. If either of these are exceeded, the rest of the file WILL BE
  65. IGNORED.
  66.  
  67. When executing !AutoRun (in the HelpMe dir), the first CLI argument
  68. should be the name and path of the Help file, and the second the name
  69. and path of the HelpData. The file MUST end in a newline!
  70.  
  71. Future
  72. ~~~~~~
  73. * Add full sprites, (then) replay movies.
  74.  
  75. My Address:
  76. ~~ ~~~~~~~~
  77. e-mail will be forwarded by: dhaynes@cix.compulink.co.uk
  78. (if you ask him nicely!)
  79.  
  80. on packet TCP/IP           : neil@g7kqy.ampr.org [44.141.6.229]
  81.  
  82. on ax25 packet, forwarded by: g7kqy@gb7oxf
  83.  
  84. Snail: Neil A Carson,
  85.         1 Penn Close,
  86.          Abingdon,
  87.           Oxford OX14 2NX
  88.            ENGLAND.
  89.