home *** CD-ROM | disk | FTP | other *** search
/ CICA 1995 May / cica_0595_4.zip / cica_0595_4 / WINWORD / WHAT2 / README.TXT < prev    next >
Text File  |  1992-02-19  |  9KB  |  209 lines
  1. MICROSOFT HELP AUTHOR
  2. ---------------------
  3.  
  4. Microsoft Help Author is an enhancement utility that makes it easier to 
  5. create Help files for Windows version 3.0 and 3.1. Help Author provides 
  6. a way to do the most common Help tasks quickly and easily.  Help Author 
  7. divides the authoring process into two feature sets: the Help Project 
  8. Editor and the Help Authoring Templates. 
  9.  
  10. The Help Project Editor makes it easy for you to:
  11. *  Create and edit Help project files.
  12. *  Add topic files to the project.
  13. *  Define and edit project file information.
  14. *  Compile Help files from Windows.
  15. *  Display error messages resulting during the build.
  16. *  View the built Help file.
  17.  
  18. The Help Authoring Templates modify Word for Windows so that you 
  19. can easily:
  20. *  Create and edit topic files.
  21. *  Insert and edit topics, graphics, and hot spots.
  22. *  Format topic text and graphics.
  23. *  Save topic files in RTF format.
  24. *  View partial topic builds in Windows Help.
  25.  
  26.  
  27. SYSTEM REQUIREMENTS
  28. -------------------
  29.  
  30. To use Help Author, you need Windows version 3.0 or 3.1.  Word for 
  31. Windows version 1.1 or 2.0 is highly recommended.  If you do not have 
  32. Word for Windows, please read the section on Using the Help Project 
  33. Editor Without Word for Windows on how to proceed.
  34.  
  35.  
  36. INSTALLING HELP AUTHOR
  37. ----------------------
  38.  
  39. To install Help Author on your hard disk, insert the Microsoft Help 
  40. Author Setup Disk in drive A.  Then follow these steps:
  41.  
  42. 1. From the File menu in Program Manager, choose Run.
  43.  
  44. The Run dialog box prompts you for a path and filename.
  45.  
  46. 2. Type a:\setup.exe and choose OK.
  47.  
  48. The Welcome dialog box prompts you to select the authoring tool sets to 
  49. install. The default selection is to install both the Help Project 
  50. Editor and the Help Authoring Templates.
  51.  
  52. 3. Choose Continue.  Or, if you do not want to install one of the tool 
  53. sets, clear its check box and then choose Continue.
  54.  
  55. If you selected the Help Project Editor check box, you are prompted for 
  56. the directory where it will be installed. The default path is C:\WHPE.
  57.  
  58. 4. Choose Continue to accept the default directory.  Or to install the 
  59. Help Project Editor in a different directory, use the BACKSPACE key to 
  60. erase the current directory and type a new directory and path in the 
  61. text box. Then choose Continue.
  62.  
  63. If you selected the Help Authoring Templates check box, you are prompted 
  64. to enter the path for Word for Windows. If you don't have a copy of Word 
  65. for Windows on your hard drive, you may not install the Help Authoring 
  66. Templates.  In this case, please read the section on Using the Help 
  67. Project Editor Without Word for Windows on how to proceed. 
  68.  
  69. Help Author supports Microsoft Word for Windows versions 1.1 and 2.0. 
  70. The setup program will install the correct templates, depending on which 
  71. version of Word for Windows it finds in the directory you specify for 
  72. it. The version 1.1 Word for Windows templates do not have the toolbar 
  73. icons but do have the same keyboard equivalents as the version 2.0 
  74. templates.  If you upgrade from Word for Windows 1.1 to 2.0, you must 
  75. reinstall the Help Authoring Templates.
  76.  
  77. 5. Ensure that the directory given in the text box is the one where you 
  78. installed Word for Windows, and choose Continue.  If the given directory 
  79. does not contain Word for Windows, use the BACKSPACE key to erase the 
  80. current path. Then type a new directory and path in the text box, and 
  81. then choose Continue.
  82.  
  83. The setup program copies files and then creates a group in Program 
  84. Manager for Help Author.  A dialog box informs you that the installation 
  85. is complete.  Or, if necessary, a dialog box prompts you to restart 
  86. Windows to complete the installation. In that case, choose Exit to quit 
  87. the setup program and restart Windows. After Windows restarts, you can 
  88. begin using Help Author.
  89.  
  90.  
  91. GETTING STARTED
  92. ---------------
  93.  
  94. After you have installed the files on your hard drive, you can begin 
  95. using Help Author. To use Help Author you simply choose menu commands 
  96. and complete the dialog box options. Each option corresponds to a 
  97. specific part of the authoring process. Although there is no fixed 
  98. method for using Help Author, you can follow these general steps to get 
  99. started.
  100.  
  101. 1. Open the Help Author group in Program Manager and double-click the 
  102. Help Project Editor icon.
  103.  
  104. 2. Enter project information. (Edit Project command)
  105.  
  106. 3. Add topic files to the project. (Add New or Existing File command)
  107.  
  108. 4. Edit the topic files (add text, graphics, etc.) to create the content 
  109. for the Help file. (Edit File command)
  110.  
  111. Note: Because Windows Help version 3.0 and 3.1 differ considerably, 
  112. Microsoft provides a separate template for each version. If you plan to 
  113. create a Help system that runs under Windows Help version 3.1, use the 
  114. 3.1 template (WHAT31.DOT). Otherwise, use the 3.0 template (WHAT30.DOT) 
  115. as the authoring template.
  116.  
  117. 5. Save the topic files and close your editor.  The Help Authoring 
  118. Templates will always save your documents in Rich Text Format (RTF).
  119.  
  120. 6. Define the Help build options. (Edit menu commands)
  121.  
  122. 7. Save the Help project file. (Save or Save As command)
  123.  
  124. 8. Build the Help file. (Start command)
  125.  
  126. 9. View the built Help file. (Run Help On command)
  127.  
  128. 10. Fix errors and make revisions, then rebuild the Help file.
  129.  
  130.  
  131. LEARNING HOW TO USE HELP AUTHOR
  132. -------------------------------
  133.  
  134. Both the Help Project Editor and the Help Authoring Templates have Help 
  135. files that explain how to use their features.  To learn how to use the 
  136. Help Project Editor:
  137.  
  138. 1. Choose the menu command you want to learn about.
  139. 2. When the dialog box appears, choose the Help button.
  140.  
  141. You can also choose Contents from the Help menu in the Project Editor 
  142. window (or press F1) and choose a topic from the Contents.
  143.  
  144. To learn how to use the authoring templates in Word for Windows 2.0:
  145.  
  146. 1. Open or create a topic file based on a help authoring template.
  147. 2. From the Help menu in Word for Windows, choose the Help on WHAT 
  148. command.
  149. 3. Then choose a topic from the Contents.
  150.  
  151. If you are using the Help Authoring Templates with Word for Windows 1.1, 
  152. then open the Help Author group in Program Manager, and double-click the 
  153. Help on WHAT icon.
  154.  
  155.  
  156. USING THE HELP PROJECT EDITOR WITHOUT WORD FOR WINDOWS
  157. ------------------------------------------------------
  158.  
  159. If you do not have Microsoft Word for Windows, you may still use the 
  160. Help Project Editor with any other editor which supports Rich Text 
  161. Format (RTF).  You may also use it with any text editor, such as 
  162. Notepad, and edit your RTF by hand.
  163.  
  164. To install Help Author when you do not have Word for Windows, insert the 
  165. Microsoft Help Author Setup Disk in drive A.  Then follow these steps:
  166.  
  167. 1. From the File menu in Program Manager, choose Run.
  168.  
  169. The Run dialog box prompts you for a path and filename.
  170.  
  171. 2. Type a:\setup.exe and choose OK.
  172.  
  173. The Welcome dialog box prompts you to select the authoring tool sets to 
  174. install. The default selection is to install both the Help Project 
  175. Editor and the Help Authoring Templates.
  176.  
  177. 3. Clear the checkbox for the Windows Help Authoring Templates, and 
  178. choose Continue.  
  179.  
  180. You are prompted for the directory where the Help Project Editor will be 
  181. installed. The default path is C:\WHPE.
  182.  
  183. 4. Choose Continue to accept the default directory.  Or to install the 
  184. Help Project Editor in a different directory, use the BACKSPACE key to 
  185. erase the current directory and type a new directory and path in the 
  186. text box. Then choose Continue.
  187.  
  188. The setup program copies files and then creates a group in Program 
  189. Manager for Help Author.  A dialog box informs you that the installation 
  190. is complete.  Or, if necessary, a dialog box prompts you to restart 
  191. Windows to complete the installation. In that case, choose Exit to quit 
  192. the setup program and restart Windows. After Windows restarts, you can 
  193. begin using Help Author.
  194.  
  195. Now, follow the steps on Getting Started, listed above.  On step 4, you 
  196. will be prompted to give the program with which you wish to edit your 
  197. RTF files.  The default editor is NOTEPAD.EXE.  Choose OK to edit your 
  198. RTF files with Notepad.  Or use the BACKSPACE key to erase the default 
  199. editor and type a new editor in the text box.  Or choose the Browse 
  200. button to select an editor from a list box.
  201.  
  202.  
  203. SENDING FEEDBACK
  204. ----------------
  205.  
  206. To send bug reports, suggestions, or other feedback to the creators of 
  207. Microsoft Help Author, send a fax to (206) 936-7329, and address it to 
  208. Microsoft Help Author.
  209.