home *** CD-ROM | disk | FTP | other *** search
/ Really Useful CD 1 / ReallyUsefulCD1.iso / extras / progutils / _helpgen / support / basic / helplibdoc next >
Encoding:
Text File  |  1991-12-14  |  3.0 KB  |  110 lines
  1.  
  2.                      +---------------------------------+
  3.                      |The BASIC HelpReader Library 1.10|
  4.                      +---------+-------------+---------+
  5.                                |by Ben Harris|
  6.                                +-------------+
  7.  
  8. +----------+
  9. |Setting up|
  10. +----------+
  11.  
  12. Before you incorporate the library into you program, you should copy
  13. HelpRdrLib into your application's directory and put the following lines in
  14. your HelpDes file:
  15.  
  16. b
  17. cANO:Appl;HelpTable;`=^
  18. fFFB
  19. p▌≥helpreader_make_table
  20. sß
  21.  
  22. Where 'ANO:Appl' is the name of the help text.  Since this is a little hard
  23. to type (involving lots of Alt-key combinations), it would probably be a
  24. good idea to copy it directly from this text file into your HelpDes file.
  25.  
  26. In the help text itself, insert context-sensitive markers as normal (see the
  27. main HelpGen help text).  The label names will be converted into variable
  28. names, so don't re-use them in your program.
  29.  
  30. +--------------+
  31. |Initialisation|
  32. +--------------+
  33.  
  34. In you application's initialisation routines, you should load the HelpReader
  35. library and initialise it as follows:
  36.  
  37. LIBRARY "<Appl$Dir>.HelpRdrLib"
  38. PROChelpreader_init("<Appl$Dir>","ANO:Appl")
  39.  
  40. Where '<Appl$Dir>' is your application's directory and 'ANO:Appl' is the
  41. name of the help text.
  42.  
  43. +----------------+
  44. |Message handling|
  45. +----------------+
  46.  
  47. In your application's message handling routine, you should use:
  48.  
  49. PROChelpreader_msg_poll
  50.  
  51. +--------------------+
  52. |Moving the help text|
  53. +--------------------+
  54.  
  55. To move the help text, use:
  56.  
  57. PROChelpreader_move(label%)
  58.  
  59. Where 'label%' is the label name specified in the help text.
  60.  
  61. +---------------------+
  62. |Loading the help text|
  63. +---------------------+
  64.  
  65. To load the help text, or move it to the front, if it is already loaded,
  66. use:
  67.  
  68. PROChelpreader_load
  69.  
  70. +-------------------+
  71. |Variable names etc.|
  72. +-------------------+
  73.  
  74. All of the library's functions, procedures and global variables have names
  75. beginning with 'helpreader_'.  It's unlikely that you will want to use
  76. anything that will clash with these, but if you were thinking of it, don't!
  77.  
  78. +------------------+
  79. |Conditions of use:|
  80. +------------------+
  81.  
  82. This library may be freely copied and distributed.
  83.  
  84. Any modifications should mentioned in this text file along with the name and
  85. address of the person who modified it and a copy of the modified library
  86. sent to me so that I can include the modification in any future versions (if
  87. I like it!).
  88.  
  89. You may use this library in any program as long as I am fully credited and
  90. I am set a copy.
  91.  
  92. If I find that anyone has breached these conditions, they will be hanged,
  93. drawn and quartered (or at least given a stern ticking-off).
  94.  
  95. +----------+
  96. |My Address|
  97. +----------+
  98.  
  99. If for any reason you would like to contact me (to report bugs, suggest
  100. improvements, give praise, donate money, etc.), please write to me at:
  101.  
  102. Ben Harris,
  103. 9 Brownhill Lane,
  104. Wembury,
  105. Plymouth.
  106. PL9 0JQ
  107.  
  108. Please note that I am only responsible for this library. The rest of the
  109. HelpReader system is the responsibility of Ben Summers.
  110.