Contents
Figures
Tables
About this guide
Availability
New information
Colophon
I. How to set up and use DITA2Go
1. Getting started with
DITA2Go
1.1 What you need to know
1.1.1 How
DITA2Go
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
DITA2Go
distribution
1.3.3 Install
DITA2Go
1.3.4 Make Omni Systems executables accessible
1.3.5 Check your
DITA2Go
installation
1.3.6 Obtain tools for Help systems or eBooks
1.3.7 Establish system-wide configuration settings
1.3.8 Obtain a file comparison tool (optional)
1.3.9 Download the
DITA2Go
User’s Guide (optional)
1.3.10 Integrate
DITA2Go
with <oXygen/> (optional)
1.4 How to update
DITA2Go
1.4.1 Update your
DITA2Go
installation
1.4.2 Try out
DITA2Go
beta executables
1.5 How
DITA2Go
works
1.6 How to start and stop
DITA2Go
1.7 How to work with
DITA2Go
1.8 How to uninstall
DITA2Go
2. Converting DITA documents
2.1 Creating a
DITA2Go
conversion project
2.2 Modifying a
DITA2Go
conversion project
2.3 Configuring default
DITA2Go
project settings
2.3.1 Understanding where to specify configuration settings
2.3.2 Choosing a source-specific configuration file
2.3.3 Deciding whether to compile and assemble output
2.3.4 Specifying a ditaval file
2.3.5 Naming an archive for output
2.3.6 Assembling graphics to include with output
2.3.7 Including output-specific settings
2.3.8 Reviewing default project settings
2.4 Inspecting and editing configuration files
2.5 Running a
DITA2Go
conversion
2.6 Customizing the
DITA2Go
Project Manager
2.7 Converting documents from the command line
2.7.1 Executing the correct version of DCL
2.7.2 Understanding how to run
DITA2Go
DCL
2.7.3 Creating a script to run
DITA2Go
DCL
3. Editing configuration files
3.1 Working with
DITA2Go
configuration files
3.2 Understanding where project settings come from
3.3 Understanding the rules for configuration settings
3.4 Specifying file paths in configuration settings
3.5 Using wildcards in configuration settings
3.6 Commenting out configuration sections
4. Setting basic conversion options
4.1 Specifying operating settings
4.1.1 Connecting to XML catalogs
4.1.2 Accommodating specializations
4.1.3 Specifying a DITA XML DTD
4.1.4 Generating a map from a DITA topic file
4.1.4.1 Choosing whether to generate a map
4.1.4.2 Specifying options for a generated map
4.1.5 Accommodating paths to network drives
4.1.6 Checking output type and file extension
4.1.7 Producing print output selectively
4.1.8 Including element tags and paths in output
4.1.9 Reusing or discarding ASCII DCL files
4.1.10 Specifying how to treat cases, spaces, and wildcards
4.2 Logging conversion events
4.3 Identifying files and elements
4.3.1 Generating document-wide unique IDs
4.3.2 Specifying building blocks for unique IDs
4.3.3 Specifying a prefix for bookmarks in RTF output
4.3.4 Checking for duplicate IDs
4.4 Processing graphics
5. Modifying output appearance
5.1 Understanding where to modify formats
5.2 Understanding how to modify formats
5.3 Changing how the output looks
5.3.1 Producing HTML output from the DITA Test Suite
5.3.2 Getting rid of that awful green color
5.3.3 Changing the indentation
5.3.4 Changing the spacing
5.4 Determining how an element is rendered
6. Mapping elements to output formats
6.1 Understanding how to assign formats
6.2 Specifying options for naming formats
6.3 Mapping outputclass attribute values to formats
6.3.1 Mapping block and inline outputclass attributes to formats
6.3.2 Mapping table outputclass attributes to formats
6.3.3 Mapping cross-reference outputclass attributes to formats
6.3.4 Mapping wrapper-element outputclass attributes to formats
6.4 Mapping element paths to output formats
6.4.1 Understanding element paths
6.4.2 Mapping block and inline element paths to formats
6.4.3 Overriding element paths for default formats
6.4.4 Mapping the same element to different formats
6.4.5 Filtering out elements via format mapping
6.5 Mapping element attributes to output formats
6.5.1 Listing elements whose attributes can affect output formats
6.5.2 Listing attributes whose values can affect output formats
6.5.3 Assigning format-name prefixes to attribute values
6.5.4 Assigning run-in headings to format-name prefixes
6.5.5 Deciding which formats need a run-in heading property
6.5.6 Understanding the order of prefixes for multiple attributes
6.5.7 Understanding how prefixes modify output formats
6.5.8 Understanding default attribute-based prefixes and headings
6.6 Specifying formats for cross references
6.7 Specifying formats for footnotes
6.8 Specifying options for figures
6.9 Specifying formats and options for tables
6.10 Specifying options for special lists
6.11 Specifying options for draft comments
6.12 Specifying options for maps
6.12.1 Providing default output formats for map content
6.12.2 Including shortdesc content in the title attribute
6.12.3 Including title-only topics in output
6.12.4 Including children of topic headings
6.13 Deciding where to display title and shortdesc
7. Configuring output formats
7.1 Understanding the purpose of output formats
7.2 Working with format configuration files
7.2.1 Understanding where to define output formats
7.2.2 Specifying paths to your own format configuration files
7.2.3 Understanding how
DITA2Go
builds format chains
7.2.4 Understanding how
DITA2Go
processes format chains
7.3 Creating aliases to existing format names
7.3.1 Understanding reasons for aliasing format names
7.3.2 Assigning legacy names to defined formats
7.4 Understanding how to define output formats
7.4.1 Assigning values to format properties
7.4.2 Understanding the basis of format properties
7.4.3 Basing format properties on other formats
7.4.4 Modifying
DITA2Go
default output formats
7.4.5 Applying CSS and RTF code to output formats
7.4.6 Assigning content-adding properties to formats
7.5 Understanding text output formats
7.5.1 Understanding where to define text output formats
7.5.2 Providing padding around the text body area for HTML
7.5.3 Establishing base values and units of measurement
7.5.4 Including formats for features not present in body content
7.6 Configuring text output formats
7.6.1 Specifying default properties for character formats
7.6.2 Specifying default properties for paragraph formats
7.6.3 Understanding based vs. inline properties for paragraph formats
7.6.4 Specifying inline properties for paragraph and character formats
7.6.5 Specifying block properties for paragraph formats
7.6.6 Configuring list formats
7.6.6.1 Assigning properties to list formats for HTML list styles
7.6.6.2 Assigning properties to list formats for
DITA2Go
list styles
7.6.6.3 Having the best of both worlds
7.6.7 Assigning border properties to paragraph formats
7.6.8 Configuring implied character formats for HTML links
7.6.9 Specifying tab positions for RTF paragraph styles
7.7 Defining table output formats
7.7.1 Configuring table format properties
7.7.2 Configuring row format properties
7.7.3 Configuring cell format properties
7.8 Defining page layouts for RTF output
7.8.1 Establishing default properties for output pages
7.8.2 Configuring output section formats
7.8.3 Configuring page header and footer formats
7.8.4 Forcing page and column breaks
7.8.5 Configuring border formats for output pages
7.8.6 Configuring a title page (an example)
7.9 Inserting line, column, and page breaks in output
8. Configuring format components
8.1 Managing format components
8.1.1 Understanding where to define subformats
8.1.2 Basing subformat properties on other subformats
8.1.3 Assigning additional names to subformats
8.1.4 Understanding subformat name lookups
8.1.5 Including typographic tags and character formats
8.2 Defining border subformats
8.3 Defining shading subformats
8.4 Overriding border and shading properties
8.5 Configuring output numbering properties
8.5.1 Understanding numbering properties
8.5.2 Declaring and defining number streams
8.5.3 Defining number subformats
8.5.4 Defining footnote numbering
8.5.5 Considering examples of numbering schemes
8.5.5.1 Numbering ordered lists
8.5.5.2 Modifying the appearance of numbers
8.5.5.3 Numbering chapters, figures, and tables
8.5.5.4 Specifying symbols for bulleted lists
8.6 Configuring run-in headings for text formats
8.7 Defining cross-reference output formats
8.8 Configuring index see and see-also entries
8.9 Configuring trademark formats
8.10 Localizing output headings, labels, and names
9. Specifying conditional processing
9.1 Extracting conditions from ditaval files
9.1.1 Specifying a single ditaval file
9.1.2 Including wildcards in ditaval statements
9.1.3 Processing complex otherprops settings
9.2 Defining conditional actions
9.2.1 Understanding the syntax of conditional action settings
9.2.2 Flagging content for special treatment in output
9.2.3 Specifying default conditions for inclusion or exclusion
9.2.4 Including or excluding content based on attribute values
9.2.5 Passing attribute values through in output
9.3 Including flags for ditaval conditions
9.4 Configuring conditional flags
9.4.1 Specifying text properties for flags
9.4.2 Providing images and alt text for startflag and endflag
9.4.3 Highlighting conflicting flag properties
9.5 Assigning attributes with conditional flags
9.6 Scoping and filtering within maps
9.6.1 Understanding the advantages of filtering in maps
9.6.2 Designating map sections as named branches
9.6.3 Reusing the same topics with different conditions
9.6.4 Directing a cross reference to the correct branch
9.6.5 Directing a content reference to the correct branch
9.6.6 Limiting the scope of keydefs by branch
9.6.7 Directing a key reference to the correct branch
10. Including content by reference
10.1 Pushing and pulling content by reference
10.1.1 Referencing internal and external maps and topics
10.1.2 Pushing content into an element
10.1.3 Understanding problems with processing conkeyrefs
10.2 Referencing external code or text fragments
10.2.1 Including external code snippets with PI markers
10.2.2 Including external code snippets with fragment identifiers
11. Defining element sets and properties
11.1 Defining sets of elements
11.2 Specifying properties of element types
11.2.1 Understanding when to assign element type properties
11.2.2 Understanding what properties are available
11.2.3 Assigning properties to element types
12. Creating and deploying user variables
12.1 Understanding how
DITA2Go
user variables work
12.2 Assigning variable names to element paths
12.3 Including user variables in
DITA2Go
macros
12.4 Deploying user variables in template macros
13. Processing related and associative links
13.1 Generating and including related links
13.2 Appending links to topics
13.2.1 Appending related links to topics
13.2.2 Appending fixed links to topics
13.3 Including descriptions with related links
13.4 Generating associative links for Help output
13.5 Formatting links in output
13.5.1 Understanding how
DITA2Go
presents related links
13.5.2 Labeling related links
13.5.3 Specifying output formats for related and fixed links
13.5.4 Inserting dividers between topics and lists of links
13.6 Changing link path for peer related links
14. Generating lists and indexes
14.1 Understanding how
DITA2Go
processes lists
14.2 Naming generated HTML list and index files
14.3 Generating a table of contents
14.3.1 Deciding whether to produce a table of contents
14.3.2 Specifying a file name and title for the TOC
14.3.3 Deciding what to include in the TOC
14.3.4 Specifying formats for TOC entries and references
14.3.5 Including navigation titles from maps in the TOC
14.4 Generating a list of figures
14.5 Generating a list of tables
14.6 Treating figure titles as table titles
14.7 Generating an index
14.7.1 Specifying basic index settings
14.7.2 Configuring index features for RTF output
14.7.3 Configuring index features for HTML output
14.7.3.1 Choosing the type of index to generate for HTML
14.7.3.2 Specifying index file name and heading
14.7.3.3 Specifying CSS classes for index components
14.7.3.4 Including heading letters in the index
14.7.3.5 Customizing and linking to the index file
II. Configuring print RTF output
15. Converting to print RTF
15.1 Setting up a print RTF project
15.1.1 Specifying output file extension
15.1.2 Specifying the default output language and code page
15.1.3 Constraining the number of bookmarks in Word
15.1.4 Including or excluding contents and index
15.1.5 Producing PDF automatically via Word
15.1.6 Launching Word from the
DITA2Go
Project Manager
15.1.7 Importing a Word template
15.2 Adjusting output for different versions of Word
15.3 Converting paragraph and character formats
15.3.1 Mapping paragraph formats to RTF styles
15.3.2 Merging paragraph formats
15.3.3 Converting autonumbered formats
15.3.4 Converting bulleted formats
15.3.5 Converting character formats
15.4 Modifying text appearance
15.4.1 Adjusting line spacing
15.4.2 Specifying a style for quotes
15.4.3 Hiding content in Word
15.4.4 Omitting content from RTF output
15.4.5 Replacing content in RTF output
15.5 Converting cross references and hypertext links
15.5.1 Converting cross references to Word
15.5.1.1 Understanding how
DITA2Go
converts cross references
15.5.1.2 Making cross references active and updatable
15.5.1.3 Weighing cross-reference behavior trade-offs
15.5.1.4 Omitting cross references
15.5.2 Converting hypertext links to Word
15.5.3 Locking hypertext links to allow revision tracking
15.5.3.1 Making page numbers in interfile links updatable
15.6 Converting tables to print RTF
15.7 Managing graphics for print RTF
15.7.1 Understanding graphics requirements for Word
15.7.2 Understanding where to locate graphics
15.7.3 Limiting bitmap resolution and color depth
15.7.4 Preserving graphics scale in Word
15.7.5 Accommodating graphics in multiple versions of Word
15.7.6 Including file names of referenced graphics in Word
15.7.7 Linking instead of embedding referenced graphics
15.7.8 Embedding graphics in converted RTF files
15.7.9 Updating fields in Word to show linked graphics
15.8 Including RTF code for Word output
15.9 Turning on revision tracking in Word
15.10 Managing Word output after conversion
15.10.1 Supporting more than one version of Word
15.10.2 Including index terms in Word
15.10.3 Producing ASCII text from a converted Word document
15.10.4 Checking print RTF output files for
DITA2Go
version
15.11 Converting to OpenOffice or StarOffice
III. Configuring on-line Help output
16. Producing on-line Help
16.1 Weighing Help-system alternatives
16.1.1 Considering Help-system features
16.1.2 Evaluating Microsoft Windows Help (WinHelp)
16.1.3 Evaluating Microsoft HTML Help
16.1.4 Evaluating WebHelp
16.1.5 Evaluating OmniHelp
16.1.6 Evaluating JavaHelp and Oracle Help for Java
16.1.7 Evaluating Eclipse Help
16.2 Completing Help system construction
16.2.1 Specifying additional processing after conversion
16.2.2 Compiling and distributing Help systems
16.2.3 Launching a Help viewer from the Project Manager
16.3 Producing contents and index for Help systems
16.3.1 Modifying contents or index production for HTML-based Help
16.3.2 Modifying contents or index production for WinHelp
16.4 Configuring contents entries for Help systems
16.4.1 Setting contents levels for WinHelp
16.4.2 Including contents entries in HTML-based Help
16.4.3 Setting contents levels for HTML-based Help
16.5 Configuring index entries for Help systems
16.5.1 Understanding how
DITA2Go
creates Help index entries
16.5.2 Preparing index entries for Microsoft Help Viewer
16.5.3 Limiting length of index entries for HTML Help or WinHelp
16.5.4 Treating commas as potential index level separators
16.5.5 Combining index levels for HTML-based Help
16.5.6 Configuring
See
and
See also
entries for HTML-based Help
16.5.6.1 Identifying
See
and
See also
index references
16.5.6.2 Specifying level breaks for
See
and
See also
index entries
16.5.6.3 Choosing where to sort
See also
index references
16.5.7 Specifying index link destinations for HTML-based Help
16.5.8 Customizing index sort order
16.5.8.1 Listing characters to ignore in index sort order
16.5.8.2 Choosing case sensitivity of indexed terms
16.5.8.3 Specifying index sort type and locale
16.6 Providing related-topic links for Help systems
16.6.1 Understanding related-topic links
16.6.2 Understanding how ALinks work
16.6.3 Understanding how KLinks work
16.6.4 Adding related-topic link keywords in DITA XML
16.6.4.1 Adding related-topic link keywords via PI markers
16.6.4.2 Adding related-topic keywords via format properties
16.6.5 Adding ALink and KLink jumps in DITA XML
16.6.5.1 Configuring ALink jumps
16.6.5.2 Configuring KLink jumps
16.6.6 Creating target-and-jump ALinks for HTML-based Help
16.6.7 Specifying ALink and KLink list-link destinations
16.7 Jumping to secondary windows in Help systems
16.7.1 Assigning secondary windows for WinHelp
16.7.2 Assigning secondary windows for HTML-based Help
16.8 Creating pop-up topics for Help systems
16.8.1 Understanding pop-up hotspots, links, and topics
16.8.2 Defining a pop-up hotspot
16.8.3 Displaying a topic in a pop-up window
16.9 Including expandable sections in Help topics
16.9.1 Understanding
DITA2Go
expandable drop-down sections
16.9.2 Setting up expandable sections for your document
16.9.3 Delimiting expandable drop-down sections
16.9.3.1 Delimiting drop-down links and blocks with paragraph formats
16.9.3.2 Delimiting drop-down links and blocks with markers
16.9.4 Configuring drop-down links
16.9.4.1 Specifying the type of link for drop-down sections
16.9.4.2 Configuring icons for drop-down links
16.9.4.3 Configuring buttons for drop-down links
16.9.4.4 Configuring text for drop-down links
16.9.4.5 Modifying code for drop-down links
16.9.5 Configuring drop-down blocks
16.9.6 Providing CSS for drop-down links and blocks
16.9.7 Deploying JavaScript code for drop-down sections
16.9.7.1 Naming the JavaScript macro for drop-down sections
16.9.7.2 Locating JavaScript code for drop-down sections
16.9.7.3 Directing
DITA2Go
to write drop-down JavaScript code
16.9.7.4 Inspecting the JavaScript code for drop-down sections
16.9.7.4.1 JavaScript code when UseCompositeDropJS=Yes
16.9.7.4.2 JavaScript code when DropLinkType=Icon
16.9.7.4.3 JavaScript code when DropLinkType=Button
16.9.7.4.4 JavaScript code when DropLinkType=Text
16.9.8 Emulating Web Works Publisher drop-down hotspots
16.9.8.1 Creating drop-down hotspots with
DITA2Go
controls and macros
16.9.8.2 Creating drop-down hotspots with
DITA2Go
macros only
16.10 Setting up Context Sensitive Help (CSH)
16.10.1 Understanding how CSH works
16.10.2 Specifying CSH mappings
16.11 Setting up a dynamic modular Help system
17. Generating WinHelp
17.1 Obtaining tools for WinHelp
17.2 Setting up a WinHelp project
17.2.1 Setting up a WinHelp project
17.2.2 Deciding where to locate configuration settings
17.2.3 Preparing a document for conversion to WinHelp
17.2.4 Accommodating platform differences
17.2.5 Setting basic WinHelp options in the configuration file
17.2.6 Handling page breaks and section breaks
17.2.7 Providing multiple .hlp files
17.2.8 Integrating WinHelp from RoboHelp
17.2.9 Compiling a WinHelp project
17.2.10 Checking WinHelp RTF files for
DITA2Go
version
17.3 Converting text
17.3.1 Suppressing unwanted paragraphs
17.3.2 Replacing paragraph or character content
17.3.3 Converting footnotes
17.4 Converting cross references
17.4.1 Creating help context markers
17.4.2 Specifying cross-reference destination files
17.4.3 Specifying cross-reference jump destinations
17.4.4 Specifying options for selected cross-reference formats
17.4.5 Limiting cross-reference text
17.5 Converting tables to WinHelp RTF
17.5.1 Positioning tables and table titles
17.5.2 Adjusting table appearance
17.5.3 Converting table rows to topics and table cells to pop-ups
17.6 Managing graphics for WinHelp
17.6.1 Choosing a graphics format for WinHelp
17.6.2 Displaying graphics in pop-ups for WinHelp
17.7 Configuring WinHelp topics
17.7.1 Creating WinHelp topics
17.7.2 Assigning properties to formats for topics and hotspots
17.7.3 Configuring topic titles for WinHelp
17.7.3.1 Categorizing titles
17.7.3.2 Deciding whether to scroll titles
17.7.3.3 Fine-tuning title appearance
17.8 Creating jumps and pop-ups for WinHelp
17.8.1 Configuring pop-up topics
17.8.2 Creating hotspots for jumps and pop-ups in WinHelp
17.8.2.1 Configuring jump vs. pop-up hotspots
17.8.2.2 Controlling hotspot appearance
17.8.2.3 Embedding hotspots in graphics
17.8.3 Using cross references for jumps and pop-ups
17.8.4 Using hypertext links for jumps and pop-ups
17.8.4.1 Using HyperPopup and HyperJump PI markers
17.8.4.2 Using alert or alerttitle markers for embedded pop-ups
17.8.5 Disallowing hypertext links for jumps and pop-ups
17.8.6 Specifying jumps to secondary windows in WinHelp
17.8.7 Specifying jumps to external files
17.9 Invoking WinHelp macros
17.9.1 Using a hypertext marker to invoke a macro
17.9.2 Assigning a hotspot property to invoke a macro
17.10 Creating related-topic links in WinHelp
17.10.1 Understanding KLink limitations
17.10.2 Adding ALinks and KLinks with PI markers
17.10.3 Adding related-topic keywords with formats
17.10.4 Inserting WinHelp macros for ALink jumps
17.11 Configuring index entries for WinHelp
17.11.1 Designating index level separators
17.11.2 Eliminating duplicate keywords
17.11.3 Keeping or discarding “See also” entries
17.12 Configuring contents for WinHelp
17.12.1 Naming and configuring Help files and titles
17.12.2 Specifying heading formats and levels for contents
17.12.2.1 Understanding WinHelp contents level numbers
17.12.2.2 Listing topics for contents with and without subheadings
17.12.2.3 Using different names in contents for heading and topic
17.12.2.4 Renaming or eliminating the contents “Overview” topic
17.12.2.5 Referencing multiple help files from contents
17.12.2.6 Displaying contents targets in the main window
17.12.3 Assembling WinHelp contents from the command line
17.13 Creating browse sequences
17.13.1 Setting up an automatic browse sequence
17.13.2 Specifying browse numbers
17.13.3 Setting up multi-file browse sequences
17.13.4 Setting up branching browse sequences
18. Generating Microsoft HTML Help
18.1 Understanding how
DITA2Go
produces HTML Help
18.2 Understanding why Unicode is not the answer
18.3 Setting up an HTML Help project
18.3.1 Creating an HTML Help project
18.3.2 Deciding where to locate configuration settings
18.3.3 Organizing source files for HTML Help
18.3.4 Specifying a project title for HTML Help
18.3.5 Deciding whether to compile HTML Help
18.3.6 Naming project and compiled files for HTML Help
18.3.7 Specifying a starting topic file for HTML Help
18.3.8 Regenerating the HTML Help project file
18.3.9 Locating graphics files for HTML Help
18.4 Customizing HTML Help display features
18.4.1 Using CSS and font tags with HTML Help
18.4.2 Eliminating graphic and table indents from HTML Help
18.4.3 Adding tabs and toolbar buttons to HTML Help
18.4.4 Adding expandable sections to HTML Help
18.5 Creating pop-ups for HTML Help
18.5.1 Using HTML Help for pop-ups
18.5.2 Using WinHelp for pop-ups
18.6 Creating links and hypertext jumps in HTML Help
18.6.1 Creating hypertext jumps to other CHM files
18.6.2 Specifying href link syntax for HTML Help
18.6.3 Linking to external files from compiled HTML Help
18.7 Creating related-topic links for HTML Help
18.7.1 Adding ALink keywords for HTML Help
18.7.2 Adding ALink and KLink jumps for HTML Help
18.7.3 Configuring ALink and KLink jumps for HTML Help
18.7.4 Rolling your own macros for ALink jumps in HTML Help
18.7.5 Using the same format for ALink keywords and jumps
18.7.5.1 Creating a list of ALink keywords from paragraphs
18.7.5.2 Initializing the ALink keyword list counter
18.7.5.3 Building an ALink button object from an ALink keyword list
18.7.5.4 Positioning the ALink button in each topic
18.7.5.5 Including multiple ALink keywords in a paragraph or marker
18.7.6 Creating buttons for other types of related-topic links
18.8 Using secondary windows in HTML Help
18.8.1 Defining secondary windows for HTML Help
18.8.2 Jumping from a topic to a secondary window
18.8.3 Jumping from contents or index to a secondary window
18.8.3.1 Assigning a secondary window with a paragraph format
18.8.3.2 Assigning a secondary window with a marker
18.9 Generating contents and index for HTML Help
18.9.1 Choosing how to generate HTML Help contents and index
18.9.2 Generating contents and index with HTML Help Workshop
18.9.3 Generating contents and index with
DITA2Go
18.9.4 Configuring contents entries for HTML Help
18.9.5 Providing mid-topic contents links in HTML Help
18.9.6 Making the TOC track index links in HTML Help
18.9.7 Customizing contents and index for HTML Help
18.10 Providing full-text search (FTS) for HTML Help
18.11 Setting up CSH for HTML Help
18.11.1 Inserting CSH destinations in your document
18.11.2 Determining whether you need map and alias files
18.11.3 Specifying a map file for CSH links
18.11.4 Creating an alias file for CSH links
18.11.5 Understanding alias-file entries
18.11.6 Producing a list of aliases and associated topic titles
18.12 Generating HTML Help in non-Western languages
18.12.1 Converting from Unicode to Windows code pages
18.12.2 Specifying locale and language for HTML Help
18.12.3 Preventing inclusion of Unicode numeric references
18.13 Compiling and testing HTML Help
18.13.1 Directing
DITA2Go
to run the HTML Help compiler
18.13.2 Copying output files and compiling later
18.13.3 Compiling in a different language
18.13.4 Registering your HTML Help system for network use
18.14 Mapping and merging CHM files
18.14.1 Interlinking multiple CHM files
18.14.1.1 Specifying the default CHM file
18.14.1.2 Mapping DITA files to CHM files
18.14.1.3 Requiring
DITA2Go
to use paths for mapped DITA files
18.14.2 Synchronizing TOC references to slave CHM files
18.14.3 Putting up with a binary index for merged CHM files
18.14.4 Merging CHM files
18.14.5 Comparing HHW settings for stand-alone vs. merged CHMs
19. Generating OmniHelp
19.1 Understanding how OmniHelp works
19.2 Setting up OmniHelp viewer control files
19.2.1 Choosing XHTML vs. HTML OmniHelp control files
19.2.2 Making OmniHelp viewer control files available
19.2.3 Customizing OmniHelp viewer control files
19.2.4 Examining generated control and data files
19.3 Setting up an OmniHelp project
19.3.1 Creating an OmniHelp project
19.3.2 Deciding where to locate configuration settings
19.3.3 Naming your OmniHelp project
19.3.4 Giving your OmniHelp project a title
19.3.5 Specifying the starting topic
19.3.6 Specifying memory requirements
19.3.7 Removing paths from interfile links for OmniHelp
19.3.8 Getting OmniHelp supporting files in the right place
19.4 Using CSS with OmniHelp
19.4.1 Specifying CSS for topics in OmniHelp
19.4.2 Understanding how CSS works in OmniHelp topics
19.4.3 Specifying CSS for OmniHelp navigation frames
19.5 Customizing OmniHelp display features
19.5.1 Configuring OmniHelp window usage and frameset dimensions
19.5.2 Altering OmniHelp top navigation frame content
19.5.3 Modifying OmniHelp navigation aids
19.5.4 Choosing whether to use cookies for OmniHelp
19.5.5 Localizing the OmniHelp interface
19.5.6 Modifying OmniHelp CSS classes
19.5.7 Modifying the OmniHelp template
19.6 Choosing navigation features for OmniHelp
19.7 Configuring contents and index for OmniHelp
19.7.1 Understanding OmniHelp contents and index creation
19.7.2 Choosing whether to use expanding contents or index
19.7.3 Choosing how far to expand contents and index subentries
19.7.4 Providing alternate expansion icons for contents or index
19.7.5 Excluding
Open All
and
Close All
buttons
19.7.6 Redirecting
See
and
See also
index entries
19.8 Providing related-topic links in OmniHelp
19.9 Jumping to secondary windows in OmniHelp
19.10 Configuring full-text search for OmniHelp
19.10.1 Understanding how OmniHelp FTS works
19.10.2 Generating search data
19.10.3 Supporting search for non-ANSI text
19.10.4 Specifying length of search terms
19.10.5 Excluding search terms
19.10.6 Excluding content from being searched
19.10.7 Using regular expressions in search
19.10.8 Highlighting search terms found in topics
19.11 Setting up CSH for OmniHelp
19.11.1 Specifying alias prefixes for OmniHelp CSH calls
19.11.2 Referencing OmniHelp topic IDs from an application
19.11.3 Using redirect pages for OmniHelp CSH calls
19.11.4 Executing browser commands for OmniHelp CSH calls
19.12 Merging OmniHelp projects
19.12.1 Understanding the OmniHelp merge process
19.12.2 Listing and mapping OmniHelp subprojects
19.12.3 Providing TOC placeholders for OmniHelp subprojects
19.12.4 Deciding when to merge OmniHelp subprojects
19.13 Assembling OmniHelp files for viewing
19.14 Deploying OmniHelp
19.14.1 Starting with the default topic or a specified topic
19.14.2 Restarting where you left off
19.14.3 Coping with browser quirks
20. Generating JavaHelp or Oracle Help
20.1 Deciding which Java Help system to use
20.2 Obtaining tools for a Java-based Help system
20.3 Setting up a JavaHelp or Oracle Help project
20.3.1 Creating a JavaHelp or Oracle Help for Java project
20.3.2 Deciding where to locate configuration settings
20.3.3 Specifying output options for JavaHelp
20.3.4 Establishing a JavaHelp environment
20.3.5 Establishing an Oracle Help environment
20.3.6 Creating a directory structure for JavaHelp / Oracle Help
20.3.6.1 Understanding the JavaHelp / Oracle Help directory structure
20.3.6.2 Letting
DITA2Go
set up the directory structure and copy files
20.3.6.3 Locating graphics files for JavaHelp and Oracle Help
20.3.6.4 Specifying a path for search-index links
20.3.6.5 Manually copying and deleting output files
20.3.7 Configuring the helpset file
20.3.7.1 Specifying helpset file name and title
20.3.7.2 Specifying a default starting topic for the helpset
20.3.7.3 Deciding whether to rewrite the helpset file
20.3.7.4 Providing a “favorites” option for JavaHelp 2
20.3.7.5 Adding custom helpset sections for JavaHelp 2
20.3.7.6 Requiring full paths in the helpset file
20.3.8 Coping with JavaHelp / Oracle Help viewer limitations
20.3.9 Compiling JavaHelp with Helen
20.4 Generating contents and index
20.4.1 Configuring contents entries for JavaHelp or Oracle Help
20.4.2 Assigning TOC images and expansion levels in JavaHelp 2
20.4.3 Configuring index entries for JavaHelp or Oracle Help
20.4.4 Locating JavaHelp or Oracle Help contents and index files
20.5 Providing full-text search for JavaHelp / Oracle Help
20.5.1 Including a search-index link in the helpset file
20.5.2 Creating a search index for JavaHelp
20.5.3 Creating a search index for Oracle Help
20.5.3.1 Directing
DITA2Go
to create full-text search for Oracle Help
20.5.3.2 Creating full-text search for Oracle Help via command line
20.5.3.3 Using the Oracle Help Wizard to create full-text search
20.6 Creating and viewing a Java Archive (JAR) file
20.6.1 Creating a JAR file
20.6.2 Viewing a JAR file
20.7 Converting a glossary to JavaHelp 2
20.7.1 Evaluating glossary usability
20.7.2 Assigning glossary properties
20.7.3 Configuring glossary IDs
20.7.4 Eliminating glossary entries from the JavaHelp TOC
20.8 Defining windows for JavaHelp or Oracle Help
20.8.1 Specifying window parameters for JavaHelp 2
20.8.1.1 Assigning default window parameters for JavaHelp 2
20.8.1.2 Mapping image names to graphics files
20.8.1.3 Understanding JavaHelp 2 window-access limitations
20.8.1.4 Specifying window-access object properties
20.8.1.4.1 Changing window type, size, or position via access object
20.8.1.4.2 Specifying link properties via window-access object
20.8.1.5 Overriding window-access properties with markers
20.8.1.6 Designing your own window-access marker names
20.8.2 Specifying window parameters for Oracle Help
20.8.3 Jumping to secondary windows in JavaHelp or Oracle Help
20.9 Linking to destinations within topics
20.10 Creating ALinks for Oracle Help
20.11 Merging JavaHelp or Oracle Help systems
20.12 Setting up CSH for JavaHelp or Oracle Help
21. Generating Eclipse Help
21.1 Understanding how Eclipse Help works
21.2 Setting up an Eclipse Help project
21.2.1 Creating an Eclipse Help project
21.2.2 Deciding where to locate configuration settings
21.2.3 Specifying Eclipse Help output options
21.2.3.1 Specifying a different output file extension
21.2.3.2 Specifying the target Eclipse version
21.2.3.3 Choosing whether to generate plugin.xml
21.2.4 Making sure links work in Eclipse Help
21.2.5 Disabling breadcrumb trails in Eclipse Help
21.3 Configuring Eclipse Help manifest files
21.3.1 Specifying a Java manifest file for Eclipse Help
21.3.2 Specifying Eclipse Help plug-in properties
21.3.3 Configuring the Java manifest file for Eclipse Help
21.3.4 Configuring the plug-in manifest file for Eclipse Help
21.3.4.1 Creating plugin.xml for Eclipse Help
21.3.4.2 Including a processing instruction to validate plugin.xml
21.3.4.3 Specifying the plug-in schema version for plugin.xml
21.3.4.4 Specifying Eclipse Help TOC properties in plugin.xml
21.3.4.5 Specifying Eclipse Help index properties in plugin.xml
21.3.4.6 Including a runtime element in plugin.xml
21.3.4.7 Including or excluding full-text search for Eclipse Help
21.3.4.8 Specifying Eclipse Help CSH properties in plugin.xml
21.4 Configuring contents and index for Eclipse Help
21.4.1 Choosing contents and index methods for Eclipse Help
21.4.2 Supplying path information for contents and index links
21.4.3 Configuring contents properties for Eclipse Help
21.4.3.1 Providing a title for the TOC
21.4.3.2 Specifying a starting topic
21.4.3.3 Enabling mid-topic jumps from the TOC
21.4.3.4 Directing TOC links to top of topic page
21.4.4 Configuring index properties for Eclipse Help
21.5 Configuring search properties for Eclipse Help
21.6 Merging Eclipse Help projects
21.6.1 Linking primary content to secondary TOCs
21.6.2 Linking secondary TOCs to primary content (
deprecated
)
21.7 Setting up CSH for Eclipse Help
21.7.1 Understanding how
DITA2Go
generates context links
21.7.2 Naming context file and attribute for secondary plug-ins
21.7.3 Configuring context IDs and context anchors
21.7.4 Configuring context descriptions
21.7.5 Locating context information
21.8 Packaging Eclipse Help files
21.8.1 Specifying a ZIP command for doc.zip
21.8.2 Specifying ZIP command parameters
21.8.3 Archiving Eclipse Help files
IV. Configuring HTML/XML output
22. Converting to HTML/XHTML
22.1 Deciding which type of output to produce
22.2 Setting up an HTML project
22.2.1 Creating an HTML or XHTML project
22.2.2 Specifying a different output file extension
22.2.3 Checking HTML or XML output files for
DITA2Go
version
22.2.4 Using XHTML tagging rules for HTML
22.3 Including starting code and entity references
22.4 Supplying values for the <head> element
22.4.1 Specifying HTML/XML version, DOCTYPE, and DTD
22.4.2 Specifying namespace and language
22.4.3 Specifying character encoding for HTML
22.4.4 Including or omitting HTML/XML generator information
22.4.5 Specifying page titles for HTML output files
22.4.6 Supplying content for the <meta> tag
22.4.6.1 Providing meta content with paragraph formats
22.4.6.2 Providing meta content with DITA PI markers
22.4.6.3 Providing meta content with
DITA2Go
macros
22.4.7 Specifying nonstandard values for declarations
22.5 Specifying HTML <body> attributes
22.6 Specifying document-wide properties for HTML
22.6.1 Specifying a default DPI setting
22.6.2 Suppressing closing </p> tags for HTML
22.6.3 Suppressing line breaks in HTML and XML output
22.6.4 Preventing adjacent <pre> elements from merging
22.7 Importing HTML files as insets
22.8 Providing hover text for links in HTML
22.9 Generating XHTML for Confluence 4.x
22.10 Exporting content for database input
22.11 Specifying a starting topic for HTML or XHTML
22.12 Using framesets
22.13 Passing W3C validation tests
22.13.1 Understanding limitations of W3C validation
22.13.2 Replacing high ASCII characters for W3C validation
22.13.3 Eliminating <nobr> tags
22.13.4 Avoiding redundant attribute assignments in tables
23. Converting to generic XML
23.1 Setting up a generic XML project
23.2 Specifying generic XML output settings
23.2.1 Creating a generic XML project
23.2.2 Changing output XML version or file extension
23.2.3 Specifying character encoding for generic XML
23.2.4 Specifying the root element and content type
23.2.5 Preventing arbitrary line breaks in XML text elements
23.2.6 Specifying a starting topic for generic XML
23.3 Providing XML tags and structure
23.3.1 Deriving XML tags from format and class names
23.3.2 Eliminating HTML attributes and tags for generic XML
23.4 Configuring links for generic XML
24. Converting to DITA XML
24.1 Generating DITA XML output from DITA input
24.2 Setting up a DITA XML project
24.2.1 Creating a DITA XML project
24.2.2 Specifying DITA output options
24.2.3 Specifying DITA version
24.2.4 Configuring the DITA DTD SYSTEM identifier
24.2.5 Substituting document format names for default names
24.3 Specifying general options for DITA
24.4 Configuring DITA elements
24.4.1 Understanding how DITA2Go delimits DITA elements
24.4.2 Treating format names as DITA element names
24.4.3 Mapping paragraph formats to DITA block elements
24.4.3.1 Assigning DITA elements to paragraph formats
24.4.3.2 Omitting element tags for selected paragraph formats
24.4.3.3 Specifying a default element for unmapped paragraph formats
24.4.3.4 Omitting invalid tags for default DITA block elements
24.4.3.5 Overriding element mapping for paragraph formats
24.4.3.6 Providing aliases for paragraph formats
24.4.3.7 Mapping paragraph format aliases to different elements
24.4.3.8 Mapping paragraph format aliases algorithmically
24.4.3.9 Mapping several paragraphs formats to the same element
24.4.4 Mapping character formats to DITA inline elements
24.4.4.1 Assigning DITA elements to character formats
24.4.4.2 Including typographic elements in addition to mapped formats
24.4.4.3 Specifying a default element for unmapped character formats
24.4.4.4 Overriding element mapping for character formats
24.4.4.5 Using alternate character formats for menu cascades
24.4.5 Assigning multiple typographic elements to a format
24.4.6 Assigning attributes to DITA elements
24.4.6.1 Specifying a value for the id attribute
24.4.6.2 Including an id attribute in every element
24.4.6.3 Specifying attribute values for the root element of a topic
24.4.6.4 Specifying attribute values for a block element or parent
24.4.6.5 Specifying attribute values for an inline element
24.4.6.6 Providing outputclass attributes for all elements
24.4.7 Preserving whitespace in block elements
24.5 Nesting DITA block elements
24.5.1 Understanding how
DITA2Go
determines element nesting
24.5.2 Designating DITA ancestor elements
24.5.3 Fixing up interpolated ancestries
24.5.4 Deciding when to fully specify ancestry
24.5.5 Specifying alternate ancestries for the same element
24.5.6 Avoiding invalid ancestries
24.5.7 Specifying first-child status for nested elements
24.5.8 Configuring nested lists
24.5.9 Closing DITA ancestor elements
24.5.9.1 Ending ancestor elements before the current block
24.5.9.2 Ending ancestor elements after the current block
24.5.10 Opening DITA ancestor elements
24.5.10.1 Starting ancestor elements before the current block
24.5.10.2 Starting a new hierarchy after the current block
24.5.11 Configuring multi-paragraph list items
24.5.12 Specifying DITA element levels
24.6 Specifying options for tables in DITA XML
24.6.1 Designating ancestors for <table> elements
24.6.2 Applying attributes to DITA tables
24.6.3 Configuring DITA table components
24.6.3.1 Omitting ancestries of DITA table components
24.6.3.2 Retaining empty paragraph tags in DITA table cells
24.6.3.3 Specifying relative vs. absolute widths for table columns
24.6.4 Omitting table coding entirely
24.7 Specifying options for images in DITA XML
24.7.1 Designating ancestors for <image> and <fig> elements
24.7.2 Specifying what to include in a <fig> wrapper
24.7.3 Omitting size attributes from images
24.8 Configuring DITA topics
24.8.1 Designating starting points for DITA topics
24.8.1.1 Identifying starting elements for non-glossary topics
24.8.1.2 Identifying the starting element for glossary topics
24.8.1.3 Preventing the first paragraph format from starting a topic
24.8.2 Specifying the DITA topic type
24.8.2.1 Understanding DITA topic type assignment precedence
24.8.2.2 Specifying a default DITA topic type
24.8.2.3 Specifying the DITA topic type with a paragraph format
24.8.2.4 Specifying the DITA topic type with a marker
24.8.3 Specifying the ID for a DITA topic
24.8.4 Adjusting DITA topic IDs generated from file names
24.8.5 Specifying alternate titles for a DITA topic
24.9 Configuring cross references and links for DITA
24.9.1 Understanding how
DITA2Go
converts cross references
24.9.2 Specifying an outputclass for cross-reference wrappers
24.9.3 Linking to elements below topic level
24.9.4 Omitting <xref> elements from footnotes
24.9.5 Overriding <xref> attribute values
24.9.5.1 Specifying the <xref> scope attribute
24.9.5.2 Specifying the <xref> format attribute
24.9.5.3 Specifying the <xref> type attribute
24.10 Overriding DITA settings with markers
25. Configuring DITA maps
25.1 Configuring ditamaps
25.1.1 Specifying options for ditamaps
25.1.1.1 Choosing whether to overwrite ditamaps
25.1.1.2 Choosing whether a ditamap references maps or topics
25.1.1.3 Specifying the base file name for a ditamap
25.1.1.4 Specifying a title for a chapter or book ditamap
25.1.1.5 Specifying a navigation title for a ditamap
25.1.1.6 Specifying the ID for a ditamap
25.1.2 Specifying topic levels in ditamaps
25.1.3 Specifying roles for topics in ditamaps
25.1.4 Adding relationship tables to ditamaps
25.1.4.1 Understanding how
DITA2Go
creates relationship tables
25.1.4.2 Excluding the ALink column from relationship tables
25.1.4.3 Adding ALink rows to relationship tables
25.1.4.4 Specifying one-way linking for a topic in a relationship table
25.1.4.5 Specifying a collection-type attribute for each topic type
25.1.5 Providing navigation aids in ditamaps
25.2 Overriding map settings with PI markers
26. Converting to DocBook XML
26.1 Generating DocBook XML with
DITA2Go
26.1.1 Understanding what you need to know about DocBook
26.1.2 Understanding what information you must supply
26.2 Setting up a DocBook XML project
26.2.1 Creating a DocBook project
26.2.2 Specifying DocBook output options
26.2.2.1 Changing the DocBook output file extension
26.2.2.2 Specifying content model and root element
26.2.2.3 Specifying book file options
26.3 Specifying general options for DocBook
26.3.1 Configuring entity information for DocBook XML
26.3.2 Configuring links for DocBook XML
26.3.3 Configuring tables for DocBook XML
26.3.4 Retaining empty paragraph tags in DocBook table cells
26.3.5 Configuring footnotes for DocBook XML
26.4 Configuring DocBook elements
26.4.1 Treating format names as element names
26.4.2 Mapping paragraph formats to DocBook elements
26.4.2.1 Assigning DocBook elements to paragraph formats
26.4.2.2 Specifying a default element for unmapped paragraph formats
26.4.2.3 Omitting invalid tags for default DocBook block elements
26.4.2.4 Overriding element mapping for paragraph formats
26.4.2.5 Providing aliases for paragraph formats
26.4.3 Mapping character formats to DocBook elements
26.4.3.1 Assigning DocBook elements to character formats
26.4.3.2 Specifying a default element for unmapped character formats
26.4.3.3 Overriding element mapping for character formats
26.4.4 Assigning ID attributes to DocBook block elements
26.4.4.1 Understanding how
DITA2Go
creates ID attribute values
26.4.4.2 Providing IDs for block elements
26.4.4.3 Providing IDs for interpolated parents of block elements
26.4.4.4 Specifying an ID for an individual block element or parent
26.4.5 Assigning attributes other than ID to DocBook elements
26.4.5.1 Specifying attribute values for a block element or ancestor
26.4.5.2 Specifying attribute values for an inline element
26.5 Nesting DocBook block elements
26.5.1 Understanding how
DITA2Go
determines element nesting
26.5.2 Designating DocBook ancestor elements
26.5.3 Fixing up interpolated ancestries
26.5.4 Deciding when to fully specify ancestry
26.5.5 Specifying alternate ancestries for the same element
26.5.6 Specifying first-child status for nested elements
26.5.7 Specifying full ancestry for nested sections
26.5.8 Closing DocBook ancestor elements
26.5.8.1 Ending ancestor elements before the current block
26.5.8.2 Ending ancestor elements after the current block
26.5.9 Opening DocBook ancestor elements
26.5.9.1 Starting ancestor elements before the current block
26.5.9.2 Starting a new hierarchy after the current block
26.5.10 Configuring multi-paragraph list items
26.5.11 Specifying DocBook element levels
26.6 Designating ancestors for table elements
26.7 Specifying options for figure elements
26.7.1 Deciding what to include in a figure element
26.7.2 Specifying ancestry for figure elements
26.7.3 Omitting size attributes from images
26.8 Overriding DocBook settings with PI markers
27. Splitting and extracting files
27.1 Splitting and extracting vs. chunking
27.2 Chunking DITA maps
27.2.1 Choosing between splitting and chunking
27.2.2 Specifying a chunking policy
27.2.3 Providing a page break between title and TOC
27.2.4 Producing a single HTML file that includes generated lists
27.3 Splitting files
27.3.1 Designating split points
27.3.2 Managing split points
27.3.2.1 Preventing splits that leave dangling headings
27.3.2.2 Keeping headings together when other content intervenes
27.4 Extracting files
27.4.1 Enabling and disabling extract processing
27.4.2 Delimiting material to extract
27.4.2.1 Using existing paragraph formats to delimit extracts
27.4.2.2 Creating special paragraph formats to delimit extracts
27.4.2.3 Using markers to delimit extracts
27.5 Identifying split and extract files
27.5.1 Understanding how split and extract files are named
27.5.2 Specifying page titles for split or extract files
27.5.2.1 Understanding title assignment precedence
27.5.2.2 Assigning a title with a paragraph format
27.5.2.3 Specifying a title prefix or suffix
27.5.2.4 Assigning a title with a file name
27.5.2.5 Assigning a title with a marker
27.5.2.6 Assigning a default title
27.5.2.7 Assigning a computed title
27.5.3 Supplying <meta> text for split or extract files
27.6 Inserting HTML code in split and extract files
27.6.1 Choosing how to insert code in extracts
27.6.2 Assigning code to [Inserts] keywords for splits and extracts
27.6.3 Using special sections to insert code in extracts
27.7 Referencing split and extract files
27.8 Customizing and replacing extracts
27.8.1 Using PI markers for extract processing
27.8.2 Customizing title text for extracts
27.8.3 Replacing extracts with links in the parent file
27.8.3.1 Assigning replacement code
27.8.3.2 Using thumbnails for links to illustrations
27.8.3.2.1 Choosing a thumbnail method
27.8.3.2.2 Providing separate thumbnails
27.8.3.2.3 Providing scaled thumbnails
27.8.3.2.4 Including text with a thumbnail
27.8.3.3 Supplying properties for extracted graphics
27.8.4 Specifying extracts: an example
28. Creating HTML links
28.1 Understanding sources of links
28.2 Specifying link appearance
28.2.1 Specifying link colors
28.2.2 Specifying link class
28.2.2.1 Assigning a link class with a PI marker
28.2.2.2 Assigning a link class with a paragraph format
28.2.3 Assigning link attributes with PI markers
28.2.4 Specifying link properties with macros
28.2.5 Replacing problem characters in links
28.2.6 Forcing link text to lowercase
28.3 Specifying link destination
28.3.1 Forcing links to top-of-page for selected paragraph formats
28.3.2 Forcing all links to top-of-page
28.3.3 Linking to an arbitrary location
28.4 Creating jumps to particular windows for HTML
28.5 Converting DITAcross-reference links to HTML
28.5.1 Specifying options for all cross references
28.5.2 Specifying options for selected cross-reference formats
28.6 Linking to other files and other
DITA2Go
projects
28.6.1 Retaining file paths in interfile links
28.6.2 Enabling links to renamed or relocated files
28.7 Linking to external destinations
29. Providing navigation in HTML
29.1 Understanding how navigation links work
29.2 Generating trails of links
29.2.1 Understanding trails of links
29.2.2 Specifying whether to include trails of links
29.2.3 Specifying what to include in trails of links
29.2.4 Specifying heading levels for trails of links
29.2.5 Specifying where to display trails of links
29.3 Creating a browse sequence
29.3.1 Understanding how browse macros work
29.3.1.1 Understanding how browse macros vary by file position
29.3.1.2 Understanding equivalent browse macros and macro variables
29.3.1.3 Understanding how browse macros employ macro variables
29.3.2 Choosing buttons versus text links for a browse sequence
29.3.3 Formatting browse-link labels
29.3.4 Modifying macros <$_prev>, <$_next>, and <$_top>
29.3.4.1 Redefining text-link browse macros
29.3.4.2 Redefining button browse macros
29.3.5 Understanding browse keyword scope and default values
29.3.6 Specifying where to invoke a browse macro
29.3.7 Considering an example of browse navigation
30. Mapping text formats to HTML/XML
30.1 Choosing how to map formats
30.2 Mapping paragraph formats
30.2.1 Assigning HTML tags and attributes to paragraph formats
30.2.2 Designating script paragraph formats
30.2.3 Overriding paragraph properties
30.2.4 Stripping paragraph properties
30.2.5 Providing content for empty paragraphs
30.2.6 Eliminating unwanted paragraphs
30.3 Mapping character formats
30.4 Mapping special characters
30.4.1 Converting Western European accented characters
30.4.2 Mapping individual special characters
30.4.3 Avoiding use of special characters in URIs
30.4.4 Preventing character mapping
30.5 Mapping fonts
30.5.1 Specifying a default font and size
30.5.2 Including or excluding font tags
30.5.3 Excluding the face attribute from font tags
30.5.4 Accommodating browser font-rendering differences
30.6 Managing typographic elements for HTML or XML
30.6.1 Deciding whether to suppress typographic elements
30.6.2 Choosing how to treat typographic elements
30.7 Specifying text colors
30.8 Configuring preformatted text for HTML/XML
30.9 Converting footnotes to HTML or XML
30.9.1 Configuring and placing footnotes
30.9.2 Eliminating links to jump footnotes
30.9.3 Using list tags or <div> and <p> tags for jump footnotes
30.9.4 Formatting jump footnote text with macros
30.10 Converting list formats to HTML (
deprecated
)
30.10.1 Understanding the problem with HTML lists
30.10.2 Converting list formats to HTML list styles
30.10.2.1 Specifying HTML list styles (
deprecated
)
30.10.2.2 Converting lists with multiple paragraph formats
30.10.2.3 Converting nested lists
30.10.2.4 Converting dictionary lists
30.10.2.5 Omitting CSS class attributes from list entries
30.10.2.6 Including or excluding the type list attribute
30.10.3 Indenting list items
30.10.3.1 Adjusting the second-line list indent in CSS
30.10.3.2 Inserting spaces between first-line list autonumber and text
30.10.4 Converting list formats to HTML/XML paragraphs
31. Setting up CSS for HTML
31.1 Deciding whether to use CSS
31.2 Understanding how to use CSS
31.3 Understanding how
DITA2Go
generates CSS
31.4 Specifying CSS file and link options
31.4.1 Specifying CSS options in a
DITA2Go
configuration file
31.4.2 Designating and locating a CSS file
31.4.3 Directing
DITA2Go
to generate a CSS file
31.4.4 Understanding effects of the older Stylesheet setting
31.5 Understanding how CSS affects other options
31.6 Linking to alternate CSS files
31.6.1 Selecting a CSS file at run time
31.6.2 Changing CSS files in the middle of a document
31.6.3 Customizing the CSS link tag
31.6.4 Using an alternate CSS link tag for Netscape 4
31.7 Assigning CSS classes
31.7.1 Understanding CSS class name restrictions
31.7.2 Mapping paragraph formats to CSS classes
31.7.3 Mapping character formats to tags or span classes
31.7.4 Assigning CSS classes to table formats
31.7.5 Assigning CSS classes to text and table footnotes
31.7.6 Assigning CSS classes based on Unicode character ranges
31.7.7 Using link format names as CSS class names
31.7.8 Using CSS class names as tags for XML
31.7.9 Omitting tags from CSS selectors
31.7.10 Overriding CSS class for selected paragraphs
31.8 Customizing CSS properties
31.8.1 Specifying CSS <body> tag properties
31.8.2 Specifying CSS size values and units of measurement
31.8.3 Overriding styles in
DITA2Go
-generated CSS files
31.8.4 Adjusting leading (line spacing) in CSS
31.8.5 Preventing <font> tags from overriding CSS properties
32. Including graphics in HTML
32.1 Locating graphics files for HTML
32.2 Specifying options for HTML graphics
32.3 Omitting graphics from HTML output
32.4 Selecting and modifying graphics
32.4.1 Assigning properties to sets of graphics
32.4.1.1 Using wildcards to assign properties to graphics
32.4.1.2 Using PI markers to assign properties to graphics
32.4.1.3 Specifying an image class for a graphic
32.4.1.4 Creating named groups of graphics
32.4.2 Replacing or surrounding a graphic with macro code
32.4.3 Omitting paragraph tags around graphics
32.5 Positioning graphics in HTML output
32.6 Specifying HTML image attributes
32.7 Providing (or omitting) alternate text for images
32.8 Scaling images for HTML
32.8.1 Excluding image size attributes from HTML
32.8.2 Adjusting image size for selected graphics
32.8.3 Specifying px units for graphics sized in pixels
32.9 Creating image maps for HTML
32.9.1 Providing alternate text for a hotspot in an image map
32.9.1.1 Assigning alternate text to an image-map hotspot
32.9.1.2 Using the title attribute for alternate text for a hotspot
32.9.2 Specifying jumps from image maps in framesets
32.10 Supplying a background image or watermark
33. Converting tables to HTML
33.1 Assigning properties to tables
33.1.1 Understanding precedence of assignment methods
33.1.2 Overriding default table and cell properties and attributes
33.2 Defining sets of tables
33.2.1 Creating table groups
33.2.2 Using wildcards to specify table sets
33.3 Specifying table structure
33.3.1 Choosing the table structure model
33.3.2 Identifying row and column groups and header cells
33.3.2.1 Using browser-dependent HTML tags for tables
33.3.2.2 Designating table header cells
33.3.2.3 Enumerating table column groups
33.3.2.4 Wrapping table row groups
33.3.2.5 Positioning table footer rows (
deprecated
)
33.3.2.6 Overriding row and column group settings
33.3.3 Identifying table headers and footers
33.3.3.1 Specifying default header and footer counts for all tables
33.3.3.2 Specifying different header and footer counts for selected tables
33.4 Specifying table attributes
33.4.1 Specifying attributes for all tables
33.4.2 Overriding attributes for selected tables
33.4.3 Assigning a CSS class to a table
33.4.4 Using PI markers to assign attributes to tables, rows, or cells
33.4.5 Specifying attributes for table rows
33.4.6 Specifying attributes for table cells
33.4.7 Adjusting borders, cell spacing, and cell padding
33.4.7.1 Specifying default border, cellspacing, and cellpadding values
33.4.7.2 Taming border, cellspacing, and cellpadding settings
33.4.7.3 Excluding border, cellspacing, and cellpadding attributes
33.4.8 Determining the width of table columns
33.4.8.1 Specifying a method for determining table column widths
33.4.8.2 Overriding the default table column sizing method
33.4.8.3 Maintaining the width of table columns via relative sizing
33.4.9 Deciding what to do with empty paragraphs in table cells
33.5 Using macros to control table properties
33.5.1 Invoking macros around tables
33.5.2 Adding space before tables
33.5.3 Adjusting space after tables
33.5.4 Turning processing on and off around selected tables
33.5.5 Specifying row-group, row, and cell attributes with macros
33.5.6 Capturing table row and column counts with variables
33.5.7 Selectively modifying table text with macros: an example
33.6 Converting tables to paragraphs
33.6.1 Removing table-specific tags from all tables
33.6.2 Removing table-specific tags from selected tables
33.6.3 Removing table-specific tags from complex tables
V. Web Accessibility Initiative
34. Generating WAI markup for HTML
34.1 Comparing
DITA2Go
markup methods for WAI
34.1.1 Choosing a markup method for WAI attributes
34.1.2 Using paragraph formats for WAI attributes
34.1.3 Inserting PI markers for WAI attributes
34.2 Applying WAI markup to images
34.2.1 Following WAI guidelines for images
34.2.2 Using special paragraphs to assign WAI image attributes
34.2.3 Using a PI marker to assign WAI image attributes
34.3 Applying WAI markup to links
34.3.1 Following WAI guidelines for links
34.3.2 Using special paragraphs to assign WAI link attributes
34.3.3 Using a PI marker to assign WAI link attributes
34.4 Applying WAI markup to tables
34.4.1 Following WAI guidelines for tables
34.4.2 Choosing a WAI markup method for tables
34.4.3 Providing table summary and title information
34.4.3.1 Using a table attribute for summary or title
34.4.3.2 Using a special paragraph format for table summary or title
34.4.3.3 Using a PI marker for table summary or title
34.4.4 Identifying table row and column information
35. Identifying HTML table structure for WAI
35.1 Identifying table rows and columns
35.1.1 Developing a strategy for row and column markup
35.1.2 Comparing scope and id/headers accessibility methods
35.1.3 Specifying a default accessibility method
35.1.3.1 Establishing a basic policy for table accessibility
35.1.3.2 Applying the scope method to all tables
35.1.3.3 Applying the id/headers method to all tables
35.1.4 Overriding the default accessibility method
35.2 Associating table cells with header cells
35.2.1 Specifying group properties for header cells
35.2.1.1 Defining blocks of header cells
35.2.1.2 Using header cells to define column groups
35.2.1.3 Using header cells to define row groups
35.2.2 Using paragraph formats for table-cell attributes
35.2.2.1 Choosing how to use paragraph formats for WAI markup
35.2.2.2 Assigning WAI attributes to paragraph formats
35.2.2.3 Assigning values to WAI attributes
35.2.2.4 Specifying a different HTML table-cell tag
35.2.2.5 Identifying table cells with formats: an example
35.2.3 Using special paragraphs for table-cell attributes
35.2.4 Using PI markers for table-cell attributes
36. Marking HTML table cells for WAI
36.1 Understanding table cell settings
36.2 Using the scope method to identify table cells
36.3 Using the id/headers method to identify table cells
36.3.1 Choosing an id/headers level
36.3.2 Specifying id/headers attributes for table cells
36.3.3 Grouping header cells for identification
36.3.4 Column-group and row-group extent
36.3.5 Choosing a different row-group method
36.3.6 Using span attributes to identify rows and columns
36.3.7 Column-span and row-span extent
36.3.8 Identifying individual table cells by row and column
36.3.9 Column and row extent
36.3.10 Using span IDs with row or column IDs
36.4 Overriding default table-cell settings
36.5 Using ColGroup and RowGroup cells
36.5.1 Understanding how the ColGroup property works
36.5.2 Understanding how the RowGroup property works
VI. Advanced topics
37. Working with macros
37.1 Defining and invoking macros
37.1.1 Defining macros
37.1.1.1 Understanding what a macro definition can include
37.1.1.2 Understanding where you can define named macros
37.1.1.3 Escaping special characters in macro definitions
37.1.1.4 Managing line breaks in macro definitions
37.1.1.5 Including comments in macro definitions
37.1.1.6 Obtaining RTF code for macro definitions
37.1.2 Invoking a macro
37.1.3 Nesting macros
37.1.4 Using predefined macros
37.2 Accessing
DITA2Go
macro libraries
37.2.1 Understanding
DITA2Go
-supplied macro libraries
37.2.2 Modifying
DITA2Go
-supplied macro definitions
37.2.3 Storing a macro definition in a separate file
37.2.4 Including macro definitions in your own macro library
37.2.4.1 Creating a macro library
37.2.4.2 Creating a file-specific macro library
37.2.4.3 Creating a chain of macro libraries
37.3 Using macro variables
37.3.1 Creating and invoking macro variables
37.3.1.1 Naming macro variables
37.3.1.2 Creating a macro variable
37.3.1.3 Invoking a macro variable
37.3.2 Assigning values to macro variables
37.3.3 Incrementing and decrementing macro variables
37.3.4 Using predefined macro variables
37.3.5 Creating macro variables from paragraph content
37.3.5.1 Capturing paragraph content with the TextStore property
37.3.5.2 Inserting code with the CodeStore property
37.3.5.3 Understanding why TextStore and CodeStore work differently
37.4 Using multiple-value list variables
37.4.1 Understanding list-variable syntax
37.4.2 Assigning a value to a list-variable item
37.4.3 Initializing list variables
37.4.4 Using macros to process lists
37.4.5 Using pointers to process lists
37.4.6 Using a list instead of a conditional expression
37.5 Accessing settings with configuration macros
37.5.1 Understanding configuration macros and variables
37.5.2 Determining the value of a configuration variable
37.5.3 Deploying configuration macros
37.6 Using expressions in macros
37.6.1 Understanding macro expressions
37.6.2 Understanding operands and operators
37.6.3 Displaying expression results in output
37.6.4 Using control structures in expressions
37.6.4.1 Understanding control-structure elements
37.6.4.2 Using conditional expressions
37.6.4.3 Using loop structures
37.6.5 Specifying substrings in expressions
37.6.6 Using list variables in expressions
37.6.7 Using indirection in expressions
37.6.8 Removing spaces from strings: an example
37.7 Passing a parameter to a macro
37.8 Debugging macros
37.9 Deploying macros and macro variables
37.9.1 Understanding where to use macros and macro variables
37.9.2 Invoking macros at predetermined points in output
37.9.3 Surrounding or replacing text with code or macros
37.9.4 Assigning macros to graphics or tables for HTML
37.9.5 Redefining navigation macros in HTML
37.9.6 Using HTML Macro PI markers to invoke macros
37.9.7 Implementing drop-down text with macros
37.10 Using macros to fine-tune HTML or XML output
38. Working with processing instructions
38.1 Understanding
DITA2Go
PI markers
38.1.1 Understanding
DITA2Go
PI marker syntax
38.1.2 Including special characters in PI markers
38.1.3 Deciding when to use PI markers
38.2 Understanding effects of PI markers
38.3 Adding attributes with PI markers
38.4 Inserting code or text with PI markers
39. Working with templates
39.1 Working with configuration templates
39.1.1 Understanding how templates are organized
39.1.2 Understanding how templates are named
39.1.3 Understanding how templates are chained together
39.1.4 Understanding how macro libraries are organized
39.1.5 Understanding how format templates are organized
39.1.6 Understanding how language templates are organized
39.2 Referencing configuration files and templates
39.3 Including document-specific configuration files
39.3.1 Understanding document-specific configuration files
39.3.2 Referencing a document-specific configuration file
39.3.3 Deciding where to keep document-specific configuration files
39.4 Deciding which configuration file to edit
39.4.1 Understanding what configuration files are available
39.4.2 Editing a project configuration file
39.4.3 Editing a document-specific configuration file
39.4.4 Editing an output-specific configuration file
39.4.5 Editing a format configuration file
39.4.6 Editing a language configuration file
39.4.7 Editing a macro configuration file
39.5 Creating your own configuration templates
39.5.1 Creating a template from a project configuration file
39.5.2 Deciding what to include in a general configuration template
39.5.3 Chaining configuration templates
40. Working with graphics
40.1 Choosing an appropriate graphics format
40.1.1 Graphics formats for Word documents
40.1.2 Graphics formats for WinHelp
40.1.3 WMF format limitations
40.1.4 Graphics formats for HTML
40.2 Replacing and relocating graphics files
40.2.1 Changing graphics files for HTML output
40.2.1.1 Specifying graphics location for HTML
40.2.1.2 Substituting graphics files for HTML
40.2.1.3 Overriding path specifications for referenced graphics
40.2.2 Changing graphics files for RTF output
40.2.2.1 Substituting graphics files for RTF
40.2.2.1.1 Substituting files with different extensions
40.2.2.1.2 Substituting files with different names or locations
40.2.2.1.3 Understanding replacement examples
40.2.2.2 Using already converted graphics for RTF
40.2.2.3 Excluding graphics from RTF output
40.3 Specifying custom settings for individual graphics
41. Working with content models
41.1 Understanding
DITA2Go
content models
41.2 Modifying or replacing a content model
41.2.1 Obtaining a copy of a built-in content-model
41.2.2 Generating a content model from a DTD
41.3 Preparing a content model for use with
DITA2Go
41.4 Understanding content-model configurations
41.4.1 Content model [Topic] settings
41.4.2 Content model [ElementSets] settings
41.4.3 Content model [TopicParents] settings
41.4.4 Content model [TopicFirst] settings
41.4.5 Content model [TopicLevels] settings
41.5 Understanding how
DITA2Go
uses content models
41.6 Inspecting and correcting element types
41.7 Specializing or modifying DITA topic types
41.7.1 Creating a content model for a specialized topic type
41.7.2 Overriding settings in a DITA content model
41.7.3 Eliminating elements from a DITA content model
41.7.4 Overriding declarations in a DITA map content model
41.7.5 Listing DITA topic type configuration files
41.7.6 Locating DITA topic type configuration files
41.8 Extracting content-model debug information
42. Overriding configuration settings
42.1 Using a different configuration for selected files
42.1.1 Providing configuration files for individual ditamaps
42.1.2 Understanding precedence of configuration settings
42.2 Overriding settings with PI markers or macros
42.2.1 Determining the extent of a configuration override
42.2.2 Overriding settings with configuration PI markers
42.2.3 Overriding settings with macros
42.2.4 Assigning values to configuration variables
42.2.5 Adding a new configuration setting on the fly
42.2.6 Assigning a macro or variable to a configuration variable
42.2.7 Understanding fixed-key vs. variable-key settings
42.2.8 Overriding fixed-key configuration settings
42.2.9 Overriding variable-key configuration settings
42.2.9.1 Overriding paragraph and character format properties
42.2.9.2 Overriding cross-reference properties
42.2.9.3 Overriding table properties for HTML
42.2.9.4 Overriding graphic properties for HTML
42.2.10 Assigning HTML table and graphic groups with overrides
42.3 Overriding configuration settings with text
VII. Project workflow automation
43. Automating
DITA2Go
conversions
43.1 Executing operating-system commands
43.1.1 Specifying system commands
43.1.2 Including macros and variables in system commands
43.1.3 Monitoring system command execution
43.1.4 Supplying system commands in a .bat file
43.1.5 Supplying system commands in a macro
43.2 Renaming output files for automated systems
43.2.1 Renaming individual output files
43.2.2 Using PI markers to name output files
43.2.3 Using paragraph formats to name output files
43.2.3.1 Constructing file names based on paragraph content
43.2.3.2 Basing output file names on existing paragraph formats
43.2.3.3 Creating special paragraph formats to name output files
43.2.3.4 Specifying a file-name prefix or suffix
43.2.3.5 Constructing file names from multiple paragraph formats
43.2.3.6 Preventing duplicate file names based on paragraph formats
44. Producing deliverable results
44.1 Understanding
DITA2Go
pre- and post-processing
44.2 Activating and logging production of deliverables
44.3 Understanding path values for deliverables
44.4 Clearing out old files before converting
44.4.1 Specifying when to delete old files from the project directory
44.4.2 Specifying which files to delete from the project directory
44.4.3 Understanding when not to delete .ref and .htm files
44.5 Gathering additional files before converting
44.6 Assembling files for distribution
44.6.1 Specifying a wrap directory
44.6.2 Emptying the wrap directory before copying
44.6.3 Listing files to copy to the wrap directory
44.6.4 Understanding when to use other file copy settings
44.6.5 Understanding which files are copied from where
44.6.6 Listing extracurricular files to put in the wrap directory
44.7 Placing graphics files for distribution
44.7.1 Copying referenced graphics to a distribution directory
44.7.2 Selecting graphics to copy from arbitrary locations
44.7.3 Deleting prior contents of the graphics destination directory
44.7.4 Synchronizing graphics settings for HTML output
44.7.5 Synchronizing graphics settings for RTF output
44.8 Placing CSS or XSL files for assembly
44.9 Gathering files for an HTML project: an example
44.10 Gathering and processing Help-system files
44.11 Archiving deliverables
44.11.1 Specifying an archiving command
44.11.2 Supplying parameters for the archiving command
44.11.3 Specifying archive file name and optional version
44.12 Placing deliverables in a shipping directory
44.12.1 Specifying a shipping directory for deliverables
44.12.2 Understanding which files are placed in the shipping directory
44.12.3 Choosing whether to copy or move deliverables
44.13 Postprocessing separately from converting
45. Converting via DCL
45.1 How the DCL filter works
45.2 Using the DCL filter
45.2.1 Understanding where to run DCL
45.2.2 Preparing for conversion
45.2.3 Converting a single DITA or DCL file
45.2.4 Converting a group of files
45.3 DCL command-line syntax
45.3.1 Command-line switch -f
format
45.3.2
Command-line switch -o
output
45.3.3 Command-line argument
input
...
45.3.4
Command-line switch -v
45.3.5 Additional command-line switches
45.4 Specifying output file paths and names
45.5 About DCL technology
45.5.1 DCL file structure
45.5.2 Writing DCL conversion modules
46. Creating a map with
DITA2Map
46.1 Understanding how
DITA2Map
works
46.2 Setting up a
DITA2Map
project
46.3 Specifying
DITA2Map
configuration options
46.3.1 Locating a DITA DTD
46.3.2 Locating configuration template files
46.3.3 Specifying processing options
46.3.4 Specifying logging options
46.3.5 Specifying map options for
DITA2Map
46.4 Running
DITA2Map
VIII. Reference
A. Technical support for
DITA2Go
A.1 Evaluation version is different
A.2 Things to check first
A.2.1 Examine your conversion log file
A.2.2 Check your
DITA2Go
installation
A.2.3 Check the
DITA2Go
User’s Guide
A.2.4 Check path and file names
A.2.5 Check your version of
DITA2Go
A.2.6 Narrow down the problem
A.3 How to request help
A.3.1 If the problem involves a crash
A.3.2 Scope the problem
A.3.3 Document the problem
A.3.4 Package the problem
A.3.5 Send the package to Omni Systems
B. Element type default properties
C. Content model configuration