4.3 Logging conversion events

By default, whenever you convert a document, Mif2Go records conversion events in a log file named m2g_log.txt, located in your project folder. This event log lists the files opened and any error messages or warnings that result from a conversion.

To disable logging, or change the name or location of the log file:

[Logging]

; UseLog = Yes (default, log as specified in this section) or No

UseLog = Yes

; LogFileName = name with path, absolute or relative to output dir

LogFileName = m2g_log.txt

Unless you specify a different path for LogFileName, Mif2Go writes the log file to the project folder. If you specify a relative path, that path is relative to the project folder. If the file specified by LogFileName already exists, Mif2Go appends new log entries to that same file.

To start a new log file, before running a conversion you must remove, relocate, or rename the old log file, or specify a new value for LogFileName. However, because the purpose of the log is to make diagnosing problems easier, it is better to allow Mif2Go to append log entries for successive conversions. A key diagnostic approach is to compare entries from successive conversion runs; and not necessarily just the last two runs.

When UseLog=Yes, you can specify the type and the importance (or level of severity) of events Mif2Go reports in the log file:

[Logging]

; These take severity values, 1 (worst) to 9, or 0 to prevent logging

; LogErrors = 1 (default, log events that terminate process)

LogErrors = 1

; LogWarnings = 1 (default, log problems with workarounds that may

; result in undesired output)

LogWarnings = 1

; LogQuerys = 1 (default, log possible ambiguities)

LogQuerys = 1

; LogInfo = 1 (default, log process information)

LogInfo = 1

; LogDebug = 0 (default, do not log possible programming issues)

LogDebug = 0

Log entry types are as follows: 

E	Error: process terminated
W	Warning: problem with a workaround
Q	Query: possible ambiguity
I	Information only
D	Debug: possible programming issue

By default, Mif2Go logs only the most important or severe events (level 1), but not less important or less severe events (levels 2 through 9). At level 1 only the most important processing events are logged, such as the start of processing for each FrameMaker file and the identity of the software module doing the processing. Unless you specify otherwise Mif2Go does not log events classified as debugging issues.

Each log entry appended to the log file includes the following information:

• timestamp (if different from the previous entry), on a line by itself

• event type (E, W, Q, I, or D)

• severity level or importance (from 1 = most severe or important to 9 = least severe or important)

• event description.

For example:

Sat Oct 04 11:38:21 2008

I1: Starting log for dwhtm, h285z10

I1: Opened file "planning.htm" for HTML

I1: File ID is z102x

W2: Xref target ag123456 not found in intro.ref

The W2 entry is a warning, severity level 2, about a cross-reference destination missing from the Mif2Go-generated reference file for chapter intro.fm.

---

> 4 Setting configuration options > 4.3 Logging conversion events