F HTML/XML configuration
This section provides an annotated list of all the configuration sections, keywords, and values for settings you can specify in configuration file mif2htm.ini, for HTML or XML output from Mif2Go.
§4 Setting configuration options.
; mif2htm.ini contains initial info for the DCL MIF to HTML filter
; this is m2htm.txt for dwhtm.dll version h286 and m2rbook.dll b110
; Output = Standard (default, HTML), MSHHelp (HTML Help), JavaHelp (Sun),
; Cross-platform OmniHelp, EclipseHelp, OracleHelp (extended JavaHelp),
; DITA, XHTML, GenXML (generic XML), Book (DocBook XML), or AsciiDCL.
; The next three items control how names are matched to ini-file settings
; CaselessMatch = Yes (default, ignore uppper/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.
; moved to [HTMLOptions] but still valid here
; HideWhiteText removes any white text (standard FrameMaker behavior)
; RemoveEmptyParagraphs = No (default) or Yes (remove paras with no text)
;EmptyParaContent = string to put in otherwise-empty paragraphs
; moved to [Graphics] but still valid here
; UseGraphicPreviews = No (default) or Yes (use preview bitmaps for frames)
; 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)
; UseFrame8MIF = Yes (default, for Frame 8 only), or No (to get Frame 7 MIF)
; UseFrame9MIF = Yes (default, for Frame 9 only), or No (to get Frame 7 MIF)
; DeleteMIF = No (default, keep MIF file when HTML 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
; ConfigTemplate = path to .ini file to be used when mif2htm.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
; PrjFileName = name of project file that references this directory
;PrjFileName=D:/path/to/yourbook.prj
; IDFileName = name of file that contains File IDs for this project
;IDFileName=D:/path/to/mif2go.ini
; UseLocalFileID = No (default, use IDFile IDs) or Yes (use [FileIDs] here)
; 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 = No (default) or Yes (include 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, JPEG (default), 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 and DITA), or
; No (default for Help formats and DITA)
; UseFrameIX = Yes (default, except for Help formats and DITA), or
; No (default for Help formats and DITA)
; UseFrameGenFiles = Yes (default for all formats except DITA), or
; 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.
; CheckLinks = No (default) or Yes (check links after running a book)
; CheckLinkLog = D:\path\to\LinkLog.fm to make copy of Book Error Log
; containing links to errors that does not disappear when Frame closes.
; LinkLogAlways = Yes (default) or No (do not display Book Error Log if
; CompileHelp = No (default, run compiler separately), or Yes (MS HH only,
; copy all needed files to the WrapPath, if given, then compile with hhc)
; KeepCompileWindow = No (default) or Yes (so any MS HTML Help error
; 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 (.chm, .hlp, .jar, or .zip) is copied to ShipPath.
; The files copied are specified in WrapCopyFiles, with defaults given below:
; For MSHH, files copied are *.htm, *.js, *.hh?, and *.h, then the
; For JH, and OHJ, files copied to the top level are *.xml, *.hs, *.jhm,
; to ./html are *.htm and *.js, and to ./graphics are *.gif, *.jpg,
; and *.png. After copying, the indexer is run if named in FTSCommand.
; For OmniHelp, files copied are *.htm and *.oh?.
; If OHViewPath is set, also copies oh*.* from there to WrapPath.
; For DITA, files copied are *.dita, *.ditamap, *.bookmap, *.dtd, *.mod,
; For other HTML and XML formats, files copied are *.htm, *.html, *.xml,
; *.js, *.txt, *.dtd, *.mod, *.ent, and *.xsd.
; For all formats, the GraphCopyFiles (default *.gif, *.jpg, *.png, and *.svg)
; are copied to GraphPath (relative to WrapPath) as well; for JH and OHJ,
; they go to the [JavaHelpOptions]GraphSubdir. If CopyGraphicsFrom is set,
; any GraphCopyFiles are also copied from there to GraphPath (or to the
; Similarly, the CssCopyFiles (default .css and .xsl) are copied to [CSS]
; CssPath (relative to WrapPath); for JH and OHJ, the CssPath is relative
; to [JavaHelpOptions]HTMLSubdir. If CopyCssFrom is set, any CssCopyFiles
; are also copied from there to CSSPath.
; 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. For JH and OHJ, these files are
; copied to the HTMLSubdir; GraphCopyFiles specifies those copied to
; the GraphSubdir, and the JavaRootFiles (*.xml, *.hs, and *.jhm) are
; copied to the top level and should not be included in WrapCopyFiles.
; Likewise, the CssCopyFiles should not be included in WrapCopyFiles.
; EmptyWrapPath = Yes (default, remove all files before copying)
; or No (leave old files in place in WrapPath directory)
; CopyCssFrom = path to directory containing the .css files, relative OK
; CssCopyFiles = list of files to copy from CopyCssFrom and output
; directories to the [CSS]CssPath (which defaults to the WrapPath),
; separated by spaces, wildcards and paths (relative and absolute)
; allowed, no spaces within an item, default is: *.css *.xsl
; For JH and OHJ, these files are copied relative to the HTMLSubdir.
; CopyGraphicsFrom = path to dir containing the graphics files, relative OK
;CopyGraphicsFrom=..\graphics2
; 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: *.gif *.jpg *.png *.svg
; For JH and OHJ, these files are copied to the ./graphics subdirectory.
; EmptyGraphPath = No (default, leave graphics files in place)
; or Yes (empty GraphPath directory before copying)
; ArchiveCommand = zip command given *without* any parameters; if program
; directory is not on the system PATH, include its path, quoted if spaces.
; If omitted, archiving is not done; if present, result is put in ShipPath.
; ArchiveStartParams = any parameters preceding the name of the archive file,
; default is empty. Specify "-add" for pkzip.
; ArchiveEndParams = any parameters following the name of the archive file,
; default is empty. Specify "*.*" for pkzip.
; ArchiveName = name for archive to be created, without extension, to be
; used if ArchiveCommand is specified. Default for MSHH is HHPFileName,
; for OH [OmniHelpOptions]ProjectName (but without prefix or suffix),
; for JH and OHJ HSFileName, for others 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 file of archiving or of
; compilation (.chm, .jar, or .zip), may be 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
; for HTML and XHTML "*.htm *.html *.ref *.grx", fir DITA "*.dita
; *.ditamap *.bookmap *.ref *.grx", and for XML "*.xml *.ref *.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 (log all automation commands to the
; OnlyAuto = No (default) or Yes (only run automation commands, used
; to save time while working out automation paths and other setings)
; RunfmDiagnostics = No (default) or Yes (include more diagnostic
; messages in the Frame console file when running from runfm)
; The book start, wrap, 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 the start of book processing
; BookWrapCommand = command line run at end, before automation processing
; BookEndCommand = command line run at end, after help compiler and archiving
; BookCommandWindow = Hide (default, no display), Keep (show until user
; dismisses), Show (during execution only)
; The file start, wrap, 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 can be overridden in a specific filename.ini.
; FileStartCommand = command line to be run at start of file processing
; FileWrapCommand = command line run at end, before automation processing
; FileEndCommand = command line run at end, after compiler and archiving
; AskForUserVars = Never (default), Always, or Once (then set to Never)
; These variables can be used in the book commands above, the macros
; used in HTML output, or 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:
; Log entries are appended to the log file, and consist of:
; timestamp (if different from last one), on its own line
; description with identifying details
; W2: Xref target ag123456 not found in somefile.ref
; UseLog = Yes (default, log as specified in this section) or No
; LogFileName = name with path, absolute or relative to output dir
; These take severity values, 1 (worst) to 9, or 0 to prevent logging
; LogErrors = 1 (default, log events that terminate process)
; LogWarnings = 1 (default, log problems with workarounds that may
; LogQuerys = 1 (default, log possible ambiguities)
; LogInfo = 1 (default, log process information)
; LogDebug = 0 (default, don't log possible programming issues)
; These options control operation of macros; they were formerly in
; [HTMLOptions], and are still recognized there for back compatibility.
; MacroFile = name of HTML 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/m2hmacro.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)
; ReplaceFrameVars = No (default) or Yes (replace Frame variables with
; the correspondingly named macro variable, if any)
; 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)
;Title = default title for HTML files, overridden by all other settings
; UseFileIDs = Yes (default, xrefs and ObjIDs) or No (single file only)
; FileSuffix = suffix used in xrefs for HTML: htm (default), html, etc.
; ObjectIDs = All (default), Referenced (only keep if used in TOC, IX) or
; None. The .ini is set to All for Help formats, Referenced for others.
; XrefType = Full (default) or Numeric (shorter for more efficient use)
; RemoveWordTocMarkers = Yes (default, remove markers starting _Toc) or No
; RemoveFilePaths = Yes (default, strip hyperlink and xref paths) or No
; ListMissingRefs = No (default) or Yes (identify missing xrefs to stderr)
; CheckAllRefs = Yes (default, even if they seem unchanged) or No (faster)
; NoLocations = No (default) or Yes (suppresses the part of all links after
; the filename, so that all links go to the start of the split file rather
; than to the CR marker or Hypertext newlink marker location. This is
; equivalent to setting NoRef for all paragraph styles in [HtmlStyles].
; UseRawNewlinks = No (default, remove punctuation, spaces) or Yes (as is)
; NoParaClose = No (default) or Yes (suppress </p> closing tags)
; NoWrap = No (default) or Yes (prevents returns within an HTML paragraph)
; PageBreaks = Rule (<HR>), None (default), or Split (before heads only)
; RunInHeads = Runin (default) or Normal (head on separate line first,
; UseRunInTag = No (default, get tag from body para) or Yes (from runin)
; ExtractEnable = Yes (allow extract files) or No (default, disable)
; UseHyperColor = No (default) or Yes (treat any non-black as hyper)
; AllowOverrides = Yes (default) or No (ignore untagged char properties,
; NoFonts = No (default, use <font...> tags) or Yes (prohibit <font ...>
; tags except for symbol fonts, default if UseCSS=Yes)
; NoSymbolFont = No (default, use <font...> tags for symbol fonts) or
; Yes (prohibit <font...> tags even for symbol fonts)
; UseFontFace = Yes (default, allow face attribute in font tags) or No
; Basefont = Yes (default) or No (no <basefont> tag put out)
; Default is reversed to No if UseCSS=Yes.
; AlignAttributes = Yes (default) or No (no align attribute in paragraph tags)
; Default is reversed to No if UseCSS=Yes.
; MinimizeLines = No (default) or Yes (remove extra newlines inserted in file)
; XMLBreakPara = No (default, each Shift+Enter becomes a space) or Yes
; (close para tag and reopen without attributes). Applies to XML formats
; only, and not to XHTML or HTML; in Preform-type tags, Shift+Enter is
; always a line ending regardless of this setting.
; DefaultTarget = name of target to use for all jumps not otherwise set
; URLTarget = name of target to use for all message URL links unless
; RemoveFramesAbove = No (default) or Yes (can be overridden in HtmlStyles)
; RemoveFramesBelow = No (default) or Yes (can be overridden in HtmlStyles)
; HTMLVersion = version to support, 4 (default), 3 (JavaHelp), or 2 (old)
; UseFrameSet = No (default) or Yes (if you have included frameset tags)
; UseDOCTYPE = Yes (default) or No (when writing DocBook entity files)
; HTMLDocType, the PUBLIC identifier required at start of HTML documents
; Default for v4 is: "-//W3C//DTD HTML 4.01 Transitional//EN"
; or if frameset is: "-//W3C//DTD HTML 4.01 Frameset//EN"
; Default for v3 is: "-//W3C//DTD HTML 3.2 Final//EN"
; Default for v2 is: "-//IETF//DTD HTML 2.0//EN"
; Default for XHTML is: "-//W3C//DTD XHTML 1.0 Transitional//EN"
; Uncomment and give alternate if needed, do not leave blank uncommented
;HTMLDocType="-//W3C//DTD HTML 4.01 Transitional//EN"
; HTMLDTD, the optional SYSTEM identifier in <!DOCTYPE>; default is to omit.
; If you want to add it back, although it breaks CSS usage, for v4 it is:
; "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd"
; "http://www.w3.org/TR/1999/REC-html401-19991224/frameset.dtd"
; "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"
; Uncomment and leave blank for no DTD (v2 and v3), or give an alternate.
; ValidOnly = No (default, allow normal use of chars from 128 to 160), or
; Yes (for warning-free W3C validation, remaps or removes those chars)
; AllowNobr = Yes (default, use <nobr> tags around nonbreaking hyphens,
; supported properly by all browsers), or No (required for W3C validation)
; GeneratorTag = Comment (dwhtm version in comment) or Meta (generator tag)
; XHNamespace default for XHTML 1.0 is "http://www.w3.org/1999/xhtml"
; Uncomment and give alternate if needed, do not leave blank uncommented
;XHNamespace=http://www.w3.org/1999/xhtml
; XHLangAttr = xml:lang (default, set as needed; DocBook wants just lang)
;UseXMLDeclaration = Yes to start with <?xml...?>, No for some browsers
; XMLVersion default is "1.0".
; XMLEncoding default is "UTF-8", entities are used for ANSI chars
; UseXMLRoot = Yes (default) or No (when writing DocBook entity files)
; XMLRoot default is "html" for XHTML, or "doc" for generic XML.
; QuotedEncoding = No (default, W3C usage, required for JavaHelp), or Yes
; (put encoding in meta tag in single quotes, needed by some older browsers)
; UseHeadAndBody = Yes (HTML/XHTML default) or No (generic XML and DITA)
; BodyContentOnly = No (default) or Yes (omit prolog, root element, and
; head and body tags, leaving only body content, for DBMS use)
; Ansi = Windows code page to use for FrameMaker font, default 1252,
; or 1250 for CE/EE, 1251 for Cyrillic, 1253 for Greek, 1254 for Turkish
; Encoding = UTF-8 (XML default), ISO-8859-1 (HTML default, numeric refs),
; or None (write 0x80-0xFF as single characters)
; NumericCharRefs = Yes (default, always use &#nnn;) or No (use UTF-8 for XML)
; ContentType = text/html (default for HTML and XHTML) or application/xml
; (default for XML); try not to use text/xml (for interoperability)
; These specify alphanumeric chars to use as space replacements in IDs
; if non-alphanumeric, spaces are stripped instead (default)
; ClassSpaceChar = alphanumeric char to use in CSS class names
; XrefSpaceChar = alphanumeric char to use in xref markers
; HyperSpaceChar = alphanumeric char to use in hyperlinks (except URLs)
; Footnotes = Jump (HTML default, at end), Embed (between []),
; Inline (XML default), or None
; NoFootnoteLinks = No (default) or Yes (eliminate links to footnotes)
; FootnoteSeparator macro is used at end of doc before Jump footnotes
;FootnoteSeparator=<br><br><hr>
; FootnoteStartCode macro is used after <a name=...> of each Jump footnote
; FootnoteEndCode macro is used at end of each Jump footnote
; UseFootnoteLists = Yes (default, use <ol> and <li> for footnotes
; except for those using symbols), or No (always use <div> and <p>).
; UseTbFootnoteLists = Yes (default, use <ol> and <li> for footnotes
; except for those using symbols), or No (always use <div> and <p>).
; These two class settings were moved to [CSS], but still work here:
; FootClass = name to use for CSS class for footnotes, default "footnote"
; TbFootClass = name to use for CSS class for table footnotes
; FootInlineTag = tag for beginning and ending inline footnotes
; FootInlineParaTag = tag for beginning and ending inline footnote paras
; FootInlineIDPrefix = start of ID attr for inline footnotes; rest
; is sequential number starting with 1 at start of file.
; UseFootXrefTag = No (HTML default) or Yes (XML default)
; FootInlineRefTag = tag for xrefs to inline footnotes, uses linkend
; for href attribute, for DocBook
; ConversionDPI = 96 (default), used when converting sizes to pixels
; ReAnchorFrames = Yes (default, anchor unanchored frames to first para
; on page) or No (skip unanchored frames)
; UseSpacers = Yes (HTML default, use to position tables and graphics)
; PixelSpacerImage = name of 1-pixel transparent GIF to use for spacing
; SpacerAlt = text to use for alt attribute for spacer, default [spacer]
; WriteSpacerFile = Yes (default, write spacer file after conversion) or No
; These settings are for the <$_madewith> macro, which adds a Mif2Go label
; where it is used (normally in an [Insert] at the bottom of the HTML page).
; WriteMadeWithGraphic = Macro (default, write graphic if its macro is used),
; Always (even if macro is not used) or Never (even if macro is used).
; MadeWithImageFile = name to use for "Made with Mif2Go" .jpg graphic
MadeWithImageFile=madewithm2g.jpg
; MadeWithPara = Yes (default, put macro inside <p>...</p> tags) or No
; MadeWithLink = Yes (default, use link to omsys home page in macro) or No
; MadeWithAttributes = attributes of <img> tag to use for macro
MadeWithAttributes= border="0" alt="Made with Mif2Go" height="48" width="78"
; UseAnums = Yes (HTML default, use unless list type) or No (XML default)
; AnumTabs = Yes (default, make tab in numbering properties into space unless
; it is in [HTMLStyles] List format, in which case remove it) or No (remove)
; TabCharsPerInch = count of spaces to use in PRE for one inch of tabbing
; the default, 16, makes 1/4" tabs into 4-char, and 1/2" tabs into 8 char
; UnwrapPRE = false (default) or true (ignore soft returns in PRE text)
; ScriptType = text/javascript (default) or other MIME type
; UseRawName = No (default, make [HtmlStyles] FileName legal) or Yes
; When UseRawName=No, allow underscores and spaces to be passed through from
; headings with the FileName property as follows:
; KeepFileNameUnderscores = No (default, remove underscores) or Yes
; KeepFileNameSpaces = No (default, remove or change spaces) or Yes (keep)
; ChangeFileNameSpaces = No (default; if not kept above, remove) or
; Yes (if not kept above, replace with the FileNameSpaceChar, below)
; FileNameSpaceChar = character with which to replace spaces, default '_',
; used if both KeepFileNameSpaces=No and ChangeFileNameSpaces=Yes
; MakeFileHrefsLower = No (default, leave case unchanged) or Yes (old)
;ATagLineBreak = Yes (default, \n before first attr) or No
; These are mainly intended for making links for Generic XML use:
; RemoveANames = No (default) or Yes (DITA, eliminate <a name=...> tags)
; RemoveATags = No (default) or Yes (eliminate <a href=...> tags)
; RemoveAHrefAttrs = No (default) or Yes (remove href attrs, keep tags)
; XMLLinkAttrs = No (default) or Yes to add attrs to <a href=..> tags:
; xml:link="simple" show="replace" actuate="user" class="url"
;ATagElement = tag to use for all link elements, default is "a"
; except for DITA, where it is "xref"
;HrefAttribute = name to use for link source attr, default href
; UseHash = Yes (default, start local hrefs with #) or No
; UseUlink = No (default, use ATagName for URLs) or Yes (use
; ulink for URLs, and url as the HrefAttribute within them)
; RemoveXrefHotspots = No (default) or Yes (remove hotspot text for
; xrefs and hyperlinks to Frame files, retain it for external URLs)
; UseListedXrefFilesOnly = No (default) or Yes (consider any xref
; target files not listed in [XrefFiles] to refer to the current file)
; This suppresses filenames for DocBook where files are in the same
; DocBook book; files not in the book must be listed in [XrefFiles].
; StartingSplit = Yes (default, allows split at start of file) or No
; SmartSplit = No (default) or Yes (suppress splits in sequences of
; heads which lack text bodies, as long as the [HelpContentsLevels]
; values continue to increase)
; KeepReplacedCharLinks = No (default) or Yes (retain hotspot href
; when CodeReplace is used for a char format, meant for IX pagenums
; and equivalent to setting KeepLink for all char-format CodeReplaces)
; <$$_splitnum> is a sequential identifier that begins at SplitNumStart
; and is incremented for each split file by SplitNumIncrement; it is
; mainly intended for use in [StyleFilePrefix], and may be formatted
; as usual for macro variables, with a default "%d" format.
; IndexSortType = Numeric (default, code-point order), Lexical (using MS strcoll
; functions), or Alpha (sort accented letters as though they are unaccented).
; IndexSortLocale = language to use for sorting index when IndexSortType is
; Lexical, default is current OS country setting. Uses MS language names.
; 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)
; moved from [Options] but still valid there
; HideWhiteText removes any white text (standard FrameMaker behavior)
; RemoveEmptyParagraphs = No (default) or Yes (remove paras with no text)
;EmptyParaContent = string to put in otherwise-empty paragraphs
; ConditionCharTag = tag to interpolate for conditions that affect only
; part of the enclosing element, default ph for DITA and span for HTML.
; These settings are also valid, but are now deprecated, in [HtmlOptions]
; Stylesheet = None (default if no setting), Init (default set by Setup,
; write .css if not existing), Generate (overwrite .css), Class (no
; link, no write), or Use (link, no write). If anything other than None,
; defaults are reversed for settings: NoFonts, Basefont, AlignAttributes,
; GraphAlignAttributes, NoClassLists, XrefFormatIsXrefClass, and
; This setting is now deprecated, and replaced by the following group.
; If Stylesheet setting is present, defaults are set according to it:
; Stylesheet = None Init Generate Class Use
; WriteClassAttributes No Yes Yes Yes Yes
; WriteCssStylesheet Never Once Always Never Never
; WriteCssLink No Yes Yes No Yes
; UseCSS = Yes (default, write class attributes, write link and write
; stylesheet once by default, reverse defaults for six settings listed
; above), or No (sets defaults for the three following settings to No)
; WriteClassAttributes = Yes (default) or No (when ClassIsTag=Yes or
; WriteCssStylesheet = Once (default, only if not present), Always
; (overwrite existing stylesheet if any), or Never (when using an
; existing stylesheet, or when not using CSS at all)
; WriteCssLink = Yes (default) or No (if not using CSS, or if writing
; stylesheet link independently using a macro in [Inserts]Head)
; CssBrowserDetect= Macro reference to JavaScript code used to sniff
; browser and write link to appropriate CSS stylesheet into the HTML.
; If present, WriteCssLink is ignored; if absent, and WriteCssLink=Yes,
; a simple link to CssFileName is written into the <head>
;CssBrowserDetect=<$BrowserCSS>
; CssFileName = name of stylesheet to reference in link when
; WriteCssLink=Yes and CssBrowserDetect is absent.
; CssPath = directory in which .css (or .xsl) files are to be placed
; at runtime, default is WrapPath if specified, otherwise the output
; directory, absolute or relative (to WrapPath/output) path allowed
; CSSLinkNS4 = No (default, required for CSS validation) or Yes (NS 4.x)
; ClassIsTag = No (default for HTML/XHTML) or Yes (default for Generic XML)
; LowerCaseCSS = No (default mixed case) or Yes (lower case only, default
; for JH, OHJ, XML, and XHTML)
; UseCSSLeading = Yes (default) or No (omit linespacing in CSS files)
; NoClassLists = Yes (default, no class in <LI> tags), or No
; Default is reversed to No if UseCSS=Yes.
; NoAttribLists = No (default, use type and value in list tags), or Yes
; AlwaysNestLists = No (default, no nesting when CSS used) or Yes
; LinkClassIsParaClass = No (default) or Yes (adds the same class attribute
; as is used for the current para to all links within that para)
; Default is reversed to Yes if UseCSS=Yes.
; XrefFormatIsXrefClass = No (default) or Yes (for xrefs, use the Frame
; xref format name as the xref class name; for hyperlinks, use the char
; format name instead. Mainly for DITA @outputclass use.)
; Default is reversed to Yes if UseCSS=Yes, and for DITA.
; ZeroCSSMargins = No (default) or Yes (specify CSS margins even if zero)
; UseSpanAsDefault = Yes (default, use span as element name for all char
; formats that do not specify one in [CharStyles]) or No
; FootClass = name to use for CSS class for footnotes, default "footnote"
; TbFootClass = name to use for CSS class for table footnotes
; CssFontUnits = units for font size and line height, default 0,
; 0=pt, 1=pc, 2=in, 3=cm, 4=mm, 5=em, 6=ex (0.5em), 7=px (pixels), 8=%
; CssIndentUnits = units for para space and indents, default 0,
; CssFontUnitDec = count of digits to right of decimal in CSS font
; values, 0, 1, or 2, default 2. Trailing zeros are trimmed.
; CssIndentUnitDec = count of digits to right of decimal in CSS indent
; values, 0, 1, or 2, default 2. Trailing zeros are trimmed.
; CssBodyFontSize = value for body {font-size: }, used as base for all
; em and ex sizes, and for font-size and line-height %, default 10.
; CssBodyFontUnit = units for body {font-size: }, default 0, values as above
; Use absolute value like 0 (pt), not 5 (em), 6 (ex), or 8 (%).
; CssBodyFontTag = Yes (default, writes body { text-size:) or No
; CssIndentBaseSize = value used for computing percents for margin
; settings (para space above and below, and indents) in .css file
; CssIndentBaseUnit = units for CssIndentBaseSize, default 2 (in)
; Use absolute value like 0 (pt) or 2 (in), not 5 (em), 6 (ex), or 8 (%).
; Font name and size put out at start of file, default none
; html filename = title, overrides [HtmlStyles] Title setting
; for split or extract files, use FileID+UID, such as mr516387
; m2rdesc=DCL MIF2RTF Filter Description
; original html filename = desired html filename, only for split or
; extract files, not usable for files named for the original Frame file
; 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.
; original filename (no ext) = html filename (no ext, possibly with path)
; essential if there are any xrefs to or from other files that are not
; in the current directory; the default is to leave the name unchanged
; original .fm filename = path to directory containing its .ref file,
; needed for files that are referenced from files in the current book
; and that have .htm and .ref files that are not in the same output
; directory as those produced for the current book by this project
; flowtags to Skip or to treat as Normal (to keep in same section)
; Document font name = HTML font name (comma-delimited list allowed)
; HTML font size = pt size it starts with for default usage
; for example, if 3=10 and 4=14, 12pt type becomes size=3
; computed size is overridden by [HtmlStyles] SizeN setting
; color name = hex RGB value (names as used by Frame), or
; color number = hex RGB value; color number 0 is invisible
; 1..8 = black, white, red, green, blue, cyan, magenta, yellow
; more may be defined in the Frame file; this overrides them
; numbers up to 255 may be defined here and used in [HtmlStyles]
; for example, 100=804000 defines 100 as olive brown
; 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.
; Note that many names have specific purposes, such as those for WAI attributes,
; where the Marker Type Name can start with any one of these identifiers:
; Table, to set the attribute in the enclosing table. If not positioned in
; a table, applies to the next table in the same flow.
; Row, to set the attribute in the enclosing table row.
; Cell, to set the attribute in the enclosing table cell.
; Graph, to set the attribute in the next <img> tag written.
; Link, to set the attribute in the next link (<a href=...>) tag.
; Meta, to set a <meta> tag in the <head> of the current file part.
; Any markers with Type Names starting differently are ignored by this process.
; The rest of the Type Name is used as the attribute name, so
; GraphAlt sets the alt attribute text of the next <img> tag,
; GraphLongdesc sets the <img> longdesc attribute (a URL for more info), and
; MetaKeywords sets <meta name="Keywords" content="..." /> in its file head.
; The CellGroup marker contains either "col" or "row" and acts as though
; ColGroup or RowGroup was assigned to the cell in [HtmlStyles].
; The CellSpan marker can contain anything, but must not be empty, and acts
; as though Span was assigned to a format in the cell in [HtmlStyles].
; For EclipseHelp output (only), there are three dedicated marker types:
; EclipseContext markers contain the context ID name (for CSH infopops),
; and are placed in each topic that the infopop should reference.
; EclipseAnchor and EclipseLink markers are placed in the topic preceding
; the desired anchor location; the marker content is a number for the TOC
; level, a space, and text, which is the anchor name for EclipseAnchor and
; the path to the desired TOC file for EclipseLink markers.
; Similarly, Marker Type Names beginning with JH2Pop and JH2Sec are used to
; set properties for the next JavaHelp2 link to a Popup or Secondary Window.
; Available properties are Type, Text, Size, Location, Name, Graphic, and
; text properties FontFamily, FontSize, FontWeight, FontStyle, and FontColor.
; For definitions of their content, see their [JavaHelpOptions] settings.
; Other useful Marker Type Names are TableSummary, TableTitle, CellScope,
; CellAxis, CellAbbr, and LinkTitle, all alternatives to the [HtmlStyles]
; settings. Any combination can be used, as can other types not settable
; from [HtmlStyles], such as LinkAlt.
; 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 an HTMLComment marker (literal) plus
; a Code marker (with macro expansion): HTML Macro=HTMLComment Code
; Config and HTMConfig allow use of markers to set many, but not all,
; of the mif2htm.ini settings. They differ in that Config will also
; work for corresponding settings in mif2rtf.ini. They can be used
; Globals, overriding the corresponding mif2htm.ini setting, stay in
; effect until the end of the file or until reset by another marker.
; These include settings in [Options], [HTMLOptions], and many more.
; Styles, as in [HTMLStyles], affect only the current paragraph or span
; of character-formatted text.
; Tables, as in [Table] and the rest of the [Table*] sections, affect
; the entire table within which they are placed.
; Graphics, as in [Graphics] and all [Graph*] sections, affect only the
; next graphic (when placed in the text before the anchor, or in any
; text frame within the graphic).
; Xrefs, for [XrefStyles] and [XrefStyleLinkSrc], affect only the next
; xref (in the text flow); the [XrefStyles] properties replace those
; specified for the xref format in the .ini.
; For Globals, use the usual mif2htm.ini syntax: [Section]key=value. For
; the other four (object-specific) types, omit the key: [Section]=value
; if you want to affect the current object (or next graphic or xref), or
; include it if you want to affect all objects later in the text stream.
; The [TableGroup] and [GraphGroup] markers assign their object to a named
; group, so that their settings can be in a [Table*] or [Graph*] .ini section
; for that name. Note that a given object can belong only to *one* group.
; marker type name = properties: Delete, Code, HTMLComment, Window, Split,
; ExtrStart, ExtrFinish, ExtrEnd, ExtrEnable, ExtrDisable, ExtrReplace,
; ExtrHead, ExtrTop, ExtrBottom, Title, FileName, ALink, Ansi, HelpMerge,
; Config, HTMConfig, EclipseContext, EclipseAnchor, and EclipseLink.
; Ansi specifies the Windows code page to use for FrameMaker, default 1252,
; or 1250 for CE/EE, 1251 for Cyrillic, 1253 for Greek, 1254 for Turkish.
; 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 results in the marker no longer having its original functionality.
; 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 macros in the marker are expanded normally, and
; any [MarkerTypeCodeBefore] and [MarkerTypeCodeAfter] are used for it.
; The HTMLComment type also does correct XML comments.
; The Window type sets the name of the secondary window to be used (only in
; MS HTML Help) for accesses to the topic from the contents and index.
; For Split and Extr* types, the marker should not be empty, but any content
; is ignored (unless other properties that use it are specified).
; For example, ALinkRef = Code, with the settings below in [MarkerTypeCode*],
; creates an OracleHelp ALink reference to the link identified in the marker.
; marker type name = macro; for markers listed in MarkerTypes as Code, or
; for attribute markers such as "LinkTitle" for which Code must *not* be
; For example, ALinkRef=<a href="alink:
; marker type name = macro; for markers listed in MarkerTypes as Code, or
; for attribute markers such as "LinkTitle" for which Code must *not* be
; For example, ALinkRef=">Related Topics</a>
; HTML element = additional attributes (macro) to set
; Elements supported are: body, table, tr, td, th, thead, tfoot, tbody
; For body, bgcolor=page (background) color, text=text (default) color,
; link=hyperlink active color, alink=hyperlink color when clicked,
; vlink=visited hyperlink color, and #...... = your hex color for any of these
; You can also insert JScript, such as the "onLoad" shown here
; For tables, table rows (tr), and table cells (td/th), settings may be browser
; dependent. The table attributes are emitted after the border, cellpadding,
; and cellspacing values specified under [Tables], so they should not include
; these attributes, as that would be illegal HTML. Use [TableAttributes] instead.
; Keep all attributes for one element on one line, regardless of line length
; For XHTML, all attribute names must be lower case
; body= bgcolor="#FFFFE1" text="#000080" link="#008020" vlink="#804000" onload="if (self != top) top.location = self.location"
; Condition name = attributes for elements, where the DITA attribute
; name is usually one of props, platform, product, audience, or
; otherprops. For HTML, the attribute name is usually class.
; ConditionName = Yes to show or No to hide. Any not mentioned
; are left in their current state; any not found are ignored.
; Document para style name = HTML style name (default is <P>)
; use H1-H6, PRE, SCRIPT, ADDRESS, or BLOCKQUOTE for HTML styles
; for XHTML, all styles must be lower case
; Document character style name = HTML starting element name(s)
; use STRONG, EM, CODE, CITE, VAR, BLINK, or SPAN for HTML elements
; anything specified will be used around the styled text segment
; for XHTML, all styles must be lower case
; Document style name = class to use (default is based on name)
; For XML, the class is used as the tag name by default.
; UseTypographicElements = Yes (HTML default) or No (XML default,
; suppress b, i, u, tt, sub, and sup even when specified in a format)
; UseFormatTypographics = Yes (default, use b, i, u, strike, sub
; and sup when set in paragraph or character formats), or No
; (suppress in both para and char formats)
; UseParagraphTypographics = Yes (default, use above when set in
; paragraph formats), or No (suppress in para formats)
; UseCharacterTypographics = Yes (default, use above when set in
; character formats), or No (suppress in char formats)
; UseTypographicStyles = No (default) or Yes (use tags below if set
; typographic tag (b, i, u, strike, sub, sup) = tag to use instead,
; possibly followed by attributes. Replaces overrides if used
; while [HTMLOptions]AllowOverrides=Yes, UseTypographicElements=Yes,
; and UseFormatTypographics=No.
; Frame font name = section to use for mapping chars in that font
; Same syntax as [CharConvert], below, Unicode char num = num or string
; char n = square bullet, char p = graphic
; Unicode char num = HTML numeric value or string replacement
; The unicode num can be decimal or "x" followed by hex; for chars
; less than xFF, it can also be the char itself. The replacement
; number can also be decimal or "x" plus hex; a replacement string
; can include macros such as <$MyProc> which are expanded. When a
; string rather than a number is provided, it is not encoded further.
; nonbreaking hyphen is x2011, decimal 8209, becomes entity –
; em space is x2003, becomes three nonbreaking spaces
; UseCALSModel = No (HTML default) or Yes (XML default)
; StripTable = No (default) or Yes to remove all table tagging while
; retaining the cell content for browsers that lack table support.
; Sets AllowTbSplit and AllowTbTitle by default, can be overridden.
; CloseStrippedTables = No (default) or Yes (allow elements started
; in stripped tables to remain open until closed for other reasons)
; Border, Spacing and Padding defaults for full table
; TableAttributes = Yes (HTML default, to allow above values), or
; No (XML default, to exclude those while keeping any attributes
; explicitly added in the .ini or in markers).
; The next two can be used to eliminate the automatically-generated cell
; attributes, but leave those specified in the .ini or in markers.
; CellAlignAttributes = Yes (HTML default) or No (XML default, eliminate
; automatically-generated align and valign)
; CellColorAttributes = Yes (HTML default) or No (XML default, eliminate
; automatically-generated bgcolor)
; TableSizing = Adaptive (default), Fixed (pixels), Percent (of table)
; used for setting width attribute in cells, not in the table element
; overridden for particular tables and groups in [TableSizing] section
; TableIndents = -1 (based on indent in FM), 0 (none), or count of pixels
; overridden for particular tables and groups in [TableIndents] section
; TableDPI = 96 (for Fixed, gives 624 pixels for 6.5" page
; InternalTableCaption = Yes (default) or No (put outside table)
; TableTitles = 0 to leave alone, 1 to put at top, 2 to put at bottom
; TableCaptionTag = tag for internal table captions, default "caption"
; UseTbHeaderCode = No (default, always use <td...>) or Yes (use <th...>)
; UseAltShading = No (default) or Yes (alt row/col shading as in Frame)
; UseRowColor = No (default) or Yes (set bgcolor for <tr> tag)
; overridden on table ID basis by [TableUseRowColor] settings
; RemoveEmptyTableParagraphs = No (default) or Yes (DITA/DocBook default)
; EmptyTbCellContent = string to put in otherwise-empty table cells
; TableWordBreak = No (default) or Yes (to force line breaks in tables
; when the break happens after a word-break hyphen, to fix browser bug)
; TableFootnotesWithTable = No (default) or Yes (put after separator)
; TableFootnoteSeparator = macro between table end tag and footnotes
;TableFootnoteSeparator=<br />
; 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)
; AllowTbSplit = No (default) or Yes (allow file split for head in table)
; AllowTbTitle = No (default) or Yes (allow title from head in table)
; UseInformaltableTag = No (default) or Yes (use when there is no
; table caption, as in DocBook)
;For WAI, AccessMethod = None (default), Scope, or IDheaders
; sets the basic policy for adding accessibility for tables
; Scope sets ScopeColGroup, ScopeRowGroup. ScopeCol and ScopeRow.
; It sets ColSpanIDs and RowSpanIDs for other straddling header cells
; (for lack of a better alternative; there's no scope for spans).
; IDheaders sets ColGroupIDs, RowGroupIDs, ColSpanIDs, RowSpanIDs,
; ColIDs, and RowIDs, so that most header cells have IDs and the
; corresponding body cells have matching headers.
; HeadFootBodyTags = No (default) or Yes (to wrap table rows in <thead>,
; <tfoot>, and <tbody> groups; needed to enable scope="rowgroup")
; FootTagLast = No (default, put after thead) or Yes (keep NS4 happy)
; ColGroupElements = No (default) or Yes (to put out <colgroup> elements
; before first table row; needed to enable scope="colgroup")
; TableHeaderCols = count of cols in which to treat cells as headers,
; counting from left at the start of each row in the table
; TableHeaderRows = count of rows in which to treat cells as headers,
; counting from the top of the table
; TableFooterRows = count of footer rows from bottom of the table,
; significant only when HeadFootBodyTags = Yes.
; ScopeColGroup = No (to not use) or Yes (to apply scope="colgroup"
; instead of "col" to column head cells identified as ColGroup via
; [HtmlStyles] or the CellGroup marker col; sets ColGroupElements).
; ScopeRowGroup = No (to not use) or Yes (to apply scope="rowgroup"
; instead of "row" to row head cells identified as RowGroup via
; [HtmlStyles] or the CellGroup marker row; sets HeadFootBodyTags).
; ScopeCol = No (to not use) or Yes (to apply default scope="col"
; to non-empty cells in table header)
; ScopeRow = No (to not use) or Yes (to apply default scope="row"
; to first non-empty cell in each row in the table)
; ColGroupIDs = No (default) or Yes (to use id="groupN" in col head cells
; identified as ColGroup via [HtmlStyles] or the CellGroup marker col)
; RowGroupIDs = No (default) or Yes (to use id="groupN" in row head cells
; identified as RowGroup via [HtmlStyles] or the CellGroup marker row)
;RowIDs and ColIDs set row and col IDs in table header cells
; and the matching headers attribute in table body cells
; ColIDs = No (to not use), or Yes
; adds id=colN to first cell in header row of each column
; adds headers=colN to each cell below in the same column(s),
; RowIDs = No (to not use), or Yes
; if ColIDs are used, does not affect all the header rows.
; adds id=rowN attribute to the first cell of each body row,
; adds headers=rowN to each following cell in that row,
;Span is more flexible, and can be used with row and col
; ColSpanIDs = No (to use only per markers or formats), or Yes
; adds id=spanN to each cell in header rows that spans columns,
; or that has a CellSpan marker, or contains any para formats
; with [HtmlStyles] Span, increments for each one used.
; adds headers=spanN to all cells below the spanning cell.
; RowSpanIDs = No (to use only per markers or formats), or Yes
; adds id=spanN to first cell in each row if it spans rows, or
; if it has a CellSpan marker, or if it has any para formats
; with [HtmlStyles] Span, increments for each one used.
; adds headers=spanN to all cells right of the spanning cell.
; if ColSpan used, first ID numerically follows last ColSpanID.
; ColGroupHead is "group" by default; it is used in the id attrs
; of header cells containing a para format with [HtmlStyles]ColGroup.
; RowGroupHead is "group" by default; it is used in the id attrs
; of left cells containing a para format with [HtmlStyles]RowGroup.
; If ColGroup is used, first ID numerically follows last ColGroup ID.
; ColHead is often seen in examples as "header", but this is
; not essential; it can be any useful identifier:
; RowHead is usually row, but again could be anything:
; ColSpanHead is usually "span".
; RowSpanHead is usually also "span"; that's why the ID numbers
; used for ColSpan are skipped for RowSpan
; table ID or format = group name usable in other Table sections for ID
; the filter first looks for specific ID, then group, then table format
; table ID = text (macro) to put inside table element, overrides settings
; in [Table] for Border, Spacing, and Padding, and [Attributes] for <table>
; table ID = method list (overrides default in [Tables]) of ColIDs, RowIDs,
; ColSpanIDs, RowSpanIDs, ScopeCol, ScopeColGroup, ScopeRow, ScopeRowGroup,
; ColGroupIDs, RowGroupIDs, or any prefixed with No, such as NoColIDs.
; Can override [Table]AccessMethod policy with NoAccess, Scope, or IDs,
; and HeadFootBodyTags with HFBTags, ColGroupElements with CGElems.
; Can also include HColsN and HRowsN, where N is the number of cols or
; rows to make td -> th (overrides TableHeaderCols and TableHeaderRows),
; and FRowsN to override TableFooterRows.
; table ID = text of macro to put before table start or top title or indent
; table ID = text of macro to put after <table> tag before first <tr>
; This is where a set of custom <colgroup> elements would go.
; table ID = text of macro to use in place of table (and title and indent)
; table ID = text of macro to put just before </table>
; table ID = text of macro to put after table end or bottom title
; table ID = number of pixels to indent using PixelSpacerImage
; zero prevents indent, -1 is autoindent (default action)
; overrides default set in [Table]TableIndents for its table or group
; table ID = text (macro) to put inside <tr>, overrides [Attributes] for <tr>
; table ID = Yes or No, overrides UseRowColor
; table ID = text of macro to put on line after <tr>
; table ID = text of macro to put before </tr>
; table ID = text (macro) to put inside <td>, overrides [Attributes] for <td>
; table ID = text of macro to put after <td>
; table ID = text of macro to put before </td>
; table ID = text (macro) to put inside <thead>, overrides [Attributes] for <thead>
; table ID = text (macro) to put inside <tfoot>, overrides [Attributes] for <tfoot>
; table ID = text (macro) to put inside <tbody>, overrides [Attributes] for <tbody>
; table ID = type of sizing: Adaptive (default), Fixed (pixels), Percent (of frame)
; overrides default set in [Table]TableSizing for its table or group
; These are used to create a local TOC to split-off files after a heading.
; The TOC is placed wherever the <$_localtoc> predefined macro appears.
; The item titles are the titles of their files, which can be overridden
; by the contents of a LocalTOCTitle marker. The start and end macros can
; be redefined below, or eliminated by giving them an empty definition.
; If there are no subitems to a heading, no TOC at all is written for it.
; The <$_lastlocaltoc> macro repeats the last local TOC produced in full.
; MakeLocalTOC = No (default) or Yes (enable use of <$_localtoc>)
; LocalTOCStart = starting code for <$_localtoc>
;LocalTOCStart=<p class="localtocstart">In this section:</p>
; LocalTOCItem = code for each <$_localtoc> item
;LocalTOCItem=<p class="localtocitem"><a href="<$$_loctocfile>"><$$_loctoctitle></a></p>
; LocalTOCEnd = ending code for <$_localtoc>
; LocalTOCSubs = false (default, include only next level below current para)
; or true (include all levels below current para, and change the LocalTOCItem
; default to begin with <p class="loctocind<$$_loctocind>">, where the macro
; var <$$_loctocind> is the indent level of the item starting with "1")
; if this section is missing, [HelpContentsLevels] is used instead.
; paraformat = level, from 1 to anything, or 0 to exclude from local TOC
; Only formats for which [HtmlStyles] Split is set are recognized here.
; These are used to create a trail, such as "Chapter > Head1 > Head2",
; which is put out for the current heading if the [HtmlStyles] Trail
; property is set for its para format, or if Split is set and also
; SplitTrail=Yes. Levels are set in [TrailLevels]. The heading must
; either be the first in the file, or begin a split or extracted file.
; For both split and extracted files, and for the original file, the
; <$_trail> predefined macro causes insertion of a trail according to
; the settings in [Trails]. The trail is always to the first para in
; the file; it is put out only if MakeTrail=Yes.
; MakeTrail = No (default) or Yes (enable use of <$_trail> as above)
; SplitTrail = No (default) or Yes (put <$_trail> out for each split head)
; TrailStart = starting code for <$_trail>
; TrailSep = code between <$_trail> elements
; TrailEnd = ending code for <$_trail>
; TrailLinkClass = value for class attribute in trail links, default is none
; TrailCurrent determines when the current element is put (without a link)
; as the last item in <$_trail>. The choices are Yes (default, put out only
; when there is at least one item in <$_trail> already), No (never put out),
; or Always (put out even if alone in <$_trail>). Always is useful if you
; have embedded another link in TrailStart, perhaps to the TOC.
; TrailPosition = Before (default), After, or Macro (where <$_trail> appears).
; The Macro choice eliminates automatic placement, useful when the <$_trail>
; is used in [Inserts] to put it at the Top or Bottom; the macro used is that
; in effect at the beginning of the HTML file.
; TrailIndent = number of s to put after TrailSep for each
; output line to create indentation; a value of 1 puts one space
; before the second line, two before the third, three before
; the fourth, etc. A value of 2 puts 2, 4, 6, etc. Zero disables.
; If a value over 4 is set, it is reduced to 4.
; Trail*Level settings determine where the trail starts and ends. If any
; level is missing from the Frame file being processed, including the first,
; it is skipped. Typically you would not want trails generated for heads
; that do not start new HTML files, so the Last setting lets you trim those.
; if this section is missing, [HelpContentsLevels] is used instead.
; paraformat = level, from 1 to 9, or 0 to exclude from trails. Any
; missing levels are skipped, so you can indicate a para that should
; always end its trail (such as an extracted figure title) with a 9.
; UseDropDowns = No (default) or Yes (enable use of dropdowns)
; DropLinkType = Icon (default, optional text), Button, or Text (only)
; Default macros for link start/end
DropLinkStart=<a class="<$DropClass>"\n <$DropLinkAttr>>
; If you use DropLinkPara, add CSS for it to match its context
DropLinkParaStart=<p class="<$DropClass>">
; <$DropLinkStart> is next; if DropLinkType=Icon, both icons follow it.
; This text is omitted if DropLinkType=Button:
; <$DropLinkEnd> in next unless DropLinkType=Button
; Default macros for block start/end
DropBlockStart=<div class="<$DropClass>" id="<$$_DropID>" style="display:none;" <$DropDivAttr>>\n
; ClickBlockToClose = Yes (default) or No (use if any links inside block)
; DropIcons can be used with or without link text
; WriteDropIconFiles = No (default) or Yes (write to output directory)
; Edit the DropIconFile/Alt macros to change image or alt text:
DropOpenIconAlt=Click to open.
DropCloseIconFile=dropclose.gif
DropCloseIconAlt=Click to close.
; Edit the DropIcon macros to alter style only:
DropOpenIcon=<img\n src="<$DropOpenIconFile>" id="io<$$_DropID>" style="border:0;" alt="<$DropOpenIconAlt>">
DropCloseIcon=<img\n src="<$DropCloseIconFile>" id="ic<$$_DropID>" style="display:none;border:0;" alt="">\n
; DropButtons can be used instead of icons and text
; so that this replaces DropLinkStart/Text/End
DropButton=\n<button type="button" class="<$DropClass>" id="bu<$$_DropID>" <$DropButtonAttr>><$DropButtonOpenLabel></button>\n
; Default components used in the DropDown macros
DropLinkAttr= href="javascript:doSection('<$$_DropID>');void 0;"
DropButtonAttr= onclick="doSection('<$$_DropID>')"
; If ClickBlockToClose=No, this is omitted:
DropDivAttr= onclick="noSection('<$$_DropID>')"
; This is the code that goes in the <head> or in a JS file
; DropJSLocation = Head (to insert the code in <script> tags),
; None (if the code is included elsewhere), or a filename to
; reference in a JS link in the <head>. The filename can
; have an absolute or relative (to the output dir) path.
; WriteDropJSFile = No (default, user provides it) or Yes
; (write to name given in DropJSLocation, but in output dir)
; doc style (para or char) = keywords for functions and properties
; Delete removes the style and all of its content
; Left, Center, Right, Size1 - Size7 apply those props to head
; Bold, Ital, ULine, and Strike apply those char props to text
; Plain turns all four of those char props off by default.
; Color1 - Color254 color text as defined in Frame and [Colors]
; NoColor suppresses use of the <font color=...> in the style.
; Overrides allows text prop overrides for B, I, U, and Strike,
; even if [HtmlOptions]AllowOverrides is turned off
; List1 - List12 specify different list styles:
; 1-5 = OL, ordered list types 1, i, I, a, and A
; 6-8 = UL, unordered list types disc, circle, and square
; The rest vary from one browser to another; Opera shows as:
; 9 = DIR, nonindented list, no bullets or numbers
; 10 = MENU, bulleted and indented like 6
; 11 = DL, dictionary list, indented, no bullets
; 12 = DL COMPACT, like 11 but with less spacing
; LFirst specifies a style that starts a list
; LEnd specifies a non-list style that ends any prior lists
; LNest specifies a style that nests in an enclosing list
; LLevel specifies the nesting level to use, 1-30
; DListDD specifies use of dd instead of dt for items in dl lists
; Anum includes Frame autonumber in para. For lists, and for
; DocBook and DITA, the default omits it.
; NoAnum excludes autonumber in non-list items, default keeps it
; for formats other than DocBook and DUTA.
; CodeBefore uses code in [StyleCodeBefore] before element tag
; CodeStart uses [StyleCodeStart] right after element tag
; CodeEnd uses [StyleCodeEnd] just before closing element tag
; CodeAfter uses [StyleCodeAfter] right after closing tag
; CodeReplace uses [StyleCodeReplace] (no Before or After)
; CodeBeforeAnum uses [AnumCodeBefore] before the paranum
; CodeAfterAnum uses [AnumCodeAfter] after the paranum
; Any Code can call a macro with <$macname> or <$.\macfile.htm>
; 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 HTML text (same as
; used for Title) 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 are HTML tags.
; If more than one instance of the format appears in the Frame file,
; only the last one used is retained, and is available in all split and
; extracted files (unlike Title, which is seperate for each HTML file).
; Contents (when ObjectIDs=Referenced) causes the ObjectID to be
; retained so that FM-generated links from the TOC will work
; NoContLink suppresses linkage for its Contents item in MS HTML Help;
; the item remains in the Contents pane, but clicking on it does not
; bring up the corresponding topic in the main pane.
; Split starts new HTML page at the start of its paragraph.
; NoSplit prevents the para format from interfering with SmartSplit
; when it occurs in between heads that would otherwise be kept together.
; Window specifies for MS HTML Help only that access from the contents
; or index opens the topic in the window named in [StyleWindow]
; Title uses head as HTML page title, see [Titles]; it may be preceded
; by [StyleTitlePrefix] and followed by [StyleTitleSuffix],
; The prefix and suffix are not used in trails or the LocalTOC, if any.
; FileName uses the contents of the para as the filename for the split
; part, which is preceded by [StyleFilePrefix] and followed by
; [StyleFileSuffix], with the extension added on after that.
; It only contains legal name chars if [HtmlOptions]UseRawName=No.
; Meta uses the contents of the para as the content attribute of a meta
; tag in the head. It gets the name attribute from [StyleMetaName].
; It works similarly to the markers of type MetaSomething.
; ALink, effective for MS HTML, OH, and Oracle Help, uses the contents of
; the para for the value of the ALink Name parameter of an ALink object.
; Config and HTMConfig 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.
; ParaLink prevents any char formats in the named para format from
; affecting the hotspot area for a link in that para.
; LinkSrc uses code in [StyleLinkSrc] in the href attribute of the
; tagged links; <$$_linksrc> is available with the normal href content.
; ParaLinkClass uses the name in [StyleParaLinkClass] as the class attribute of the
; contained links; if none is specified, it uses the same class as the para itself
; KeepLink is used with CodeReplace for char formats only, and retains
; the first hyperlink in the replaced text; meant for IX <$pagenum>s
; NoHref supresses <a href=...> tags in para formats; meant for IX formats
; Level1IX and Level2IX to prevent links for See Also entries when using
; KeepLink, which overrides NoHref for the real page numbers.
; NoRef suppresses the part of the link after the filename, so that the link
; goes to the start of the split file rather than to the CR marker location
; Trail, if [Trails]MakeTrail=Yes, causes the <$_trail> to be put out as
; specified by [Trails] settings. Trail elements themselves are the same
; as the Title text for their para, without the [StyleTitlePrefix] and
; [StyleTitleSuffix]. They are preceded by [StyleTrailPrefix] and
; followed by [StyleTrailSuffix],
; DropDown puts a DropLinkPara and DropBlockStart before
; the current para, and a DropBlockEnd after it. Note that
; you need to add the proper CSS for p.dropdown in this case.
; DropDownLink puts DropLinkStart/End around the text in
; the current para (or char) format, used with DropDownBlock.
; DropDownBlock puts DropBlockStart/End around the current
; para, outside its tags, used after DropDownLink.
; DropDownStart puts DropLinkStart/End around the text in
; the current para, and DropBlockStart after it.
; DropDownEnd puts DropBlockEnd after the current para.
; CSSReplace uses [StyleCSS] to specify on a single line the code
; to be written to the .css for the format when WriteCssStylesheet
; is Always or Once in [HtmlOptions].
; NoCSS suppresses any writing of info to the .css file for its format.
; Extr* properties provide a way of extracting the content of a part
; of the document into an "extract" file, replacing it with a link.
; ExtrStart begins an extract. ExtrFinish is the last part of it, and
; ExtrEnd ends it but is not part of the extract itself (like LEnd);
; the two properties are alternative ways of ending an extract. If
; the extract is one para, use both ExtrStart and ExtrFinish for it.
; ExtrEnable and ExtrDisable turn extract processing on or off; the
; starting state is given in [HtmlOptions]ExtractEnable=Yes or No
; The [Extr*] sections provide additional per-style macro definitions:
; [ExtrReplace] contains the material to put in the original file,
; in place of the extracted paragraph, typically a link to it
; [ExtrHead], [ExtrTop], and [ExtrBottom] override the [Inserts]
; macros with the same names for the extract file
; In extracted text, Title, FileName, and Meta affect the extract file
; instead of the original file
; FrameAbove and NoFrameAbove override the RemoveFramesAbove default
; FrameBelow and NoFrameBelow override the RemoveFramesBelow default
; NoBreak changes any Shift+Enter in the para to space instead of
; <br> for HTML and XHTML, but has no effect in <pre> where it
; remains a line ending, or in XML formats where <br> is invalid.
; The next two apply to XML formats, but not to XHTML or HTML. In
; preform-type elements, Shift+Enter is always a line ending.
; XMLBreak closes the current para tag at each Shift+Enter, and reopens
; it without attributes; overrides [HTMLOptions]XMLBreakPara=No.
; XMLNoBreak replaces each Shift+Enter with a space; overrides
; [HTMLOptions]XMLBreakPara=Yes.
; Comment makes the entire element a comment, replacing the para tags,
; unless ParaStyle is "script", then the comment is within the tags
; NoTags supresses any attributes for the para tag, and any tags within
; NoPara eliminates the para tags only, which must be provided in a macro
; Raw acts like NoTags, and also eliminates the para tags entirely
; It is used to put macro inclusions in between document elements
; TextFrameIsText is applied to an anchor para format to cause anchored
; frames containing a text frame to be rendered as in-line text. It is
; best used with NoPara NoTags to remove the empty anchor para itself.
; GlossTerm is used for JavaHelp 2 only, to identify para formats used for
; glossary terms (where they are defined in the next following paragraph).
; NoFig is used in DITA for a graphic anchor para to prevent wrapping
; of the image inside it in a fig tag.
; These provide support for Web Accessibility Initiative table markup.
; RowAttribute inserts the contents of [StyleRowAttribute] into
; the start tag of the enclosing table row (ignored outside tables).
; CellAttribute inserts the contents of [StyleCellAttribute] into
; the start tag of the enclosing table cell (ignored outside tables).
; Span causes assignment of ColSpanID or RowSpanID to the enclosing cell,
; regardless of the ColSpanIDs or RowSpanIDs [Table] settings.
; NoColID prevents assignment of id for ColIDs (when enabled in [Table])
; for any cell that contains an instance of its para format.
; ColGroup is used for para formats in cells in the header of their table.
; If ColGroupElements = Yes, each ColGroup cell starts a new colgroup.
; If ColGroupIDs, the cell is given an id attr comprised of the ColGroupHead
; and a sequential number; this id is used as a header attr in all cells
; to the right or below, until the cell with the next ColGroup para. It
; also prevents assignment of a ColID for its cell (but not below or right).
; RowGroup is used for para formats in cells at the left of their rows.
; If HeadFootBodyTags = Yes, each RowGroup starts a new tbody rowgroup.
; If RowGroupIDs, the cell is given an id comprised of the RowGroupHead
; and a sequential number; this id is used as a header attr in all cells
; to the right or below, until the cell with the next RowGroup para. It
; also prevents assignment of a RowID for its cell (but not below or right).
; These alter properties or attributes of their table cell:
; TableHead forces containing cell tag to th instead of td
; TableBody forces containing cell tag to td instead of th
; Abbr looks up value for abbr= attribute in [StyleCellAbbr]
; Axis looks up value for axis= attribute in [StyleCellAxis]
; Scope looks up value for scope= attribute in [StyleCellScope]
; These para format properties all make their content into attributes.
; If you don't want the content in the text also, use with Delete.
; Table cell, for current <td> or <th>:
; AbbrVal makes current para content into abbr attribute
; AxisVal makes current para content into axis attribute
; Table, for current or next <table> tag:
; Summary makes current para content into summary attribute
; TableTitle makes current para content into title attribute
; Graphic, affects next <img> tag:
; Alt makes current para content into alt attribute
; Longdesc makes current para content into longdesc attribute
; Link, affects next <a href=...> tag:
; LinkTitle makes current para content into title attribute
; LinkClass makes current para content into class attribute
; used to set the link display properties in CSS.
; Macros and macro variables may also be referenced in the attributes,
; both from markers and from text identified as attribute content.
; The Link* markers (and LinkTitle text) may reference <$$_linksrc>.
; TableTitle=Center Size4 Bold Italic
; Numbered1=List1 LFirst Overrides
; BulletedLast=List6 Overrides CodeAfter
; All of the following sections, here called [Style*], may also be
; named [HtmlStyle*] for back compatibility. The same applies to
; doc style = HTML code to use before starting element such as <p>
; doc style = HTML code to use after starting element
; doc style = HTML code to use before ending element such as </p>
; doc style = HTML code to use after ending element
; doc style = HTML code to use instead of para (no elements used)
; doc style = HTML code to use before start of autonumber if any
; doc style = HTML code to use after end of autonumber sequence
; doc para format = name of macro variable in which to store para content
; if omitted, default is a macro variable of the para format name
; doc para format = name of macro variable in which to store para text
; if omitted, default is a macro variable of the para format name
; doc style = CSS code to use in .css file, use macro if more than one line
; CSS code to be inserted at the start of the .css file if generated
; CSS code to be inserted at the end of the .css file if generated
; doc style = attribute to insert in enclosing table row start tag,
; used in addition to other row attributes given under [Table...]
; doc style = attribute to insert in enclosing table cell start tag,
; used in addition to other cell attributes given under [Table...]
; format name = abbr attribute value to insert in enclosing cell,
; format name = axis attribute value to insert in enclosing cell,
; format name = scope attribute value to insert in enclosing cell,
; required by WAI to be one of col, colgroup, row, or rowgroup.
; doc style = prefix to use (if any) for file title in para content
; doc style = suffix to use (if any) for file title in para content
; doc style = prefix to use (if any) for file title in trails
; doc style = suffix to use (if any) for file title in trails
; doc style = prefix to use (if any) for file name in para content
; doc style = suffix to use (if any) for file name in para content
; doc style = name to use for meta tag whose content is the para text
; doc style = text macro to use in the href attribute of the tagged links
; <$$_linksrc> is available to use in the macro, with the normal href content.
; doc style = name to use in the class attribute of the links in the para
; para style = window to use in HH when accessed from contents or index
; doc style = HTML code to use instead of tab sequence, can be macro
; doc style = HTML code to use instead of extracted para, which may use
; three predefined macros; the extract file name is <$$_extrfile>, the
; first extracted graphic file name, after it has been modified by any
; ExtrGraphSuffix, is <$$_extrgraph>, the FDK ID of that graphic is
; <$$extrgraphid>, and the title of the extract page is <$$_extrtitle>.
; doc style = text to use for title of the extract file, which may use
; macros, including <$$_currtitle> which has the title of the parent file.
; This is ignored if the Title is set for any para in the extract file.
; doc style = HTML code for the head of the extract file, see [Inserts]
; doc style = HTML code for the top of the extract body, see [Inserts]
; doc style = HTML code for the bottom of the extract body, see [Inserts]
; xref format name = properties (Delete, Text, NoRef, or LinkSrc)
; if Delete or Text are not used, xref is treated as a link by default
; NoRef suppresses the part of the link after the filename, so that the link
; goes to the start of the split file rather than to the CR marker location
; LinkSrc permits modification of the link href, as with [HtmlStyles]
; xref format name = text macro to use in the href attribute of the xref link
; <$$_linksrc> is available to use in the macro, with the normal href content.
; doc style = name of secondary window to use for jumps from
; within the span marked by this style (same as WinHelp usage).
; For OracleHelp, JavaHelp, and OmniHelp, window name Popup specifies popups.
; For OmniHelp, after the window name are optional comma-separated parameters
; The first is width (pixels), the second height, and the third a list of
; properties to pass to the JS window.open() function. Those properties
; are also comma-separated, but unlike the sizes must have *no* spaces in
; between them; see JS docs for acceptable values. Some examples:
;ProcWin2=proc, 400, 600, menubar,titlebar,title,scrollbars
; doc style = name of frame to use for jumps from within this style
; For OmniHelp ALink and KLink jumps, targets make no sense and are ignored.
; filename (no ext) or URL destination = target frame to be used
; a URL destination is the last element in the URL (no extension)
; location = macro to insert, can call another macro
; BeginFile is placed at the very start of the file
; Entities is placed before the HEAD element
; BeginFile and Entities are also used for split and extracted files
; Head is placed after the TITLE element within the HEAD element
; Frames is placed between the HEAD and BODY (for framesets)
; Top is placed at the beginning of the BODY element
; Bottom is placed just before the ending of the BODY
; End is placed after the ending of the BODY (to close NOFRAMES)
; For split files, there are more locations:
; The first file gets FirstHead, FirstFrames, FirstTop, FirstBottom,
; and FirstEnd. If FirstBottom is not defined, SplitBottom is used
; if it is defined, otherwise Bottom. If any others are not defined,
; the corresponding non-First item is used.
; The last file gets LastHead, LastFrames, LastTop, LastBottom, and
; LastEnd. If any of the first three are not defined, the related
; Split form is used, otherwise the non-Last (as for the last two).
; SplitHead, SplitFrames, SplitTop, SplitBottom, and SplitEnd are used
; for all the files except the first and last ones. If any are not
; defined, the corresponding non-Split item is used.
; NonsplitTop and NonsplitBottom are used when splitting does not
; occur in the file; if they are missing, FirstTop and LastBottom
; (or, if that is also missing, FirstBottom) are used instead.
; For extracted files, only the macros ExtrHead, ExtrTop, and ExtrBottom
; apply; specific overrides to them may be given in their style sections.
; Bottom=<br><hr> or: <br /><hr /> for XHTML
; These employ the file sequence information from the .book file to simplify
; setup of navigation tables at the start and end of HTML pages.
; UseNavButtons = No (default, use links for <$_prev> and <$_next>)
; or Yes (change the set of defaults to those for buttons instead)
; This setting can be altered in a Config macro any time before use.
; When UseNavButtons=No, these are the navigation macros used, which can
; TopMacro = content to put out for <$_top>, link to top of current file
TopMacro= <a href="<$$_currfile>"><$$_toptitle></a>
; PrevMacro = content to put out for <$_prev>. For example, to add a title
; attribute to the link in <$_prev> for WAI purposes:
; PrevMacro= <a href="<$$_prevfile>" title="<$$prevtitle>"><$$_prevtitle></a>
PrevMacro= <a href="<$$_prevfile>"><$$_prevtitle></a>
; NextMacro = content to put out for <$_next>
NextMacro= <a href="<$$_nextfile>"><$$_nexttitle></a>
; For the first split part (the one with the original name, or the first
; split part if StartingSplits are used), <$_prev> is changed to use:
; PrevFSMacro = <$_seqprev>, macro to use for <$_prev> at start of file
PrevFSMacro= <a href="<$$_seqprevfile>"><$$_seqprevtitle></a>
; For the last file part, <$_next> is changed to use:
; NextFSMacro = <$_seqnext>, macro to use for <$_next> at end of file
NextFSMacro= <a href="<$$_seqnextfile>"><$$_seqnexttitle></a>
; StartingPrevFSMacro = <$_prev> to use at start of first file in book
StartingPrevFSMacro= <$$_seqstarttitle>
; EndingNextFSMacro = <$_next> to use at end of last file in book
EndingNextFSMacro= <$$_seqendtitle>
; When UseNavButtons=Yes, these (modifiable) macros are used instead:
TopButton= <button type="button" onclick="javascript:location.href='<$$_currfile>'"><$$_toptitle></button>
PrevButton = <button type="button" onclick="javascript:location.href='<$$_prevfile>'"><$$_prevtitle></button>
NextButton = <button type="button" onclick="javascript:location.href='<$$_nextfile>'"><$$_nexttitle></button>
PrevFSButton = <button type="button" onclick="javascript:location.href='<$$_seqprevfile>'"><$$_seqprevtitle></button>
NextFSButton = <button type="button" onclick="javascript:location.href='<$$_seqnextfile>'"><$$_seqnexttitle></button>
StartingPrevFSButton = <button type="button"><$$_seqstarttitle></button>
EndingNextFSButton = <button type="button"><$$_seqendtitle></button>
; These titles are used regardless of the UseNavButtons setting:
; TopTitle = definition of <$$_toptitle>
; StartingPrevFSTitle = definition of <$$_seqstarttitle>
; EndingNextFSTitle = definition of <$$_seqendtitle>
; While for most purposes the <$_prev> and <$_next> macros suffice, a large
; set of component macro variables is predefined for split files.
; <$$_currfile>, <$$_prevfile>, and <$$_nextfile> put out filenames of the
; current, previous, and next split parts.
; <$$_currbase> puts out the basename only (no extension) of the current doc..
; <$$_currtitle> is the title of the current doc, unaffected by extracts, so
; it can be used it in an extract to get the parent doc title.
; <$$_basetitle> is the title of the original doc, unaffected by splits;
; <$$_basefile> is the basename of that doc file.
; <$$_prevtitle> and <$$_nexttitle> are the titles of the <$$_prevfile>.and
; There are also predefined "booleans" that are *not* names: <$$_firstfile>
; and <$$_lastfile> return "1" when true or else "0". These are meant for
; For extracted files, the normal predefined macro vars contain the original
; file names, and the extract file is <$$_extrfile>. The first extracted
; graphic file name, as modified by any [Graphics]ExtrGraphSuffix, is
; <$$_extrgraph>, and its FDK name (ID) is <$$_extrgraphid>. The title of
; the current extracted file is <$$_extrtitle>, which may be used in the
; replace macro for the extract format when referencing the extract. See
; the description in [Graphics] for the <$_extrthumb> predefined macro.
; <$$_seqcurrtitle> is the title of the current file. From the .book file
; information, <$$_seqprevfile> is the filename (with extension) of the
; preceding file in sequence, and <$$_seqprevtitle> is that file's title.
; <$$_seqnextfile> and <$$_seqnexttitle> are for the next file in sequence.
; These are rarely needed, as they are used in place of the corresponding
; <$$_prev*> and <$$_next*> macro vars for the first and last parts of the
; UseGraphicPreviews = No (default) or Yes (use preview bitmaps for frames)
; moved from [Options] but still valid there
; EpsiUsage = Preview (only, default), EPS (no preview) or Retain (both)
; StripGraphPath = No (default) or Yes (remove path from imported graphics)
; GraphPath = path to use (replacing any previous one) for all graphics
; GraphPathOverrides = No (default) or Yes (overrides any path in Config
; markers and in [GraphFiles], adding GraphPath and using FixGraphSpaces)
; GraphSuffix = suffix to use in place of Frame imported graphics suffixes
; KeepGraphicsInPara = No (default) or Yes (keep inline graphics in para block)
; GraphWrapPara = Yes (default, wrap graphics that are not inline in
; paragraph tags) or No (eliminate wrapping tags)
; UseOriginalGraphicNames = No (default, always use previews) or Yes (if avail)
; UseImageIDs = No (default) or Yes (add frame ID as id attrib in img tag)
; FixGraphSpaces = Yes (default, replace spaces with underscores) or No
; GraphClass = class name to use for paras created to hold <img> tags
; GraphScale = Yes (default) to put out width and height attributes,
; or No to eliminate them all (mainly for Generic XML)
; UsePxSuffix = Yes (default except for JavaHelp, include "px" in the
; width and height attributes), or No (JavaHelp default)
; GraphAlignAttributes = Yes (default, allow when set in [GraphAlign])
; or No (no align attribute in img tags even if set in [GraphAlign]).
; Default is reversed to No if UseCSS=Yes.
; RefPageGraphIndent = Yes (treat reference-page graphic indents normally)
; or No (suppress use of spacer before graphics from reference pages)
; UseTitleForAlt = No (default) or Yes (use title attribute instead of alt for
; the alt content, for Netscape compatibility; adds alt="" for W3C validation)
; This affects only alts added in the [GraphALT] section, not those added
; using markers or the [HtmlStyles] Alt property, which are unchanged.
;ImgTagElement = tag to use for all image elements, default is "img"
;ImgSrcAttr = name to use for all image source attrs, default is "src"
; XMLGraphAttrs = No (default) or Yes to add attrs to XML <img .../> tags:
; xml:link="simple" show="embed" actuate="auto"
; The predefined macro <$_extrthumb> is available for use in [ExtrReplace],
; with the equivalent default of:
; <p class="<$$_extrgraphclass>"><a href="<$$_extrfile>"
; target="<$$_extrgraphtarget>"><img src="<$$_extrgraph>" \
; <$_if ($$_extrgraphhigh > 0)> height="<$$_extrgraphhigh>"<$_endif>\
; <$_if ($$_extrgraphwide > 0)> width="<$$_extrgraphwide>"<$_endif>\
; alt="<$$_extrtitle>" /></a></p>
; ExtrGraphThumbnail = Named (default, use orig name plus ExtrGraphSuffix),
; or Scaled (use ExtrGraphHigh and/or ExtrGraphWide to set sizes)
; OrigSizedThumbnail = No (default) or Yes (use original Frame size for it)
; ExtrGraphSuffix = suffix for file name of first graphic in an extract,
; used in the predefined <$$_extrgraph> macro to identify its thumbnail
; only if ExtrGraphThumbnail=Named, default is "tn"
; ExtrGraphClass = name of CSS class to use in predefined <$_extrthumb> macro
; ExtrGraphTarget = target attribute for window used by <$_extrthumb>
; If you want to use a reduced size for the thumbnail graphic, but not all
; of your images have the same aspect ratio, set only one of the High or
; Wide properties to the pixel size you want, and set the other to 0. If
; OrigSizedThumbnail is Yes, the Frame pixel sizes are used instead.
; ExtrGraphHigh = size in pixels for height of thumbnail display of graphic
; when ExtrGraphThumbnail=Scaled, default 96 pixels (one inch)
; ExtrGraphWide = size in pixels for width of thumbnail display of graphic
; when ExtrGraphThumbnail=Scaled, default 96 pixels (one inch)
; FDK name = graphic group name, any name you want
; in the rest of the Graph sections, you can then use the group name
; in place of the FDK name, and have the setting affect all graphics
; defined in this section as being in that group, except those that
; are explicitly given a different property setting in later sections
; FDK name (with or without extension) = new name (with extension)
; new name overrides any [Graphics]GraphPath specified
; FDK name (with or without extension) = desired attributes
; ch01f853.gif= usemap="#schematic" border="0"
; FDK name (with or without extension) = desired ALT tag
; if UseTitleForAlt = Yes, sets title attribute instead of alt
; ch01f853.gif=Schematic of tuner
; for image map areas (hotspots), the format is:
; destination or FDK name#dest or URL dest = desired ALT tag
; a URL destination is the last part of the URL without extension
; ch01f853#RFstage=Tuner first stage
; mif2go=Jump to http://www.omsys.com/dcl/mif2go.htm
; IFstage=Intermediate Frequency stage
; FDK name = desired alignment to text, one of these: left, right,
; top, texttop, middle, absmiddle, baseline, bottom, or absbottom
; FDK name = desired alignment for containing para: left, right,
; or center, primary method of centering standalone graphics
; FDK name = DPI to use when generating, overrides [FDK]GraphicExportDPI
; FDK name = percent of original size to scale (both dimensions)
; FDK name = number of pixels wide, 0 to omit width attribute
; FDK name = number of pixels high, 0 to omit height attribute
; FDK name = number of pixels to indent using PixelSpacerImage
; zero prevents indent, -1 is autoindent (default action)
; FDK name = number of pixels space on right using PixelSpacerImage
; FDK name = text of macro to put before graphic
; FDK name = text of macro to put instead of graphic
; macro can use predefined variables <$$_graphsrc> as the name that
; would have been used in the <img src=...> attribute, with ext,
; and <$$_graphbase> as the same without extension. <$$_graphorighigh>
; and <$$_graphorigwide> are the original pixel dimensions of the image,
; before any [GraphScale], [GraphHigh], or [GraphWide] is applied.
; FDK name = text of macro to put after graphic
; ch01f853.gif= <map name="schematic"><area coords="0,0,20,30" alt="input"></map>
; old suffix = new suffix, overrides [Graphics]GraphSuffix
; jpg=jpg leaves all .jpgs alone even if GraphSuffix=gif
; wmf=svg but .wmfs are being made into .svgs using a third-party tool
; this section is used by drmif only, not by dwhtm
; 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)
; 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
; 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
; ExportJpgFiles = Yes (makes external .jpg files, default) or No
; ExportOleFiles = Yes (makes external .ole files) or No (default)
; when not exported, a .wmf is extracted if possible and kept in DCL
; 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)
; FM paragraph format name = TOC level (MS or Java)
;This group was formerly in each [*HelpOptions] section, and is now
;deprecated there. UseIndexentryTag is Java only, and KeywordLimit
;is MS HH only; they remain in their specific [*HelpOptions] sections.
;The rest apply to all Help systems when an index is generated by Mif2Go.
; KeywordRefs = Keyword (default), File, or Para (start of containing para)
; CaseSensitiveIndexCompare=No (default) or Yes (treat words that differ
; only in the case of their first letter as different)
; UseSortString = No (default) or Yes (use Frame sort string if present)
; IgnoreCharsIX = chars to exclude when sorting index entries; the en dash,
; em dash, and nonbreak hyphen are all converted to hyphens first
; IgnoreLeadingCharsIX = chars to exclude if at the beginning of the entry
; when sorting index entries; multiples like $$ or .. are all excluded
; SeeTerm = word(s) used as the start of a See index entry, default
; "See" without the quotes, case is significant
; SeeAlsoTerm = word(s) used as the start of a See also entry, default
; "See also" without the quotes, case is significant
; SortSeeAlsoFirst = No (default, put See also entries after any other
; index subentries), or Yes (put them first after the parent entry)
; LevelBreakForSee = Yes (default, always force a level break before
; See and See also entries), or No (break only for explicit colon)
;Both of these settings, if Yes, break only if two or more entries
;in the project match up to the colon or comma. Escaped (backslash)
;colons are never used as level separators.
; CombineIndexLevels = Yes (default) or No (always break at colon)
; UseCommaAsSeparator = Yes (default) or No (never break at comma)
; DocBookRoot = element to use at the XMLRoot. Both article and book
; are built in, but others (like set) can be used by replacing the
; ContentModel below, and setting its root element name here.
; WriteBookFile = Yes (default, write one file for Frame book) or No
; Sets UseDOCTYPE and UseXMLRoot to No for the chapter entity files.
; BookFileName = name to use for book file, with ext, default is
; Frame book file name with extension .xml
BookFileName= YourBookFileName.xml
; BookFileTitle = text of title for book, default is book file name
BookFileTitle= Your Book Title
; ContentModel = name of content-model .ini, without extension,
; with which to replace the built-in DocBook 4.5 content model.
; UseFormatAsTag = No (default, if tag unmapped use default elem below),
; or Yes (if unmapped, use Frame format name if valid in content model).
; DropInvalidParaTag = No (default) or Yes (if the para tag is the default
; DefParaElem <para> and is invalid, but #PCDATA is valid, drop the tag)
; DefParaElem = element to use for Frame para formats that are neither
; named for DocBook elements nor mapped in [DocBookParaTags], default
; is the Frame format name (adjusted as for CSS class names) as is,
; which can cause an <!--Invalid tag --> comment in the XML output.
; DefCharElem = element for Frame char formats as above, default is
; the CSS-normalized Frame char format name; best set to "phrase".
; ImageParents = parents for image tags, default none (use content model),
; may include sets from [DocBookElementSets].
; TableParents = parents for table tags, default none (use content model),
; may include sets from [DocBookElementSets].
; DocBook includes most of the [DITA*] sections, with the same meanings:
; ParaTags, ParaAttributes, CharTags, CharAttributes, Levels, Parents,
; ParentAttributes, ImageParents, TableParents, Alias, ElementSets,
; OpenBefore, OpenAfter, CloseBefore, and CloseAfter, as well as the
; corresponding [MarkerTypes], all prefixed with "DocBook". See m2dita.txt
; (in the DITA/DocBook configuration appendix) for the details on those.
; These are predefined in the starting .ini for DocBook:
$top=chapter appendix preface article
$sections=sect1 sect2 sect3 sect4 sect5 section simplesect
$text=sect1 sect2 sect3 sect4 sect5 section simplesect chapter appendix preface article entry
$list=itemizedlist orderedlist
; Frame para format = No (default, no ID set automatically) or Yes
; (use the Frame ID for the element specified in [DocBookParaTags]).
; In either case, IDs assigned by markers (both hypertext newlink
; and DocBookElemID) are always used, and override the automatic ID.
; Frame para format = single parent element for which the Frame ID
; of the para should be used. Works only if the parent is started as
; a result of the current para, and if used disables any ParaIDs set
; for the same Frame format in [DocBookParaIDs] since IDs must be unique.
; Any ID assigned by the DocBookParentID marker overrides this ID.
;The first group of settings is for both JavaHelp and Oracle Help for Java
; HSFileName = name for JavaHelp or Oracle HelpSet file used in archive
; HelpFileTitle = title to put in HelpSet file, default filename or bookname
; DefaultTopic = starting topic ID (not file name)
; WriteHelpSetFile = No (default) or Yes (write each time)
; HSPathNames = No (default, strip path from filenames) or Yes (use full path)
; RemoveInternalAnchors = Yes (JavaHelp 1 default, avoid JavaHelp bug) or
; No (OracleHelp and JavaHelp 2 default)
; JavaRootFiles = list of files to copy to WrapPath (the top directory),
; separated by spaces, wildcards and paths (relative and absolute)
; allowed, no spaces within an item, overrides the defaults below.
JavaRootFiles=*.hs *.jhm *.xml
; HTMLSubdir = for JH and OHJ only, subdirectory of WrapPath to which the
; WrapCopyFiles files are copied, default "html"; also used as
; the default for MapFilePrefix with trailing "/" added.
; EmptyJavaHTMLSubdir = Yes (default, empty HTMLSubdir directory before
; copying) or No (leave HTML files in place)
; GraphSubdir = for JH and OHJ only, subdirectory of WrapPath to which the
; GraphCopyFiles files are copied, default "graphics"; also used
; as the default setting for [Graphics]GraphPath with "../" prepended.
; EmptyJavaGraphSubdir = No (default, leave graphics files in place)
; or Yes (empty GraphSubdir directory before copying)
; MapFilePrefix = prefix to insert at start of map file URLs, so that
; html files can be placed in a subdirectory under the .hs, as required
; for creating the search index for them
; UseFTS = Yes (default) or No (affects HelpSet File rewrite)
; FTSCommand = for Sun Java Help, path to jhindexer, such as:
;FTSCommand=D:\jh2.0_01\jh2.0\javahelp\bin\jhindexer
; or for Oracle Help, indexing command, with minus for switches, such as:
;FTSCommand=java -mx64m oracle.help.tools.index.Indexer
; JarCommand = path to jar, without any parameters; the cvf and * are
; added before and after the HSFileName (with .jar ext) automatically
;JarCommand=D:\j2sdk14\jdk\bin\jar
; RefFileType = Full (default), Body, None
; for Full, filter creates a TOC.xml and Index.xml for each original file
; for Body, it creates DCL .bhc and bhk files that are merged later
; ListType (for filter to create) = Both (default), Contents, or Index
;These images in the Contents file are all mapped in [JHImages] if used
; UseIndexentryTag = Yes (OracleHelp only, default) or No (as in Sun JavaHelp)
;This group is now in [Index] and is deprecated here.
; KeywordRefs = Keyword (default), File, or Para (start of containing para)
; CaseSensitiveIndexCompare=No (default) or Yes (treat words that differ
; only in the case of their first letter as different)
; SeeTerm = word(s) used as the start of a See index entry, default
; "See" without the quotes, case is significant
; SeeAlsoTerm = word(s) used as the start of a See also entry, default
; "See also" without the quotes, case is significant
; UseSortString = No (default) or Yes (use Frame sort string if present)
; SortSeeAlsoFirst = No (default, put See also entries after any other
; index subentries), or Yes (put them first after the parent entry)
;UseSubHelpSets = No (default) or Yes (requires [HelpMergePaths] info)
;These settings are for Oracle Help for Java but not for JavaHelp
; MakeALinkFile = Yes (default, include OracleHelp ALinks) or No
; ALinkRefs = File (default) or Para (start of containing para)
;The rest here are for Sun's JavaHelp but not Oracle Help for Java
; JHVersion2 = Yes (default) or No (limit features used to Version 1)
; UseFavorites = No (default) or Yes (affects HelpSet File rewrite)
; UseGlossary = No (default) or Yes (affects HelpSet File rewrite)
; GlossPrefix = prefix used to form glossary term IDs, default GLO_
; GlossSuffix = suffix used to form glossary term IDs, default none
; GlossSpace = replacement for spaces in glossary term IDs, default none
; Helen = No (default) or Yes (to account for quirks in Helen for JH)
; In JH2, popups and jumps to secondary windows are represented as objects,
; placed at the start of their hotspots, rather than as conventional links.
; PopMarkerPrefix = default JH2Pop, prefix for marker type for settings below
; PopType = Button (default), Graphic, or Text (inline with properties below)
; PopSize = width,height (default 250,300 with *no* space between numbers)
; PopText = text to appear on button (default >) or as normal text, also
; used for URL for a graphic included on a button (instead of PopGraphic)
; PopFontFamily = SansSerif (default), Serif, Monospaced, Symbol, Dialog, or
; DialogInput, not all of which seem to work as one might expect.
; PopFontSize = numerous choices. names: xx-small, x-small, small (default),
; medium, large, x-large; index number (plain digit), bigger (by one index),
; smaller (by one index), +n (increase by n), -n (decrease by n), nnpt (pts).
; PopFontWeight = plain (default) or bold
; PopFontStyle = plain (default) or italic
; PopFontColor = blue (default), black, cyan, darkGray, gray, green, lightGray,
magenta, orange, pink, red, white, yellow
; PopGraphic = relative URL for GIF or JPEG when PopType=Graphic
; SecMarkerPrefix = default JH2Sec, prefix for marker type for settings below
; SecType = Button (default), Graphic, or Text (inline with properties below)
; SecSize = width,height (default 250,300 with *no* space between numbers)
; SecLocation = left,top (default 600,200 with no space)
; SecName = name for sec window to use (default is [SecWindows] name)
; SecText = text to appear on button (default >) or as normal text, also
; used for URL for a graphic included on a button (instead of SecGraphic)
; SecFontFamily = Serif (default), SansSerif, Monospaced, Symbol, Dialog, or
; DialogInput, not all of which seem to work as one might expect.
; SecFontSize = numerous choices. names: xx-small, x-small, small (default),
; medium, large, x-large; index number (plain digit), bigger (by one index),
; smaller (by one index), +n (increase by n), -n (decrease by n), nnpt (pts).
; SecFontWeight = plain (default) or bold
; SecFontStyle = plain (default) or italic
; SecFontColor = blue (default), black, cyan, darkGray, gray, green, lightGray,
magenta, orange, pink, red, white, yellow
; SecGraphic = relative URL for GIF or JPEG when SecType=Graphic
; Windows = list of JH2 windows, each defined by its own section as below
;The next five sections are for JavaHelp but not for Oracle Help for Java
[JH window name] such as [mainwin] or [secwin]
; Default = No (default) or Yes (to make this the default window)
; Name = name used to reference in code
; Image = image ID mapped in [JHImages] if used
; Top = top edge, pixels from top of screen, default 200
; Left = left edge, pixels from left side of screen, default 200
; Height = height in pixels, default 400
; Width = width in pixels, default 400
; NavPane = Yes (default, with toolbar is tripane) or No (for secondary wins)
; NavIcons = Yes (default) or No (show text instead)
; Toolbar = list of items to include, from: Back, Forward, Home, Reload,
; Favorites (add current page to), Print, PrintSetup, Separator (on bar).
Toolbar=Home Back Forward Separator Print PrintSetup Separator Favorites
; optional images for toolbar items, itemImage=image file ID, mapped in
; image ID = path, relative to .hs file
; Optional section used for literal additions to the JH2 <helpset>, such as
; an <impl> section if needed:
; <helpsetregistry helpbrokerclass="javax.help.DefaultHelpBroker" />
; <viewerregistry viewertype="text/html"
; viewerclass="com.sun.java.help.impl.CustomKit />
; <viewerregistry viewertype="text/xml"
; viewerclass="com.sun.java.help.impl.CustomXMLKit />
; The JH default is to expand only top-level (1) items; this sets the
; <tocitem> expand attribute according to level.
; The JH default is to use the Toc*Image graphics for all levels; this
; replaces those graphics by setting the <tocitem> image attributes.
; The image IDs are mapped in [JHImages] as usual
; subproject name = path to its files during use (not construction) of Help
; For JavaHelp and Oracle, only the path part, not the name, is used,
; Not used in MS HTML Help or OmniHelp.
; Default and secondary window definitions for OracleHelp only (not Java).
; name=height,width,xpos,ypos,textcolor,linkcolor,background,buttons,title
; height and width are in pixels or %, xpos and ypos in pixels, the three
; colors are in hex RGB, buttons are the hex sum of the following hex values:
; 4=remove default buttons, 40=add URL display, 400=add Navigator button,
; 2000=Print, 4000=Back and Forward, 8000=Search, 10000=Dock and Undock.
; The first window listed below becomes the default window.
Main=50%,240,100,100,000000,0000ff,ffffff,c000,Main Help Window
; EclipseVer = Eclipse version point number, default 3, for 3.3
; affects back-incompatible coding added in 3.3 in plugin.xml
; IncludeVersionPI = Yes (default, include PI with version
; specified by PluginSchemaVersion at start of plugin.xml) or No
; PluginSchemaVersion = version used to validate plugin.xml, either
; 3.0 or 3.1 (default is 3.1) if not using the manifest file,
; or 3.2 if using it; not to be confused with EclipseVer, above.
; Note that 3.3 is not a valid version here, even if EclipseVer=3.
; UseManifest = Yes (default, required for .jars) or No
; WriteManifest = Yes (default, always write, even if it exists)
; or No (write only if not found)
; ManifestName = MANIFEST.MF, place in META-INF dir under plugin
; UseSingleton = No (default) or Yes (add "; singleton:=true" after
; UsePlugin = Yes (default), or No (never write plugin.xml, use if
; not part of the deliverable system because others provide it)
; WritePlugin = Yes (default, write plugin.xml) or No (write only
; if not already present, use if customized)
; PluginName = text used in <plugin> or manifest for name attribute
PluginName=Mif2Go Eclipse Help
; PluginID = text used in <plugin> or manifest for id attribute
; PluginVer = text used in <plugin> or manifest for version attribute,
; not to be confused with Eclipse versions above
; PluginProvider = text used in <plugin> or manifest for provider-name
; toc properties in the plugin file
; TocFilename = name for contents file, always toc.xml for primary
; TocPrimary = Yes (default, toc.xml) or No (secondary)
; TocExtradir = path to dir for additional docs to include
; in search index, even if not referenced from any toc topic
; toc properties in the toc file
; TocLabel = text that appears in the Help title bar; if missing,
; TocTopic = name of opening topic file (required)
; TocLinkTo = path to another (secondary) toc with anchor,
; such as ../anotherPlugin/api.xml#moreapi, for link_to attribute
; The anchors are set with EclipseAnchor markers in the topic
; preceding the desired anchor location; the marker content is
; a number for the TOC level, a space, and the anchor name.
; Similarly, the EclipseLink marker specifies another TOC to be
; inserted after the current topic, also with level, space, and
; path to the desired TOC file.
; TocNamesFileOnly = Yes (default, workaround for Eclipse bug 184787,
; and others, where use of #aname breaks Eclipse native breadcrumbs),
; or No (allows direct midtopic jumps to points within files).
; TocIdxFilePrefix = prefix to insert at start of file URLs, when
; html files are placed in a subdirectory under the toc and idx
; idx properties in the plugin file
; IdxFilename = name for index file, normally index.xml
; UseIndex = Yes (for newer releases of Eclipse) or No (default)
; UseFTS = Yes (default, adds extension point to plugin file) or No
; csh properties in the plugin file, used to produce infopops
; UseContext = Yes (default, add context ref to plugin.xml) or No
; WriteContext = Yes (default, write contexts.xml) or No
; ContextFileName = name for context file, default contexts.xml
; ContextPluginName = plug-in attribute for secondary plugins,
; ContextDescription = Yes (default, include) or No (omit)
; DescriptionIsFirstLabel = No (default) or Yes (use the label from
; the first context item as the description for the context)
; ContextAnchors = No (default, filename only) or Yes (refer to para)
; The contexts are set with EclipseContext markers containing the
; context ID name, placed in each topic that the infopop should
; reference; the infopop descriptions are in [EclipseHelpContexts].
; zip packaging for topic files is required for Eclipse Help
; ZipCommand = zip command given *without* any parameters; if program
; directory is not on the system PATH, include its full absolute path
; ZipParams = parameters to issue for ZipCommand in WrapPath dir to create
; required doc.zip, specifies files to be included (not *.xml), such as:
ZipParams=-add doc.zip *.htm *.jpg *.gif *.css
; after doc.zip is made, the [Automation] archive command should make a
; zip containing doc.zip and *.xml, and place that in the ShipPath dir,
; to be unzipped later in its own subdir under the Eclipse plugins dir.
; RefFileType = Full (default) or Body
; for Full, filter creates a toc.xml and index.xml for each original file
; for Body, it creates DCL .bhc and bhk files that are merged later
; ListType (for filter to create) = Contents (default) or Both (with index)
; ContextID = short plain-text description for its infopop
; The IDs are specified in the Frame file by EclipseContext markers
; placed in each topic to be linked from within the infopop.
; HHPFileName = name for MS HTML Help project file used for compilation
; HelpFileTitle = title to put in project file, default filename or bookname
; WriteHelpProjectFile = Yes (write each time) or No; if no setting,
; write only if the file does not already exist.
; UseFTS = Yes (default) or No (affects Help Project File rewrite)
; HelpFileLanguage = LCID to put in project file, default is for US English
; note that even if the .chm is being used in other locales, this setting
; is required for the HelpFileTitle to display instead of just "HTML Help"
;HelpFileLanguage=0x409 English (United States)
; MSHHctrl = MS hhctrl.ocx class ID (GUID), varies by version of OCX
; Older (default) version is: clsid:adb880a6-d8ff-11cf-9377-00aa003b7a11
; Newer version is: clsid:41b23c28-488e-4e5c-ace2-bb0bbabe99e8
MSHHctrl=clsid:adb880a6-d8ff-11cf-9377-00aa003b7a11
; DefaultTopicFile = starting topic file name (no extension)
; RefFileType = HHW (default, leave for HH Workshop), Full, Body, None
; but note: when Set up... writes the .ini, this setting is never HHW
; for HHW, filter removes attributes (including class) from Hn tags
; for Full, filter creates an .hhc and .hhk for each original file
; for Body, it creates DCL .bhc and bhk files that are merged later
; ListType (for filter to create) = Both (default), Contents, or Index
; CshMapFile = name of file to #include in .hhp [MAP] for CSH support
; MakeAliasFile = Yes (default, make list of newlinks and files) or No
; AliasPrefix = all prefixes wanted in alias file, comma or space delimited
; if omitted, all newlinks are included; wildcards do *not* work in prefixes
; UseAliasAName= No (default), or Yes (to allow midtopic jumps for CSH)
; AliasTitle = No (default) or Yes (generate .hht file with titles for all
; topics containing CSH aliases, like the .hha but with titles not filenames)
; KeywordLimit = 488 (default), max length of HTML Help index entries
;This group is now in [Index] and is deprecated here.
; KeywordRefs = Keyword (default), File, or Para (start of containing para)
; CombineIndexLevels = Yes (default) or No (as done by HHW)
; IgnoreCharsIX = chars to exclude when sorting index entries; the en dash,
; em dash, and nonbreak hyphen are all converted to hyphens first
; IgnoreLeadingCharsIX = chars to exclude if at the beginning of the entry
; when sorting index entries; multiples like $$ or .. are all excluded
; CaseSensitiveIndexCompare=No (default) or Yes (treat words that differ
; only in the case of their first letter as different)
; SeeTerm = word(s) used as the start of a See index entry, default
; "See" without the quotes, case is significant
; SeeAlsoTerm = word(s) used as the start of a See also entry, default
; "See also" without the quotes, case is significant
; UseSortString = No (default) or Yes (use Frame sort string if present)
; SortSeeAlsoFirst = No (default, put See also entries after any other
; index subentries), or Yes (put them first after the parent entry)
; ContentsLocalValuePrefix = text to put before file references in .hhc,
; used in slave .chms that are used only with a master.chm, not alone
;ContentsLocalValuePrefix=master.chm::/slave.chm::/
; ContentsNamesFileOnly = Yes (default, allows tracking) or No (allows
; direct midtopic jumps to points within files, but disables tracking)
; MS HTML Help Popup options, for use with text in Hypertext Alert markers
; PopFont = Facename[,point size[,charset[,color[,PLAIN BOLD ITALIC UNDERLINE]]]]
; PopMargins = left margin, right margin (in pixels)
; PopColors = foreground, background (in decimal RGB, -1 is default)
; DefaultChmFile = name of target .chm for project if not in [ChmFiles]
; UseChmInLinks = No (default, for same .chm or for uncompiled help, where
; normal links are needed)or Yes (always use ChmFormat at start of links).
; ChmFormat = format to use when UseChmInLinks is set, where the first %s
; is the chm name and the second %s is the filename.
ChmFormat=mk:@MSITStore:%s.chm::/%s
; RemoveChmFilePaths = Yes (default) to try to match filenames without their
; path component in [ChmFiles] after trying with it, or No to require the
; path used by Frame (with forward slashes) be present on the left-side names.
; Properties for the .hhc and .hhk files; can contain macros. A typical
; value might be <param name="FrameName" value="Content"> The enclosing
; <object type="text/site properties"> tag is supplied automatically.
; Properties for ALink and KLink jumps. All apply to both ALinks and KLinks.
; To set different properties for one or the other, prefix the name with an
; A or K, as in ALinkFlags or KLinkText. To set properties for an individual
; link, use Link* markers just before the link, named for the settings below.
;LinkType = Button (default), Chiclet, Graphic, Icon, Shortcut, Text
;LinkFlags = "1" (show dialog even for one item), ",,1" (if no items, make
; button disappear), or empty (if only one item, take the jump directly)
;LinkEmptyTopic = name of .htm topic file to show if no items match at all
; Otherwise, unless LinkFlags=,,1, the Not Found complaint will be used.
;LinkButtonWidth = pixels, if LinkType = Button, Graphic, or Icon
;LinkButtonHeight = pixels, if LinkType = Button, Graphic, or Icon
;LinkButtonText = Text: plus name on button, if LinkType=Button
;LinkButtonGraphic = Bitmap: plus name of .bmp (only), if LinkType=Graphic
LinkButtonGraphic=Bitmap:mybutton.bmp
;LinkButtonIcon = Icon: plus name of .ico (only), if LinkType=Icon
LinkButtonIcon=Icon:mybutton.ico
;LinkTextFont = same syntax as PopFont above, if LinkType=Text
LinkTextFont=Helvetica,10,,PLAIN
; LinkText = Text: plus text to use for link, if LinkType=Text
; original or remapped filename (no ext) = chm filename (no ext)
; overrides default set by [MSHtmlHelpOptions]DefaultChmFile. The
; corresponding section for OmniHelp is [OHMergeFiles].
; definitions for the [WINDOWS] section of the .hhp, best prepared
; using HTML Help Workshop. After editing in HHW, save the .hhp,
; then re-open it in Notepad and copy the contents of [WINDOWS] here.
; For MS HTML Help, include all the other .chm files to be merged at
; runtime with the .chm for the current project, omitting extensions;
; whatever you put to the right of the = is ignored.
; For OmniHelp, include the other project-file names, without extensions,
; and after the = specify the title to be displayed in the OH Contents.
; A HelpMerge marker is necessary somewhere in a Frame doc file for each
; file listed in the [HelpMerge] section. It contains the (single-digit)
; contents level desired for the top TOC entry for a project (or .chm) file,
; followed by a space, and then by the name of that project. The marker is
; placed either at the start of the following topic (before any text), or
; at the end of the preceding topic (after all topic text, in an otherwise-
; ProjectName = name for OmniHelp project, used for merge identification
; and for a set of .oh* file names, usually the book name (no .ext)
; OHProjFilePrefix = default is underscore (_), prefix to add to project file
; name so that it does not conflict with the name of any file in the project.
; OHProjFileSuffix = default none, suffix to be added to project file name so
; that it does not conflict with the name of any other file in the project
; OHProjFileXhtml = No (default, to make project file HTML 4.01 as required
; by some browsers), or Yes (to make the project file XHTML 1.0)
; HelpFileTitle = title to put in project-specific frameset file
;HelpFileTitle=Your Title Here
; DefaultTopicFile = starting topic file name (no extension), first file in
; OHViewPath = path to dir containing the OHVFiles (OH viewer files, oh*.*),
; from which they will be copied to the WrapPath for OH output
OHViewPath=D:\path\to\ohview\zip\files
; OHVFiles = list of files to copy from OHViewPath (the viewer files),
; separated by spaces, wildcards and paths (relative and absolute)
; allowed, no spaces within an item, overrides the defaults, which are
; oh*.* for HTML, and ox*.htm, ox*.js, oh*.css, and oh*.js for XHTML.
; ProjectTemplate = path to template for generating OHProj and .ohx files,
; with sections containing text and macro references for variable items
; NavElems = navigation elements to use in left pane: Toc, Idx, Fts, Rel
; NewWindow = Yes (default, use settings below for FrameHigh, FrameWide, and
; FrameOptions) or No (use existing browser window)
; CloseOldWindow = No (default) or Yes (if NewWindow, close opening window)
;Frameset dimensions (in pixels) and properties
;FrameOptions = JS window.open() values as in [SecWindows]
; Frame dimensions, do not reduce any of them at all
; TopFirst = Yes (top frame full width) or No (left frame full height)
; These settings control what buttons are added to the top nav pane
; UseTopButtons = Yes (default, use buttons) or No (use links instead)
; UseStart = Yes (default, provide Start button) or No
; UsePrevNext = Yes (default, provide Prev and Next buttons) or No
; UseBackForward = Yes (default, provide Back and Fwd buttons) or No
; UseHideShow = Yes (default, provide a button to hide and show the left-side
; nav pane as in MS HTML Help) or No
; ShowNavLeft = Yes (default, open with nav pane visible on left) or No
; PersistSettings = Yes (default, OH settings persist after closing, for the
; next time the project is re-opened), or No (keep during session only)
; LowMem = Yes (default, reduce memory requirements while writing Contents by
; writing many short segments instead of one long one) or No (faster)
; CSS defaults if browser detection fails
; CSS for top and left (navigation) frames
; These items control the expanding Toc available for all browsers but NS4.
; TocExpand = Yes (default) or No (don't use expanding Toc)
; TocGroupsOpen = No (default, open expanding Toc with groups closed) or Yes
; TocOpenLevel = number of level to open to, default 0 for top level only.
; If set, also set TocGroupsOpen=No, as otherwise all levels are opened.
; TocIcoBase = ohct (default, basename for set of .gifs used for expanding Toc)
; This permits alternative icon sets for use with different CSS color schemes.
; TocButtons = Yes (default, provide Open All and Close All) or No
; These items control the expanding Index available for all browsers but NS4.
; IdxExpand = Yes (default) or No (don't use expanding Index)
; IdxGroupsOpen = No (default, open expanding Index with groups closed) or Yes
; IdxOpenLevel = number of level to open to, default 0 for top level only.
; If set, also set IdxGroupsOpen=No, as otherwise all levels are opened.
; IdxIcoBase = ohct (default, basename for set of .gifs used for expanding Idx)
; This permits alternative icon sets for use with different CSS color schemes.
; IdxButtons = Yes (default, provide Open All and Close All) or No
; RefFileType = Full (default for single files), Body (default for books), None
; for Full, filter creates a set of .oh* files for the original file;
; for Body, it creates a set of DCL .bh* files that are merged with those from
; other chapter files to produce a combined set of oh*.dat files for the book
; UseFTS = Yes (default, write .bhs and .ohs files) or No (faster)
; SearchWordMin = minimum length of word to index for search, default 3
; UseDefaultStopWords = Yes (use set shown in [StopWords] below, plus
; any more added in your own [StopWords]) or No (use your own words only)
; UseListButton = Yes (default) or No (remove from Search panel)
; UseSearchHighlight = Yes (default, highlight search terms found) or No
; SearchHighlightStyle = style to use in span to highlight search terms found
;SearchHighlightStyle=background-color:yellow;
; ShowSubjects = No (default, don't show subjects for ALinks) or Yes
; OmniHelp always creates an alias file, .oha, needed even if empty
; AliasPrefix = all prefixes wanted for CSH use, comma or space delimited
; if omitted, all newlinks are included; wildcards do *not* work in prefixes
; MergeFirst = No (default, merge subprojects only when they are called on),
; or Yes (do all merges during initial load, takes longer to start up)
;This group is now in [Index] and is deprecated here.
; KeywordRefs = Keyword (default), File, or Para (start of containing para)
; IgnoreCharsIX = chars to exclude when sorting index entries; the en dash,
; em dash, and nonbreak hyphen are all converted to hyphens first
; IgnoreLeadingCharsIX = chars to exclude if at the beginning of the entry
; when sorting index entries; multiples like $$ or .. are all excluded
; CaseSensitiveIndexCompare=No (default) or Yes (treat words that differ
; only in the case of their first letter as different)
; SeeTerm = word(s) used as the start of a See index entry, default
; "See" without the quotes, case is significant
; SeeAlsoTerm = word(s) used as the start of a See also entry, default
; "See also" without the quotes, case is significant
; UseSortString = No (default) or Yes (use Frame sort string if present)
; SortSeeAlsoFirst = No (default, put See also entries after any other
; index subentries), or Yes (put them first after the parent entry)
; optional (X)HTML content for ohtop nav table left cell, same width as
; the left pane below it; if TopFirst is No, this cell is not shown.
; escape any single quotes with \', keep all on one line ending with \
; and do not have more than one blank line after it.
<img src="ohlogo.jpg" height="25" width="50" alt="Logo" /> OmniHelp Example\
; optional (X)HTML content for ohtop nav table right cell, always shown
; escape any single quotes with \', keep all on one line ending with \
; and do not have more than one blank line after it.
<img src="ohvalidh.gif" border="0" alt="Valid HTML 4.01!" height="25" width="71" />\
; mapping of Frame files which are linked to by files in the current project,
; but are themselves part of another OH project that is listed in [HelpMerge],
; to the name of that project. Omit all file extensions.
; list of words excluded from search index for OmniHelp if UseDefaultStopWords
;about after again all already also always and any are been but can
;did does doing each for from has have having its may maybe might not
;see than that the their them then these they this those too use used
;uses using very want was when where which will with would you your
; add more of your own words as needed in your own .ini's [StopWords]
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;put macro definitions here, in sections of their own, as in:
<img src="1p.gif" height="10" width="<$$spacerwidth>" alt="[spacer]">
; varname = value to use as literal replacement, can be in Macro Ini
; can also be set in any macro with <$$name=value>, settings persist
; until the end of the file, but are not stored in the .ini
; variables are called with <$$name>; some are predefined by the filter
; and cannot be changed, such as currfile and lastfile
> F HTML/XML configuration