home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / VISUAL_B / REFERENC / HELPINFO / README.TXT < prev    next >
Encoding:
Text File  |  1994-01-06  |  5.0 KB  |  113 lines
  1. WHY HAVE THIS FILE?
  2. =========================
  3.    The Microsoft Windows Help Complier can be a difficult program to 
  4. understand, at least I know I found it so. That's why I created 
  5. HELPINFO.ZIP. The information presented here encompasses much of 
  6. what I've learned over the last six months while writing the Help 
  7. file for our Visual Basic program. While some of the information 
  8. is specific to VB, the vast majority is applicable to all Help 
  9. file developers.
  10.  
  11.    There are three reasons why creating Help files is so difficult:
  12.  
  13. 1) The process of creating a Help file is completely different 
  14. from any other programming language you may know, and it is not 
  15. intuitive. In other words, you cannot easily take previous 
  16. programming experiences and apply them here.
  17.  
  18. 2) The Microsoft documentation is incomplete and there are few 
  19. examples for many of the features. This lack of information is so 
  20. pervasive, that I have found several significant Help Complier 
  21. features which are not supported by most Help Authoring Tools. 
  22. Specifically: mid-topic jumps, keyword mid-topic jumps, and 
  23. tables (which tend not be supported by Help Authoring Tools that 
  24. supply their own editors).
  25.  
  26. 3) Hypertext is new to most of us, and writing hypertext documents 
  27. is not easy to do well. How many times have you tried to find a 
  28. piece of information in a Help file and been frustrated. After 
  29. writing your own, you'll have a better appreciation of why.
  30.  
  31.    The Help file content (3 above) is beyond the scope of the 
  32. information presented here. It is, however, designed to supplement 
  33. existing documentation and contains many examples relating to the 
  34. "mechanics" of creating Help files. 
  35.  
  36.  
  37. WHAT'S IN THE FILE? 
  38. =========================
  39. 1) ARTICLE.TXT. This document was the predecessor to an article I 
  40. wrote for the Visual Basic Programmers Journal (415/917-7650). 
  41. While the two articles contain much of the same information, 
  42. there are significant differences. The published article 
  43. emphasizes the basics of how a Help file is organized, 
  44. particularly as it pertains to control codes. (If you've never 
  45. written a Help file, this would be a good place to start.)
  46.  
  47.    The article included here contains much more technical 
  48. information, especially in the areas of Help macros and 
  49. integrating the Help file into your program. Both articles 
  50. contain information not found in the Visual Basic documentation.
  51. There is also some information that I have not seen documented
  52. anywhere else.
  53.  
  54. 2) HELPINFO.HLP. This Help file illustrates many of the features 
  55. talked about in the article. I have also included ALL the files 
  56. necessary to create HELPINFO.HLP, so you will be able to see 
  57. exactly how its done. Most of the features are really very easy 
  58. to implement, once you know they exist and see an example. All 
  59. the files relating to creating the help file are in the file 
  60. HELPFILE.ZIP.
  61.  
  62.    To create (or modify this help file) you will need to have a copy 
  63. of the Help Compiler and change the file makehelp.bat to reflect 
  64. its directory.
  65.  
  66.    Microsoft Winword Version 6 RTF files require using Help 
  67. Compiler Version 3.10.505 or later. This version can be downloaded 
  68. from CompuServe: WinSDK forum, WinHELP lib, file HCP505.ZIP.
  69.  
  70.  
  71. 3) HELPINFO.EXE. This is a Visual Basic program that shows you 
  72. how to integrate your Help file into your program. All the API 
  73. calls and contents are in GLOBAL.BAS. Just about all the features 
  74. commonly used in most programs are here. Much of the information 
  75. here is very similar to that required by other programming 
  76. languages. All the files relating to creating the VB program are
  77. in the file VB_PROG.ZIP.
  78.  
  79.    To run the VB program HELPINFO.EXE you will need a copy of 
  80. VBRUN300.DLL. 
  81.  
  82.  
  83. HOW DO I INSTALL AND USE THESE FILES?
  84. =========================================
  85.    Simply unZIP them. We recommend using C:\HELPINFO as the 
  86. directory. If you use another directory or drive, you will need 
  87. to change references in the BAT and HPJ files accordingly. 
  88.  
  89.  
  90. ARE THESE FILES COPYRIGHTED?
  91. ==================================
  92.    This information is copyrighted by Crunch Software Corporation. 
  93. However, you are free to incorporate any feature, bitmap, and 
  94. computer code contained in these files into your own program or 
  95. Help file on a royalty-free basis, so long you do not hold me or 
  96. Crunch Software responsible for any errors. While you may 
  97. redistribute HELPINFO.ZIP as a unit, you may not separate the 
  98. files for redistribution. Nor can you charge for redistribution, 
  99. except for a nominal fee for media and shipping.
  100.  
  101.    I hope that the information I presented here makes your Help file 
  102. creation process less frustrating and allows you to write better 
  103. documents. If you notice any errors or have any comments, they 
  104. would be most appreciated. If you have any questions, I'll do the 
  105. best I can to try and help, time-constraints notwithstanding.
  106. Enjoy!
  107.  
  108.         -Ted Kahn
  109.          tedkahn@netcom.com
  110.          CIS 70353,2603
  111.          (510) 562-9900
  112.          (510) 562-9919 (Fax)
  113.