; This is the general settings file for the West Street AXCM plugin.
; It contains very important settings for plugin operation.
; You should review this entire file before using the plugin.
; If you have any questions,
; please contact us at info@weststreetconsulting.com.
;
; NOTE THE FOLLOWING:
;
; - You should probably open this file through the AXCM menu
;   to be sure you are editing the correct file! If your installation
;   is configured to store settings in your user profile area, it
;   is easy to get confused.
;
; - You can add your own comments and reorganize this file as you want.
;   HOWEVER, DO NOT CHANGE THE SYNTAX of any actual parameter names;
;   that is, anything to the left of an equals (=) sign!
;
; - Valid values for all true/false boolean
;   setting are TRUE and FALSE.


******************************
[General Options]
******************************

---------------------------------------------------------------
; Specifies the location of the master copy of your
; main settings document. This is a very important setting.
; See the User Guide for an extended description of how AXCM
; handles its main settings file.
;
; When you use the interface tools to browse to a new
; main settings file, this setting is changed automatically.
; The original setting is left in this file, commented out.
; 
; To use the local, default copy of the file, specify DEFAULT.
;
; Examples:
;MAIN_SETTINGS_PATH=C:\SomeFolder\SomeMainSettingsFile.fm
;MAIN_SETTINGS_PATH=DEFAULT

MAIN_SETTINGS_PATH=DEFAULT

---------------------------------------------------------------

---------------------------------------------------------------
; Specifies the condition tag to assign (and apply) during
; "source file" filter actions, as the mechanism for hiding 
; content that is "filtered out." This tag will be created 
; in filtered documents if it does not currently exist.
; This value is case-sensitive.

SOURCE_FILE_FILTER_CONDITION_TAG=Hidden
---------------------------------------------------------------

---------------------------------------------------------------
; Sets the maximum character length of XPath expressions. The value should
; be an integer between 100 and 10000. The recommended value is 1000.
; A FrameMaker restart is required for changes to take effect.

XPATH_EXPRESSION_MAX_LENGTH=1000
---------------------------------------------------------------

---------------------------------------------------------------
; Sets the maximum number of node matches that can be made during
; an XPath query action. This limit is enforced to prevent 
; bogging down the processor with too many node matches, normally
; caused by an expression that was too vague. The value should
; be an integer between 100 and 1000000. The recommended value
; is 10000 and should not be changed without consultation with 
; West Street.
; A FrameMaker restart is required for changes to take effect.

XPATH_MAX_MATCHES=10000
---------------------------------------------------------------

---------------------------------------------------------------
; Sets the maximum number of expressions that can be stored in the
; XPath history list. An expression gets added to the list when
; entered through the XPath scheme editor and then appears as an
; option in applicable expression drop-down dialog boxes. The value should
; be an integer between 0 (zero) and 200.

XPATH_HISTORY_MAX_LENGTH=50
---------------------------------------------------------------

---------------------------------------------------------------
; Sets the default category to appear in coloring, filtering, and
; validation dialog boxes, upon startup. Once changed
; in one of these dialog boxes, it has no further effect on 
; AXCM functionality. The default category will initially appear 
; in the coloring, filtering, and validation dialog boxes. 
; It will also be used for locating the default validation scheme 
; if you have auto-validation turned on.

DEFAULT_SCHEME_CATEGORY=Samples
---------------------------------------------------------------


---------------------------------------------------------------
; Sets whether AXCM should print scheme parameters to the console
; after reading any kind of scheme data during a filtering,
; coloring, or general "set scheme" action. This may be useful as a
; rudimentary debugging tool.

PRINT_SCHEME_PARMS_AFTER_ANY_DATA_READ=FALSE
---------------------------------------------------------------


******************************
[Coloring options]
******************************

---------------------------------------------------------------
; Sets the default scheme to appear in coloring dialog boxes,
; upon FrameMaker startup. It must be a valid scheme in the category
; indicated by DEFAULT_SCHEME_CATEGORY. Once changed
; in one of these dialog boxes, it has no further effect on 
; AXCM functionality.

COLOR_DEFAULT_COLORING_SCHEME=Product A vs. Product B
---------------------------------------------------------------

---------------------------------------------------------------
; These option control whether change bars are removed when
; AXCM uncolors a document. The "MANUAL" setting applies when you 
; run an "uncolor" command from a menu. The "AUTO" setting applies
; to instances when AXCM automatically uncolors, including just before
; any document-wide coloring action or during a filter, if that option
; was chosen in the filter dialog. If enabled, all change bars are removed,
; regardless of whether AXCM applied them or not.

COL_REMOVE_CHG_BARS_ON_MANUAL_UNCOLOR=FALSE
COL_REMOVE_CHG_BARS_ON_AUTO_UNCOLOR=FALSE
---------

---------------------------------------------------------------
; This is the delimiter that should be used to separate
; foreground and background color names in coloring schemes
; within tabular configuration files. This setting only applies
; to users of configuration files and then only if color names
; might contain the default delimiter (a comma). For most (if not
; all) users, this setting should be left as the default.

CONFIG_FILE_COLOR_DELIMITER=,
---------

******************************
[Filtering options]
******************************

---------------------------------------------------------------
; Default filter type that appears initially in the filter dialog box, 
; where it can be changed later. Valid values are SOURCE (source file)
; and DUPLICATE (duplicate file). For more information, see 
; the User Guide.

FILT_DEFAULT_FILTER_TYPE=DUPLICATE
---------------------------------------------------------------

---------------------------------------------------------------
; Allows screen display updates to be disabled during filter actions, 
; which may reduce filtering time. Valid values are TRUE and FALSE.

FILT_DISABLE_SCREEN_UPDATES=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; When set to FALSE, causes filtering with XPath-based schemes to ignore
; (that is, automatically preserve) text nodes, even if the XPath expression(s) 
; in the scheme do not account for them. If checked, your expressions 
; must match text nodes, otherwise they will be deleted. 
; For more information, see the User Guide. Valid values are TRUE and FALSE.

FILT_XPATH_CONSIDER_TEXT_NODES=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; When set to TRUE, allows the plugin to properly walk through
; and filter content within native FrameMaker text insets. If you
; use native text insets, this should be set to TRUE, otherwise
; filtering behavior may be unpredictable. Valid values are TRUE
; and FALSE. Note that this does not apply to InsetPlus insets
; (another West Street plugin), which are automatically filtered
; properly by AXCM. 

FILT_FILTER_TEXT_INSETS=TRUE
---------------------------------------------------------------

---------------------------------------------------------------
; Default startup setting for the "Delete empty folders and groups" option
; in the Filter dialog box. You can change this afterwards in the dialog box.
; This setting applies to FM9 or later only, as earlier versions did not
; support folders and groups in books.
; Valid values are TRUE and FALSE.

FILT_DELETE_BOOK_EMPTIES_DEFAULT=TRUE
---------------------------------------------------------------

---------------------------------------------------------------
; Sets whether to show all native FM conditions
; (including SOURCE_FILE_FILTER_CONDITION_TAG)
; before a no-restore source-file filter. Typically, filtering
; is much cleaner when all content is shown. The application of a
; condition tag when that condition is already hidden can sometime cause
; unpredictable behavior.
;
; Valid values are TRUE and FALSE.

FILT_SHOW_ALL_BEFORE_RESTORE_FILTER=TRUE
---------------------------------------------------------------

---------------------------------------------------------------
; Sets whether to hide the "Hidden" condition (SOURCE_FILE_FILTER_CONDITION_TAG)
; following a "no-restore" source-file filter. Hiding the condition is
; the final step to completing a filter action, but in some cases if
; you are performing several filters on the same file, hiding the condition
; after each filter may cause undesired results. If you do not allow AXCM
; to hide the condition automatically, it becomes your responsibility to
; hide it whenever appropriate to complete the filtering.
; 
; This is an advanced setting for specialized use only.
;
; Valid values are ALWAYS, PROMPT_FIRST, and NEVER.

FILT_HIDE_CONTENT_AFTER_NO_RESTORE_FILTER=ALWAYS
---------------------------------------------------------------

---------------------------------------------------------------
; During a duplicate-file book filter, sets whether to force 
; all cross-references to target a file in the filtered folder.
; In other words, it makes the filter assume that the targets for
; all cross-references will ultimately be found in the filtered 
; folder. If set to FALSE, any cross-references that target
; a file external to the book will remain pointing to the
; original target file location following the filter.
;
; Valid values are TRUE and FALSE. The normal setting is FALSE.

FILT_REDIRECT_ALL_XREFS_DURING_BOOK_FILTER=FALSE
---------------------------------------------------------------



******************************
[Validation options]
******************************

---------------------------------------------------------------
; Default validation scheme to use upon FrameMaker startup, as a valid scheme
; within the default category (DEFAULT_SCHEME_CATEGORY). 
; If you have auto-validation turned on (VAL_AUTO_VALIDATION_ENABLED),
; you should have a valid scheme specified here, 
; otherwise the validation actions 
; will fail until you manually specify a valid scheme.
; Note that this setting affects startup only... once changed
; in a dialog box, it has no further effect on AXCM functionality.

VAL_DEFAULT_VALIDATION_SCHEME=Sample validation
---------------------------------------------------------------


---------------------------------------------------------------
; Causes validation to occur during key user events such as 
; inserting and wrapping elements, and setting attribute values. 
; Auto-validation only occurs on the single element in question, 
; such as the one just inserted. For more information on validation,
; see the User Guide. Valid values are TRUE and FALSE.

VAL_AUTO_VALIDATION_ENABLED=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; Causes elements that violate validation rules to be marked 
; with strikethrough text during a validation action. If unchecked, 
; validation will produce warnings and/or a report only.
; Valid values are TRUE and FALSE

VAL_APPLY_STRIKETHROUGH_TEXT=TRUE
---------------------------------------------------------------


---------------------------------------------------------------
; Activates/deactivates each of the four validation rules,
; respectively. Deactivated rules are completely ignored.
; For more information, see the User Guide. Valid values
; are TRUE and FALSE.

VAL_RULE_1_ENABLED=TRUE
VAL_RULE_2_ENABLED=TRUE
VAL_RULE_3_ENABLED=FALSE
VAL_RULE_4_ENABLED=TRUE
---------------------------------------------------------------



*************************
[Warning and prompt options]
*************************

---------------------------------------------------------------
; The following options control if and when certain warning and
; prompt message boxes appear. Valid values are TRUE (enabled)
; and FALSE (disabled).

---------
; The confirmation warning that appears when attempting to delete a
; scheme item in a scheme editor, such as a scheme or a coloring rule.

PROMPT_DELETE_SCHEME_ITEM_WARNING=TRUE
---------

---------
; For duplicate file filters only, the confirmation warning before 
; filtering an unsaved document, if unsaved changes are detected and the
; "Save File" option in the filter dialog is unchecked.
; NOTE: If this warning is disabled, AXCM will automatically save the
; file in this situation!

PROMPT_FILTER_UNSAVED_FILE_WARNING=TRUE
---------

---------
; The warning produced when a document is opened that appears to have 
; been filtered with a source-file filter. The warning appears 
; if the document has the “filtered” condition tag in the hidden state 
; (see SOURCE_FILE_FILTER_CONDITION_TAG above);

PROMPT_OPENED_PREVIOUSLY_FILTERED_DOC_WARNING=TRUE
---------

---------
; The completion message following a document filter.

PROMPT_POST_DOCUMENT_FILTER_MESSAGING=TRUE
---------

---------
; The completion messages following a book filter, 
; including the warning about any files that were removed 
; from the book (duplicate file filters only).

PROMPT_POST_BOOK_FILTER_MESSAGING=TRUE
---------

---------
; The warning that appears during startup if you have auto-validation turned 
; on, but the default validation scheme could not be read. 
; In this case, auto-validation will fail until you manually
; set a valid scheme. Note that both the auto-validation setting
; and the default validation scheme are also set in this file. 
;
; This warning is only applicable for users of classic schemes and the
; auto-validation feature.

PROMPT_BAD_VAL_SCHEME_ON_STARTUP_WARNING=FALSE
---------

---------
; The warning prompt that appears during coloring when AXCM finds
; a color specified in the scheme that does not exist in 
; the template of the current document. In either case, no coloring is applied.

PROMPT_BAD_COLOR_IN_SCHEME=TRUE
---------

---------
; The confirmation prompt that appears when you select the Restore Book
; or Restore Document command, which restores the file(s) from a previous
; source file filter. IT IS RECOMMENDED THAT YOU KEEP THIS PROMPT ENABLED,
; as these commands will remove most or all existing condition assignment
; (native conditional text) from the file(s), not just the conditional text
; that AXCM applied during the course of filtering. Without the prompt,
; the action will proceed immediately and the changes cannot be undone.
;

PROMPT_PRE_RESTORE_FILE=TRUE
---------

---------
; The confirmation prompt that appears when you select the Uncolor Book
; or Uncolor Document command.

PROMPT_PRE_UNCOLOR_FILE=TRUE
---------

---------
; Confirmation prompt that appears when you have invoked an action
; that requests AXCM to open a file that
; requires the WYSIWYG view, but the current view is set to
; something else.
; 
; Note that this setting only applies to FM11 and later. Valid values are:
;
; - NEVER
; - ONCE
; - ALWAYS

PROMPT_SET_WYSIWYG_TO_COMPLETE_OPERATION=ALWAYS
---------



---------------------------------------------------------------

*************************
[Misc]
*************************

---------------------------------------------------------------

; This setting sets the initial language for the plugin. The default is
; DEFAULT, which indicates to use the language for which FrameMaker is set.
; To use a language other than English, you must have the proper configuration 
; files in place. See your User Guide for more information. 
;
; Examples: 
; STARTUP_LANGUAGE=DEFAULT 
; STARTUP_LANGUAGE=English 
; STARTUP_LANGUAGE=German 
; STARTUP_LANGUAGE=Bogusian 
; 

STARTUP_LANGUAGE=English
---------------------------------------------------------------

---------------------------------------------------------------
; This setting controls whether FrameMaker can produce any applicable
; alerts and/or prompts when opening files, such as when
; browsing for a scheme configuration file or main settings file.
; If set to TRUE, most interactive alerts will be suppressed,
; including the prompt for the structured application to use
; when opening an XML or SGML file. Normally, you should keep
; this set to FALSE, unless there is some particular alert that
; you receive frequently and do not want to see anymore. In the
; case of opening XML and SGML files, a setting of TRUE will
; always cause FrameMaker to use a default structured
; application, which may not be what you want to happen.

SUPPRESS_FILE_OPENING_ALERTS=FALSE
---------------------------------------------------------------


---------------------------------------------------------------
; This setting forces AXCM to use an alternative type of dialog
; box for its general alert messages. It is provided as a workaround
; for situations where an FDK bug prevents the normal alert boxes
; to appear. This setting normally should not be changed unless you are
; specifically instructed to do so.

USE_ALTERNATE_ALERTS=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; This setting is the path to your Notepad application EXE file.
; You may need to edit this setting if AXCM is not able to find Notepad
; in order to open the local settings file through its menus.

NOTEPAD_EXE_PATH=C:\Windows\NOTEPAD.EXE
---------------------------------------------------------------


---------------------------------------------------------------
; This setting affects the starting path when you browse
; for a "configuration file" from a filter, coloring, or validation
; dialog box. If set to TRUE, the initial starting folder in the
; browser window is always the folder containing the active file
; (that is, the file you intend to filter, color, or validate).
; Otherwise, the starting point defaults to the last folder selected
; (if applicable) or a system default.

CFG_FILE_BROWSE_USE_ACTIVE_FILE_FOLDER=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; A general purpose utility used during development and debugging,
; left here for general use. It has nothing to do with the core
; functionality of AXCM. The plugin will attempt to open all the files
; listed directly after the parameter upon FrameMaker startup. They must be
; specified as absolute paths.
; WARNING! This function will ignore most file opening errors as well
; as file locks!

FILES_TO_OPEN_ON_STARTUP
;C:\Documents\somedoc.fm
;C:\Documents\somebook.book

---------------------------------------------------------------


---------------------------------------------------------------
; Debug mode. This is for specialized use only. Don't change this
; setting unless specifically instructed to do so.

AXCM_DEBUG_MODE=OFF
---------------------------------------------------------------

---------------------------------------------------------------
; Internal use only. Do not change.

AXCM_LICENSE_TYPE=NORMAL
---------------------------------------------------------------


