home *** CD-ROM | disk | FTP | other *** search
/ Programming Tool Box / SIMS_2.iso / vb_tools / helpconv / readme.txt < prev   
Text File  |  1991-02-19  |  5KB  |  116 lines
  1. ======================================================================
  2.          MICROSOFT EXCEL CUSTOM HELP FILE CONVERSION UTILITY
  3. ======================================================================
  4.  
  5.  --------------------------------------------------------------------
  6. | INFORMATION PROVIDED IN THIS DOCUMENT AND ANY SOFTWARE THAT MAY    |
  7. | ACCOMPANY THIS DOCUMENT (collectively referred to as an            |
  8. | Application Note) IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY      |
  9. | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO    |
  10. | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A     |
  11. | PARTICULAR PURPOSE. The user assumes the entire risk as to the     |
  12. | accuracy and the use of this Application Note. This Application    |
  13. | Note may be copied and distributed subject to the following        |
  14. | conditions: 1) All text must be copied without modification and    |
  15. | all pages must be included; 2) If software is included, all files  |
  16. | on the disk(s) must be copied without modification (the DOS        |
  17. | utility DISKCOPY is appropriate for this purpose); 3) All          |
  18. | components of this Application Note must be distributed together;  |
  19. | and 4) This Application Note may not be distributed for profit.    |
  20. |                                                                    |
  21. | Copyright 1990 Microsoft Corporation. All Rights Reserved.         |
  22. | Microsoft and the Microsoft logo are registered trademarks of      |
  23. | Microsoft Corporation.                                             |
  24.  --------------------------------------------------------------------
  25.  
  26. (Please copy and distribute this utility as per the guidelines, stated
  27. above.)
  28.  
  29.  
  30.  
  31. Background
  32. ----------
  33.  
  34. Microsoft Excel version 3.00 for Windows no longer offers internal
  35. support for the use of custom Help files in the text (ASCII) format.
  36. Instead, Microsoft Excel 3.00 for Windows uses the Windows 3.00 Help
  37. engine for custom Help. The Windows 3.00 Help engine requires Help
  38. files in the Help-file format.
  39.  
  40. By using the Windows 3.00 Help engine, you can create powerful custom
  41. Help for your Microsoft Excel applications. You can set jump topics
  42. and glossary items and take advantage of the Help-window interface. It
  43. is recommended that you use the Windows 3.00 Software Development Kit
  44. (SDK) for extensive Help file development.
  45.  
  46. About This Utility
  47. ------------------
  48.  
  49. If you've created custom Help files in Microsoft Excel version 2.00 or
  50. 2.10 for Windows, you can use the Microsoft Excel Custom Help File
  51. Conversion Utility to convert your text files into Help-format files
  52. so they can be accessed by Microsoft Excel 3.00.
  53.  
  54. This utility consists of two files: HELPCONV.EXE and HC.EXE.
  55. HELPCONV.EXE  is the conversion utility. HC.EXE is the Help compiler,
  56. which is needed for the conversion process (HC.EXE is also available
  57. in the Windows 3.00 SDK).
  58.  
  59. To convert a text-format file to a Help-format file, run HELPCONV.EXE.
  60. This program converts the text file to a rich text format (.RTF) file
  61. and creates a Help project (.HPJ) file. Then HELPCONV.EXE calls
  62. HC.EXE, which uses the .HPJ file to compile the .RTF file into a Help-
  63. format file. The Help-format file is given the name of your original
  64. text-format file, and your original text file is saved with the
  65. extension .BAK. The intermediate files are deleted.
  66.  
  67. To Run This Utility
  68. -------------------
  69.  
  70. You can run the Microsoft Excel Custom Help File Conversion
  71. Utility from the DOS prompt, or you can choose Run from the File
  72. menu in the Program Manager. If you want to run the program from
  73. the DOS prompt, make sure you have set a path to HELPCONV.EXE and
  74. HC.EXE, or that the files reside in the current directory.
  75.  
  76. The form of the DOS command is as follows
  77.  
  78.   HELPCONV <filename> [/T "help_title_text"] [/U] [/L] [/D]
  79.  
  80. where
  81.  
  82.   [ ] indicates an optional parameter
  83.  
  84. Please note that there is a space between each parameter on the
  85. command line and that you should include the drive and pathname of
  86. HELPCONV.EXE if you are running the command from the Program Manager.
  87.  
  88. Parameter             Description
  89. ---------             -----------
  90.  
  91. <filename>            The DOS filename, including extension, of the
  92.                       text-format file you want to convert
  93.  
  94. /T "help_title_text"  Required to insert the Help-window title (will
  95.                       default to "Excel Macro" if no  entry is made)
  96.  
  97. /U                    An optional switch to prevent HC.EXE from being
  98.                       executed
  99.  
  100. /L                    An optional switch to prevent deletion of
  101.                       intermediate .RTF and .HPJ files
  102.  
  103. /D                    An optional switch to delete the .BAK file when
  104.                       finished
  105.  
  106.  
  107. For example, assume you want to convert the Excel 2.10 Help file
  108. "MACROHLP.TXT", and you want to delete the .BAK file when finished.
  109. The command line should appear as follows:
  110.  
  111.   HELPCONV MACROHLP.TXT /T "Sample Macro" /D
  112.  
  113. In this example, you will have a Help-format file with the title
  114. "Sample Macro" and with the same name as your original text-format
  115. file; thus, you will not need to make any changes to your macro sheet.
  116.