home *** CD-ROM | disk | FTP | other *** search
/ Really Useful CD 1 / ReallyUsefulCD1.iso / extras / progutils / _helpgen / support / c / doc
Encoding:
Text File  |  1991-12-02  |  1.8 KB  |  62 lines
  1. C interface to context sensitive HelpReader help systems
  2. by Ben Summers
  3.  
  4. Source code included - please do not modfify.
  5.  
  6.  
  7. Setup of HelpDes
  8. ~~~~~~~~~~~~~~~~
  9. Select context sensitiveness with the 'c' option with a line like
  10.  
  11. cBDS:HelpGen;h.helpn;#define HELPREADER_~ ^
  12.  
  13. This will create a header file in the 'h' directory inside the application
  14. directory. Each line will be something like this:
  15.  
  16. #define HELPREADER_LABELNAME
  17.  
  18. You can also have prefixs and suffixs if you wish. The filetype does not
  19. need to be specified, HelpGen defaults to Text.
  20.  
  21.  
  22. Use in program
  23. ~~~~~~~~~~~~~~
  24. To use be able to use HelpReader it must first be initialised:
  25.  
  26.   helpreader_init("BDS:HelpGen");
  27.  
  28. The name 'BDS:HelpGen' is the name of the help text you want it to move. See
  29. the main help file for guidelines on the selection of the name.
  30.  
  31. When you want to move the text just use:
  32.  
  33.   helpreader_move(HELPREADER_LABELNAME);
  34.  
  35. The constant 'HELPREADER_LABELNAME' is set in the number file by HelpGen.
  36. You will use a line like this, for example, when a window or menu is opened.
  37. If the help text is not loaded, this function will have no effect.
  38.  
  39. That's all there is to it really, except if you want to put a 'Help option'
  40. on your iconbar menu. To load the help text, use
  41.  
  42.   helpreader_load("HelpGen");
  43.  
  44. The string here is the name of the application. It is used for the system
  45. variable for the directory the help text is in. This example will produce
  46. the system variable '<HelpGen$Dir>'.
  47.  
  48. If the help text is already loaded, it will be moved to the front of the
  49. window stack. You can also do this with
  50.  
  51.   helpreader_helptext_to_front();
  52.  
  53. You will need to #include the helpreader header file in every source file as
  54. well as the number file.
  55.  
  56.  
  57. ~~~~~~~~~~~
  58.  
  59. I hope you find this useful. If you use this library, please credit me, and
  60. send me a copy of your application.
  61.  
  62.