Omni Systems, Inc.


Mif2Go User's Guide, Version 55


Valid HTML 4.01!


Made with Mif2Go

> Contents




About this guide

1 Getting started with Mif2Go

1.1 What you need to know

1.1.1 How Mif2Go is organized

1.1.2 File, directory, and path names

1.1.3 Output types you can specify

1.1.4 Languages and character sets

1.2 What you need to have

1.3 What you need to do

1.3.1 Set up a framework for Omni Systems applications

1.3.2 Download a Mif2Go distribution

1.3.3 Install Mif2Go

1.3.4 Make Omni Systems executables accessible

1.3.5 Obtain tools for Help systems or eBooks

1.3.6 Establish system-wide configuration settings

1.3.7 Locate document-specific settings

1.3.8 Obtain a file comparison tool (optional)

1.3.9 Download the Mif2Go User’s Guide (optional)

1.4 How to update Mif2Go

1.4.1 Change from the evaluation version to a licensed version

1.4.2 Update your Mif2Go installation

1.4.3 Try out Mif2Go beta executables

1.5 How Mif2Go works

1.6 How to start and stop Mif2Go

1.7 How to work with Mif2Go

1.8 How to uninstall Mif2Go

2 Planning a conversion project

2.1 Naming files, directories, and paths

2.2 Naming FrameMaker formats

2.3 Understanding Mif2Go configuration files

2.4 Importing formats from a conversion template

2.5 Preparing documents for conversion

2.5.1 Updating your document in FrameMaker

2.5.2 Planning for graphics processing

2.5.3 Replacing embedded graphics with referenced graphics

2.5.4 Setting up cross references to and from text insets

2.5.5 Creating hotspots for hypertext links

2.5.6 Producing a single output file from a FrameMaker book

2.5.7 Preparing a structured document for conversion

2.6 Establishing a conversion environment

2.7 Setting up multiple interlinked HTML projects

2.8 Preparing deliverables after conversion

3 Converting a book or document

3.1 Checking set-up and conversion requirements

3.2 Starting Mif2Go

3.3 Creating a Mif2Go conversion 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 output-specific set-up options

3.5 Understanding how Mif2Go sets up a project

3.6 Converting documents

3.7 Choosing final conversion options

3.7.1 Understanding how export options work

3.7.2 Specifying output type 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 Editing configuration files

4.1 Working with Mif2Go configuration files

4.2 Editing files with the Configuration Manager

4.2.1 Understanding how to use the Configuration Manager

4.2.2 Starting the Configuration Manager

4.2.3 Setting Configuration Manager preferences

4.2.4 Establishing a starting point

4.2.5 Choosing a configuration category or file type

4.2.6 Understanding variable vs. fixed names and keys

4.2.7 Choosing the kind of change to make

4.2.8 Selecting a configuration section

4.2.9 Selecting a configuration setting

4.2.10 Selecting a configuration file

4.2.11 Specifying a final value

4.3 Understanding where project settings come from

4.4 Understanding the rules for configuration settings

4.5 Specifying file paths in configuration settings

4.6 Using wildcards in configuration settings

4.7 Commenting out configuration sections

4.8 Ending a configuration file

5 Setting basic conversion options

5.1 Specifying operating settings

5.1.1 Checking output type and file extension

5.1.2 Excluding files from book conversions

5.1.3 Reusing or discarding MIF files

5.1.4 Reusing or discarding ASCII DCL files

5.1.5 Checking for broken links in HTML or XML output

5.1.6 Skipping the Mif2Go Export and Finished dialogs

5.1.7 Specifying how to treat cases, spaces, and wildcards

5.1.8 Reordering text flows

5.1.9 Converting system variables to text

5.1.10 Preserving Word-generated cross-reference markers

5.2 Logging conversion events

5.3 Identifying files and objects

5.3.1 Understanding how Mif2Go creates identifiers

5.3.2 Working with FrameMaker ObjectIDs

5.3.3 Working with FrameMaker cross-reference IDs

5.3.4 Working with Mif2Go FileIDs

5.4 Applying FrameMaker conditions and variables

5.4.1 Applying condition Show/Hide settings

5.4.2 Replacing values of FrameMaker user variables

5.5 Converting FrameMaker-generated files

5.5.1 Converting FrameMaker TOC and IX files

5.5.2 Preventing conversion of other generated files

5.5.3 Activating hypertext links in a converted index

5.5.4 Making See and See also index entries into useful links

5.6 Generating/updating before converting

5.7 Processing graphics

5.7.1 Understanding which graphics are included

5.7.2 Choosing how to convert graphics

5.7.3 Choosing when to convert graphics

5.7.4 Identifying exported graphics files

5.8 Converting structured documents

5.9 Converting equations

5.9.1 Understanding how equations are processed

5.9.2 Specifying equation size and DPI

5.9.3 Specifying equation output format

5.9.4 Providing a file-name suffix for equations

5.9.5 Positioning equations in RTF output

5.10 Creating hotspots for hypertext links

5.10.1 Delimiting a hotspot with a character format

5.10.2 Making an entire paragraph into a hotspot

5.10.3 Delimiting a hotspot with a color

5.11 Repurposing FrameMaker markers

6 Converting to print RTF

6.1 Converting to Word: a one-way street

6.1.1 Understanding differences in implementation

6.1.2 Understanding differences in file sizes

6.1.3 Understanding why round-tripping is not an option

6.1.4 Migrating a document from FrameMaker to Word

6.1.5 Developing a workflow using Word for reviews

6.2 Setting up a print RTF project

6.2.1 Creating a print RTF project

6.2.2 Choosing set-up options for a print RTF project

6.2.3 Specifying output file extension

6.2.4 Specifying the default output language and code page

6.2.5 Constraining the number of bookmarks in Word

6.2.6 Importing a Word template

6.3 Adjusting output for different versions of Word

6.4 Converting a FrameMaker book to print RTF

6.5 Specifying document layout options

6.5.1 Understanding page layout restrictions

6.5.2 Eliminating large top or bottom margins

6.5.3 Using text frames to solve spacing problems

6.5.4 Maintaining pagination in Word

6.5.5 Managing page and section breaks

6.5.6 Specifying columns and gaps

6.5.7 Adjusting sidehead width for Word

6.5.8 Converting footnotes

6.5.9 Converting headers and footers

6.5.10 Converting special text flows for RTF output

6.5.11 Handling different page size or orientation

6.6 Converting system variables to text for RTF

6.7 Converting paragraph and character formats

6.7.1 Mapping paragraph formats to RTF styles

6.7.2 Merging paragraph formats

6.7.3 Converting sidehead formats

6.7.4 Converting run-in headings

6.7.5 Converting autonumbered formats

6.7.6 Converting bulleted formats

6.7.7 Converting reference frames for Word

6.7.8 Converting character formats

6.7.9 Removing unused formats

6.8 Converting tabs and spaces

6.8.1 Understanding differences in tab behavior

6.8.2 Understanding differences in spaces

6.8.3 Altering tab behavior for Word output

6.8.4 Altering font metrics to adjust tabs

6.9 Specifying font usage

6.9.1 Setting default font parameters

6.9.2 Remapping fonts

6.9.3 Specifying font types

6.9.4 Specifying font encoding for non-Western characters

6.9.5 Specifying font encoding for FrameMaker 8 Unicode

6.9.6 Removing unused fonts

6.10 Modifying text appearance

6.10.1 Adjusting line spacing

6.10.2 Adjusting paragraph spacing

6.10.3 Adjusting small caps

6.10.4 Specifying a style for quotes

6.10.5 Mapping high ASCII characters for RTF output

6.10.6 Specifying text color

6.10.7 Hiding white text

6.10.8 Hiding content in Word

6.10.9 Omitting content from RTF output

6.10.10 Replacing content in RTF output

6.11 Converting cross references and hypertext links

6.11.1 Including ObjectIDs for Word links and cross references

6.11.2 Converting cross references to Word

6.11.3 Converting hypertext links to Word

6.11.4 Locking hypertext links to allow revision tracking

6.11.5 Enabling interfile cross references and hypertext links

6.11.6 Replacing building blocks in master-page references

6.12 Converting generated files to print RTF

6.12.1 Specifying which generated files to convert

6.12.2 Activating links in converted index and list files

6.12.3 Making the entire text of each list entry an active link

6.12.4 Ensuring link targets are present in RTF output

6.12.5 Correcting <$nopage> index links

6.13 Converting tables to print RTF

6.14 Managing graphics for print RTF

6.14.1 Understanding graphics requirements for Word

6.14.2 Converting referenced graphics

6.14.3 Converting embedded graphics

6.14.4 Limiting bitmap resolution and color depth

6.14.5 Managing callouts added to graphics

6.14.6 Positioning graphics and wrapping text

6.14.7 Preserving graphics scale in Word

6.14.8 Accommodating graphics in multiple versions of Word

6.14.9 Including file names of referenced graphics in Word

6.14.10 Linking instead of embedding referenced graphics

6.14.11 Embedding graphics in converted RTF files

6.14.12 Updating fields in Word to show linked graphics

6.15 Including RTF code for Word output

6.16 Turning on revision tracking in Word

6.17 Managing Word output after conversion

6.17.1 Supporting more than one version of Word

6.17.2 Including index terms in Word

6.17.3 Producing ASCII text from a converted Word document

6.17.4 Combining RTF files into a Word master document

6.17.5 Checking print RTF output files for Mif2Go version

6.18 Converting to OpenOffice or StarOffice

7 Producing on-line Help

7.1 Weighing Help-system alternatives

7.1.1 Considering Help-system features

7.1.2 Understanding the effects of mid-topic links

7.1.3 Evaluating Microsoft Windows Help (WinHelp)

7.1.4 Evaluating Microsoft HTML Help

7.1.5 Evaluating WebHelp

7.1.6 Evaluating OmniHelp

7.1.7 Evaluating JavaHelp and Oracle Help for Java

7.1.8 Evaluating Eclipse Help

7.2 Setting up a Help system project

7.2.1 Checking automatic Help topic assignments

7.2.2 Configuring run-in paragraphs

7.2.3 Specifying additional processing after conversion

7.2.4 Compiling and distributing Help systems

7.3 Producing contents and index for Help systems

7.3.1 Understanding how Mif2Go produces contents and index

7.3.2 Including FrameMaker TOC and IX in Help systems

7.3.3 Grouping contents entries

7.3.4 Modifying contents or index production for HTML-based Help

7.3.5 Modifying contents or index production for WinHelp

7.4 Configuring contents entries for Help systems

7.4.1 Understanding how contents levels are assigned

7.4.2 Setting contents levels for WinHelp

7.4.3 Including contents entries in HTML-based Help

7.4.4 Setting contents levels for HTML-based Help

7.5 Configuring index entries for Help systems

7.5.1 Understanding how Mif2Go creates Help index entries

7.5.2 Preparing index entries for Microsoft Help Viewer

7.5.3 Limiting length of index entries for HTML Help or WinHelp

7.5.4 Omitting intermediate index-range entries

7.5.5 Treating commas as potential index level separators

7.5.6 Combining index levels for HTML-based Help

7.5.7 Configuring See and See also entries for HTML-based Help

7.5.8 Specifying index link destinations for HTML-based Help

7.5.9 Customizing index sort order

7.6 Providing related-topic links for Help systems

7.6.1 Understanding related-topic links

7.6.2 Understanding how ALinks work

7.6.3 Understanding how KLinks work

7.6.4 Adding related-topic link keywords in FrameMaker

7.6.5 Adding ALink and KLink jumps in FrameMaker

7.6.6 Creating target-and-jump ALinks for HTML-based Help

7.6.7 Specifying ALink and KLink list-link destinations

7.7 Jumping to secondary windows in Help systems

7.7.1 Assigning secondary windows for WinHelp

7.7.2 Assigning secondary windows for HTML-based Help

7.8 Creating pop-up topics for Help systems

7.8.1 Understanding pop-up hotspots, links, and topics

7.8.2 Defining a pop-up hotspot

7.8.3 Displaying a topic in a pop-up window

7.9 Including expandable sections in Help topics

7.9.1 Understanding Mif2Go expandable drop-down sections

7.9.2 Setting up expandable sections for your document

7.9.3 Delimiting expandable drop-down sections

7.9.4 Configuring drop-down links

7.9.5 Configuring drop-down blocks

7.9.6 Providing CSS for drop-down links and blocks

7.9.7 Deploying JavaScript code for drop-down sections

7.9.8 Emulating Web Works Publisher drop-down hotspots

7.10 Setting up Context Sensitive Help (CSH)

7.10.1 Understanding how CSH works

7.10.2 Specifying CSH mappings

7.11 Setting up a dynamic modular Help system

8 Generating WinHelp

8.1 Obtaining tools for WinHelp

8.2 Setting up a WinHelp project

8.2.1 Setting up a WinHelp project

8.2.2 Choosing set-up options for a WinHelp project

8.2.3 Deciding where to locate configuration settings

8.2.4 Preparing a document for conversion to WinHelp

8.2.5 Understanding initial set-up requirements

8.2.6 Deciding whether to regenerate the WinHelp project file

8.2.7 Accommodating platform differences

8.2.8 Setting basic WinHelp options in the configuration file

8.2.9 Including ObjectIDs in WinHelp

8.2.10 Handling page breaks and section breaks

8.2.11 Providing multiple .hlp files

8.2.12 Integrating WinHelp from RoboHelp

8.2.13 Compiling a WinHelp project

8.2.14 Checking WinHelp RTF files for Mif2Go version

8.3 Converting text

8.3.1 Converting formats for WinHelp

8.3.2 Converting special characters

8.3.3 Removing unused formats and fonts

8.3.4 Converting autonumbers

8.3.5 Replacing paragraph or character content

8.3.6 Specifying text color

8.3.7 Converting footnotes

8.4 Converting cross references

8.4.1 Creating help context markers

8.4.2 Specifying cross-reference destination files

8.4.3 Specifying cross-reference jump destinations

8.4.4 Specifying WinHelp options for cross-reference formats

8.4.5 Limiting cross-reference text

8.5 Converting tables to WinHelp RTF

8.5.1 Positioning tables and table titles

8.5.2 Adjusting table appearance

8.5.3 Converting table rows to topics and table cells to pop-ups

8.6 Managing graphics for WinHelp

8.6.1 Choosing a graphics format for WinHelp

8.6.2 Avoiding the GDI resource leak

8.6.3 Positioning graphics in WinHelp

8.6.4 Displaying graphics in pop-ups for WinHelp

8.7 Converting generated files for WinHelp

8.7.1 Converting lists of paragraph references

8.7.2 Converting indexes and lists of marker references

8.8 Configuring WinHelp topics

8.8.1 Creating WinHelp topics

8.8.2 Assigning properties to formats for topics and hotspots

8.8.3 Configuring topic titles for WinHelp

8.9 Creating jumps and pop-ups for WinHelp

8.9.1 Identifying WinHelp jump destinations with FileIDs

8.9.2 Configuring pop-up topics

8.9.3 Creating hotspots for jumps and pop-ups in WinHelp

8.9.4 Using cross references for jumps and pop-ups

8.9.5 Using hypertext links for jumps and pop-ups

8.9.6 Disallowing hypertext links for jumps and pop-ups

8.9.7 Specifying jumps to secondary windows in WinHelp

8.9.8 Specifying jumps to external files

8.9.9 Using the same content for both normal topics and pop-ups

8.9.10 Creating a glossary pop-up: an example

8.9.11 Configuring alternative jumps and pop-ups

8.9.12 Specifying the scope of alternative jumps and pop-ups

8.10 Invoking WinHelp macros

8.10.1 Using a hypertext marker to invoke a macro

8.10.2 Assigning a hotspot property to invoke a macro

8.11 Creating related-topic links in WinHelp

8.11.1 Understanding KLink limitations

8.11.2 Adding ALinks and KLinks with markers

8.11.3 Adding related-topic keywords with formats

8.11.4 Inserting WinHelp macros for ALink jumps

8.12 Configuring index entries for WinHelp

8.12.1 Designating index level separators

8.12.2 Eliminating duplicate keywords

8.12.3 Keeping or discarding “See also” entries

8.12.4 Using FrameMaker Index markers

8.13 Configuring contents for WinHelp

8.13.1 Naming and configuring Help files and titles

8.13.2 Specifying heading formats and levels for contents

8.13.3 Assembling WinHelp contents from the command line

8.14 Creating browse sequences

8.14.1 Setting up an automatic browse sequence

8.14.2 Specifying browse numbers

8.14.3 Setting up multi-file browse sequences

8.14.4 Setting up branching browse sequences

9 Generating Microsoft HTML Help

9.1 Understanding how Mif2Go produces HTML Help

9.2 Understanding why Unicode is not the answer

9.3 Setting up an HTML Help project

9.3.1 Creating an HTML Help project

9.3.2 Choosing set-up options for an MS HTML Help project

9.3.3 Deciding where to locate configuration settings

9.3.4 Organizing source files for HTML Help

9.3.5 Specifying a project title for HTML Help

9.3.6 Deciding whether to compile HTML Help

9.3.7 Naming project and compiled files for HTML Help

9.3.8 Specifying a starting topic file for HTML Help

9.3.9 Regenerating the HTML Help project file

9.3.10 Locating graphics files for HTML Help

9.4 Customizing HTML Help display features

9.4.1 Using CSS and font tags with HTML Help

9.4.2 Eliminating graphic and table indents from HTML Help

9.4.3 Adding tabs and toolbar buttons to HTML Help

9.4.4 Adding expandable sections to HTML Help

9.5 Creating pop-ups for HTML Help

9.5.1 Using HTML Help for pop-ups

9.5.2 Using KeyHelp for pop-ups

9.5.3 Using WinHelp for pop-ups

9.6 Creating links and hypertext jumps in HTML Help

9.6.1 Creating hypertext jumps to other CHM files

9.6.2 Specifying href link syntax for HTML Help

9.6.3 Linking to external files from compiled HTML Help

9.7 Creating related-topic links for HTML Help

9.7.1 Adding ALink keywords for HTML Help

9.7.2 Adding ALink and KLink jumps for HTML Help

9.7.3 Configuring ALink and KLink jumps for HTML Help

9.7.4 Rolling your own macros for ALink jumps in HTML Help

9.7.5 Using the same format or marker for ALink keywords and jumps

9.7.6 Creating buttons for other types of related-topic links

9.8 Using secondary windows in HTML Help

9.8.1 Defining secondary windows for HTML Help

9.8.2 Jumping from a topic to a secondary window

9.8.3 Jumping from contents or index to a secondary window

9.9 Generating contents and index for HTML Help

9.9.1 Choosing how to generate HTML Help contents and index

9.9.2 Choosing whether to generate binary contents or index

9.9.3 Generating contents and index with HTML Help Workshop

9.9.4 Generating contents and index with Mif2Go

9.9.5 Configuring contents entries for HTML Help

9.9.6 Providing mid-topic contents links in HTML Help

9.9.7 Making the TOC track index links in HTML Help

9.9.8 Customizing contents and index for HTML Help

9.10 Converting generated files for HTML Help

9.10.1 Converting lists of paragraph references

9.10.2 Converting lists of marker references

9.11 Providing full-text search (FTS) for HTML Help

9.12 Setting up CSH for HTML Help

9.12.1 Inserting CSH destinations in your document

9.12.2 Determining whether you need map and alias files

9.12.3 Specifying and generating a map file for CSH links

9.12.4 Creating an alias file for CSH links

9.12.5 Understanding alias-file entries

9.12.6 Producing a list of aliases and associated topic titles

9.13 Generating HTML Help in non-Western languages

9.13.1 Converting from Unicode to Windows code pages

9.13.2 Specifying locale and language for HTML Help

9.13.3 Preventing inclusion of Unicode numeric references

9.13.4 Coping with FrameMaker index-entry conversion defects

9.14 Compiling and testing HTML Help

9.14.1 Directing Mif2Go to run the HTML Help compiler

9.14.2 Copying output files and compiling later

9.14.3 Compiling in a different language

9.14.4 Testing HTML Help generation

9.14.5 Registering your HTML Help system for network use

9.15 Mapping and merging CHM files

9.15.1 Interlinking multiple CHM files

9.15.2 Synchronizing TOC references to slave CHM files

9.15.3 Putting up with a binary index for merged CHM files

9.15.4 Merging CHM files

9.15.5 Comparing HHW settings for stand-alone vs. merged CHMs

10 Generating OmniHelp

10.1 Understanding how OmniHelp works

10.2 Setting up OmniHelp viewer control files

10.2.1 Choosing XHTML vs. HTML OmniHelp control files

10.2.2 Making OmniHelp viewer control files available

10.2.3 Customizing OmniHelp viewer control files

10.2.4 Examining generated control and data files

10.3 Setting up an OmniHelp project

10.3.1 Creating an OmniHelp project

10.3.2 Choosing set-up options for an OmniHelp project

10.3.3 Deciding where to locate configuration settings

10.3.4 Naming your OmniHelp project

10.3.5 Giving your OmniHelp project a title

10.3.6 Specifying the starting topic

10.3.7 Specifying memory requirements

10.3.8 Removing paths from interfile links for OmniHelp

10.3.9 Getting OmniHelp supporting files in the right place

10.4 Using CSS with OmniHelp

10.4.1 Specifying CSS for topics in OmniHelp

10.4.2 Understanding how CSS works in OmniHelp topics

10.4.3 Specifying CSS for OmniHelp navigation frames

10.5 Customizing OmniHelp display features

10.5.1 Configuring OmniHelp window usage and frameset dimensions

10.5.2 Altering OmniHelp top navigation frame content

10.5.3 Modifying OmniHelp navigation aids

10.5.4 Choosing whether to use cookies for OmniHelp

10.5.5 Localizing the OmniHelp interface

10.5.6 Modifying OmniHelp CSS classes

10.5.7 Modifying the OmniHelp template

10.6 Choosing navigation features for OmniHelp

10.7 Configuring contents and index for OmniHelp

10.7.1 Understanding OmniHelp contents and index creation

10.7.2 Choosing whether to use expanding contents or index

10.7.3 Choosing how far to expand contents and index subentries

10.7.4 Providing alternate expansion icons for contents or index

10.7.5 Excluding Open All and Close All buttons

10.7.6 Redirecting See and See also index entries

10.8 Providing related-topic links in OmniHelp

10.9 Jumping to secondary windows in OmniHelp

10.10 Configuring full-text search for OmniHelp

10.10.1 Understanding how OmniHelp FTS works

10.10.2 Generating search data

10.10.3 Making compound terms searchable

10.10.4 Supporting search for non-ANSI text

10.10.5 Specifying length of search terms

10.10.6 Excluding search terms

10.10.7 Excluding content from being searched

10.10.8 Using regular expressions in search

10.10.9 Highlighting search terms found in topics

10.11 Setting up CSH for OmniHelp

10.11.1 Specifying alias prefixes for OmniHelp CSH calls

10.11.2 Referencing OmniHelp topic IDs from an application

10.11.3 Using redirect pages for OmniHelp CSH calls

10.11.4 Executing browser commands for OmniHelp CSH calls

10.12 Merging OmniHelp projects

10.12.1 Understanding the OmniHelp merge process

10.12.2 Listing and mapping OmniHelp subprojects

10.12.3 Providing TOC placeholders for OmniHelp subprojects

10.12.4 Deciding when to merge OmniHelp subprojects

10.13 Assembling OmniHelp files for viewing

10.14 Deploying OmniHelp

10.14.1 Starting with the default topic or a specified topic

10.14.2 Restarting where you left off

10.14.3 Coping with browser quirks

11 Generating JavaHelp or Oracle Help

11.1 Deciding which Java Help system to use

11.2 Obtaining tools for a Java-based Help system

11.3 Setting up a JavaHelp or Oracle Help project

11.3.1 Creating a JavaHelp or Oracle Help for Java project

11.3.2 Choosing set-up options for a JavaHelp or Oracle Help project

11.3.3 Deciding where to locate configuration settings

11.3.4 Specifying output options for JavaHelp

11.3.5 Establishing a JavaHelp environment

11.3.6 Establishing an Oracle Help environment

11.3.7 Creating a directory structure for JavaHelp / Oracle Help

11.3.8 Configuring the helpset file

11.3.9 Coping with JavaHelp / Oracle Help viewer limitations

11.3.10 Compiling JavaHelp with Helen

11.4 Generating contents and index

11.4.1 Configuring contents entries for JavaHelp or Oracle Help

11.4.2 Assigning TOC images and expansion levels in JavaHelp 2

11.4.3 Configuring index entries for JavaHelp or Oracle Help

11.4.4 Eliminating index-marker artifacts from text

11.4.5 Locating JavaHelp or Oracle Help contents and index files

11.5 Providing full-text search for JavaHelp / Oracle Help

11.5.1 Including a search-index link in the helpset file

11.5.2 Creating a search index for JavaHelp

11.5.3 Creating a search index for Oracle Help

11.6 Creating and viewing a Java Archive (JAR) file

11.6.1 Creating a JAR file

11.6.2 Viewing a JAR file

11.7 Converting a glossary to JavaHelp 2

11.7.1 Evaluating glossary usability

11.7.2 Assigning glossary properties

11.7.3 Configuring glossary IDs

11.7.4 Eliminating glossary entries from the JavaHelp TOC

11.8 Defining windows for JavaHelp or Oracle Help

11.8.1 Specifying window parameters for JavaHelp 2

11.8.2 Specifying window parameters for Oracle Help

11.8.3 Jumping to secondary windows in JavaHelp or Oracle Help

11.9 Linking to destinations within topics

11.10 Creating ALinks for Oracle Help

11.11 Merging JavaHelp or Oracle Help systems

11.12 Setting up CSH for JavaHelp or Oracle Help

12 Generating Eclipse Help

12.1 Understanding how Eclipse Help works

12.2 Setting up an Eclipse Help project

12.2.1 Creating an Eclipse Help project

12.2.2 Choosing set-up options for an Eclipse Help project

12.2.3 Deciding where to locate configuration settings

12.2.4 Specifying Eclipse Help output options

12.2.5 Making sure links work in Eclipse Help

12.2.6 Disabling breadcrumb trails in Eclipse Help

12.3 Configuring Eclipse Help manifest files

12.3.1 Specifying a Java manifest file for Eclipse Help

12.3.2 Specifying Eclipse Help plug-in properties

12.3.3 Configuring the Java manifest file for Eclipse Help

12.3.4 Configuring the plug-in manifest file for Eclipse Help

12.4 Configuring contents and index for Eclipse Help

12.4.1 Choosing contents and index methods for Eclipse Help

12.4.2 Supplying path information for contents and index links

12.4.3 Encoding special characters for contents and index entries

12.4.4 Configuring contents properties for Eclipse Help

12.4.5 Configuring index properties for Eclipse Help

12.5 Configuring search properties for Eclipse Help

12.6 Merging Eclipse Help projects

12.6.1 Linking primary content to secondary TOCs

12.6.2 Linking secondary TOCs to primary content (deprecated)

12.7 Setting up CSH for Eclipse Help

12.7.1 Understanding how Mif2Go generates context links

12.7.2 Naming context file and attribute for secondary plug-ins

12.7.3 Configuring context IDs and context anchors

12.7.4 Configuring context descriptions

12.7.5 Locating context information

12.8 Packaging Eclipse Help files

12.8.1 Specifying a ZIP command for

12.8.2 Specifying ZIP command parameters

12.8.3 Specifying a JAR command for doc.jar

12.8.4 Monitoring the packaging step for errors

12.8.5 Archiving Eclipse Help files

13 Converting to HTML/XHTML

13.1 Deciding which type of output to produce

13.2 Setting up an HTML project

13.2.1 Creating an HTML or XHTML project

13.2.2 Choosing set-up options for an HTML or XHTML project

13.2.3 Preparing a document for conversion to HTML or XHTML

13.2.4 Specifying a different output file extension

13.2.5 Checking automatic settings for HTML or XML split files

13.2.6 Establishing a conversion workflow for HTML

13.2.7 Checking HTML output files for broken links

13.2.8 Checking HTML or XML output files for Mif2Go version

13.2.9 Using XHTML tagging rules for HTML

13.3 Including starting code and entity references

13.4 Supplying values for the <head> element

13.4.1 Specifying HTML/XML version, DOCTYPE, and DTD

13.4.2 Specifying namespace and language

13.4.3 Specifying character encoding for HTML

13.4.4 Including or omitting HTML/XML generator information

13.4.5 Specifying page titles for HTML output files

13.4.6 Supplying content for the <meta> tag

13.4.7 Specifying nonstandard values for declarations

13.5 Specifying HTML <body> attributes

13.6 Specifying document-wide properties for HTML

13.6.1 Specifying a default DPI setting

13.6.2 Converting system variables to text for HTML

13.6.3 Suppressing closing </p> tags for HTML

13.6.4 Suppressing line breaks in HTML and XML output

13.6.5 Preventing adjacent <pre> elements from merging

13.7 Defining and mapping colors for HTML

13.7.1 Converting colors

13.7.2 Mapping FrameMaker colors to new values

13.7.3 Defining new colors

13.7.4 Using Web-safe colors

13.7.5 Redefining colors via conversion template

13.7.6 Understanding CMYK-to-RGB conversion anomalies

13.8 Converting generated files for HTML

13.8.1 Converting FrameMaker IX and other marker lists

13.8.2 Converting FrameMaker TOC and other paragraph lists

13.9 Importing HTML files as insets

13.10 Converting conditions to HTML attributes

13.10.1 Understanding how Mif2Go converts conditions

13.10.2 Mapping FrameMaker conditions to HTML attributes

13.10.3 Displaying condition indicators in HTML with CSS

13.11 Providing hover text for terms in HTML

13.12 Generating XHTML for Confluence 4.x

13.13 Exporting content for database input

13.14 Using framesets

13.15 Adding a “Made with Mif2Go” label or button

13.16 Passing W3C validation tests

13.16.1 Understanding limitations of W3C validation

13.16.2 Replacing high ASCII characters for W3C validation

13.16.3 Eliminating <nobr> tags

13.16.4 Removing full-row straddles from tables

13.16.5 Avoiding redundant attribute assignments in tables

13.16.6 Eliminating duplicate ObjectIDs

14 Converting to generic XML

14.1 Understanding how Mif2Go generates XML output

14.1.1 Accommodating HTML features in XML output

14.1.2 Introducing structure with Mif2Go

14.1.3 Introducing structure with XSLT

14.1.4 Creating structure in FrameMaker

14.1.5 Producing SGML with Mif2Go and XSLT

14.2 Setting up a generic XML project

14.3 Specifying generic XML output settings

14.3.1 Creating a generic XML project

14.3.2 Changing output XML version or file extension

14.3.3 Specifying character encoding for generic XML

14.3.4 Specifying the root element and content type

14.3.5 Preventing arbitrary line breaks in XML text elements

14.4 Providing XML tags and structure

14.4.1 Generating XML from an unstructured document

14.4.2 Deriving XML tags from format and class names

14.4.3 Eliminating HTML attributes and tags for generic XML

14.4.4 Including or excluding FrameMaker autonumbers

14.4.5 Configuring forced returns for XML

14.5 Converting FrameMaker lists to generic XML

14.6 Configuring links for generic XML

14.7 Converting graphics for generic XML

14.8 Converting index entries to generic XML

14.8.1 Configuring index markers for conversion to XML

14.8.2 Defining macros to process index content

15 Converting to DITA XML

15.1 Generating DITA XML with Mif2Go

15.1.1 Understanding the complexity of a DITA conversion project

15.1.2 Understanding what you need to know about DITA

15.1.3 Clarifying your purpose for creating DITA output

15.1.4 Converting from structured vs. unstructured FrameMaker

15.1.5 Understanding what information you must supply

15.1.6 Understanding how Mif2Go generates DITA output

15.1.7 Creating valid DITA XML output

15.2 Setting up a DITA XML project

15.2.1 Creating a DITA XML project

15.2.2 Choosing set-up options for a DITA XML project

15.2.3 Specifying DITA output options

15.2.4 Specifying DITA version

15.2.5 Configuring the DITA DTD SYSTEM identifier

15.2.6 Ensuring FrameMaker 8 import compatibility

15.2.7 Substituting document format names for default names

15.3 Specifying general options for DITA

15.4 Configuring DITA elements

15.4.1 Understanding how Mif2Go delimits DITA elements

15.4.2 Treating FrameMaker format names as DITA element names

15.4.3 Mapping paragraph formats to DITA block elements

15.4.4 Mapping character formats to DITA inline elements

15.4.5 Assigning multiple typographic elements to a format

15.4.6 Assigning attributes to DITA elements

15.4.7 Preserving whitespace in block elements

15.4.8 Including PIs for line, column, or page breaks

15.4.9 Providing a <shortdesc> element for a DITA topic

15.4.10 Converting index markers to <indexterm> elements

15.5 Nesting DITA block elements

15.5.1 Understanding how Mif2Go determines element nesting

15.5.2 Designating DITA ancestor elements

15.5.3 Fixing up interpolated ancestries

15.5.4 Deciding when to fully specify ancestry

15.5.5 Specifying alternate ancestries for the same element

15.5.6 Avoiding invalid ancestries

15.5.7 Specifying first-child status for nested elements

15.5.8 Configuring nested lists

15.5.9 Closing DITA ancestor elements

15.5.10 Opening DITA ancestor elements

15.5.11 Configuring multi-paragraph list items

15.5.12 Splitting a paragraph into separate DITA elements

15.5.13 Specifying DITA element levels

15.6 Converting tables to DITA XML

15.6.1 Working with Mif2Go DITA table types

15.6.2 Marking table footer rows for future reference

15.6.3 Designating ancestors for <table> elements

15.6.4 Applying attributes to DITA tables

15.6.5 Configuring DITA table components

15.6.6 Converting tables used only as image containers

15.6.7 Omitting table coding entirely

15.7 Specifying options for images in DITA XML

15.7.1 Designating ancestors for <image> and <fig> elements

15.7.2 Specifying what to include in a <fig> wrapper

15.7.3 Omitting size attributes from images for DITA output

15.7.4 Providing alternate text for images

15.7.5 Including MathFullForm equations in <alt> elements

15.7.6 Including the original image DPI as an attribute

15.7.7 Understanding why images might look incorrectly scaled

15.8 Organizing DITA topics

15.8.1 Understanding when to split, nest, or wrap DITA topics

15.8.2 Splitting FrameMaker files into DITA topic files

15.8.3 Renaming DITA topic files

15.8.4 Nesting DITA topics in unsplit files

15.8.5 Wrapping DITA topics in a top-level <dita> element

15.9 Configuring DITA topics

15.9.1 Designating starting points for DITA topics

15.9.2 Specifying the DITA topic type

15.9.3 Specifying the ID for a DITA topic

15.9.4 Adjusting DITA topic IDs generated from file names

15.9.5 Specifying alternate titles for a DITA topic

15.9.6 Omitting a DITA topic from the TOC

15.10 Configuring cross references and links for DITA

15.10.1 Understanding how Mif2Go converts cross references

15.10.2 Specifying an outputclass for cross-reference wrappers

15.10.3 Linking to elements below topic level

15.10.4 Retaining cross-reference content in <xref> elements

15.10.5 Omitting <xref> elements from footnotes

15.10.6 Overriding <xref> attribute values

15.11 Exporting FrameMaker variables to DITA XML

15.11.1 Understanding how Mif2Go represents variables in DITA

15.11.2 Specifying how to treat FrameMaker variables

15.11.3 Treating FrameMaker variables as conrefs

15.11.4 Retaining format properties of user variables in DITA

15.12 Converting conditions to DITA attributes

15.12.1 Understanding how Mif2Go converts conditional text

15.12.2 Mapping FrameMaker conditions to element attributes

15.12.3 Disallowing condition conversion for selected elements

15.13 Marking FrameMaker text insets in DITA

15.14 Including CSH targets in DITA XML

15.15 Overriding DITA settings with markers

16 Configuring DITA maps

16.1 Understanding how Mif2Go generates DITA maps

16.2 Configuring DITA ditamaps

16.2.1 Specifying options for ditamaps

16.2.2 Specifying topic levels in ditamaps

16.2.3 Accounting for missing topic levels

16.2.4 Specifying roles for topics in ditamaps

16.2.5 Adding relationship tables to ditamaps

16.2.6 Providing navigation aids in ditamaps

16.3 Constructing a DITA bookmap

16.3.1 Specifying the type of map for a book

16.3.2 Specifying <booktitle> information

16.3.3 Specifying <bookmeta> information

16.3.4 Extending <part> to include <appendix>

16.3.5 Choosing whether a bookmap references maps or topics

16.3.6 Excluding the book-level reltable from a bookmap

16.4 Mapping FrameMaker files to bookmap components

16.4.1 Assigning bookmap roles to FrameMaker files

16.4.2 Assigning frontmatter and backmatter roles and components

16.4.3 Including multiple booklist components of the same type

16.4.4 Assigning a divider role to a section file or chapter

16.4.5 Assigning a series of roles to a single FrameMaker file

16.4.6 Assigning a single role to a series of FrameMaker files

16.4.7 Including placeholders for additional bookmap elements

16.5 Providing attributes for bookmap wrapper elements

16.6 Overriding DITA map settings with markers

17 Converting to DocBook XML

17.1 Generating DocBook XML with Mif2Go

17.1.1 Understanding what you need to know about DocBook

17.1.2 Clarifying your purpose for creating DocBook output

17.1.3 Understanding what information you must supply

17.2 Setting up a DocBook XML project

17.2.1 Creating a DocBook project

17.2.2 Choosing set-up options for a DocBook project

17.2.3 Specifying DocBook output options

17.3 Specifying general options for DocBook

17.3.1 Configuring styles for DocBook XML

17.3.2 Configuring entity information for DocBook XML

17.3.3 Configuring links for DocBook XML

17.3.4 Configuring tables for DocBook XML

17.3.5 Retaining empty paragraph tags in DocBook table cells

17.3.6 Configuring footnotes for DocBook XML

17.4 Configuring DocBook elements

17.4.1 Treating FrameMaker format names as element names

17.4.2 Mapping paragraph formats to DocBook elements

17.4.3 Mapping character formats to DocBook elements

17.4.4 Assigning ID attributes to DocBook block elements

17.4.5 Assigning attributes other than ID to DocBook elements

17.5 Nesting DocBook block elements

17.5.1 Understanding how Mif2Go determines element nesting

17.5.2 Designating DocBook ancestor elements

17.5.3 Fixing up interpolated ancestries

17.5.4 Deciding when to fully specify ancestry

17.5.5 Specifying alternate ancestries for the same element

17.5.6 Specifying first-child status for nested elements

17.5.7 Specifying full ancestry for nested sections

17.5.8 Closing DocBook ancestor elements

17.5.9 Opening DocBook ancestor elements

17.5.10 Configuring multi-paragraph list items

17.5.11 Specifying DocBook element levels

17.6 Designating ancestors for table elements

17.7 Specifying options for figure elements

17.7.1 Deciding what to include in a figure element

17.7.2 Specifying ancestry for figure elements

17.7.3 Omitting size attributes from images for DocBook

17.8 Overriding DocBook settings with markers

18 Splitting and extracting files

18.1 Splitting versus extracting

18.2 Splitting files

18.2.1 Designating split points

18.2.2 Managing split points

18.2.3 Combining instead of splitting files

18.3 Extracting files

18.3.1 Enabling and disabling extract processing

18.3.2 Delimiting material to extract

18.4 Identifying split and extract files

18.4.1 Understanding how split and extract files are named

18.4.2 Specifying page titles for split or extract files

18.4.3 Supplying <meta> text for split or extract files

18.5 Inserting HTML code in split and extract files

18.5.1 Choosing how to insert code in extracts

18.5.2 Assigning code to [Inserts] keywords for splits and extracts

18.5.3 Using special sections to insert code in extracts

18.6 Referencing split and extract files

18.7 Customizing and replacing extracts

18.7.1 Using markers for extract processing

18.7.2 Customizing title text for extracts

18.7.3 Replacing extracts with links in the parent file

18.7.4 Specifying extracts: an example

19 Creating HTML links

19.1 Understanding sources of links

19.2 Specifying link appearance

19.2.1 Specifying link colors

19.2.2 Specifying link class

19.2.3 Assigning link attributes with markers

19.2.4 Specifying link properties with macros

19.2.5 Replacing problem characters in links

19.2.6 Forcing link text to lowercase

19.3 Specifying link destination

19.3.1 Forcing links to top-of-page for selected paragraph formats

19.3.2 Forcing all links to top-of-page

19.3.3 Linking to an arbitrary location

19.3.4 Providing alternate link destinations

19.3.5 Troubleshooting bad links

19.4 Creating jumps to particular windows for HTML

19.5 Converting FrameMaker links to HTML

19.5.1 Converting FrameMaker cross references to HTML

19.5.2 Converting FrameMaker hypertext links to HTML

19.5.3 Including ObjectID anchors as link targets

19.6 Linking to other files and other Mif2Go projects

19.6.1 Identifying HTML link destinations with FileIDs

19.6.2 Retaining file paths in interfile links

19.6.3 Enabling links to renamed or relocated files

19.6.4 Enabling links to files in other projects

19.6.5 Updating links between files in different projects

19.6.6 Mapping links to text insets

19.7 Linking to external destinations

20 Providing navigation in HTML

20.1 Understanding how navigation links work

20.2 Generating trails of links

20.2.1 Understanding trails of links

20.2.2 Specifying whether to include trails of links

20.2.3 Specifying what to include in trails of links

20.2.4 Specifying heading levels for trails of links

20.2.5 Specifying where to display trails of links

20.3 Including local TOCs

20.3.1 Directing Mif2Go to generate local TOCs

20.3.2 Configuring local TOCs

20.3.3 Positioning local TOCs in HTML topics

20.3.4 Creating local TOCs in FrameMaker

20.4 Creating a browse sequence

20.4.1 Understanding how browse macros work

20.4.2 Choosing buttons versus text links for a browse sequence

20.4.3 Formatting browse-link labels

20.4.4 Modifying macros <$_prev>, <$_next>, and <$_top>

20.4.5 Understanding browse keyword scope and default values

20.4.6 Specifying where to invoke a browse macro

20.4.7 Considering an example of browse navigation

20.4.8 Specifying an alternate file sequence for browse links

21 Mapping text formats to HTML/XML

21.1 Understanding how Mif2Go converts text

21.2 Choosing how to map formats

21.3 Mapping paragraph formats

21.3.1 Assigning HTML tags and attributes to paragraph formats

21.3.2 Converting sidehead and run-in paragraph formats

21.3.3 Converting paragraph formats with autonumbers

21.3.4 Including text-frame content in line

21.3.5 Designating script paragraph formats

21.3.6 Stripping paragraph properties

21.3.7 Keeping or removing reference frames

21.3.8 Deciding how to treat forced returns

21.3.9 Providing content for empty paragraphs

21.3.10 Eliminating empty paragraphs in text

21.3.11 Eliminating invisible paragraphs

21.3.12 Eliminating unwanted paragraphs

21.4 Mapping character formats

21.5 Assigning properties to text formats

21.5.1 Understanding where to specify format property overrides

21.5.2 Overriding paragraph alignment and size properties

21.5.3 Overriding properties added by typographic elements

21.5.4 Overriding properties specified in font tags

21.6 Mapping special characters

21.6.1 Understanding how Mif2Go represents characters

21.6.2 Understanding how Mif2Go treats tabs in HTML/XML

21.6.3 Understanding Mif2Go support for FrameMaker 8+ Unicode

21.6.4 Converting Western European accented characters

21.6.5 Mapping individual special characters

21.6.6 Mapping characters in a special font

21.6.7 Avoiding use of special characters in URIs

21.6.8 Preventing character mapping

21.7 Mapping fonts

21.7.1 Specifying a default font and size

21.7.2 Remapping fonts

21.7.3 Mapping font sizes

21.7.4 Including or excluding font tags

21.7.5 Managing font tags for symbol fonts

21.7.6 Excluding face and size attributes from font tags

21.7.7 Accommodating browser font-rendering differences

21.8 Managing typographic elements for HTML or XML

21.8.1 Deciding whether to suppress typographic elements

21.8.2 Choosing how to treat typographic elements

21.9 Specifying text colors for HTML

21.10 Configuring preformatted text for HTML/XML

21.10.1 Eliminating line wraps in preformatted text

21.10.2 Replacing tabs with spaces in preformatted text

21.11 Converting footnotes to HTML or XML

21.11.1 Configuring and placing footnotes

21.11.2 Eliminating links to jump footnotes

21.11.3 Using list tags or <div> and <p> tags for jump footnotes

21.11.4 Formatting jump footnote text with macros

21.12 Converting list formats to HTML

21.12.1 Understanding the problem with HTML lists

21.12.2 Converting list formats to HTML list styles

21.12.3 Indenting list items

21.12.4 Converting list formats to HTML/XML paragraphs

22 Setting up CSS for HTML

22.1 Deciding whether to use CSS

22.2 Understanding how to use CSS

22.3 Understanding how Mif2Go generates CSS

22.4 Specifying CSS file and link options

22.4.1 Specifying CSS options at project set-up time

22.4.2 Specifying CSS options in a Mif2Go configuration file

22.4.3 Designating and locating a CSS file

22.4.4 Directing Mif2Go to generate a CSS file

22.4.5 Understanding effects of the older Stylesheet setting

22.5 Understanding how CSS affects other options

22.6 Linking to alternate CSS files

22.6.1 Selecting a CSS file at run time

22.6.2 Changing CSS files in the middle of a document

22.6.3 Customizing the CSS link tag

22.6.4 Using an alternate CSS link tag for Netscape 4

22.7 Assigning CSS classes

22.7.1 Understanding CSS class name restrictions

22.7.2 Mapping paragraph formats to CSS classes

22.7.3 Mapping character formats to tags or span classes

22.7.4 Assigning CSS classes to table formats

22.7.5 Assigning CSS classes to text and table footnotes

22.7.6 Assigning CSS classes based on Unicode character ranges

22.7.7 Assigning CSS classes to FrameMaker conditions

22.7.8 Using link format names as CSS class names

22.7.9 Using CSS class names as tags for XML

22.7.10 Omitting tags from CSS selectors

22.7.11 Overriding CSS class for selected paragraphs

22.8 Customizing CSS properties

22.8.1 Assigning a CSS generic font family

22.8.2 Specifying CSS <body> tag properties

22.8.3 Specifying CSS size values and units of measurement

22.8.4 Overriding styles in Mif2Go-generated CSS files

22.8.5 Adjusting leading (line spacing) in CSS

22.8.6 Preventing <font> tags from overriding CSS properties

23 Including graphics in HTML

23.1 Starting with default graphics options

23.2 Understanding graphics processing for HTML

23.3 Locating graphics files for HTML

23.4 Specifying options for HTML graphics

23.4.1 Using referenced graphics without converting

23.4.2 Specifying formats of replacement graphics

23.4.3 Choosing a graphics conversion method

23.4.4 Using referenced, embedded, and compound graphics

23.4.5 Omitting graphics from HTML or XML output

23.5 Selecting and modifying graphics

23.5.1 Assigning properties to sets of graphics

23.5.2 Replacing or surrounding a graphic with macro code

23.5.3 Converting only the visible portion of a graphic

23.5.4 Converting reference-page graphics for HTML

23.5.5 Eliminating graphics in unanchored frames

23.5.6 Omitting paragraph tags around graphics

23.5.7 Retaining run-in images in otherwise empty paragraphs

23.6 Positioning graphics in HTML output

23.6.1 Positioning graphics anchored in empty paragraphs

23.6.2 Aligning anchored graphics

23.6.3 Indenting images

23.6.4 Adding space above an image

23.6.5 Eliminating space above or below graphics in table cells

23.7 Specifying HTML image attributes

23.8 Providing (or omitting) alternate text for images

23.9 Scaling images for HTML

23.9.1 Excluding image size attributes from HTML

23.9.2 Adjusting image size for selected graphics

23.9.3 Adjusting image resolution for referenced graphics

23.9.4 Specifying image resolution for exported graphics

23.9.5 Specifying px units for graphics sized in pixels

23.10 Creating image maps for HTML

23.10.1 Creating hotspots for image maps

23.10.2 Providing alternate text for a hotspot in an image map

23.10.3 Specifying jumps from image maps in framesets

23.11 Supplying a background image or watermark

23.12 Converting equations for HTML

24 Converting tables to HTML

24.1 Assigning properties to tables

24.1.1 Understanding which table features can be converted

24.1.2 Understanding precedence of assignment methods

24.1.3 Overriding default table and cell properties and attributes

24.2 Defining sets of tables

24.2.1 Determining the TableID

24.2.2 Creating table groups

24.2.3 Using wildcards to specify table sets

24.3 Specifying table structure

24.3.1 Choosing the table structure model

24.3.2 Identifying row and column groups and header cells

24.3.3 Identifying table headers and footers

24.4 Specifying table attributes

24.4.1 Specifying attributes for all tables

24.4.2 Overriding attributes for selected tables

24.4.3 Assigning a CSS class to a table

24.4.4 Using markers to assign attributes to tables, rows, or cells

24.4.5 Specifying attributes for table rows

24.4.6 Specifying attributes for table cells

24.4.7 Eliminating automatically generated attributes

24.4.8 Adjusting borders, cell spacing, and cell padding

24.4.9 Determining the width of table columns

24.4.10 Deciding what to do with empty paragraphs in table cells

24.4.11 Using shading and color in tables

24.5 Positioning tables, table titles, and table footnotes

24.5.1 Indenting tables

24.5.2 Configuring and positioning table titles

24.5.3 Eliminating FrameMaker table title variables

24.5.4 Positioning table footnotes

24.6 Using macros to control table properties

24.6.1 Invoking macros around tables

24.6.2 Adding space before tables

24.6.3 Adjusting space after tables

24.6.4 Turning processing on and off around selected tables

24.6.5 Specifying row-group, row, and cell attributes with macros

24.6.6 Capturing table row and column counts with variables

24.6.7 Selectively modifying table text with macros: an example

24.7 Converting tables to paragraphs

24.7.1 Removing table-specific tags from all tables

24.7.2 Removing table-specific tags from selected tables

24.7.3 Removing table-specific tags from complex tables

25 Generating WAI markup for HTML

25.1 Comparing Mif2Go markup methods for WAI

25.1.1 Choosing a markup method for WAI attributes

25.1.2 Using paragraph formats for WAI attributes

25.1.3 Creating custom markers for WAI attributes

25.2 Applying WAI markup to images

25.2.1 Following WAI guidelines for images

25.2.2 Assigning WAI image attributes with dedicated formats

25.2.3 Assigning WAI image attributes with custom markers

25.2.4 Assigning WAI image attributes via the Object Attributes dialog

25.3 Applying WAI markup to links

25.3.1 Following WAI guidelines for links

25.3.2 Assigning WAI link attribute values with dedicated formats

25.3.3 Assigning WAI link attribute values with custom markers

25.4 Applying WAI markup to tables

25.4.1 Following WAI guidelines for tables

25.4.2 Choosing a WAI markup method for tables

25.4.3 Providing table summary and title information

25.4.4 Identifying table row and column information

26 Identifying HTML table structure for WAI

26.1 Identifying table rows and columns

26.1.1 Developing a strategy for row and column markup

26.1.2 Comparing scope and id/headers accessibility methods

26.1.3 Specifying a default accessibility method

26.1.4 Overriding the default accessibility method

26.2 Associating table cells with header cells

26.2.1 Specifying group properties for header cells

26.2.2 Using paragraph formats for table-cell attributes

26.2.3 Assigning table-cell attribute values with dedicated formats

26.2.4 Assigning table-cell attribute values with custom markers

27 Marking HTML table cells for WAI

27.1 Understanding table cell settings

27.2 Using the scope method to identify table cells

27.3 Using the id/headers method to identify table cells

27.3.1 Choosing an id/headers level

27.3.2 Specifying id/headers attributes for table cells

27.3.3 Grouping header cells for identification

27.3.4 Column-group and row-group extent

27.3.5 Choosing a different row-group method

27.3.6 Using span attributes to identify rows and columns

27.3.7 Column-span and row-span extent

27.3.8 Identifying individual table cells by row and column

27.3.9 Column and row extent

27.3.10 Using span IDs with row or column IDs

27.4 Overriding default table-cell settings

27.5 Using ColGroup and RowGroup cells

27.5.1 Understanding how the ColGroup property works

27.5.2 Understanding how the RowGroup property works

28 Working with macros

28.1 Defining and invoking macros

28.1.1 Defining macros

28.1.2 Invoking a macro

28.1.3 Nesting macros

28.1.4 Using predefined macros

28.2 Accessing Mif2Go macro libraries

28.2.1 Understanding Mif2Go-supplied macro libraries

28.2.2 Modifying Mif2Go-supplied macro definitions

28.2.3 Storing a macro definition in a separate file

28.2.4 Including macro definitions in your own macro library

28.3 Using macro variables

28.3.1 Creating and invoking macro variables

28.3.2 Assigning values to macro variables

28.3.3 Incrementing and decrementing macro variables

28.3.4 Using predefined macro variables

28.3.5 Treating FrameMaker user variables as macro variables

28.3.6 Using some FrameMaker system variables as macro variables

28.3.7 Creating macro variables from paragraph content

28.4 Using multiple-value list variables

28.4.1 Understanding list-variable syntax

28.4.2 Assigning a value to a list-variable item

28.4.3 Initializing list variables

28.4.4 Using macros to process lists

28.4.5 Using pointers to process lists

28.4.6 Using a list instead of a conditional expression

28.5 Accessing settings with configuration macros

28.5.1 Understanding configuration macros and variables

28.5.2 Determining the value of a configuration variable

28.5.3 Deploying configuration macros

28.6 Using expressions in macros

28.6.1 Understanding macro expressions

28.6.2 Understanding operands and operators

28.6.3 Displaying expression results in output

28.6.4 Using control structures in expressions

28.6.5 Specifying substrings in expressions

28.6.6 Using list variables in expressions

28.6.7 Using indirection in expressions

28.6.8 Removing spaces from strings: an example

28.7 Passing a parameter to a macro

28.8 Debugging macros

28.9 Deploying macros and macro variables

28.9.1 Understanding where to use macros and macro variables

28.9.2 Invoking macros at predetermined points in output

28.9.3 Surrounding or replacing text with code or macros

28.9.4 Converting a dictionary-style list to an HTML table

28.9.5 Assigning macros to graphics or tables for HTML

28.9.6 Redefining navigation macros in HTML

28.9.7 Using HTML Macro markers to invoke macros

28.9.8 Implementing drop-down text with macros

28.10 Using macros to fine-tune HTML or XML output

29 Working with FrameMaker markers

29.1 Using custom FrameMaker markers

29.2 Adding custom marker types

29.2.1 Identifying dedicated custom marker types

29.2.2 Naming new custom marker types

29.2.3 Understanding attribute markers

29.2.4 Using attribute markers for HTML or XML

29.3 Remapping marker types and hypertext commands

29.3.1 Remapping and cloning marker types

29.3.2 Understanding when to remap marker types

29.3.3 Remapping FrameMaker hypertext commands

29.4 Defining and redefining marker behavior

29.4.1 Assigning properties to marker types

29.4.2 Observing restrictions on redefining marker behavior

29.4.3 Understanding examples of marker redefinition

29.5 Suppressing markers

29.6 Using marker property names for marker types

29.7 Inserting code or text with markers

29.7.1 Inserting marker content in output

29.7.2 Surrounding marker content with code

29.7.3 Processing marker content as text for XML/HTML/XHTML

29.7.4 Surrounding attribute markers with code

29.7.5 Converting custom markers to attributes

29.7.6 Including code to be executed before a topic

29.8 Identifying markers with variable <$$_objectid>

30 Working with templates

30.1 Working with configuration templates

30.1.1 Understanding how templates are organized

30.1.2 Understanding how templates are named

30.1.3 Understanding how templates are chained together

30.1.4 Understanding how macro libraries are organized

30.2 Referencing configuration files and templates

30.3 Including document-specific configuration files

30.3.1 Understanding document-specific configuration files

30.3.2 Referencing a document-specific configuration file

30.3.3 Deciding where to keep document-specific configuration files

30.3.4 Indicating the intended scope of a configuration file

30.4 Including chapter-specific configuration files

30.5 Deciding which configuration file to edit

30.5.1 Understanding what configuration files are available

30.5.2 Editing a project configuration file

30.5.3 Editing a document-specific configuration file

30.5.4 Editing an output-specific configuration file

30.5.5 Editing a macro configuration file

30.5.6 Indicating the intended scope of a configuration file

30.6 Creating your own configuration templates

30.6.1 Creating a template from a project configuration file

30.6.2 Deciding what to include in a general configuration template

30.6.3 Chaining configuration templates

30.7 Applying FrameMaker conversion templates

30.7.1 Specifying conversion-template settings

30.7.2 Applying alternate conversion templates

30.7.3 Changing template options

30.7.4 Avoiding template-related disasters

30.7.5 Troubleshooting template import problems

31 Working with graphics

31.1 Choosing an appropriate graphics format

31.1.1 Graphics formats for Word documents

31.1.2 Graphics formats for WinHelp

31.1.3 WMF format limitations

31.1.4 Graphics formats for HTML

31.2 Converting and exporting graphics

31.2.1 Converting bitmap graphics

31.2.2 Converting vector graphics

31.2.3 Exporting and converting embedded graphics

31.2.4 Exporting images and creating files from OLE objects

31.2.5 Converting graphics with FrameMaker export filters

31.2.6 Embedding bitmap graphics in WMF for WinHelp

31.2.7 Exporting embedded graphics imported from Word

31.3 Replacing and relocating graphics files

31.3.1 Changing graphics files for HTML output

31.3.2 Changing graphics files for RTF output

31.4 Specifying custom settings for individual graphics

31.4.1 Overriding graphics settings with custom markers

31.4.2 Overriding graphics settings with FrameMaker object attributes

31.5 Controlling image appearance in RTF output

31.5.1 Rescaling bitmap graphics

31.5.2 Reorienting bitmap graphics

31.5.3 Compressing bitmap graphics

31.5.4 Positioning borders around inline graphics

31.5.5 Mapping FrameMaker pen style patterns

31.5.6 Converting graphic text

31.5.7 Specifying transparency for WinHelp 4

31.6 Converting graphics with Microsoft Word filters

32 Working with content models

32.1 Understanding Mif2Go content models

32.2 Modifying or replacing a content model

32.2.1 Obtaining a copy of a built-in content-model

32.2.2 Generating a content model from a DTD

32.3 Preparing a content model for use with Mif2Go

32.4 Understanding content-model configurations

32.4.1 Content model [Topic] settings

32.4.2 Content model [ElementSets] settings

32.4.3 Content model [TopicParents] settings

32.4.4 Content model [TopicFirst] settings

32.4.5 Content model [TopicLevels] settings

32.5 Understanding how Mif2Go uses content models

32.6 Inspecting and correcting element types

32.7 Specializing or modifying DITA topic types

32.7.1 Creating a content model for a specialized topic type

32.7.2 Overriding settings in a DITA content model

32.7.3 Eliminating elements from a DITA content model

32.7.4 Overriding declarations in a DITA map content model

32.7.5 Listing DITA topic type configuration files

32.7.6 Locating DITA topic type configuration files

32.7.7 Providing table structure information for DITA topic types

32.8 Extracting content-model debug information

33 Overriding configuration settings

33.1 Using a different configuration for selected files

33.1.1 Providing configuration files for individual chapters

33.1.2 Understanding precedence of configuration settings

33.1.3 Updating a single chapter of a FrameMaker book

33.2 Overriding settings with markers or macros

33.2.1 Determining the extent of a configuration override

33.2.2 Overriding settings with configuration markers

33.2.3 Overriding settings with macros

33.2.4 Assigning values to configuration variables

33.2.5 Adding a new configuration setting on the fly

33.2.6 Assigning a macro or variable to a configuration variable

33.2.7 Understanding fixed-key vs. variable-key settings

33.2.8 Overriding fixed-key configuration settings

33.2.9 Overriding variable-key configuration settings

33.2.10 Assigning HTML table and graphic groups with overrides

33.3 Overriding configuration settings with text

34 Automating Mif2Go conversions

34.1 Preparing documents for single-sourcing

34.1.1 Using character formats to identify Help elements

34.1.2 Using markers to add links and instructions

34.1.3 Using conditional text to differentiate output

34.1.4 Importing formats and conditional text settings

34.2 Converting a single chapter of a book

34.3 Considering ways to automate conversions

34.4 Executing operating-system commands

34.4.1 Specifying system commands

34.4.2 Including macros and variables in system commands

34.4.3 Monitoring system command execution

34.4.4 Changing configuration settings with system commands

34.4.5 Supplying system commands in a .bat file

34.4.6 Supplying system commands in a macro

34.5 Supplying run-time values for user variables

34.5.1 Assigning an initial value to a user variable

34.5.2 Assigning a prompt to a user variable

34.5.3 Deciding how often to prompt for values of user variables

34.5.4 Understanding when Mif2Go prompts for user variables

34.5.5 Inspecting and editing values of user variables

34.6 Supporting document review in Word

34.7 Converting autonumbers for database systems

34.8 Renaming output files for automated systems

34.8.1 Understanding which files can be renamed

34.8.2 Renaming individual output files

34.8.3 Using custom markers to name output files

34.8.4 Using paragraph formats to name output files

34.8.5 Including identifiers and sequence numbers in file names

35 Producing deliverable results

35.1 Understanding Mif2Go pre- and post-processing

35.2 Activating and logging production of deliverables

35.3 Understanding path values for deliverables

35.4 Clearing out old files before converting

35.4.1 Specifying when to delete old files from the project directory

35.4.2 Specifying which files to delete from the project directory

35.4.3 Understanding when not to delete .ref and .htm files

35.4.4 Deleting MIF files from the project directory

35.5 Gathering additional files before converting

35.6 Assembling files for distribution

35.6.1 Specifying a wrap directory

35.6.2 Emptying the wrap directory before copying

35.6.3 Listing files to copy to the wrap directory

35.6.4 Understanding when to use other file copy settings

35.6.5 Understanding which files are copied from where

35.6.6 Listing extracurricular files to put in the wrap directory

35.7 Placing graphics files for distribution

35.7.1 Copying referenced graphics to a distribution directory

35.7.2 Selecting graphics to copy from arbitrary locations

35.7.3 Deleting prior contents of the graphics destination directory

35.7.4 Synchronizing graphics settings for HTML output

35.7.5 Synchronizing graphics settings for RTF output

35.8 Placing CSS or XSL files for assembly

35.9 Gathering files for an HTML project: an example

35.10 Gathering and processing Help-system files

35.11 Archiving deliverables

35.11.1 Specifying an archiving command

35.11.2 Supplying parameters for the archiving command

35.11.3 Specifying archive file name and optional version

35.12 Placing deliverables in a shipping directory

35.12.1 Specifying a shipping directory for deliverables

35.12.2 Understanding which files are placed in the shipping directory

35.12.3 Choosing whether to copy or move deliverables

35.13 Postprocessing separately from converting

36 Converting via runfm

36.1 Designing a project for unattended operation

36.2 Setting up FrameMaker for unattended operation

36.3 Understanding runfm command-line syntax

36.4 Using runfm for Mif2Go conversions

36.4.1 Locating FrameMaker executable and files

36.4.2 Identifying your Mif2Go project

36.4.3 Configuring runfm output

36.4.4 Closing FrameMaker files after conversion

36.5 Troubleshooting runfm processes

36.5.1 Increasing console diagnostics: runfm -diag option

36.5.2 Capturing console diagnostics: runfm -log option

36.5.3 Reviewing FrameMaker console messages after runfm

36.5.4 Troubleshooting failed runfm processes

36.5.5 Running a single Mif2Go conversion or print job

36.5.6 Running a series of Mif2Go conversions

36.5.7 Including runfm in a multi-step or scheduled process

36.6 Comparing runfm with the DCL command-line filter

36.7 Operating runfm across a network

36.8 Using runfm for other FrameMaker plug-ins

37 Converting via DCL

37.1 How the DCL filter works

37.2 Using the DCL filter

37.2.1 Understanding where to run DCL

37.2.2 Preparing for conversion

37.2.3 Converting a single MIF or DCL file

37.2.4 Converting a group of MIF or DCL files

37.2.5 Merging ancillary Help files with DCL

37.3 DCL command-line syntax

37.3.1 Command-line switch -f format

37.3.2 Command-line switch -o output

37.3.3 Command-line argument input ...

37.3.4 Command-line switch -v

37.3.5 Additional command-line switches

37.4 Command-line examples

37.4.1 Creating a document information file

37.4.2 Writing converted files to a different directory

37.4.3 Converting a group of files to RTF

37.4.4 Converting a file to HTML

37.4.5 Converting from one DCL format to another

37.4.6 Generating DITA output via command line

37.5 Converting in multiple steps via DCL

37.6 Specifying output file paths and names

37.7 About DCL technology

37.7.1 DCL file structure

37.7.2 Writing DCL conversion modules

38 Generating intermediate output

38.1 Producing MIF with Mif2Go vs. FrameMaker

38.2 Generating MIF output

38.2.1 Understanding how MIF files are generated

38.2.2 Setting up a FrameMaker MIF project

38.2.3 Specifying which files to include in MIF output

38.2.4 Saving FrameMaker 8 files as FrameMaker 8 MIF

38.2.5 Saving FrameMaker 9+ files as FrameMaker 7 MIF

38.2.6 Specifying file extensions for MIF output

38.3 Converting to ASCII DCL

38.3.1 Setting up an ASCII DCL project

38.4 Generating ASCII DCL output

38.4.1 Including generated files in ASCII DCL output

38.4.2 Specifying type and file extension for ASCII DCL output

38.4.3 Exporting embedded graphics via ASCII DCL output

A WAI marker library for HTML

B Distribution files

C Document and conversion files

D Technical support for Mif2Go

E DITA <bookmeta> template

F Content model configuration

RTF keyword index

HTML/XML keyword index

Subject index

> Contents