MICROSOFT HELP AUTHOR --------------------- Microsoft Help Author is an enhancement utility that makes it easier to create Help files for Windows version 3.0 and 3.1. Help Author provides a way to do the most common Help tasks quickly and easily. Help Author divides the authoring process into two feature sets: the Help Project Editor and the Help Authoring Templates. The Help Project Editor makes it easy for you to: * Create and edit Help project files. * Add topic files to the project. * Define and edit project file information. * Compile Help files from Windows. * Display error messages resulting during the build. * View the built Help file. The Help Authoring Templates modify Word for Windows so that you can easily: * Create and edit topic files. * Insert and edit topics, graphics, and hot spots. * Format topic text and graphics. * Save topic files in RTF format. * View partial topic builds in Windows Help. SYSTEM REQUIREMENTS ------------------- To use Help Author, you need Windows version 3.0 or 3.1. Word for Windows version 1.1 or 2.0 is highly recommended. If you do not have Word for Windows, please read the section on Using the Help Project Editor Without Word for Windows on how to proceed. INSTALLING HELP AUTHOR ---------------------- To install Help Author on your hard disk, insert the Microsoft Help Author Setup Disk in drive A. Then follow these steps: 1. From the File menu in Program Manager, choose Run. The Run dialog box prompts you for a path and filename. 2. Type a:\setup.exe and choose OK. The Welcome dialog box prompts you to select the authoring tool sets to install. The default selection is to install both the Help Project Editor and the Help Authoring Templates. 3. Choose Continue. Or, if you do not want to install one of the tool sets, clear its check box and then choose Continue. If you selected the Help Project Editor check box, you are prompted for the directory where it will be installed. The default path is C:\WHPE. 4. Choose Continue to accept the default directory. Or to install the Help Project Editor in a different directory, use the BACKSPACE key to erase the current directory and type a new directory and path in the text box. Then choose Continue. If you selected the Help Authoring Templates check box, you are prompted to enter the path for Word for Windows. If you don't have a copy of Word for Windows on your hard drive, you may not install the Help Authoring Templates. In this case, please read the section on Using the Help Project Editor Without Word for Windows on how to proceed. Help Author supports Microsoft Word for Windows versions 1.1 and 2.0. The setup program will install the correct templates, depending on which version of Word for Windows it finds in the directory you specify for it. The version 1.1 Word for Windows templates do not have the toolbar icons but do have the same keyboard equivalents as the version 2.0 templates. If you upgrade from Word for Windows 1.1 to 2.0, you must reinstall the Help Authoring Templates. 5. Ensure that the directory given in the text box is the one where you installed Word for Windows, and choose Continue. If the given directory does not contain Word for Windows, use the BACKSPACE key to erase the current path. Then type a new directory and path in the text box, and then choose Continue. The setup program copies files and then creates a group in Program Manager for Help Author. A dialog box informs you that the installation is complete. Or, if necessary, a dialog box prompts you to restart Windows to complete the installation. In that case, choose Exit to quit the setup program and restart Windows. After Windows restarts, you can begin using Help Author. GETTING STARTED --------------- After you have installed the files on your hard drive, you can begin using Help Author. To use Help Author you simply choose menu commands and complete the dialog box options. Each option corresponds to a specific part of the authoring process. Although there is no fixed method for using Help Author, you can follow these general steps to get started. 1. Open the Help Author group in Program Manager and double-click the Help Project Editor icon. 2. Enter project information. (Edit Project command) 3. Add topic files to the project. (Add New or Existing File command) 4. Edit the topic files (add text, graphics, etc.) to create the content for the Help file. (Edit File command) Note: Because Windows Help version 3.0 and 3.1 differ considerably, Microsoft provides a separate template for each version. If you plan to create a Help system that runs under Windows Help version 3.1, use the 3.1 template (WHAT31.DOT). Otherwise, use the 3.0 template (WHAT30.DOT) as the authoring template. 5. Save the topic files and close your editor. The Help Authoring Templates will always save your documents in Rich Text Format (RTF). 6. Define the Help build options. (Edit menu commands) 7. Save the Help project file. (Save or Save As command) 8. Build the Help file. (Start command) 9. View the built Help file. (Run Help On command) 10. Fix errors and make revisions, then rebuild the Help file. LEARNING HOW TO USE HELP AUTHOR ------------------------------- Both the Help Project Editor and the Help Authoring Templates have Help files that explain how to use their features. To learn how to use the Help Project Editor: 1. Choose the menu command you want to learn about. 2. When the dialog box appears, choose the Help button. You can also choose Contents from the Help menu in the Project Editor window (or press F1) and choose a topic from the Contents. To learn how to use the authoring templates in Word for Windows 2.0: 1. Open or create a topic file based on a help authoring template. 2. From the Help menu in Word for Windows, choose the Help on WHAT command. 3. Then choose a topic from the Contents. If you are using the Help Authoring Templates with Word for Windows 1.1, then open the Help Author group in Program Manager, and double-click the Help on WHAT icon. USING THE HELP PROJECT EDITOR WITHOUT WORD FOR WINDOWS ------------------------------------------------------ If you do not have Microsoft Word for Windows, you may still use the Help Project Editor with any other editor which supports Rich Text Format (RTF). You may also use it with any text editor, such as Notepad, and edit your RTF by hand. To install Help Author when you do not have Word for Windows, insert the Microsoft Help Author Setup Disk in drive A. Then follow these steps: 1. From the File menu in Program Manager, choose Run. The Run dialog box prompts you for a path and filename. 2. Type a:\setup.exe and choose OK. The Welcome dialog box prompts you to select the authoring tool sets to install. The default selection is to install both the Help Project Editor and the Help Authoring Templates. 3. Clear the checkbox for the Windows Help Authoring Templates, and choose Continue. You are prompted for the directory where the Help Project Editor will be installed. The default path is C:\WHPE. 4. Choose Continue to accept the default directory. Or to install the Help Project Editor in a different directory, use the BACKSPACE key to erase the current directory and type a new directory and path in the text box. Then choose Continue. The setup program copies files and then creates a group in Program Manager for Help Author. A dialog box informs you that the installation is complete. Or, if necessary, a dialog box prompts you to restart Windows to complete the installation. In that case, choose Exit to quit the setup program and restart Windows. After Windows restarts, you can begin using Help Author. Now, follow the steps on Getting Started, listed above. On step 4, you will be prompted to give the program with which you wish to edit your RTF files. The default editor is NOTEPAD.EXE. Choose OK to edit your RTF files with Notepad. Or use the BACKSPACE key to erase the default editor and type a new editor in the text box. Or choose the Browse button to select an editor from a list box. SENDING FEEDBACK ---------------- To send bug reports, suggestions, or other feedback to the creators of Microsoft Help Author, send a fax to (206) 936-7329, and address it to Microsoft Help Author.