The default values for these parameters should be sufficient
for most people, but there are reasons that you may want to change
the default behavior. The following settings must be changed manually
in the ditafmx.ini file.
- General section
MaxRefLevels -
Specifies the number of nested files that are opened due to the auto-loading
of references (xref or conref). If your files never have references
within references (such as an xref within a conref), then you should
set this to a value of “1”. If your files do make use of nested
references, set this value equal to the maximum number of reference
levels that exist. The greater the number the longer it may take to
open files since all references in all opened files will resolve
(unless limited by this option). Valid values are 0 through 9 or
“*” (asterisk means unlimited levels). Setting this value to 0 disables
the auto-updating of xrefs and conrefs.
This
reference resolving process is used when generating a book from
a map, but is not used while authoring unless the INIOnly/UseRefList
parameter is set to “0”.
- INIOnly section
UseRefList - Controls the way references
are resolved while authoring. If set to “1” (default), references
(xrefs and conrefs) are resolved “on disk,” allowing for much faster
processing and less time required to open files. If set to “0” all
referenced files are opened in FrameMaker in order to resolve the
references. The number of files opened is determined by the reference
nesting level, which is controlled by the General/MaxRefLevels parameter.
LastReferencedElement - Record of the
last element tag selected in the Reference Manager to allow access
to last referenced elements.
ForceTablesWide -
If set to 1, tables are forced to fill the text column (or page
if the pgwide attribute is set to 1). This overcomes a limitation
where under certain circumstances tables are not rendered full width
in Book builds. If your EDD already handles “pgwide” tables, you
may need to disable this functionality by setting ForceTablesWide
to 0.
StructappsFile -
If set, this file is used as the structapps definition file. In
order for this to function properly you must also have set the Directories/StructureDir
parameter in the maker.ini file.
XrefElements -
A vertical-bar delimited list of element names that defines the elements
that are valid as xref or link targets. For example, setting XrefElements
to the following string limits the xref targets to the elements
specified:
- XrefElements=topic|concept|task|reference|section|dt
DitaFMxGuide -
Specifies the name of the DITA-FMx User Guide Help file (relative
to the DITA-FMx folder).
DitaHelpKeys -
Specifies the shortcut keystrokes to launch context-help for DITA authoring
(this runs the “DitaReference” Help file).
DitaReference -
Specifies the name of the DITA Reference Help file (relative to
the DITA-FMx folder).
DitaRefTargetType -
Specifies the file extension of target topics in the “DitaReference”
Help file for context sensitive Help.
MapFromOutlineTemplate -
Specifies the “Map from Outline” template file used as the template
for the New ‘Map from Outline’ Template command.
The default value for this parameter is “$STRUCTDIR\xml\DITA-FMx_1.1\map-from-outline_template.fm”.
BaselineOffset -
Specifies the distance (in points) an inline image is shifted below the
baseline of the surrounding text. The default value is 2 pts.
BookTitleVariableName - Specifies the
name of the variable that is updated with the book title (from map/title,
map/@title, bookmap/title, or bookmap/booktitle/mainbooktitle).
This variable is only updated in generated list files if it is included in
the generated list template (structured files can access the book
title via the attribute on the fm-ditabook element). The default
name for this variable is “FMxBookTitle”.
StripClassAttribute -
Set this to “0” to prevent the @class attribute value from being deleted
when changing an element’s type (using the “Change” button in the
Element Catalog). By default this is enabled.
TplDelimChar -
Set this to specify the character to use as the file name delimiter
for new file templates (new~<topictype>~<template
name>.fm), book-build component templates (tpl~<mapelemtype>.fm), and generated
list templates (gentpl~<mapelemtype>.fm).
If this is not set, the default character is the tilde (~), but
if necessary you can set this to another character (such as the
hash symbol, #).
MaxOpenFiles -
Specifies the number of XML files opened before a warning is displayed.
This is convenience when working with FM7.2 and FM8 to allow time
to restart FrameMaker before it crashes. These version of FrameMaker
have a bug that results in a crash after opening 300+ XML files
in the same session.
- INIOnly section (for use with
the Set Attributes command)
SetAttrIgnore - Specifies the attributes
to ignore (and not display) in the dialog. This is a vertical bar
delimited string. By default this is set to the following values,
you can change these values as needed.
xtrc|xtrf|xmlns|class|xmlns:ditaarch|ditaarch:DITAArchVersion|domains
SetAttrStrings - Specifies an INI file
that defines additional “default” values for the indicated “Strings”
attributes (the default value of this parameter is FilterGroups.ini). These
default values are organized into named groups which can be associated
with a specific file system path. All topic files that fall within
the specified root path are mapped to that group. Each group lists
one or more attributes and a vertical bar delimited list of default
values for that attribute. This lets you provide alternate filtering
options for different projects that use the same structure application
without modifying the EDD.
Unless the value of the SetAttrStrings
parameter specifies an absolute path and file name, it is relative
to the FrameMaker\DITA-FMx folder. If you use
a SetAttrStrings file, no default values need be set in the EDD
at all. This adds flexibility to the EDD not otherwise obtainable.
For more information and details, see Set Attributes.
SetAttrStringsDefault - Specifies the
“default” value that is ignored when displaying the list of defaults.
Note: This
INI parameter is for very specialized and atypical use. Unless you
are doing special FDK processing using attributes of type “Strings”
you can safely ignore the following information.
When
you specify default values to a Strings attribute in the EDD, the
first default may be used as the actual default for certain types
of processing. If you want to specify a special value as the first
default so that your processing can match on it and ignore the value,
enter that string as the value for the SetAttrStringsDefault parameter.
A likely value is the dot (“.”) character, but you can specify any
value that makes sense for your processing. If you specify this
value, it will be ignored and excluded from the options displayed
in the Set Attribute dialog.
If you do not have processing
that cares about the initial default value of a Strings attribute,
you can ignore this parameter.
- INIOnly section (for use with content management
systems)
CMSClientName -
Specifies the FDK client name used to connect with the CMS bridge or
connector. Typically set automatically by the CMS client.
CMSImageDefaultDpi -
Specifies the default DPI for new images. Currently only used for
XDocs CMS.
- GeneralImport section
IndextermProcessing - If set to 1, enables conversion
of indexterm elements to proper format required by FrameMaker.
TableProcessing - If set to 1, enables the counting
of table columns for proper import of simpletable and other table
types into FrameMaker.
UseLanguageTemplate - If set to 1, enables the use of language-specific
template files. When opening a DITA XML file, if the “topic”/@xml:lang
attribute specifies a value, the plugin checks for a language template
in the same folder as the default template. The language template
must be named “<templatename>.<langval>.fm” (the “.fm” extension
is optional, but if the default template includes the extension,
the language template must also. For example, if your default template
is topic.template.fm, a Japanese language template
would be named topic.template.ja-jp.fm (assuming
that “ja-jp” was the value in the xml:lang attribute).
- GeneralExport section
IndextermProcessing - If set to 1, enables conversion
of indexterm elements from the format required by FrameMaker back
to one required by DITA.
XrefProcessing - If set to 1, enables processing and
conversion of xrefs and links.
CrossRefToXref - If set to 1, enables the conversion
of FM-based cross-references to DITA-based xrefs and links.
DitaXrefElem - Defines the element name to use when
mapping FM-based cross-refs to DITA xrefs on file export (only used
if GeneralExport/CrossRefToXref is enabled).
DitaLinkElem - Defines the element name to use when
mapping FM-based cross-refs to DITA links on file export (only used
if GeneralExport/CrossRefToXref is enabled).
IgnoreElemPrefix - If you use elements in FrameMaker
that do not exist in the DITA DTDs, you should make sure they all
have the same prefix (“fm-” for example). This INI setting specifies
that prefix. This is required for proper generation of conrefs on export,
and should be used in conjunction with any read/write rules that
may be needed.
- TableImport section
SetColumnsProp - If set to 1, enables the automatic
assignment of the “columns” property.
SetColumnWidthsProp - If set to 1, enables the automatic
assignment of the “column width” property.
CustomTableCount and N - Specifies the
number of instances of simpletable elements that have been specialized
that need to be automatically analyzed for their column number.
The Count value should match the number of N values.
Each N value should have the following format: “<table-element>|<row-element>|<cell-element>”.
- BuildFile section
AntCommand - Specifies the command or path/command
used to run Ant. The default is “ant”, but if you need to specify
another executable or if you need to include the path, change this
value. This value is used for both Generate Output options, Current
File and Selected Target.
EnvironmentSetup - Specifies a batch file to run before
the Ant script in order to set up any needed environment variables.
AntScript - Specifies the filename of the Ant script
that is run for the Generate Output: Current File option. The default
is “ditafmx-ant.xml”, but if you need to specify another filename,
change this value. This filename is assumed to be relative to the
path specified by the DitaDir parameter.
Count and N - Specifies the number of
build options available in the AntScript file (and thus displayed
in the Generate Output: Current File output option). If you modify the
targets in that script, be sure to update the Count value
and add/remove the related N value.
- AntBuild section
Count and N - Specifies the number of
“ANT:” sections which define the available build options displayed
in the Generate Output: Selected Target output option. For each
“ANT:” section added, you must update the Count value and
add/remove the related N value. The value of each N parameter
must exactly match the text following the “ANT:” section name.
- ANT:build name section
BuildFile - Specifies path and filename of the associated
Ant script (use double backslashes as the directory delimiter).
EnvironmentSetup - Specifies a batch file to run before
the Ant script in order to set up any needed environment variables.
Target - Specifies target within the BuildFile.
OutputDir - Specifies the path to the output directory
(use double backslashes as the directory delimiter).
Logfile - Specifies the path and filename to the log
file (use double backslashes as the directory delimiter).
- DitavalFiles section
Each parameter and value in this section define a “friendly
name” and path/filename for a ditaval file. These ditaval files
must be created manually and added manually to the INI file in order
to be recognized by the Generate Output command and the Apply Ditaval
as Conditions command.