30.5.1 Understanding what configuration files are available

Most of the supplied Mif2Go configuration files available for editing are located in subdirectories of %OMSYSHOME%\m2g\local, with the following exceptions: 

• Starting project configuration file, copied by Mif2Go from %OMSYSHOME%\m2g\local\starts (or from %OMSYSHOME%\m2g\system\starts) to your project directory

• Document-specific configuration files you have placed in the Mif2Go documents subdirectory or in the document _config subdirectory; see §30.3.3 Deciding where to keep document-specific configuration files

• Site-specific configuration file local_omsys.ini, located in %OMSYSHOME%\common\local\config.

Table 30-3 lists the types of configuration files, shows where the files are located, and indicates the intended scope of settings for each type.

Table 30-3 Intended scope of settings by configuration type

Type	Orientation	Location of file(s)	Intended scope of settings
General	Project-specific	Project directory	Current project only
	Source-specific	..\_config (parallel to project directory)	All or most outputs to be generated from a given FrameMaker source document
	Output-specific	m2g\local\config	All or most FrameMaker source documents to be converted to a given output type
	Mif2Go-wide	m2g\local\config	All Mif2Go projects for all documents and outputs
	Site-wide	common\local\config	All Omni Systems projects
Macro	Usually output-specific	m2g\local\macros	All or most outputs of a given output type or set of output types

Each configuration file in a \m2g\local subdirectory references an eponymous configuration template in a \m2g\system subdirectory that contains default settings. Do not edit those referenced templates, because they will be overwritten whenever you update Mif2Go. Instead, override settings in the corresponding \local configuration file.

Table 30-4 shows a sample hierarchy of configuration files for an HTML Help project, with the most widely applicable configuration at the top of the chain, and the most narrowly applicable (the project configuration file) at the bottom. With the exception of the document-specific configuration file (shown in green), each file in Table 30-4 references the file above it. The project configuration file at the bottom references both the document-specific file and the next configuration file above that.

Each configuration file in the chain can override settings in all those above it in Table 30-4. This is true even for a document-specific configuration file that does not reference any of the other configuration files, because it is treated as though it were right above the project configuration file. If a document-specific configuration file does reference other configuration files, Mif2Go treats all their settings as overruling any files above the project configuration file in the main chain.

Note:  Edit only the files shaded in blue or green; the others are system files.

Table 30-4 Chain of general configuration files for HTML Help output

Scope of settings		General configuration file
All Omni Systems projects	System:	%OMSYSHOME%\common\system\config\omsys.ini
	Local site:	%OMSYSHOME%\common\local\config\local_omsys.ini
All Mif2Go projects	System:	%OMSYSHOME%\m2g\system\config\m2g_config.ini
	Local site:	%OMSYSHOME%\m2g\local\config\local_m2g_config.ini
All HTML/XML projects	System:	%OMSYSHOME%\m2g\system\config\m2htm_config.ini
	Local site:	%OMSYSHOME%\m2g\local\config\local_m2htm_config.ini
All Help projects	System:	%OMSYSHOME%\m2g\system\config\m2help_config.ini
	Local site:	%OMSYSHOME%\m2g\local\config\local_m2help_config.ini
All HTML Help projects	System:	%OMSYSHOME%\m2g\system\config\m2htmlhelp_config.ini
	Local site:	%OMSYSHOME%\m2g\local\config\local_m2htmlhelp_config.ini
All HTML output types from this source document		..\_config\html_doc.ini (parallel to project directory)
This project only		_m2htmlhelp.ini (in project directory)

General configuration settings

If you have just one FrameMaker document to convert to a single output type, most general configuration settings can go in the project configuration file; see §30.5.2 Editing a project configuration file.

If you think you might want to produce other types of output from the same source document, settings that are the same for all output types (but that would be different for other source documents) can go in a document-specific configuration file; that way you avoid duplicating the settings in every project configuration file. See §30.5.3 Editing a document-specific configuration file.

If you have many FrameMaker documents to convert to a single output type, settings that are specific to that output type and the same for every document (but that would be different for other output types) can go in the appropriate output-specific configuration file; see §30.5.4 Editing an output-specific configuration file.

Macro configuration files

You can add macros to editable source-specific, output-specific, or project configuration files, as needed. Or you can add them to a macro library configuration file in m2g\local\macros. See §30.5.5 Editing a macro configuration file.

---