Contents
1.1.1 For first-time users of Mif2Go
1.1.3 Create or replace the Mif2Go installation script
1.1.4 Install updates to Mif2Go
1.2.1 For successful conversions
1.2.2 How the conversion process works
1.2.3 Output formats you can specify
1.2.4 Languages and character sets supported by Mif2Go
1.4.3 Activate Mif2Go context-sensitive Help
1.4.5 Download the Mif2Go User's Guide
1.4.6 Obtain third-party tools for Help systems
2 Planning a conversion project
2.1 Naming files, folders, and paths
2.3 Working with Mif2Go configuration files
2.4 Importing formats from a conversion template
2.5 Preparing documents for conversion
2.5.1 Planning for graphics processing
2.5.2 Replacing embedded graphics with referenced graphics
2.5.3 Setting up cross references to and from text insets
2.5.4 Creating hotspots for hypertext links
2.5.5 Excluding files from a book conversion
2.5.6 Preparing a structured document for conversion
2.6 Establishing a conversion environment
2.7 Preparing deliverables after conversion
3 Converting a book or document
3.1 Checking set-up and conversion requirements
3.3 Setting up a Mif2Go project
3.4 Choosing project set-up options
3.4.1 Importing formats from a FrameMaker template
3.4.2 Converting FrameMaker system variables to text
3.4.3 Generating and updating your document
3.4.4 Including FrameMaker-generated files
3.4.5 Understanding configuration settings for general set-up options
3.4.6 Choosing format-specific set-up options
3.5 Specifying conversion settings
3.7 Choosing final conversion options
3.7.1 Understanding how export options work
3.7.2 Specifying output format and file extension
3.7.3 Choosing input source and disposition
3.7.4 Figuring out graphics export options
3.7.5 Choosing postprocessing options
4 Setting configuration options
4.1 Editing a Mif2Go configuration file
4.1.1 Understanding what settings are available
4.1.2 Understanding default configuration values
4.1.3 Editing the correct configuration file
4.1.4 Understanding the rules for configuration settings
4.1.5 Specifying file paths in configuration settings
4.1.6 Using wildcards in configuration settings
4.2 Specifying operating settings
4.2.1 Specifying an output format
4.2.2 Specifying the output file extension
4.2.3 Reusing or discarding MIF files
4.2.5 Checking for broken links
4.2.6 Skipping the Mif2Go Export and Finished dialogs
4.2.7 Specifying how to treat cases, spaces, and wildcards
4.2.9 Converting system variables to text
4.2.10 Eliminating Word-generated cross-reference markers
4.3 Identifying files and objects
4.3.1 Understanding how Mif2Go creates identifiers
4.3.2 Working with FrameMaker ObjectIDs
4.3.3 Working with FrameMaker cross-reference IDs
4.3.4 Working with Mif2Go FileIDs
4.4 Using Mif2Go configuration templates
4.5 Applying FrameMaker conversion templates
4.5.1 Specifying template settings
4.5.2 Applying alternate conversion templates
4.5.3 Changing template options
4.5.4 Avoiding template-related disasters
4.6 Applying FrameMaker conditions and variables
4.6.1 Applying condition Show/Hide settings
4.6.2 Replacing values of FrameMaker user variables
4.7 Converting FrameMaker-generated files
4.7.1 Converting FrameMaker TOC and IX files
4.7.2 Preventing conversion of other generated files
4.7.3 Activating hypertext links in a converted index
4.7.4 Making See and See also index entries into useful links
4.8 Generating/updating before converting
4.9.1 Understanding which graphics are included
4.9.2 Choosing how to convert graphics
4.9.3 Choosing when to convert graphics
4.9.4 Identifying graphics files
4.10.1 Understanding how equations are processed
4.10.2 Specifying equation size and DPI
4.10.3 Specifying equation output format
4.10.4 Positioning equations in RTF output
4.11 Creating hotspots for hypertext links
4.11.1 Delimiting a hotspot with a character format
4.11.2 Making an entire paragraph into a hotspot
4.11.3 Delimiting a hotspot with a color
4.12 Repurposing FrameMaker markers
5.1 Converting to Word: a one-way street
5.1.1 Understanding differences in implementation
5.1.2 Understanding differences in file sizes
5.1.3 Understanding why round-tripping is not an option
5.1.4 Migrating a document from FrameMaker to Word
5.1.5 Developing a workflow using Word for reviews
5.1.6 Supporting more than one version of Word for review
5.2 Setting up a print RTF project
5.2.1 Creating a print RTF project
5.2.2 Choosing set-up options for a print RTF project
5.2.3 Specifying output type and file extension
5.2.4 Specifying the default output language
5.2.5 Adjusting for different versions of Word
5.2.6 Importing a Word template
5.3 Converting a FrameMaker book to print RTF
5.3.1 Understanding why Mif2Go produces separate RTF files
5.3.2 Producing a single RTF file from a FrameMaker book
5.4 Specifying document layout options for print RTF
5.4.1 Understanding document layout restrictions
5.4.2 Eliminating large top or bottom margins
5.4.3 Using text frames to solve spacing problems
5.4.4 Maintaining pagination in Word
5.4.5 Keeping or removing page breaks
5.4.6 Specifying columns and gaps
5.4.7 Adjusting sidehead width for Word
5.4.9 Converting headers and footers
5.4.10 Converting special text flows for RTF output
5.4.11 Handling different page size or orientation
5.4.12 Converting system variables to text for RTF
5.5 Converting paragraph and character formats
5.5.1 Mapping paragraph formats to RTF styles
5.5.2 Merging paragraph formats
5.5.3 Converting sidehead formats
5.5.4 Converting run-in headings
5.5.5 Converting autonumbered formats
5.5.6 Converting bulleted formats
5.5.7 Converting reference frames for Word
5.5.8 Converting character formats
5.6 Converting tabs and spaces
5.6.1 Understanding differences in tab behavior
5.6.2 Understanding differences in spaces
5.6.4 Altering font metrics to adjust tabs
5.7.1 Setting default font parameters
5.7.4 Specifying font encoding for non-Western characters
5.7.5 Specifying font encoding for FrameMaker 8 Unicode
5.8.2 Adjusting paragraph spacing
5.8.4 Specifying a style for quotes
5.8.5 Mapping high ASCII characters for RTF output
5.8.9 Omitting content from RTF output
5.8.10 Replacing content in RTF output
5.9 Converting cross references and hypertext links
5.9.1 Including ObjectIDs for Word links and cross references
5.9.2 Converting cross references to Word
5.9.3 Converting hypertext links to Word
5.9.4 Locking hypertext links to allow revision tracking
5.9.5 Enabling interfile cross references and hypertext links
5.9.6 Replacing building blocks in master-page references
5.10 Converting generated files to print RTF
5.10.1 Specifying which generated files to convert
5.10.2 Activating links in converted index and list files
5.10.3 Making the entire text of each list entry an active link
5.10.4 Ensuring link targets are present in RTF output
5.10.5 Correcting <$nopage> index links
5.11 Converting tables to print RTF
5.12 Converting graphics for print RTF
5.12.1 Understanding graphics requirements for Word
5.12.2 Converting referenced graphics
5.12.3 Converting embedded graphics
5.12.4 Limiting bitmap resolution and color depth
5.12.5 Managing callouts added to graphics
5.12.6 Positioning graphics and wrapping text
5.12.7 Preserving graphics scale in Word
5.12.8 Including file names of referenced graphics in Word
5.12.9 Linking instead of embedding referenced graphics
5.12.10 Embedding graphics in converted RTF files
5.13 Turning on revision tracking in Word
5.14 Modifying Word output after conversion
5.14.1 Generating an index in Word
5.14.2 Combining RTF files into a Word master document
5.14.3 Checking print RTF output files for Mif2Go version
5.15 Converting to OpenOffice or StarOffice
6.1 Weighing Help-system alternatives
6.1.1 Considering Help-system features
6.1.2 Evaluating Microsoft Windows Help (WinHelp)
6.1.3 Evaluating Microsoft HTML Help
6.1.6 Evaluating JavaHelp and Oracle Help for Java
6.2 Setting up a Help system project
6.2.1 Checking automatic Help topic assignments
6.2.2 Configuring run-in paragraphs
6.2.3 Specifying additional processing after conversion
6.2.4 Compiling and distributing Help systems
6.3 Producing contents and index for Help systems
6.3.1 Understanding how Mif2Go produces contents and index
6.3.2 Including FrameMaker TOC and IX in Help systems
6.3.3 Modifying contents or index production for HTML-based Help
6.3.4 Modifying contents or index production for WinHelp
6.4 Configuring contents entries for Help systems
6.4.1 Understanding how contents levels are assigned
6.4.2 Setting contents levels for WinHelp
6.4.3 Including contents entries in HTML-based Help
6.4.4 Setting contents levels for HTML-based Help
6.5 Configuring index entries for Help systems
6.5.1 Understanding how Mif2Go creates Help index entries
6.5.2 Limiting length of index entries for HTML Help or WinHelp
6.5.3 Omitting intermediate index-range entries
6.5.4 Treating commas as potential index level separators
6.5.5 Combining index levels for HTML-based Help
6.5.6 Configuring See and See also entries for HTML-based Help
6.5.7 Specifying index link destinations for HTML-based Help
6.5.8 Customizing index sort order for HTML-based Help
6.6 Providing related-topic links for Help systems
6.6.1 Understanding related-topic links
6.6.2 Understanding how ALinks work
6.6.3 Understanding how KLinks work
6.6.4 Adding related-topic link keywords in FrameMaker
6.6.5 Adding ALink and KLink jumps in FrameMaker
6.6.6 Creating target-and-jump ALinks for HTML-based Help
6.6.7 Specifying ALink and KLink list-link destinations
6.7 Jumping to secondary windows in Help systems
6.7.1 Assigning secondary windows for WinHelp
6.7.2 Assigning secondary windows for HTML-based Help
6.8 Creating pop-up topics for Help systems
6.8.1 Understanding pop-up hotspots, links, and topics
6.8.2 Defining a pop-up hotspot
6.8.3 Displaying a topic in a pop-up window
6.9 Including expandable sections in Help topics
6.9.1 Understanding Mif2Go expandable drop-down sections
6.9.2 Setting up expandable sections for your document
6.9.3 Delimiting expandable drop-down sections
6.9.4 Configuring drop-down links
6.9.5 Configuring drop-down blocks
6.9.6 Providing CSS for drop-down links and blocks
6.9.7 Deploying JavaScript code for drop-down sections
6.9.8 Emulating Web Works Publisher drop-down hotspots
6.10 Setting up Context Sensitive Help (CSH)
6.10.1 Understanding how CSH works
6.10.2 Specifying CSH mappings
6.11 Setting up a dynamic modular Help system
7.1 Setting up a WinHelp project
7.1.1 Creating a WinHelp project
7.1.2 Choosing set-up options for a WinHelp project
7.1.3 Preparing a document for conversion to WinHelp
7.1.4 Understanding initial set-up requirements
7.1.5 Accommodating platform differences
7.1.6 Setting basic options in the configuration file
7.1.7 Including ObjectIDs in WinHelp
7.1.8 Handling page breaks and section breaks
7.1.9 Providing multiple .hlp files
7.1.10 Integrating WinHelp from RoboHelp
7.1.11 Compiling a WinHelp project
7.1.12 Checking WinHelp RTF files for Mif2Go version
7.2 Converting FrameMaker text
7.2.1 Converting formats for WinHelp
7.2.2 Converting special characters
7.2.3 Removing unused formats and fonts
7.2.4 Replacing paragraph or character content
7.3 Converting cross references
7.3.1 Creating help context markers
7.3.2 Specifying cross-reference destination files
7.3.3 Specifying cross-reference jump destinations
7.3.4 Specifying options for selected cross-reference formats
7.3.5 Limiting cross-reference marker text
7.4 Converting tables for WinHelp
7.4.1 Positioning tables and table titles
7.4.2 Adjusting table appearance
7.4.3 Converting table rows to topics and table cells to pop-ups
7.5 Converting graphics for WinHelp
7.5.1 Choosing a graphics format for WinHelp
7.5.2 Avoiding the GDI resource leak
7.5.3 Positioning graphics in WinHelp
7.5.4 Displaying graphics in pop-ups for WinHelp
7.6 Converting generated files for WinHelp
7.6.1 Converting lists of paragraph references
7.6.2 Converting indexes and lists of marker references
7.7 Configuring WinHelp topics
7.7.2 Assigning properties to formats for topics and hotspots
7.7.3 Configuring topic titles for WinHelp
7.8 Creating jumps and pop-ups for WinHelp
7.8.1 Identifying WinHelp jump destinations with FileIDs
7.8.2 Configuring pop-up topics
7.8.3 Creating hotspots for jumps and pop-ups in WinHelp
7.8.4 Using cross references for jumps and pop-ups
7.8.5 Using hypertext links for jumps and pop-ups
7.8.6 Disallowing hypertext links for jumps and pop-ups
7.8.7 Specifying jumps to secondary windows in WinHelp
7.8.8 Specifying jumps to external files
7.8.9 Using the same content for both normal topics and pop-ups
7.8.10 Creating a glossary pop-up: an example
7.8.11 Configuring alternative jumps and pop-ups
7.8.12 Specifying the scope of alternative jumps and pop-ups
7.9.1 Using a hypertext marker to invoke a macro
7.9.2 Assigning a hotspot property to invoke a macro
7.10 Creating related-topic links in WinHelp
7.10.1 Understanding KLink limitations
7.10.2 Adding ALinks and KLinks with markers
7.10.3 Adding related-topic keywords with formats
7.10.4 Inserting WinHelp macros for ALink jumps
7.11 Configuring index entries for WinHelp
7.11.1 Designating index level separators
7.11.2 Eliminating duplicate keywords
7.11.3 Keeping or discarding "See also" entries
7.11.4 Using FrameMaker Index markers
7.12 Configuring contents for WinHelp
7.12.1 Naming and configuring Help files and titles
7.12.2 Specifying heading formats and levels for contents
7.12.3 Assembling WinHelp contents from the command line
7.13 Creating browse sequences
7.13.1 Setting up an automatic browse sequence
7.13.2 Specifying browse numbers
7.13.3 Setting up multi-file browse sequences
7.13.4 Setting up branching browse sequences
8 Generating Microsoft HTML Help
8.1 Understanding how Mif2Go produces HTML Help
8.2 Setting up an HTML Help project
8.2.1 Creating an HTML Help project
8.2.2 Choosing set-up options for an MS HTML Help project
8.2.3 Organizing files for HTML Help
8.2.4 Specifying a project title for HTML Help
8.2.5 Naming .hhp and .chm files for HTML Help
8.2.6 Specifying a starting topic file for HTML Help
8.2.7 Specifying help-file language for HTML Help
8.2.8 Regenerating the HTML Help project file
8.2.9 Locating graphics files for HTML Help
8.2.10 Compiling and testing an HTML Help project
8.2.11 Registering an HTML Help system for network use
8.3 Customizing HTML Help display features
8.3.1 Using CSS and font tags with HTML Help
8.3.2 Eliminating graphic and table indents from HTML Help
8.3.3 Adding tabs and toolbar buttons to HTML Help
8.3.4 Adding expandable sections to HTML Help
8.4 Creating pop-ups for HTML Help
8.4.1 Using HTML Help for pop-ups
8.4.2 Using KeyHelp for pop-ups
8.4.3 Using WinHelp for pop-ups
8.5 Creating links and hypertext jumps in HTML Help
8.5.1 Creating hypertext jumps to other CHM files
8.5.2 Specifying href link syntax for HTML Help
8.5.3 Linking to external files from compiled HTML Help
8.6 Creating related-topic links for HTML Help
8.6.1 Adding ALink keywords for HTML Help
8.6.2 Adding ALink and KLink jumps for HTML Help
8.6.3 Configuring ALink and KLink jumps for HTML Help
8.6.4 Rolling your own macros for ALink jumps in HTML Help
8.6.5 Using the same format or marker for ALink keywords and jumps
8.6.6 Creating buttons for other types of related-topic links
8.7 Using secondary windows in HTML Help
8.7.1 Defining secondary windows for HTML Help
8.7.2 Jumping from a topic to a secondary window
8.7.3 Jumping from contents or index to a secondary window
8.8 Generating contents and index for HTML Help
8.8.1 Choosing how to generate HTML Help contents and index
8.8.2 Generating contents and index with HTML Help Workshop
8.8.3 Generating contents and index with Mif2Go
8.8.4 Configuring contents entries for HTML Help
8.8.5 Providing mid-topic contents links in HTML Help
8.8.6 Making the TOC track index links in HTML Help
8.8.7 Customizing contents and index for HTML Help
8.9 Converting generated files for HTML Help
8.9.1 Converting lists of paragraph references
8.9.2 Converting lists of marker references
8.10 Providing full-text search (FTS) for HTML Help
8.11 Setting up CSH for HTML Help
8.11.1 Inserting CSH destinations in your document
8.11.2 Determining whether you need map and alias files
8.11.3 Specifying a map file for CSH links
8.11.4 Creating an alias file for CSH links
8.11.5 Understanding alias-file entries
8.12 Mapping and merging CHM files
8.12.1 Interlinking multiple CHM files
8.12.2 Synchronizing TOC references to slave CHM files
9.1 Understanding how OmniHelp works
9.2 Setting up OmniHelp viewer control files
9.2.1 Choosing XHTML vs. HTML OmniHelp control files
9.2.2 Making OmniHelp viewer control files available
9.2.3 Customizing OmniHelp viewer control files
9.2.4 Examining generated control and data files
9.3 Setting up an OmniHelp project
9.3.1 Creating an OmniHelp project
9.3.2 Choosing set-up options for an OmniHelp project
9.3.3 Specifying the OmniHelp output format
9.3.4 Naming your OmniHelp project
9.3.5 Giving your OmniHelp project a title
9.3.6 Specifying the starting topic
9.3.7 Specifying the start-up file type
9.3.8 Specifying memory requirements
9.3.9 Removing paths from interfile links for OmniHelp
9.3.10 Getting OmniHelp supporting files in the right place
9.4.1 Specifying CSS for topics in OmniHelp
9.4.2 Understanding how CSS works in OmniHelp topics
9.4.3 Specifying CSS for OmniHelp navigation frames
9.5 Customizing OmniHelp display features
9.5.1 Configuring OmniHelp window usage and frameset dimensions
9.5.2 Altering OmniHelp top navigation frame content
9.5.3 Modifying OmniHelp navigation aids
9.5.4 Choosing whether to use cookies for OmniHelp
9.5.5 Localizing the OmniHelp interface
9.5.6 Modifying the OmniHelp template
9.6 Choosing navigation features for OmniHelp
9.7 Configuring contents and index for OmniHelp
9.7.1 Understanding OmniHelp contents and index creation
9.7.2 Choosing whether to use expanding contents or index
9.7.3 Choosing how to expand contents and index subentries
9.7.4 Providing alternate expansion icons for contents or index
9.7.5 Excluding Open All and Close All buttons
9.7.6 Redirecting See and See also index entries
9.8 Providing related-topic links in OmniHelp
9.9 Jumping to secondary windows in OmniHelp
9.10 Configuring full-text search for OmniHelp
9.10.2 Specifying length of search terms
9.10.4 Using regular expressions in search
9.10.5 Highlighting search terms found in topics
9.11 Setting up CSH for OmniHelp
9.11.1 Specifying alias prefixes for OmniHelp CSH calls
9.11.2 Referencing OmniHelp topic IDs from an application
9.11.3 Using redirect pages for OmniHelp CSH calls
9.11.4 Executing browser commands for OmniHelp CSH calls
9.12 Merging OmniHelp projects
9.12.1 Understanding the OmniHelp merge process
9.12.2 Listing and mapping OmniHelp subprojects
9.12.3 Providing TOC placeholders for OmniHelp subprojects
9.12.4 Deciding when to merge OmniHelp subprojects
9.13 Assembling OmniHelp files for viewing
9.14.1 Starting with the default topic or a specified topic
9.14.2 Restarting where you left off
9.14.3 Coping with browser quirks
10 Generating JavaHelp or Oracle Help
10.1 Choosing which Java Help system to use
10.2 Setting up a JavaHelp or Oracle Help project
10.2.1 Creating a JavaHelp or Oracle Help for Java project
10.2.2 Choosing set-up options for a JavaHelp or Oracle Help project
10.2.3 Specifying output options for JavaHelp
10.2.4 Specifying output options for Oracle Help for Java
10.2.5 Establishing a JavaHelp environment
10.2.6 Establishing an Oracle Help environment
10.2.7 Creating a folder structure for JavaHelp / Oracle Help
10.2.8 Configuring the helpset file
10.2.9 Coping with JavaHelp / Oracle Help viewer limitations
10.2.10 Compiling JavaHelp with Helen
10.3 Generating contents and index
10.3.1 Configuring contents entries for JavaHelp or Oracle Help
10.3.2 Assigning TOC images and expansion levels in JavaHelp 2
10.3.3 Configuring index entries for JavaHelp or Oracle Help
10.3.4 Eliminating index-marker artifacts from text
10.3.5 Locating JavaHelp or Oracle Help contents and index files
10.4 Providing full-text search for JavaHelp / Oracle Help
10.4.1 Including a search-index link in the helpset file
10.4.2 Creating a search index for JavaHelp
10.4.3 Creating a search index for Oracle Help
10.5 Creating a Java Archive (JAR) file
10.6 Converting a glossary to JavaHelp 2
10.6.1 Evaluating glossary usability
10.6.2 Assigning glossary properties
10.6.3 Configuring glossary IDs
10.6.4 Eliminating glossary entries from the JavaHelp TOC
10.7 Defining windows for JavaHelp or Oracle Help
10.7.1 Specifying window parameters for JavaHelp 2
10.7.2 Specifying window parameters for Oracle Help
10.7.3 Jumping to secondary windows in JavaHelp or Oracle Help
10.8 Linking to destinations within topics
10.9 Creating ALinks for Oracle Help
10.10 Merging JavaHelp or Oracle Help systems
10.11 Setting up CSH for JavaHelp or Oracle Help
11.1 Understanding how Eclipse Help works
11.2 Setting up an Eclipse Help project
11.2.1 Creating an Eclipse Help project
11.2.2 Choosing set-up options for an Eclipse Help project
11.2.3 Specifying Eclipse Help output options
11.2.4 Making sure links work in Eclipse Help
11.2.5 Disabling breadcrumb trails in Eclipse Help
11.3 Configuring Eclipse Help manifest files
11.3.1 Specifying a Java manifest file for Eclipse Help
11.3.2 Specifying Eclipse Help plug-in properties
11.3.3 Configuring the Java manifest file for Eclipse Help
11.3.4 Configuring the plug-in manifest file for Eclipse Help
11.4 Configuring contents and index for Eclipse Help
11.4.1 Choosing contents and index methods for Eclipse Help
11.4.2 Supplying path information for contents and index links
11.4.3 Encoding special characters for contents and index entries
11.4.4 Configuring contents properties for Eclipse Help
11.4.5 Configuring index properties for Eclipse Help
11.5 Merging Eclipse Help projects
11.6 Setting up CSH for Eclipse Help
11.6.1 Understanding how Mif2Go generates context links
11.6.2 Naming context file and attribute for secondary plug-ins
11.6.3 Configuring context IDs and context anchors
11.6.4 Configuring context descriptions
11.6.5 Locating context information
11.7 Packaging Eclipse Help files
11.7.1 Specifying a ZIP command for doc.zip
11.7.2 Specifying ZIP command parameters
11.7.3 Specifying a JAR command for doc.jar
11.7.4 Archiving Eclipse Help files
12.1 Setting up an HTML or XML project
12.1.1 Creating an HTML or XML project
12.1.2 Choosing set-up options for an HTML or XML project
12.1.3 Preparing a document for conversion to HTML or XML
12.1.4 Specifying output type and file extension
12.1.5 Checking automatic settings for HTML or XML split files
12.1.6 Establishing a conversion workflow for HTML
12.1.7 Checking HTML output files for broken links
12.1.8 Checking HTML or XML output files for Mif2Go version
12.1.9 Using XHTML tagging rules for HTML
12.2 Including starting code and entity references
12.3 Supplying values for the <head> element
12.3.1 Specifying HTML/XML version, DocType, and DTD
12.3.2 Specifying namespace and language