August 2000: Using the Single-Source Wizards in RoboHelp Office
This Help Corner column was originally published in August, 2000, and written for RoboHELP Office Version 8.
by Char James-Tanny
Using the Single-Source Wizards in RoboHELP Office
In this month's Help Corner, I originally planned to discuss the different dialog boxes and the impact of the various options when using the single-source wizards in RoboHELP Office. But then I realized that this column would never end if I did that.
So I'm going to focus on HTML Help, WebHelp, and printed documentation from RoboHELP for WinHelp and RoboHELP for HTML Help.
What is Single-Sourcing?
Single-sourcing allows you to use one set of development files for multiple kinds of output. While many technical communicators argue that online content should be different from print content, deadlines and budgets can get in the way. Many times, documents end up very similar in both forms.
In addition, developers sometimes use one development tool (such as RoboHELP for WinHelp), even though they are producing an HTML-based Help solution like WebHelp. This enables them to use a familiar development environment and still take advantage of technology.
With RoboHELP Office, you can produce:
- Printed documentation for those users who want hardcopy
- HTML Help for those users who have Internet Explorer installed on their systems
- WebHelp when you want to put your files on an intranet, extranet, or the Internet to provide a cross-platform, cross-browser solution
In This Column...
- Using the Single-Source Wizards in RoboHELP 2000 for WinHelp
- Using the Single-Source Wizards in RoboHELP 2000 for HTML Help
- Using the HTML Help Wizard in RoboHELP 2000 for WinHelp
- Using the WebHelp Wizard in RoboHELP 2000 for WinHelp
- Using the WebHelp Wizard in RoboHELP 2000 for HTML Help
- Using the Printed Documentation Wizard in RoboHELP 2000 for WinHelp
- Using the Printed Documentation Wizard in RoboHELP 2000 for HTML Help
Using the Single-Source Wizards in RoboHELP 2000 for WinHelp
To generate single-source output from RoboHELP projects, either:
- Double-click the wizard and verify or modify the information on the different dialog boxes. Once you've modified information on a dialog box, RoboHELP "remembers" it the next time you run the wizard.
- Right-click over the wizard and select Properties. The dialog box that displays lists the same options as the dialog boxes you see when you use the wizard. Verify or modify the information. To generate the document, right-click over the wizard and select Quick Generate.
Using the Single-Source Wizards in RoboHELP 2000 for HTML Help
To generate single-source output from RoboHELP HTML projects, either:
- Select File | Generate and then select the desired output option.
- Select File | Select Primary Target and then select the desired output option. When you want to generate the results, click the Generate Primary Target icon on the toolbar. (By default, this option is set to HTML Help.)
You can't generate Printed Documentation as a primary target.
Using the HTML Help Wizard in RoboHELP 2000 for WinHelp
HTML Help is the Windows Help standard for 32-bit operating systems (for example, Windows 95, Windows 98, Windows NT, or Windows 2000). Your users must have Internet Explorer installed on their systems (or at least the necessary core components).
To provide a cross-platform, cross-browser output, generate WebHelp instead of HTML Help.
By using the HTML Help Wizard, you produce:
- A new HTML Help project, including Microsoft's project file (.hhp). This lets you open the project in RoboHELP HTML and edit the resulting files, if necessary. The following files are generated:
- HTML files (one per topic)
- The Contents file (.hhc), from your Contents file (.cnt)
- The Index file (.hhk), from your current index information
- Graphic files (.gif), from your bitmaps and shed files
- Other files, as necessary
- The compiled HTML Help file (.chm) only
When you convert a WinHelp project to an HTML Help project:
- Your WinHelp project (.hpj) is converted to a RoboHELP HTML project (.mpj)
- Your topics are converted to individual HTML files.
- Your graphics (bitmaps or metafiles) are converted to GIF files.
- Your SHED files are converted to image maps.
- Your links and authorable buttons are converted to HTML hyperlinks and HTML Help controls.
- Your popups are converted to Dynamic HTML popups.
- Your Table of Contents file (.cnt) is converted to an HTML Help Table of Contents
- file (.hhc).
- Your K-Keywords are added to an HTML Help Index file (.hhk).
Generating HTML Help
When generating HTML Help from RoboHELP for WinHelp, you can select from the following options:
Wizard Dialog Box |
Option |
Description |
Generate Microsoft HTML Help |
Output Folder and File Name |
Select where you want to store the results. By default, RoboHELP creates an HtmlHelp folder under the current project and uses the current project name for the .chm and project file names. |
-- |
Choose Source Documents |
Displays a list of documents in the WinHelp project. By default, all are selected, but you can include as many or as few as you want. |
-- |
Build Expression |
If you used build tags in your WinHelp project, you can include or exclude topics by specifying the build tags. |
Microsoft HTML Help - Folders |
Folder for HTML Files |
Select how you want to store the new topics: no subfolders, all topics in one subfolder (default name html), subfolders based on document names (default), or subfolders based on books in the Table of Contents. |
If you want to verify the number of topics that the conversion process creates, select No Subfolder or Create Subfolder. Then, count the number of HTML files in the output folder. |
||
-- |
Folder for Images |
Select how you want to store the converted graphics: no subfolder or all in one subfolder (default name image) (default). |
-- |
File Options |
Select the HTML extension you want to use for topic files: .htm (default) or .html. Click the checkbox to convert all file names to lowercase. |
Microsoft HTML Help - Formatting |
Style Sheet Formatting |
Select how you want to format your HTML files: inline styles (no style sheet), one style sheet per source document (default), one style sheet (based on one source document), or one style sheet (based on existing style sheet). Inline styles produce results that look the most like the source WinHelp file. However, they can't be modified easily. If you want to make a change (for example, changing the definition of H2 to a different font size), modify the Word files in RoboHELP, then re-generate HTML Help. |
Microsoft HTML Help - Features |
Popups |
Select how you want to convert WinHelp popups: Smart Popups (default) or regular hyperlinks. Smart popups use Dynamic HTML and size to their content. |
-- |
What's This Help |
Select how you want to convert any context-sensitive topics from the WinHelp project: HTML Help text- only topics (default) or individual HTML files, or remove them completely from the conversion. |
-- |
External Topics |
Select how you want to convert external WinHelp topic links: links to topics in external .chm files (default) or keep the current link to a WinHelp topic, or remove the links completely. Use the first option if you will be converting linked WinHelp projects to HTML Help files, because it maintains the links. |
-- |
Images |
Select how you want to convert your bitmaps: .gif (default) or .jpg. |
-- |
Bullets/Numbering |
Select how you want to convert your bulleted and numbered lists: HTML bullets and numbers (default) or paragraphs that are formatted with inline styles. |
Microsoft HTML Help - Options |
Navigation Pane |
Select what features you want in the navigational pane of your HTML Help file:
|
-- |
Options |
Select from the following list of options:
|
-- |
Advanced Button |
Click to display a dialog box that lets you select specific options for the HTML Help window. You can change which buttons display, control the navigational pane, select the default font, modify the display of the Contents tab, and add custom buttons. |
Once you select your options, click Finish.
The files are stored in the specified folder. If you need to make changes, you can either use RoboHELP for WinHelp and then re-generate the HTML Help files, or, if you created a new HTML Help project, you can make modifications by opening the .hhp file in RoboHELP 2000 for HTML Help, which automatically creates a RoboHELP HTML project file (.mpj).
Portions of the material in this column were originally presented as a conference session at TECH/COMM 2000 in July, 2000. Portions of the WinHelp section have been taken from Using RoboHELP 2000 for WinHelp, a training seminar provided by SOLUTIONS, Inc. and taught by Char James-Tanny. Portions of the HTML Help section have been taken from Sams Teach Yourself RoboHELP 2000 for HTML Help in 24 Hours by Char James-Tanny, ISBN 0-672- 31625-0. Used with permission from Macmillan Computer Publishing USA.
Copyright © 2000 Char James-Tanny.
Using the WebHelp Wizard in RoboHELP 2000 for WinHelp
Use WebHelp to publish any kind of online documentation- manuals, online Help (including context-sensitive Help), and Web sites. WebHelp produces cross-platform, browser- independent files that can be accessed with Internet Explorer, Netscape Navigator, or other popular browsers (such as Opera).
For more information on WebHelp, see in this month's column.
Generating WebHelp
When generating WebHelp from RoboHELP for WinHelp, you can select from the following options:
Wizard Dialog Box |
Option |
Description |
Generate WebHelp |
Output Folder and File Name |
Select where you want to store the results. By default, RoboHELP creates a WebHelp folder under the current project and uses the current project name for the start file name. |
-- |
Use Short Folder/File Name |
Renames folder and file names to follow the DOS 8.3 naming convention. You must use this feature if your server doesn't support long file names. |
-- |
Choose Source Documents |
Displays a list of documents in the WinHelp project. By default, all are selected, but you can include as many or as few as you want. |
-- |
Build Expression |
If you used build tags in your WinHelp project, you can convert topics by specifying the build topics to include or exclude. |
WebHelp - Folders |
Folder for HTML Files |
Select how you want to store the new topics: no subfolders, all topics in one subfolder (default name html), subfolders based on document names, or subfolders based on books in the Table of Contents. |
-- |
Folder for Images |
Select how you want to store the converted graphics: no subfolder or all in one subfolder (default name image). |
-- |
File Options |
Select the HTML extension you want to use for topic files: .htm (default) or .html. Click the checkbox to convert all file names to lowercase. |
WebHelp - Formatting |
Style Sheet Formatting |
Select how you want to format your HTML files: inline styles (no style sheet), one style sheet per source document, one style sheet (based on one source document), or one style sheet (based on existing style sheet). Inline styles produce results that look the most like the source WinHelp file. However, they can't be modified easily. If you want to make a change (for example, changing the definition of H2 to a different font size), you have to modify the Word files in RoboHELP, then re-generate the WebHelp. |
-- |
Minimum Font Size |
Sets the size of the smallest font in the HTML files. The default is 9 points, although I'd suggest 10 points as the smallest font size. |
WebHelp - Features |
Popups |
Select how you want to convert WinHelp popups: Smart Popups (default) or regular hyperlinks. Smart popups, used when the files are viewed with Internet Explorer, use Dynamic HTML and size to their content. When the files are viewed with Netscape, a JavaScript secondary window displays. |
-- |
What's This Help |
Select how you want to convert any context-sensitive topics from the WinHelp project: Individual HTML files or remove them completely from the conversion. |
-- |
External Topics |
Select how you want to convert external WinHelp topic links: as links to topics in other WebHelp projects (default) or keep the current link to a WinHelp topic, or remove the links completely. Use the first option if you will be converting linked WinHelp projects to WebHelp files, because it maintains the links. If you use the second option, the links will not work when the WebHelp files are viewed through Netscape. |
-- |
Images |
Select how you want to convert your bitmaps: .gif (default) or .jpg. |
-- |
Bullets/Numbering |
Select how you want to convert your bulleted and numbered lists: HTML bullets and numbers (default) or paragraphs that are formatted with inline styles. |
WebHelp - Options |
Navigation Pane |
Select what features you want in the navigational pane of your WebHelp file:
|
-- |
Preferred Format |
For WebHelp files viewed with Internet Explorer, select either Dynamic HTML (default) or Java applet. Files viewed with Netscape Navigator always use the Java applet. |
-- |
In Topic Navigation Bar |
Select from the following list of options:
If you select to not display the Navigation Bar, your initial results display space at the top of each topic (where the Navigation Bar would go if the options had been selected). To remove the space, you must generate the WebHelp files twice. First, select one or both Navigation Bar options and set the location as Bottom Left or Bottom Right. Then, generate the WebHelp files again, but turn off the Navigation Bar options. The space will still display, but at the bottom of the file. |
-- |
Prefix HTML Files with Help Project Name |
Select to add the project name to all HTML files that are created during generation. |
Once you select your options, click Finish.
The files are stored in the specified folder. To make changes to the results, make the necessary modifications in the RoboHELP project and then re-generate WebHelp.
Using the WebHelp Wizard in RoboHELP 2000 for HTML Help
Use WebHelp to publish any kind of online documentation- manuals, online Help (including context-sensitive Help), and Web sites. WebHelp produces cross-platform, browser- independent files that can be accessed with Internet Explorer, Netscape Navigator, or other popular browsers (such as Opera).
If you create a Table of Contents and Index, this information is included in the results.
Some of the differences between HTML Help and WebHelp are:
- WebHelp isn't compiled. You must deploy all files in the WebHelp folder to your Web site.
- WebHelp uses a bi-pane format to display the Table of Contents, Index, and full-text Search on the left and topics on the right. The user's browser provides the navigation.
- WebHelp doesn't allow an auto-synching Table of Contents.
Browser and Operating System Tips and Tricks
Before you deploy your project, you should be aware of issues concerning browsers and operating systems.
Macintosh
- Be sure to specify a Macintosh font in your font family (for example, Helvetica).
- Macintosh fonts typically display at a smaller font size than their Windows counterparts.
UNIX
- UNIX is case-sensitive. All file requests must exactly match the case of the file name, or error messages result.
- Be sure to specify a UNIX font in your font family (for example, Helvetica).
- For the Table of Contents (.hhc) and Index (.hhk) to display, your ISP must specify the correct MIME type for Notepad (TEXT/HTML = HHC HHK).
- Make sure that users enable Java support and the Java version is at least 1.02.
Netscape
- Bugs in Netscape's implementation of Cascading Style Sheets cause display problems. Things that display correctly in Internet Explorer might not look right in the Netscape. Verify your HTML code and Cascading Style Sheets definitions. Visit CSS Pointers Group (Bugs and Workarounds) (http://css.nu/pointers/bugs.html) and WebReview Master Compatibility Chart (http://webreview.com/wr/pub/guides/style/mastergrid.shtml) for information on Netscape bugs and possible workarounds.
- Versions of Netscape before 4.6 ignore margin settings. As a result, the right side of all topics tends run over the browser window. Work around the problem by applying a 6-point indent to the right margin of <BODY> in your style sheet and setting tables to 97% of the window width.
- Any specified style sheets must be available when the HTML file loads or Netscape crashes. This won't be a problem if you copy the entire WebHelp folder.
- File names cannot contain spaces. This includes graphics and folders, which are easy to overlook, especially if you edit the resulting files.
- Map drives on a local area network. Java applets won't load from locations specified by UNC file names (for example, //server/share/paint.htm). Use g:\share\paint.htm intead.
- Netscape doesn't directly support ActiveX components.
Generating WebHelp
When generating WebHelp from RoboHELP HTML, you can select from the following options:
Wizard Dialog Box |
Option |
Description |
WebHelp Options |
Output Folder and Start Page |
Select where you want to store the results. By default, RoboHELP HTML creates a WebHelp folder under the current project and uses the current project name for the start page file name. |
-- |
Build Expression |
If you used build tags in your RoboHELP HTML project, you can convert topics by specifying the build topics to include or exclude. |
-- |
Navigation Pane |
Select what features you want in the navigational pane of your WebHelp file:
|
-- |
Preferred Format |
For WebHelp files viewed with Internet Explorer, select either Dynamic HTML (default) or Java applet. Files viewed with Netscape Navigator always use the Java applet. |
-- |
In Topic Navigation Bar |
Select from the following list of options:
If you select to not display the Navigation Bar, your initial results display space at the top of each topic (where the Navigation Bar would go if the options had been selected). To remove the space, you must generate the WebHelp files twice. First, select one or both Navigation Bar options and set the location as Bottom Left or Bottom Right. Then, generate the WebHelp files again, but turn off the Navigation Bar options. The space will still display, but at the bottom of the file. |
-- |
Always Use Lowercase |
UNIX is case-sensitive. When deploying your WebHelp files to a UNIX server, select this option so that all file names and hyperlink target topics are converted to lowercase. This guarantees that your links will work correctly. |
Using the Printed Documentation Wizard in RoboHELP 2000 for WinHelp
Because RoboHELP and the resulting documentation both use Word, it is fairly easy to create printed documentation, as long as you remember my first rule of Word:
USE TEMPLATE STYLES!
Take complete advantage of Word by designing styles that are easy to implement and store them in your RoboHELP template. Create and apply styles during development that carry through to the printed document. Make sure that these styles exist in your print template, so that all formatting displays correctly.
For a print template to be effective, the styles must match the styles in the RoboHELP documents, as discussed earlier. This lets you take advantage of Word's Automatically Update Document Styles setting in the Tools | Templates and Add-Ins dialog box.
When designing your print template:
- Create a new template. While you could modify an existing template, it might include extraneous information. It's better to create a new one.
- Use the Styles tab in the Organizer dialog box to copy styles from the RoboHELP template. Then, modify them for print (for example, change your online font to a print font).
- Design your header and footer. Include graphics, if desired, and be sure to include page numbers.
- Use field codes and the Document Properties dialog box to set global information. You can update field codes by using macros or by changing their values in the Document Properties dialog box.
Working Around the Contents File
When you're developing a Help file that you want to convert to printed documentation, you can work with-or around-the information in the Contents file.
When you're single-sourcing, you can choose to base your heading levels and topic order on the Table of Contents. If most of your topics are referenced in the Table of Contents, this method works very well. However, some developers create a minimal Table of Contents. If you're planning to single-source to print, this causes major problems. Only the topics referenced by pages in the Table of Contents are stored in the correct order. All other topics are stored in topic order after the initial topics, or, if you're creating documents from books, they are stored in a file called Extra Topics.
To work around the Contents file:
- Edit your project documents so that all topics are organized in the order you want them in the print document.
- Organize all documents into the order you want them in the print document.
- Store information that shouldn't end up in the print document in a separate document (for example, a main list of links). When generating the print document, don't include that document.
To edit your documents:
- Use whatever information you have available to determine the correct topic order. Sometimes, this is an existing topic that displays a list of links.
- Tile RoboHELP Explorer and Microsoft Word so that you can easily see the Project tab.
- Expand the Topics folder on the Project tab and expand the topics list within the documents. This lets you see the current topic order within individual documents.
- If you have topics that list a series of links, display one of those topics in Word and compare the list of links against the topic order.
- Use Cut and Paste to move the topics into place.
To organize the documents:
- Select Tools | Set Document Order from RoboHELP Explorer. The Set Document Order dialog box displays.
- Use the up and down arrows to position the documents.
- When you're finished, click OK.
Generating Printed Documentation
When generating print documentation from RoboHELP, you can select from the following options:
Wizard Dialog Box |
Option |
Description |
Documentation Wizard - First Screen |
Path and File Name |
Select where you want to store the results. By default, RoboHELP creates a Doc folder under the current project and uses the current project name for the document name. |
-- |
Choose Source Documents |
Displays a list of documents in the WinHelp project. By default, all are selected, but you can include as many or as few as you want. |
Documentation Wizard - Second Screen |
Use CNT File for Heading Levels and Topic Order |
If selected, the information in the printed document will use the CNT file to determine the order of topics. Topics not in the CNT will appear in alphabetical order at the end of the file. If not selected, the information in the printed document will follow the Document Order from the project file, with topics following their order in the source document files. |
-- |
Create Documents from Books in the CNT |
If selected, separate files will be created for each book in the Contents file. Topics not listed in the CNT will be stored in a document called "Extra Topics." The master document will also be created. If not selected, all topics will stored in one document. |
-- |
Create a TOC and Index |
This section contains three options.
|
Documentation Wizard - Third Screen |
Selecting a Print Template |
Specifies the template that should be used. By default, robodocs.dot is specified when you first run the wizard. Click the File Open icon to specify your print template. |
-- |
Enable Global Formatting for Heading Styles |
If selected, applies formatting to headings so that they can be controlled through a template. |
-- |
Converting Styles Not Defined in the Print Template |
This section contains three options:
|
Documentation Wizard - Fourth Screen |
Color for Converted Hotspot Text |
Unless you change the global setting, hotspots are formatted as green when inserted into documents in RoboHELP, although they can be changed individually. This option controls the color of hotspots in the printed document: the original color of the hotspot, green, or black. If you're producing a document for your editors, you might want the hotspots to use a color other than black so there is some kind of indication of the link. If you're producing a document for your users, make the hotspots black. |
-- |
Color for Regular Text |
If you have developed a Help file with custom font colors, either keep the original color or select black. If you keep the original font colors, make sure you print the document on a color printer. |
-- |
Saving Converted Graphics |
If you've used graphics in your Help project, select how you want to save them: as embedded graphics in the document or as linked graphics, after the files are created. |
On one of your first passes through the Printed Documentation Wizard, select linked graphics. If there are any problems with the graphical format, the links will be corrupted and error messages display instead. Once you've verified that all graphics are fine, select embedded. |
||
-- |
Skip Conversion of Graphics in Topic Headings |
If you've used identity graphics in the topic headings, select this option to strip them from the file. Printed documentation doesn't typically use logos or other identity graphics in the headings. |
Documentation Wizard - Fifth Screen |
Insert Page Numbers |
Set by default, this option inserts page numbers in the footer of the printed document. If you've set up a custom template that includes page numbers, deselect this option. |
-- |
Keep Page Break Before Each Topic |
If selected, retains the page break before each topic in the printed document. With this option, you will have as many pages as you have topics, plus the Table of Contents and Index (if selected). |
-- |
Select Page Size |
If necessary, click the drop-down arrow to select the page size for the printed document. The other choices are A4, A5, and B5. |
Once you select your options, click Finish.
The file(s) are stored in the specified folder. To make changes to the results, open the document in Word.
Tip
RoboHELP creates the new document and then applies the specified template. If you have added custom headers or footers, these aren't applied to the results.
To correctly assign your template:
- Create a new document, based on your template.
- Copy the content from the old document.
- Paste the content into your new document.
- Save your new document.
If you close the old document first, you can save the new document with the existing name.
Using the Printed Documentation Wizard in RoboHELP 2000 for HTML Help
By producing printed documentation from your RoboHELP HTML project, you can provide hardcopy for your editors or indexers. You can also create a printed manual. However, due to the inherent restrictions when working with HTML files (that is, no prescribed document order unless every topic is in the Table of Contents), you usually have to modify the resulting document to get the topics in the desired order.
RoboHELP HTML is a little more difficult to work with, due to the fact that styles in development are stored in a Cascading Style Sheet, which must be converted to a Word template. HTML includes a minimum number of basic styles:
- Address
- Headings 1 - 6
- Normal (P)
- Preformatted
As a result, many developers use classes to create custom styles. Whenever you create a new style in RoboHELP HTML, you must base it on an existing style. This new style is called a class.
In a Cascading Style Sheet, the style name is preceded by a period (for example, .text). In RoboHELP HTML, the style drop-down list displays classes as style names indented under the associated style. In the resulting Word template, the style displays as style.class (for example, Normal.BulletList).
The easiest way to see what styles will be created is to generate a printed document as a draft. The process creates a template in the output folder. Copy this template to C:\Program Files\Microsoft Office\Templates. Then, edit the styles in this template as desired.
After generating the printed documentation, you can apply the modified template, which helps to apply your designed styles.
Generating Printed Documentation
When generating printed documentation from RoboHELP HTML, you can select from the following options:
Wizard Dialog Box |
Option |
Description |
Documentation Wizard |
Path and File Name |
Select where you want to store the results. By default, RoboHELP HTML creates a PrintDoc folder under the current project and uses the current project name for the document name. |
-- |
Choose Source Documents |
Displays a list of topics in the project. By default, all are selected, but you can include as many or as few as you want. You can filter the list by using the Folders drop- down box at the top of the list. |
Style Sheet |
Specify How to Format Your Document |
Format the resulting Word document by using a template based on a Cascading Style Sheet or inline styles. The style sheet choices from the drop- down list are:
The new template is stored in the PrintDoc folder, not in the Templates folder under Microsoft Office. |
TOC and Index |
Base Heading Levels and Topic Order on TOC |
If selected, the information in the printed document will use the TOC information to determine the order of topics. Topics not in the TOC will appear in alphabetical order at the end of the file. If you develop a fairly complete TOC, this is the best option. If not selected, the topics in the project appear in the resulting document in alphabetical order. If you've used folders to organize all topics, the folders are in alphabetical order and the topics are in alphabetical order inside the folders. If you've used folders to organize some of the topics, the folders and topics at the root level are combined in alphabetical order. If you've linked topics to books and then use the TOC to generate print documentation, the book name displays in the resulting document, followed by the linked topic name. Basically, the resulting document will require editing to place the topics in the correct order, no matter which method you use. |
-- |
Create Separate Documents from First-level Books |
If selected, this option organizes all books into separate documents. The previous option must be selected or this option isn't available. If topics are linked to the books, the linked topic goes into the document for the previous book, except for the first book. Its topic goes into the Extra Topics document. If topics aren't linked to books, no separate documents are created. All topics are stored in the Extra Topics document, sorted alphabetically by book, then alphabetically by topic file name. |
-- |
Create Table of Contents |
If selected, this Table of Contents will be inserted at the beginning of the document, based on your heading styles. The first option must be selected or this option isn't available. |
-- |
Create Index |
If selected, your Index keywords will be converted to index tokens in the resulting document and the index will be created at the end of the document. |
-- |
Create Glossary Page |
If you entered information on the Glossary tab, select this option to create a glossary in your printed documentation. It is inserted after the topics, before the Index. |
-- |
Leave Glossary Definitions in Topics |
If you used the Smart Glossary Wizard to create expanding hotspots in your topics, select this option to retain those definitions. Glossary definitions use inline styles to maintain their original formatting. |
Text Color and Images |
Text Colors |
If you have developed a Help file with custom font colors, either keep the original color or select black. If you keep the original font colors, make sure you print the document on a color printer. |
-- |
Remove All Images from Documents/Topic Titles |
Select Remove All Images from Documents to produce printed documentation without any graphics. Once selected, the other three options are disabled. If you don't select the first option, you can select the second option to strip images from topic titles in your files. Printed documentation doesn't typically use logos or other identity graphics in the headings. |
-- |
Embed or Link Images in Documents |
If you've used graphics in your Help project, select how you want to save them: as embedded graphics in the document or as linked graphics, after the files are created. |
On one of your first passes through the Printed Documentation Wizard, select linked graphics. If there are any problems with the graphical format, the links will be corrupted and error messages display instead. Once you've verified that all graphics are fine, select embedded. |
||
Page Options |
Insert Page Numbers |
Set by default, this option inserts page numbers in the footer of the printed document. If you've set up a custom template that includes page numbers, deselect this option. |
-- |
Insert Page Break After Each Topic |
Set by default, inserts a page break after each topic in the printed document. With this option, you will have as many pages as you have topics, plus the Table of Contents and Index (if selected). |
-- |
Insert Page Break After Each Book |
Inserts a page break after each book in the TOC. |
Once you select your options, click Finish.
The file(s) are stored in the specified folder. To make changes to the results, open the document in Word.
Portions of the material in this column were originally presented as a conference session at TECH/COMM 2000 in July, 2000. Portions of the WinHelp section have been taken from Using RoboHELP 2000 for WinHelp, a training seminar provided by SOLUTIONS, Inc. and taught by Char James-Tanny. Portions of the HTML Help section have been taken from Sams Teach Yourself RoboHELP 2000 for HTML Help in 24 Hours by Char James-Tanny, ISBN 0-672- 31625-0. Used with permission from Macmillan Computer Publishing USA.
Copyright © 2000 Char James-Tanny.
