### 44.10 Gathering and processing Help-system files

Most Help systems require additional steps after DITA2Go generates output files from your DITA document, and before archiving files for distribution. You can have DITA2Go automatically do the following:

WinHelp | Run the WinHelp compiler; see §17.2.9 Compiling a WinHelp project.
HTML Help | Run the HTML Help compiler; see §18.13 Compiling and testing HTML Help.
OmniHelp | Copy viewer files to the WrapPath directory (needed only if they are not already in the project directory); see §19.13 Assembling OmniHelp files for viewing.
JavaHelp | Run the full-text-search indexing program; see §20.5.2 Creating a search index for JavaHelp.
Oracle Help for Java | Run the full-text-search indexing program (although you might not get a usable search index); see §20.5.3 Creating a search index for Oracle Help.
Eclipse Help | Archive topic files into doc.zip; see §21.8 Packaging Eclipse Help files.

Compile WinHelp or HTML Help

To direct DITA2Go to compile WinHelp or HTML Help:

    [Automation]
    ; CompileHelp = No (default, run compiler separately),
    ; or Yes copy all needed files to the WrapPath, if given,
    ; then compile with hhc (HTML Help) or hcw (WinHelp).
    CompileHelp = Yes

By default, CompileHelp=No. See:

§17.2.5 Setting basic WinHelp options in the configuration file

§18.13 Compiling and testing HTML Help

Index JavaHelp or Oracle Help

To direct DITA2Go to run the JavaHelp or Oracle Help indexer to create a search index:

    [JavaHelpOptions] or [OracleHelpOptions]
    FTSCommand = path/to/indexer

If FTSCommand is missing or is set to blank, DITA2Go does not run the indexer. See:

§20.5 Providing full-text search for JavaHelp / Oracle Help

Certain automation settings are activated

When CompileHelp=Yes or FTSCommand=path/to/indexer, DITA2Go acts on those [Automation] settings that need to be processed prior to compilation or indexing, regardless of the setting for WrapAndShip. Then DITA2Go runs the appropriate compiler or indexer. Table 44-4 shows which settings are activated.

Table 44-4 Automation settings activated by CompileHelp or FTSCommand

[Automation] setting | Action | Ref.
    CopyCssFrom
| Copy CSS files from the designated directory | 44.8
    CopyGraphicsFrom
| Copy graphics files from the designated directory | 44.7.1
    CssCopyFiles
| Select only specified CSS files for copying | 44.8
    EmptyGraphPath
| Delete prior copied graphics files before copying | 44.7.3
    EmptyOutputDir
| Delete files from the project directory before conversion | 44.4.1
    EmptyOutputFiles
| Select only specified files to delete from the project directory | 44.4.2
    EmptyWrapPath
| Delete all files from the WrapPath directory before copying | 44.6
    GraphCopyFiles
| Select only specified graphics files for copying | 44.7.1
    WrapCopyFiles
| Copy only specified files from the project directory | 44.6
    WrapPath
| Directory to which files are copied for compiling and assembling for distribution | 44.6
    ShipPath
| Directory to which compiled or archived files are copied or moved | 44.12

Assemble files without compiling or indexing

When CompileHelp=No (the default for WinHelp and HTML Help), or FTSCommand is not specified for JavaHelp or Oracle Help, you must run the compiler or indexer separately. If WrapAndShip=Yes, uncompiled or unindexed Help-system files are assembled for distribution; see §44.2 Activating and logging production of deliverables. You might use this combination for WinHelp if you are sending files to be branded by a subcontractor, or to be integrated with other WinHelp systems. For HTML Help, you might send uncompiled files for use on a server.

Assembling and archiving are optional

For WinHelp or HTML Help, you can set the value of WrapPath for compiled Help output to blank (or explicitly to the project directory), because the Help compilers rely on a list of files to include in the compilation. Eliminating a separate wrap subdirectory avoids creating a duplicate set of output files. Also, archiving is not always necessary for compiled Help, because compilation itself creates a compressed deliverable.

Previous Topic: 44.9 Gathering files for an HTML project: an example

Next Topic: 44.11 Archiving deliverables

Parent Topic: 44. Producing deliverable results

Sibling Topics:

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.5 Gathering additional files before converting

44.6 Assembling files for distribution

44.7 Placing graphics files for distribution

44.8 Placing CSS or XSL files for assembly

44.9 Gathering files for an HTML project: an example

44.11 Archiving deliverables

44.12 Placing deliverables in a shipping directory

44.13 Postprocessing separately from converting