home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / help / a245_1 / CHelp / ReadMe < prev   
Text File  |  1993-02-13  |  3KB  |  77 lines
  1. riphelp by Mark H. Wilkinson (C) 1993
  2. This version: 13feb93
  3.  
  4. Description:
  5.  
  6. This is a simple program to build HelpData and Index files
  7. for StrongHelp v 1.00, the help system which accompanies
  8. StrongED II v 1.10. It extracts the help text for the
  9. standard C library from the Desktop C !SrcEdit program and
  10. also allows other help pages to be added. You may find it
  11. useful if you program in C and hate !SrcEdit.
  12.  
  13.  
  14. Instructions for use:
  15.  
  16. 1. Compile riphelp. There's a simple Makefile included to
  17.    do this.
  18. 2. Load !StrongHlp.
  19. 3. Go to the !StrongHlp application directory and create a
  20.    new directory called "C" in the HelpData directory (i.e.
  21.    create "<StrongHelp$Dir>.HelpData.C")
  22. 4. Load !SrcEdit; quit it again if you want. (This is
  23.    needed to get SrcEdit$Dir set properly.)
  24. 5. Run riphelp.
  25. 6. Quit StrongHelp and restart it again.
  26. 7. Modify the MainMenu page from StrongHelp to include a
  27.    link to the root of the C help system (you need to add a
  28.    line saying "<C       =>C.$>" onto the page).
  29. 8. Select "Save Help" on StrongHelp's icon bar menu to save
  30.    the change to MainMenu.
  31. 9. Enjoy instant help on all standard library routines and
  32.    definitions. (And a one page summary of all the operators
  33.    and their precedence and associativity.)
  34. 10. Write extra pages for the things you think are missing
  35.    and send them to me for inclusion in the next release!
  36.  
  37.  
  38. How to add your own pages:
  39.  
  40. Create a file in the c directory and type your text in
  41. there. Follow the format of the entry in c.operators - the
  42. text is an initialiser for an array in the main program so
  43. don't forget the commas and quote marks or the compiler
  44. will complain.
  45.  
  46. The first entry is the name of the page in the index. Use
  47. something descriptive and long enough to avoid name clashes.
  48.  
  49. The second entry indicates whether the name can be searched
  50. for by pressing F1 in StrongED and should be either YES or
  51. NO.
  52.  
  53. The third entry is the text for the help page. The first
  54. line appears in the title bar of the help window and the
  55. rest appears in the window itself.
  56.  
  57. You can include link words in the help text following the
  58. syntax described in the StrongHelp documentation. Ensure
  59. you double all backslashes to get them through the compiler
  60. intact.
  61.  
  62.  
  63. The next version:
  64.  
  65. Hopefully will include more information about the C
  66. language (keywords, types and such). I've already started
  67. doing this, but the text I have is based heavily on K&R and
  68. probably shouldn't be distributed.
  69.  
  70. May also attempt to automatically cross reference the
  71. library help.
  72.  
  73.  
  74. Contact me:
  75.  
  76. Send modifications and stuff to me as mhw@minster.york.ac.uk
  77.