E RTF configuration
This section provides an annotated list of all the configuration sections, keywords, and values you can specify in configuration file mif2rtf.ini, for RTF output from Mif2Go.
§4 Setting configuration options.
; mif2rtf.ini contains initial info for the DCL MIF2RTF filter Ver 3.3
; this is m2rtf.txt for dwrtf.dll version r290 and m2rbook b108
; the first several sections apply to both WinHelp and Word conversions
; Output = Standard (default, Word RTF), Help (WinHelp), or FrameMIF
; The next three items control how names are matched to ini-file settings
; CaselessMatch = Yes (default, ignore upper/lower differences) or No
; SpacelessMatch = Yes (default, ignore embedded spaces) or No
; WildcardMatch = Yes (default, allow ? and * in settings) or No
; These two are used for diagnosis of possible memory-management problems.
; Try changing them to "Yes", one at a time, if you get a crash at the very
; end of processing, after the output files have been writtten correctly.
; This group is used only for drmif.dll
; DirectiveMarker = Frame marker type for DCL use, default 3 (Comment)
; NoSymMap = No (default, map text chars from Frame set) or Yes (unmapped)
; This one is also valid in [Graphics]
; UseGraphicPreviews = No (default) or Yes (use preview bitmaps for frames)
; The rest in [Options] are also valid in [WordOptions] and [HelpOptions]
; CharStyles sets char properties in styles (causes problems with WP)
; ParaSpace = Normal (retain above & below) or Frame (adjust above)
; ExactLineSpace = No (default, variable line height allowed) or Yes
; OccludedTabs = Remove (normal), Space, or Tab
; RMarginTabs = Left (return), Right (keep in col), Both (default), None
; UnderlineTabs = No (default, normal FrameMaker behavior) or Yes
; EmbedEqsInWMFs = Yes (default, scale to size using WMFs) or No
; EqVertAdjust = half-points to adjust equations down (negative for up)
; EqHorAdjust = half-points to adjust equations right (negative for left)
; HideWhiteText removes any white text (standard FrameMaker behavior)
; KeepAnchorParagraphs = No (default), Yes keeps anchor paras as spacers
; UseParaAnchors = No (default), Yes for successive paras in same frame
; UseInitDialog = Yes (default, to display dialog before conversion) or No
; UseDoneDialog = Yes (default, to display dialog after conversion) or No
; UseExistingMIF = No (default, save new .mif file) or Yes (use if it exists)
; DeleteMIF = No (default, keep MIF file when RTF is done) or Yes (delete it)
; UseExistingDCL = No (default, make .dcb) or Yes (use .dcl file if it exists)
; Suffixes to use for each output type
; WinHelp is always .rtf, others are settable
; ConfigTemplate = path to .ini file to be used when mif2rtf.ini and any
; specific filename.ini do not contain the setting being checked. The
; referenced file can also contain [FDK]ConfigTemplate, so the chain of
; templates searched can be any length. However, all files in the chain
; must have distinct names; the chain stops if it finds a repeat.
ConfigTemplate=D:/path/to/template.ini
; Settings for FrameMIF projects
; MakeBookMIF = Yes (default, make MIF of book file too) or No
; MIFBookSuffix = suffix to use for book file MIF, default ".mif"
; OrigExtForMIF = Yes (default, use original FM file extensions) or No
; WriteEquations = No (default) or Yes (write equations as graphics files)
; WriteAllGraphics = No (default) or Yes (write all anchored frames as files)
; WriteRefPageGraphics = Yes (default) or No (exclude reference frames)
; WriteMasterPageGraphics = Yes (default) or No (exclude header/footer graphics)
; UseGraphicFileID = Yes (default) or No (single-file projects only)
; GraphicNameDigits = 6 (default), or 4 to 8 (for longer or shorter names)
; GraphicsFirst = No (default, write only needed graphics after DCL process),
; or Yes (old way, write graphics of the types specified before DCL process)
; EquationExportDPI = number (from 50 to 1200, default 120)
; EquationFrameExpand = percentage of original size (default 125)
; GraphicExportDPI = number (from 50 to 1200, default 96)
; GraphicExportFormat = BMP, TIFF, WMF (default), JPEG, GIF, PNG, EPS,
; ApplyTemplateFile = No (default) or Yes (save and restore around it)
; TemplateFileName = filename.fm (FrameMaker template for export)
; AppliedTemplateFlags = 0 (default) or bitfield spec of properties
; 0=all + 1=PgfFmt + 2=CharFmt + 4=PageLayout + 8=TblFmt + 16=CondText +
; 32=RefPage + 64=VarDef + 128=CrossRef + 256=ColorDef + 512=MathDefs +
; 1024=DocProps + 16384=RemoveManPageBreaks + 32768=RemoveOverrides
; ImportDocProps = Yes (default) or No (exclude doc props from import)
; SetFrameConditions = No (default) or Yes (set per [ConditionsShown]
; after template import, if any).
; ConvertVariables = No (default) or Yes (convert to plain text)
; GenerateBook = No (default) or Yes (generate after import)
; UseFrameTOC = Yes (default, except for Help formats), or No (default
; UseFrameIX = Yes (default, except for Help formats), or No (default
; UseFrameGenFiles = Yes (default for all formats), or No
; PrjFileName = name of project file that references this directory
;PrjFileName=D:/path/to/yourbook.prj
; IDFileName = name of file that contains [FileIDs] for this project
;IDFileName=D:/path/to/mif2go.ini
; UseLocalFileID = No (default, use IDFile IDs) or Yes (use [FileIDs] here)
; PluginVersion = version identifier for m2rbook.dll last used, written
; by plugin at the start of each run. Check it against the version of
; m2rbookNN.zip in the downloads dir on the Web site to make sure you are
; using the most current version.
; CompileHelp = No (default, run compiler separately), or Yes (WinHelp only,
; copy all needed files to the WrapPath, if given, then compile with "hcw /c"
; for WinHelp 4, or "hcp" for WinHelp 3)
; KeepCompileWindow = No (default) or Yes (so WinHelp error messages can be seen)
; WrapAndShip = No (default) or Yes (use WrapPath, ArchiveCommand, ShipPath,
; and Copy/Empty settings as described below)
; WrapPath = path to dir to contain the files to be wrapped for distribution;
; when ArchiveCommand or CompileHelp are specified, dir where that is done,
; after which the result (.hlp or .zip) is copied to ShipPath.
; The files copied are specified in WrapCopyFiles, with defaults given below:
; For WinHelp, files copied are *.rtf, *.hpj, *.cnt, and *.h.
; For Word, files copied are *.rtf.
; For both formats, the GraphCopyFiles (default *.bmp and *.wmf) are copied
; to WrapPath as well; for WH, *.shg is also included. If CopyGraphicsFrom
; is set, any GraphCopyFiles files are also copied from there to WrapPath.
; WrapCopyFiles = list of files to copy, separated by spaces, wildcards
; and paths (relative and absolute) allowed, no spaces within an item,
; overrides the defaults shown above.
; EmptyWrapPath = Yes (default, remove all files before copying)
; or No (leave old files in place in WrapPath directory)
; CopyGraphicsFrom = path to dir containing the graphics files, relative OK
; GraphCopyFiles = list of files to copy from CopyGraphicsFrom and output
; directories, separated by spaces, wildcards and paths (relative and absolute)
; allowed, no spaces within an item, default is: *.bmp *.wmf (and *.shg for WH)
; ArchiveCommand = for Word, zip command, result is put in ShipPath. If
; omitted, archiving is not done, and files remain in WrapPath if given.
; ArchiveStartParams = any parameters preceding the name of the archive file,
; default empty, specify ArchiveStartParams=-add for pkzip.
; ArchiveEndParams = any parameters following the name of the archive file,
; default empty, specify ArchiveEndParams=*.* for pkzip.
; ArchiveName = name for archive to be created, without extension, to be
; used if ArchiveCommand is specified. Default for WinHelp is HPJFileName,
; for Word it is the PrjFileName without path.
; ArchiveVer = version number if any to be appended to ArchiveName
; ArchiveExt = the correct extension to be added for the archive type,
; ShipPath = path to dir to contain final result of archiving or compilation,
; possibly the same for several projects.
;ShipPath=D:\deliverables\new_versions
; MoveArchive = No (default, copy archive to ShipPath) or Yes (move
; archive to ShipPath instead of copying it)
; EmptyOutputDir = Never (default), Book (when running a full book),
; or File (for running a single-file project with no external links).
; EmptyOutputFiles = list of files to delete, separated by spaces,
; wildcards allowed but not paths, no spaces within an item, default
; "*.rtf *.grx". Do not use "*.*" or "*.ini".
; DeleteExistingMIF = No (default) or Yes (delete *.mif from the
; output directory before the conversion if UseExistingMIF is not set).
; LogAuto=No (default) or Yes (put a copy of each command given into the
; Frame console window, including md and cd settings but not error msgs)
; OnlyAuto = No (default) or Yes (run only CompileHelp and WrapAndShip
; functions, not including Book/FileCommands, rather than the full real
; conversion which was presumably run earlier)
; RunfmDiagnostics = No (default) or Yes (include more diagnostic
; messages in the Frame console file when running from runfm)
; The book start and end commands below can contain the variables:
; <$$_basename> = base name (without path or ext) of current book
; <$$_prjpath> = path to source directory (with .prj file), no ending slash
; <$$_currpath> = path to current directory (with .ini), no ending slash
; They can also contain any entry in [UserVars], below, within <$$...>.
; BookStartCommand = command line to be run at start of book processing
; BookEndCommand = command line run at end of book (after help compiler)
; BookCommandWindow = Hide (default, no display), Keep (show until user
; dismisses), Show (during execution only)
; The file start and end commands apply when the selection is a doc
; rather than a book file; they are similar to the book commands, except
; that the file commands csn be overridden in a specific filename.ini.
; FileStartCommand = command line to be run at start of file processing
; FileEndCommand = command line run at end of file (after help compiler)
; AskForUserVars = Never (default), Always, or Once (then set to Never)
; These variables can be used in the book commands above, in the macros
; used in RTF output, or in both. Enclose them in <$$...> like other
; macro variables. This section is searched after the [MacroVariable]
; section in this file, but before the same section in the macros file.
; When using AskForUserVars, use the starting content to explain what
; is wanted for the value (requested just before the BookStartCommand).
;version=Specify the version of the doc product
; var name = prompt to use when the value is requested, default is:
; Edit content of variable, or supply new content:
;version=Enter current version number:
; MacroFile = name of RTF macro library file, ext .ini, path optional
; checked for macro section if no matching section found here first;
; macro files can name a macro file too, the search proceeds up the
; chain until there are no more macro files or the macro or var is found.
MacroFile=d:/path/to/m2rmacro.ini
; FixMacroQuotes = No (default) or Yes (change baseline and curly quotes)
; OmitMacroReturns = No (default) or Yes (omit macro linebreaks in output)
; MacroVarNesting = Yes (default, vars contain <>) or No (first > ends var)
; MacroNestMax = maximum depth of macro calls in one statement
; used to prevent runaways when macros call each other in circles
; RepeatMax = maximum count for <$_repeat> when value is not given, so that
; loop continues until a <$_break cond> is met
; WhileMax = maximum count for <$_while>, to prevent runaways; the current
; count can be accessed using the predefined macro variable <$$_wcount>
; NameUndefinedMacros = No (default) or Yes (insert $macro name in output)
; NameUndefinedMacroVars = No (default) or Yes (insert $$macrovar name in output)
; ConditionName = Yes to show or No to hide. Any not mentioned
; are left in their current state; any not found are ignored.
; FontSize and LineSpacing are in twips, 240 = 12pt
; FontWidth is width in twips for a 12pt en space
; Language is the decimal Unicode for the RTF default language
; It overrides the type in the source doc if given.
; US English 1033, UK English 2057, Oz English 3081, German 1031
; Document font name = RTF font name
; for winhelp, stick to TT fonts in the RTF
; MS Serif and MS Sans Serif are always available,
; but only at 8, 10, 12, 14, 18, and 24pt sizes
; these change from PS fonts to the corresponding TT
Century Schoolbook=NewCenturySchlbk
; RTF font name = relative width, used to compute line length for tabs
; reduce slightly if needed tabs omitted, increase if extra tabs present
; add entries for any additional fonts used in RTF documents
;used in RTF fontlist: 0 = fnil, 1 = froman, 2 = fswiss,
; 3 = fmodern, 4 = fscript, 5 = fdecor, 6 = ftech
;for WinHelp 3, all chars of type 5 fonts are replaced by bullet.bmp
; if the type is 32 to 254, all chars are replaced by char of that value
; see BitmapChars below for a more flexible option for WinHelp use
; Font name = value to use in font table for fcharset
; Default for FontTypes 5 and 6 = 2, for all others = 0
; Use 204 for Cyrillic fonts, as in:
; Others include: Baltic 186, Central European 238, Greek 161,
; Johab 130, Mac 77, Thai 222, Turkish 162, and Vietnamese 163
; For Frame 8 Unicode, only Cyr 204, CE 238, Greek 161, and
; Tur 162 are supported. Others will be added as requested.
; The [FontEncoding] for these for Times New Roman, Arial, and
; Courier New is built in for Frame 8 conversions and need not
; For conversions from Frame 8 Unicode, the default fonts used
; for characters that are not in the Windows ANSI encoding are
; Times New Roman for froman fonts, Arial for fswiss fonts, and
; Courier New for fmodern fonts. In each case, the encoding
; identifier (Cyr, CE, Greek, or Tur) is added to the font name.
; If you want to use different default fonts for one or more of
; the font types frpman, fswiss, or fmodern, map them here as in:
; Times New Roman Cyr=Century Cyr
; Make sure the font you specify really contains the characters
; for the encoding you indicate.
; Document para style name = RTF style name (affects name only)
; always use the remapped (RTF) name in the HelpStyles sections
; the RTF name must be unique; some examples are shown below
; the Heading N styles support Word outline and autonumber features
; Document para style name = replacement existing RTF style name
; the RTF name need not be unique, and may be created in [Styles]
; the properties of the original style remain as-is in the text
; unless Template and TemplateAutoUpdate are set in [WordOptions]
;Mapping Table Title=TableTitle
; override default RefFrames setting here for specific frame names
; give the frame name with no style, or "Graphic", after the "=" to
; keep the frame as a graphic, specify a style name to make it text,
; or use "None" to eliminate it altogether
; xref format name = properties (Delete or Text), if omitted treated as link
; original filename (no ext) = prefix ID for text and graphic objects.
; If [FDK]UseLocalFileID=No (the default), the IDs in mif2go.ini are
; used instead; this section is really just to support earlier projects
; and should never be used in current projects, use mif2go.ini instead.
; flowtags to Skip or to treat as Normal (to keep in same RTF section)
; marker type name = one or more marker type names, can include original type.
; Names on the right cannot contain spaces or commas, but those on the left can.
; Conditional Text markers cannot be remapped; others are remapped literally.
; Original marker type names are Header/Footer $1, Header/Footer $2, Index,
; Comment, Subject, Author, Glossary, Equation, Hypertext, Cross-Ref, and HTML
; Macro. The following hypertext names are recognized: openObjectIDfitwin,
; openObjectID, gotoObjectIDfitwin, gotoObjectID, gotopage, openlinkfitwin,
; openlink, gotolinkfitwin, gotolink, newlink, alert, and message; note that
; message specifically means "message URL", and that such a marker should
; have a URL as its content. Any name not in these lists is a custom name.
; When markers are remapped to a standard type, that type's number is used for
; that instance; when remapped to a custom type, number 12 is used for all.
; (This number may affect some RTF Help settings used for legacy docs only.)
; For example, Subject = Index ALink adds all Subject markers to the Index,
; and also makes clones of them as ALink markers for their help topic.
; This makes each HTML Macro marker into a Code marker (with macro expansion):
; RTFSetting and M2GSetting allow use of markers to set many, but not all,
; of the mif2rtf.ini settings. They differ in that M2GSetting will also
; work for corresponding settings in mif2htm.ini. They can be used for
; Globals, overriding the corresponding mif2rtf.ini setting, stay in
; effect until the end of the file or until reset by another marker.
; These include settings in [Options], [WordOptions], and many more.
; Styles, as in [HelpStyles], affect only the current paragraph or span
; of character-formatted text.
; Tables, as in [Table], affect the entire table where they are placed.
; Graphics, as in [Graphics], affect only the next graphic (when placed
; in the text before the anchor, or in any text frame within the graphic).
; Xrefs, for [XrefStyles], affect only the next xref (in the text flow);
; the properties replace those specified for the xref format in the .ini.
; For Globals, use the usual mif2rtf.ini syntax: [Section]key=value. For
; the other four (object-specific) types, omit the key: [Section]value.
; marker type name = properties: Delete, Code, ALink, RTFSetting, M2GSetting
; If a type is remapped in [Markers], and the mapping does not include
; the original type name on the right, that type will not be recognized
; in this section. However, new types defined in [Markers] will be.
; Listing a marker in this section results in the marker no longer having its
; Index, Hypertext, HTML Macro, and Cross-Reference Markers cannot be included
; here but can be remapped to other types in [Markers] which can be used here.
; When assigned to Code, any [MarkerTypeCodeBefore] and [MarkerTypeCodeAfter]
; are added if specified, any macros in the marker are expanded normally, and
; the marker-derived content is then inserted in the RTF text. No checking of
; the code is done, so be very sure of the RTF syntax used in Code markers.
; marker type name = macro; for markers listed in MarkerTypes as Code
; marker type name = macro; for markers listed in MarkerTypes as Code
; RemoveGraphics = No (default) or Yes (strip all graphics from doc)
; EpsiUsage = Preview (only, default), EPS (no preview) or Retain (both)
; ClipType = Show (leave alone), Move (up into frame, default), Delete
; applies only to graphic text in Frame native vector graphics
; ClipLimit = twips to allow below frame before clipping graphic text
; GrVertAdjust = half-points to adjust in-line graphics down (neg for up)
; TextScale = value in percent to apply to font sizes in graphics
; TextWidth = percent of unscaled font height for font widths in graphics
; TextVertAdjust = twips to move text in metafiles down (neg for up)
; BackMode = 1 (transparent) or 2 (opaque) for graphic text
; StretchMode for bitmaps = 0 (default), 1 (black), 2 (white), 3 (color)
; DefBrushType = Black (default), White, or Hollow
; EmbedBMPsInWMFs = Yes (default, includes scaling info) or No
; EmbedWMFsInWMFs = Yes (default, includes scaling info) or No
; UseFrameImage = No (default) or Yes (in preference to other formats)
; BitmapDPI = 0 (default, scale as is), or new value (typically 72)
; BitmapFlip = 0 (default, leave as is), or 1 (flip vertically)
; CompressRasters = Yes (default, compress 16 and 256 color BMPs) or No
; RasterBorders = No (default), Inside (raster), Outside, or Frame
; Frame centers border on edge, as in FM, but results in narrowing
; to half width if graphic edge is at an edge of its anchored frame
; FrBorders = Frame (default, centered), Inside, Outside, or None
; FrameBorders = No (default, no borders on inlined frames) or Yes
; This is best used when such frames are alone in their paragraphs.
; Should not be used unless FrBorders does not operate correctly.
; DefFont = name of default font in WMF graphics
; DefFSize = size in twips for default font in WMF graphics
; FrameDefaultFontName = name of default font in FrameMaker graphics
; must match setting that Frame uses internally for this purpose
FrameDefaultFontName=Times New Roman
; FrameDefaultFontSize = size of default font in FrameMaker graphics
; must match setting that Frame uses internally (hundredths of a point)
; UseDefaultGraphicFormat = No (default), or Yes for persistent graphics
; text formats, if text properties are not being maintained correctly
; UseTopSpaceAbove = No (ignore first space above in callouts) or Yes
; NoBlankFirstGTLine = Yes (default, ignore blank first line in graphic
; SuppressGTUnderlines = No (default) or Yes (no underlines in gr text)
; FrameExactHeight = 0 (default, auto) or 1 (size as original)
; WrapAllFrames = No (default) or Yes (to eliminate use of nowrap)
; MetaNameChars = chars from base file name to use in external WMF names
; MetaNumDigits = number of digits to use in external WMF file names
; BulletFile = name to use for bullet bitmap, default is "bullet.bmp"
; NameWMFsAsBMPs = No (default) or Yes (to change .wmf refs in the .rtf)
; NameGraphics = No (default) or Yes (for Word only, put original Frame
; graphic name in an INCLUDEPICTURE field, with the WMF in the result
; part of the field, so that the name is shown by showing Field Codes)
; This group has been moved from [WordOptions and [HelpOptions] but
; is still valid there and also in [Options].
; GraphText = Embed (as for captions), Frame (as text), or Text
; applies only to "graphics" consisting solely of one text frame
; FilePaths (for graphics) = Retain (default) or None (strip off)
; FileNames = Retain (default) or Map (in the GraphFiles section)
; Metafiles = Internal (in place) or External (in AAAAAnnn.WMF)
; always use External for winhelp; Internal is better for Word
; This one is also valid in [HelpOptions].
; Transparent makes white bitmap pixels transparent (WinHelp 4 only)
; This one is also valid in [Options].
; UseGraphicPreviews = No (default) or Yes (use preview bitmaps for frames)
; this section is used by drmif only, not by dwrtf
; make external files when they need to be converted or changed
; normally wmf, bmp, and rf files do *not* need to be changed
; the first sets the default for the rest
; ImportGraphics = Normal (default), Retain (in file) or Export (ext files)
; ExportNameChars = chars from base file name to use in export file names
; ExportNumDigits = number of digits to use in export file names
; ExportWmfFiles = Yes (makes external .wmf files) or No (default)
; ExportBmpFiles = Yes (makes external .bmp files) or No (default)
; ExportRfFiles = Yes (makes external .rf files) or No (default)
; ExportOleFiles = Yes (makes external .ole files) or No (default)
; ExportPctFiles = Yes (makes external .pct files, default) or No
; ExportTifFiles = Yes (makes external .tif files, default) or No
; ExportGifFiles = Yes (makes external .gif files, default) or No
; ExportJpgFiles = Yes (makes external .jpg files, default) or No
; ExportPngFiles = Yes (makes external .png files, default) or No
; ExportPcxFiles = Yes (makes external .pcx files, default) or No
; ExportWpgFiles = Yes (makes external .wpg files, default) or No
; ExportCdrFiles = Yes (makes external .cdr files, default) or No
; ExportEpsFiles = Yes (makes external .eps files, default) or No
; MultipleOLE = No (export only the last WMF image in an OLE object), or
; Yes (export all WMFs found, with "Xnn" suffixes for all but the last)
; types to map, replace extension, old=new for referenced graphics
; specific filenames to replace, old = new, overrides type setting
; FrameMaker pen style number = WMF line style
; valid FM pen styles are 1-6 and 8-14, excluding 0 (black), 7 (white),
; and 15 (invisible) which have fixed mappings
; valid WMF line styles are 0 (solid, default), 1 (dashed), 2 (dotted),
; 3 (dot-dash), 4 (dash-dot-dot), and 5 (invisible)
; all but solid force the line width to the minimum (a WMF requirement)
; this section is effective only when Frame graphics are being converted
; by mif2go itself, without using the FrameMaker graphic export filters
; This group has been moved from [Word&HelpOptions] but is still valid there
; TableTitles = 0 to leave alone, 1 to put at top, 2 to put at bottom
; TitleInRow = No (default), or Yes (puts table title in a row sized according
; to Frame's implicit rules for table title boxes)
; TableRules = Cell (Word default), None (help default), or one
; of the Box types: Box, Double, Thick, Shadow, Para (variable)
; TableFill = AsIs (default), ColorOnly, ShadingOnly, None
; TableGraphics = Standard (default, in cell), None, or Outside
; applies only to non-inline and non-runin frames anchored in cell
; ShiftWideTablesLeft = Yes (default, unindent overwidth tables) or No
; MergeStradCells = No (Word default) or Yes (help default, combine
; This group has been moved from [WordOptions] but is still valid there
; TableContinued = No (default) to remove variable from table titles
; TableContVar = name of the variable used for table (continued)
TableContVar=Table Continuation
; TableSheet = No (default) to remove this variable from table titles
; TableSheetVar = name of the variable used for table (Sheet m of n)
; This group has been moved from [HelpOptions] but is still valid there
; ForceTableLineBreaks = No (default) or Yes (make soft breaks hard)
; TblColWid* rescales all table column widths in the file, using:
; Pct as the percentage to apply to the original size, 0-32766
; Add as the twips to add to the scaled result, negative to subtract
; StripTables = No (default) or Yes (when every row is a new topic)
; StrippedCellPar = Yes (default, add \par after cells) or No (omit it)
; TableWidthsFixed = Yes (default) or No (centered tables are variable)
; These Code sections are used from both [WordStyles] and [HelpStyles]
; Any except *Store can call a macro with <$macname> or <$.\macfile.txt>
; For CodeBefore, format = code to put before the para start \pard
; for para formats, or the opening brace for char formats.
; For CodeStart, format = code to put at the start of the text after props
; for para formats, or after char props for char formats.
; For CodeEnd, format = code to put at the end of the text just before \par
; for para formats, or the closing brace for char formats.
; For CodeAfter, format = code to put right after the closing \par
; for para formats, or the closing brace for char formats.
; For CodeReplace, format = code to replace entire para (no Before or After)
; for para formats, or the entire char-formatted part for char formats.
; For CodeBeforeAnum, para format = code to put before the paranum
; For CodeAfterAnum, para format = code to put after the paranum
; For CodeStore, para format = name of macro variable in which to store para
; content; if omitted, default is a macro variable of the para format name
; For TextStore, para format = name of macro variable in which to store para
; content; if omitted, default is a macro variable of the para format name
; location = content to insert, which may be a Mif2Go macro
; For Word, locations are: Top, Bottom, Header, Footer, FirstHeader,
; FirstFooter, LeftHeader, LeftFooter, RightHeader, RightFooter.
; For Help, locations are: TopicStart, TopicEnd, SlideStart, SlideEnd.
; *******************************************************************
; Word non-Help specific options are in this section
; Index = Help (K footnotes), Standard (Word index markers), or None
; Quotes = Help (only " and ') or Standard (allow left/right quotes)
; SmallCaps = Standard (default), Frame (using FM sizing), or None
; NoSeeAlso = No (default, keep See Also markers) or Yes (removes them)
; Xrefs = Standard (default, working) or None (plain text)
; XrefHyper = Yes (default, make xrefs work as hyperlinks) or No
; WrapXrefs = Yes (default, wrap full xref format content as hyperlink,
; but displays xrefs as errors in Word version 2000) or No
; LockXrefs = Yes (default, faster load) or No (allow updating of xrefs)
; LockHyper = No (default, allow edit) or Yes (when revision tracking)
; ExtXrefPages = Yes (default, make page refs to external files into
; updatable fields), or No (just put page numbers as plain text)
; XrefFileSuffix = suffix to use when converting [WordXrefFiles] xrefs
; XrefFileDefault = name of file to use for missing XrefFiles
; XrefType = Numeric (default) or Full (use only to eliminate dupes)
; ExternalXrefs = Yes (default, create all of the bookmarks for each
; para that has an xref marker in it, for links from ext files) or No
; (create xref bookmarks only as required by refs in the current file)
; WriteAnums = Yes (default, write per SeqAnums) or No (omit entirely,
; used when having a Word stylesheet add them for selected styles)
; SeqAnums = No (default, write as text) or Yes (write as SEQ fields)
; UseHyperlinks = Yes (default) or No (ignore all hyperlinks)
; ObjectIDs = Referenced (default, used by TOC or IX), None, or All
; UseFileIDs = Yes (default, needed for identifying xrefs) or No
; KeepIXMarkerIDs = No (default, keep only if [FDK]UseFrameIX) or
; Yes (always keep Unique ObjectIDs for Index markers)
; RevTrack = No (default) or Yes (turn on Word revision tracking)
; RevProt = No (default) or Yes (locks on Word revision tracking so
; that user cannot turn it off, also sets RevTrack=Yes)
; RemoveUnusedStyles = No (default for Word) or Yes
; RemoveUnusedFonts = No (default for Word) or Yes
; CharStylesUsedInText = Yes (default, to use cs codes in text) or No
; WriteMissingForms = Yes (default, write empty hidden paras at start of
; file for var formats that are used in headers/footers but not in doc)
; WriteAllVarForms = No (default) or Yes (write empty hidden paras for
; all var formats even if they appear to be used somewhere in doc body)
; DefTabWidth = 0 (default, ignore undefined tabs) or twips (720 for 0.5")
; Template = name or full path of template file to attach
; TemplateAutoUpdate = Yes (default, use template style defs) or No
; WordPerfect = Yes to override all features that WP does not tolerate
; Word8 = Yes (default, for Word8/Office97 and later) or No (earlier)
; Word2000 = No (default) or Yes
; Word2002 = No (default) or Yes (for Word XP)
; Word2003 = No (default) or Yes (changes graphics size to twips again)
; The rescale settings are used to help Word paginate the same as Frame,
; so they affect vertical sizes primarily, and horizontal sizes only
; as needed to maintain the original aspect ratio of glyphs/graphics.
; Small changes in the 90-95 range for Text and Table usually suffice.
; NOT YET IMPLEMENTED; under development for the next upgrade release.
; TextRescale = percent of original size (default 100), affects font size,
; line spacing, and paragraph spacing.
; TableRescale = percent of original size for fixed row heights, and for
; cell top and bottom margins.
; GraphicsRescale = percent of original size for both graphics dimensions.
; Footnotes = Standard (Word default), Embed (between []), None, or
; Variable (using real Word footnotes, so xrefs to them are wrong)
; PageBreaks = Normal (retain), Format (only in format def), or Remove
; KeepSectBreaks = Yes (retain, Word default) or No (remove)
; HeadFoot = Standard (for Word), Text (no graphics), or None (for help)
; HFVertAdjust = twips to move header/footer text down (negative for up)
; HFFramed = Yes (default) to position Headers and Footers using frames
; WrapAroundHFFrames = Yes (default, let text wrap around) or No
; HFGap = twips to space around header/footer frames, default none
; UseTextFrames = Yes (default, to emulate framing) or No
; WrapAroundTextFrames = Yes (default, leave room around) or No
; Sideheads = Left (simplest), Indent, Frame (most accurate), or Normal
; ForceSideHeadPos = No (default), Left, Right, Inner, or Outer
; SHSpannerAnchors = Yes (default, anchor paras after framed spanners)
; SHVertAdjust = twips to move sidehead framed text down (neg for up)
; SHWidth = 0 (default, set per first usage) or twips to use
; SHGap = 0 (default, set per first usage) or twips to use
; RunInHeads = Runin (Word default) or Normal (help default)
; FrameStyle = para style to use for non-in-line anchored frames
; default is not to specify, which uses the previous para style
; EmptyFrames = Standard (retain), Remove, or Identify (missing file)
; SingleFlow = No (default, handle flows separately) or Yes
; PageColumns = 0 (default, set per Right master) or number to use
; PageColGap = 0 (default, set per Right master) or twips to use
; TextColor = 0 all black (help default) or 1 as is (standard default)
; This group has been moved to [Table] but is still valid here
; TableTitles = 0 to leave alone, 1 to put at top, 2 to put at bottom
; TableContinued = No (default) to remove variable from table titles
; TableContVar = name of the variable used for table (continued)
TableContVar=Table Continuation
; TableSheet = No (default) to remove this variable from table titles
; TableSheetVar = name of the variable used for table (Sheet m of n)
; TableRules = Cell (standard default), None (help default), or one
; of the Box types: Box, Double, Thick, Shadow, Para (variable)
; TableFill = AsIs (default), ColorOnly, ShadingOnly, None
; TableGraphics = Standard (default, in cell), None, or Outside
; applies only to non-inline and non-runin frames anchored in cell
; ShiftWideTablesLeft = Yes (default, unindent overwidth tables) or No
; MergeStradCells = No (default) or Yes (combine col-straddling cells)
; This group has been moved to [Graphics] but is still valid here
; GraphText = Embed (as for captions), Frame (as text), or Text
; applies only to "graphics" consisting solely of one text frame
; FilePaths (for graphics) = Retain (default) or None (strip off)
; FileNames = Retain (default) or Map (in the GraphFiles section)
; Metafiles = Internal (in place) or External (in AAAAAnnn.WMF)
; always use External for winhelp; Internal is better for Word
; These two replace the former RefFrameFormat setting, which is deprecated
; RefFrames = Graphic (show FrameAbove and Below), Text (name only), or None
; RefFrameDefFormat = the style to be used for Text reference frames
; file name in xref = file name for Word inter-file xref
; file name = text for <$paranum> or <$paranumonly>, default "#"
; format (char or para) = list of any of the following keywords:
; KeepID retains the Frame ObjectID so that hyperlinks in Frame-generated
; files (TOC, LO*, IO*) work in Word; not needed for IX files.
; Contents (DEPRECATED) indicates that the format appears in [WordCntStyles]
; Delete is used to remove displayable text, mainly with AKey or SpKey
; Replace deletes, and also puts out the RTF in [WordReplacements]
; Hide makes the content Word hidden text (reserved in WinHelp).
; CodeBefore uses code in [StyleCodeBefore] before the para start \pard
; or before the opening brace for char fomats
; CodeStart uses [StyleCodeStart] at the start of the text after props;
; if a starting char format also has a start macro, both are used
; CodeEnd uses [StyleCodeEnd] at the end of the text just before \par
; or before the closing brace for char formats
; CodeAfter uses [StyleCodeAfter] right after the closing \par
; or after the closing brace for char formats
; CodeReplace uses [StyleCodeReplace] (no Before or After is used)
; CodeBeforeAnum (para only) uses [AnumCodeBefore] before the paranum
; CodeAfterAnum (para only) uses [AnumCodeAfter] after the paranum
; Any Code can call a macro with <$macname> or <$.\macfile.txt>
; CodeStore causes the paragraph content to be stored in the macro
; variable named in [StyleCodeStore]; the para must *precede*
; the point of use of the macro variable in the output document.
; The original para is removed; it can be put back by invoking the
; macro variable in a CodeAfter macro. Note that any CodeStart and
; CodeEnd macros are included in the macro variable content, but
; CodeBefore, CodeAfter, frames, and tables are not.
; TextStore stores the paragraph content as plain text in the macro
; variable named in [StyleTextStore]. The macro may be used at any
; point (unlike CodeStore), and the original para is left in place
; (but may be removed with Delete). Macros, frames, and tables are
; not included, nor is RTF formatting code. If more than one instance
; of the format is in the file, only the last one used is retained.
; ParaLink makes the entire para a hotspot for the first hyperlink in
; it, ignoring char formats; mainly helpful in the TOC.
; Config and RTFConfig use the contents of the para as though it is a
; set of Config markers, each ending with a hard return, but also allow
; the normal .ini syntax with [Sections] on their own lines and comments.
; DEPRECATED, use [WordStyles] KeepID property instead.
; format = level (1..9), required when using Frame-generated TOC
; with hyperlinks to text, so that bookmarks are created for the IDs
; of the paragraphs included in the TOC, such as ChapTitle=1
; Replace causes the insertion of the corresponding raw RTF code below
; in place of the original content of the named para or char format
; *******************************************************************
; WinHelp-specific sections start here and run to the end of the file
; HelpVersion = 3 for Win 3.1 compatible or 4 for Win 95/NT
; Altura = No (default) or Yes (needed for Altura QuickHelp for Mac)
; HyperHelp = No (default) or Yes (needed for Bristol HyperHelp for UNIX)
; HPJFileName = name of .hpj to use when compiling WinHelp
; MakeCombinedCnt = Yes (default, when processing file from open book) or No
; ForceBmc = No (default) or Yes (use bmc not bml, for HyperHelp)
; HelpSectionBreaks = Yes (default) for sect break before each topic,
; or No for Altura (filter strips table formatting from topic titles)
; Index = Help (make into K footnotes) or None (removed)
; KeywordLimit = max characters total (all levels) in keywords
; DisambiguateIndex = Yes (default, always write first-level keys),
; Strip (no first-level keys), Topic (only write first instance of
; a first-level key in each topic), No (only write first in doc)
; NoSeeAlso = No (default, leaves See Alsos in index) or Yes (removes them)
; IdxColon = No (default, allow colon and comma as level delimiters)
; or Yes (use only colon as delimiter, treat comma as regular text)
; IndexRanges = Yes (default, include ref to every topic within range in IX)
; or No (use only refs to topics at start and end of range in IX)
; KeepIXMarkerIDs = No (default, keep only if [FDK]UseFrameIX) or
; Yes (always keep Unique ObjectIDs for Index markers)
; DefTabWidth = 0 (default, ignore undefined tabs) or twips (720 for 0.5")
; Quotes = Help (default), Standard (curly, may cause errors), or Numeric
; Bullets = Help (default, bmc reference) or Standard (using \'95)
; BMPsForDingbats = No (default) or Yes (to use bullet.bmp for deco fonts)
; SmallCaps = Standard (default) or None
; Xrefs = Help (make context markers) or None (plain text)
; UseFileIDs = Yes (default, xrefs and ObjIDs) or No (single topic file)
; XrefFileSuffix = suffix to use when converting [HelpXrefFiles] xrefs
; XrefFileDefault = name of file to use for missing XrefFiles
; XrefType = Numeric (default) or Full (use only to eliminate dupes)
; XrefLenLimit = 64 (default max length for xref identifiers, truncate)
; ObjectIDs = Referenced (default, used by TOC or IX), None, or All
; UseHyperlinks = Yes (default) or No (ignore all hyperlinks)
; UseGreen = Yes (default) or No (remove green color from all links)
;IXnewlinkPrefix = prefix to use on newlinks, used only in specific .inis
; to differentiate Frame autogenerated newlinks in different Index files
; RemoveUnusedStyles = Yes (default for WinHelp) or No
; RemoveUnusedFonts = Yes (default for WinHelp) or No
; CharStylesUsedInText = No (help default, no cs codes allowed in text)
; HelpLineBreak = Yes (default, end topic title at hard return) or No
; TitleScroll = Yes (title para scrolls with text), or No (fixed at top)
; TitleSpace = Yes (help title para can have space above/below), or No
; TitleIndent = Yes (help title para can have left/right indents), or No
; HelpTabLimit = maximum tab definitions allowed in paragraph formatting
; ExtendHelpNoScroll = No (default) or Yes (allow Keep With Next paras)
; Footnotes = Standard, Embed (between []), Jump, Popup, or None
; default is Jump, which looks more normal than Popup
; EndFtnWithSpace = Yes (Help default) or No (HyperHelp default)
; FootnoteSpace = After (the } after the symbol, default), Before, or None
; PageBreaks = Normal (retain), Format (only in format def), or Remove
; KeepSectBreaks = No (remove, Help default) or Yes (retain)
; Sideheads = Left (default), Indent (looks more like doc), or Normal
; RunInHeads = Runin (Word default) or Normal (help default)
; FrameStyle = para style to use for non-in-line anchored frames
; default is not to specify, which uses the previous para style
; EmptyFrames = Standard (retain), Remove, or Identify (missing file)
; TextColor = 0 all black (help default) or 1 as is (standard default)
; UseHyperColor = No (default) or Yes (treat any non-black as hyper)
; NoXrefPopups = No (default, allow override to popup) or yes
; AllowLiningOverrides = No (default, underline change only in formats)
; This group has been moved to [Table] but is still valid here
; TableTitles = 0 to leave alone, 1 to put at top, 2 to put at bottom
; put at top when used as topic titles or jump targets
; TableRules = None (help default), or one of the Box types:
; Box, Double, Thick, Shadow, Para, or Variable
; TableFill = AsIs (default, shading is unavailable), ColorOnly, None
; TableGraphics = Standard (default, in cell), None, or Outside
; applies only to non-inline and non-runin frames anchored in cell
; ForceTableLineBreaks = No (default) or Yes (make soft breaks hard)
; TblColWid* rescales all table column widths in the file, using:
; Pct as the percentage to apply to the original size, 0-32766
; Add as the twips to add to the scaled result, negative to subtract
; StripTables = No (default) or Yes (when every row is a new topic)
; StrippedCellPar = Yes (default, add \par after cells) or No (omit it)
; TableWidthsFixed = Yes (default) or No (centered tables are variable)
; ShiftWideTablesLeft = Yes (default, unindent overwidth tables) or No
; MergeStradCells = Yes (default, combine col-straddling cells) or No
; This group has been moved to [Graphics] but is still valid here
; GraphText = Embed (as for captions) or Text (as normal text)
; applies only to "graphics" consisting solely of one text frame
; normally Embed for help, unless framing isn't actually needed
; FilePaths (for graphics) = Retain (default) or None (strip off)
; FileNames = Retain (default) or Map (in the GraphFiles section)
; Metafiles = Internal (in place) or External (in AAAAAnnn.WMF)
; always best to use External for help
; Transparent makes white bitmap pixels transparent (WinHelp 4 only)
; These two replace the former RefFrameFormat setting, which is deprecated
; RefFrames = Graphic (show FrameAbove and Below), Text (name only), or None
; RefFrameDefFormat = the style to be used for Text reference frames
; It is best not to use the following two settings, but to use the
; new [Markers] section instead.
; MarkerType11 = Midtopic (default), Full (as newlink), None
; ALinkMarkerType = number of marker type to convert to A footnotes
; use 4 (Subject), 5 (Author), 6 (Glossary), or a custom type
; 0 (the default) disables the conversion
; RemoveWordTocMarkers = Yes (default, remove markers starting _Toc) or No
; BitmapFont = name of font to check for chars to map here
; following chars are remapped when in BitmapFont in WinHelp only
; sample mappings are all to bitmaps supplied in Help Workshop
; * = bullet, using the decimal numeric value of the character
; A = arrow, using the character itself (printable, not ";" or "[")