1.3.6 Establish system-wide configuration settings

To specify values for system-wide settings that apply to all Omni Systems applications, open the following configuration file in a text editor:

%omsyshome%\common\local\config\local_omsys.ini

This configuration file is accessed by all other Mif2Go configuration files, through chains of links; the settings it contains are available to all Mif2Go projects. You can place in this file any setting that will apply to most or all of your DITA2Go and Mif2Go projects. For particular FrameMaker documents or conversion projects, you can override these settings in output- or document-specific configuration files.

Note:  For proper syntax, see §4.3 Understanding the rules for configuration settings.

Specify settings for any of the following features that might be required for your conversion projects:

Archiving program and options

HTML Help compiler command

Eclipse Help zip command

JavaHelp, Oracle Help index and JAR commands

WinHelp copyright statement and compiler command

Location of document-specific settings

Archiving program and options

Mif2Go can package the output from your conversion projects in .zip files for distribution. You must provide an archiving program that can be run from a command line, and specify appropriate parameters:

[Automation]

ArchiveCommand = path\to\archiver

ArchiveStartParams = parameters preceding name of archive file

ArchiveEndParams = parameters following name of archive file

ArchiveExt = file extension; usually zip

MoveArchive = Yes to move archive, No to copy archive

LogAuto = Yes to record archiving steps in the run log

See §35.11 Archiving deliverables. The starting and ending parameters for the archive command have default values; for some output types you will need to override these defaults in your project configuration file.

HTML Help compiler command

For HTML Help projects, Mif2Go can run the Microsoft HTML Help compiler for you, to produce compiled CHM files. Unless the compiler is on your system PATH, you must tell Mif2Go where to find it:

[MSHtmlHelpOptions]

Compiler = path\to\hhc

See §9.13.1 Directing Mif2Go to run the HTML Help compiler.

Eclipse Help zip command

For Eclipse Help projects, Mif2Go can package your HTML topic files in doc.zip. You must provide an archiving program that can be run from a command line, and specify appropriate parameters:

[EclipseHelpOptions]

ZipCommand = path\to\archiver

ZipParams = all required parameters

See §12.8 Packaging Eclipse Help files.

JavaHelp, Oracle Help index and JAR commands

For JavaHelp projects, Mif2Go can run the JavaHelp indexer to produce a full-text search index, and also package the output in a .jar file. You must specify the indexer and JAR commands:

[JavaHelpOptions]

FTSCommand = path\to\jhindexer

JarCommand = path\to\jar

For Oracle Help projects, Mif2Go can run the Oracle Help indexer to produce a full-text search index:

[OracleHelpOptions]

FTSCommand = java -mx256m oracle.help.tools.index.Indexer

See §11.5 Providing full-text search for JavaHelp / Oracle Help, and §11.6.1 Creating a JAR file.

WinHelp copyright statement and compiler command

For WinHelp projects, Mif2Go can provide a copyright statement to be included in the WinHelp .hpj project file:

[HelpOptions]

HelpCopyright = your copyright statement

Mif2Go can also run the Microsoft WinHelp compiler for you, to produce compiled HLP files. Unless the WinHelp compiler is already on your system PATH, you must tell Mif2Go where to find it. For example:

[HelpOptions]

; Compiler = path\to\hcw; can include run parameters

Compiler = hcw /c /e

See §8.2.12 Compiling a WinHelp project.

Location of document-specific settings

The default location for document-specific configuration files is a directory named _config, located parallel to your project directory. To change this location, or to specify different default names for these files, you must edit values of the following options in configuration file %OMSYSHOME%\m2g\local\config\local_m2g_config.ini:

[Setup]

; Used when creating document-specific configuration files:

; LocalConfigPath = location relative to project directory

LocalConfigPath = ..\_config\

; WinHelpDocName = default document-specific .ini for WinHelp output

WinHelpDocName = winhelp_doc.ini

; WordDocName = default document-specific .ini for Word output

WordDocName = word_doc.ini

; HTMLDocName = default document-specific .ini for all HTML outputs

HTMLDocName = html_doc.ini

To determine whether the default location is appropriate, see §30.3.3 Deciding where to keep document-specific configuration files.

Your Mif2Go installation is now complete, and you can set up a Mif2Go conversion project. See §2 Planning a conversion project.