; This is the general settings file for the West Street FrameSLT 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 FrameSLT 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.
;
; - If you receive a patch from West Street with instructions to add
;   one or more settings, you can add them anywhere. Just be
;   sure not to alter the syntax.






******************************
[Node Wizard and Node Wizard Script Options]
******************************

---------------------------------------------------------------
; Specifies whether the autorun capability of
; Node Wizard scripts is enabled overall. If set to FALSE,
; all autorun settings of all configured scripts are ignored.
; If you enable script autorunning, you should be very careful
; in the management of your scripts. It is possible to forget
; that you have a script set to autorun and miss the changes that
; it causes.

NW_ALLOW_SCRIPT_AUTORUNNING=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; Specifies whether an attribute action that copies
; or moves data from element text to an attribute value is allowed
; to move an empty string; that is, no
; value, effectively overwriting any values at the target. For example,
; if you are moving text from an element to a "props"
; attribute and the element is empty, this setting specifies
; whether the action will clear all values from the props attribute or
; simply abort the action.

NW_ATTR_ACTIONS_COPY_EMPTY_STRING=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; Sets whether FrameSLT should return focus to the active book or 
; document after you click “Match First” or “Match Next” in the
; Node Wizard. With this option checked, any key stroke following 
; the click of these buttons will act upon the active document, 
; according to the current insertion point or element selection. 
; If this option is unchecked, the focus will remain on the 
; Node Wizard and you will need to manually click within the 
; active document window to return focus.

NW_FOCUS_ON_DOC_AFTER_MATCH=TRUE
---------------------------------------------------------------

---------------------------------------------------------------
; Sets the maximum number of errors and/or warnings to report
; during any given "Perform Actions On All" Node Wizard run
; or a Node Wizard Script run

NW_MAX_ERRORS_TO_REPORT=100
---------------------------------------------------------------


---------------------------------------------------------------
; Sets whether full paths or filenames only are displayed in 
; applicable Node Wizard and Node Wizard Script dialog box labels

NW_DISPLAY_FULL_FILE_PATHS=FALSE
---------------------------------------------------------------


---------------------------------------------------------------
; Sets whether to load the current XPath favorites upon startup

NW_LOAD_XPATH_FAVORITES_ON_STARTUP=TRUE
---------------------------------------------------------------

---------------------------------------------------------------
; Sets whether alert the West Street Structure Tools plugin
; following a Node Wizard match action in order to refresh its
; modeless attribute editor, if the editor is currently displayed.
; This setting is not applicable if you do not have WS Structure
; Tools installed.

NW_REFRESH_WS_STRUCTURE_TOOLS_ATTR_EDITOR=TRUE
---------------------------------------------------------------


*************************
[Warning and prompt option]
*************************

---------------------------------------------------------------
; The following options control if and when certain warning and
; prompt message boxes appear. In some cases, you may want to
; disable messaging if it becomes an annoyance.
; For all these settings, the valid values are:
; - ALWAYS
; - ONCE
; - NEVER
; ... where ALWAYS means that the warning should
; always appear and ONCE allows the respective messaging to appear only
; once during any given FrameMaker session.

---------------------------------------------------------------
; Warning that appears when you click the “Perform All Actions”
; button in the Node Wizard.

PROMPT_NW_PERFORM_ALL_ACTIONS_WARNING=ALWAYS

---------------------------------------------------------------
; Message after you click the “Match All” button in the Node Wizard 
; which reports the total number of matches.

PROMPT_NW_MATCH_ALL_STATS_MSG=ALWAYS

---------------------------------------------------------------
; Warning that appears when the "Process all flows" option in the
; Node Wizard must be overridden due to other parameters, such as a 
; contextual and/or a book-wide search.

PROMPT_NW_OVERRIDE_ALL_FLOWS_SETTING_WARNING=ALWAYS

---------------------------------------------------------------
; Confirmation prompt that appears when you have invoked an action
; that requests FrameSLT 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.

PROMPT_SET_WYSIWYG_TO_COMPLETE_OPERATION=ALWAYS

---------------------------------------------------------------
; Warning that appears when you attempt to transform a source file;
; that is, perform a transformation without duplicating the 
; document first.

PROMPT_XFORM_SOURCE_FILE_WARNING=ALWAYS

---------------------------------------------------------------
; Post-transformation warning when one or more cross-references 
; were created by FSLT_create-xref elements, and the target file(s) 
; need to be saved to preserve their resolution. When a 
; cross-reference is created in structured frame, a value must 
; be assigned to the ID attribute of the target element. 
; This warning indicates that an ID attribute was set in a 
; currently unsaved file(s) which must be saved, 
; otherwise the cross-reference(s) will be broken.

PROMPT_XFORM_CREATE_XREF_WARNING=ALWAYS

---------------------------------------------------------------
; Pre-transformation warning on a document, if it is a 
; “duplicate document” transformation and there are unsaved 
; changes in the document. When duplicating a document, 
; FrameSLT uses the file on disk, and therefore must 
; save the document beforehand if it has unsaved changes.

PROMPT_XFORM_UNSAVED_CHANGES_WARNING=ALWAYS

---------------------------------------------------------------
; Non-error messaging associated with the “Run Script” and “Run Event”
; buttons on the Node Wizard Scripts dialog. These message boxes
; include the confirmation prompt before a Node Wizard script 
; launch, and the statistics and completion message boxes after
; it finishes. With these messages deactivated, an error-free 
; script will run with no message boxes. 
; Error-related warnings will still appear.

PROMPT_NW_SCRIPT_GENERAL_MSGS=ALWAYS




******************************
[Miscellaneous strings]
******************************


---------------------------------------------------------------
; During a Node Wizard Script run, this is the
; string to set for the result parameter following a string entry, 
; path browser, or file browser prompt if the user clicked Cancel 
; or did not select anything, as applicable.

STR_NWS_PROMPT_USER_CANCEL=USER_CANCELED
---------------------------------------------------------------


---------------------------------------------------------------
; During an external call from ExtendScript to retrieve
; a parameter value with GetScriptParm(), this is the string
; to return if the parameter is not defined

STR_EO_GET_UNDEFINED_PARM=PARAMETER_NOT_DEFINED
---------------------------------------------------------------




******************************
[Other miscellaneous settings]
******************************

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

; 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=German 
; 

;STARTUP_LANGUAGE=Bogusian
STARTUP_LANGUAGE=English
---------------------------------------------------------------

---------------------------------------------------------------
; This setting determines where the FrameSLT menu appears.
; Valid values are:
;
; - MAIN (FrameMaker main document and book menus)
; - WESTSTREET (West Street parent menu that appears in the main document
    and book menus. If you have other West Street plugins installed, they
    may have a presence in this menu as well.
; - NONE (No FrameSLT menu anywhere - Only API calls will be functional)
;
; Note that you must restart FrameMaker for changes to take effect.

FSLT_MENU_LOCATION=MAIN
---------------------------------------------------------------

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

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

---------------------------------------------------------------
; Amount of memory to reserve for parsed XPath data, in kilobytes.
; This should not be altered unless necessary. See your
; User Guide for more information.

TOTAL_XPATH_MEMORY=350
---------------------------------------------------------------

---------------------------------------------------------------
; The maximum number of characters that an XPath expression can
; contain. The valid range is 255 to 20,000.

MAX_XPATH_LENGTH=2000
---------------------------------------------------------------

---------------------------------------------------------------
; When testing the text content of an element, the maximum number
; of characters to retrieve and test. Large numbers may slow 
; performance, but small numbers may hide text from view of the
; XPath. The valid range is 255 to 20,000.

MAX_XPATH_TEXT_CHARS_FOR_QUERY=255
---------------------------------------------------------------

---------------------------------------------------------------
; The maximum number of matches permitted for any type of XPath
; matching action that matches nodes in a batch, such as the
; Match All button on the Node Wizard. It is recommended that you
; do not change this value without consultation with West Street.
; This limit is designed to prevent FrameSLT from overwhelming your
; system memory in the event that an XPath expression is sufficiently
; vague and/or the queried document(s) are sufficiently large.
; The minimum acceptable value is 1000.

MAX_XPATH_MATCHES=20000
---------------------------------------------------------------

---------------------------------------------------------------
; A special setting to enable debug mode, normally used only
; for troubleshooting purposes in conjunction with West Street
; Consulting. It should not be enabled for normal operation.

FSLT_DEBUG_MODE=OFF
---------------------------------------------------------------


---------------------------------------------------------------
; License key. If provided a string key to enable the full license,
; this is where it goes.

FSLT_LICENSE_KEY=WagMoreBarkLess
---------------------------------------------------------------




*************************
[General transformation settings]
*************************
; NOTE:  TRANSFORMATION FUNCTIONALITY IS SCHEDULED FOR DEPRECATION!

---------------------------------------------------------------
; This setting allows FrameSLT to disable screen updates during
; transformations, which allow for faster transformations.

XFORM_DISABLE_SCREEN_UPDATES=TRUE
---------------------------------------------------------------

---------------------------------------------------------------
; This setting allows FrameSLT to close any files that it had
; to open during a transformation process. If set to TRUE, all
; files opened are closed without saving any changes. If set to
; FALSE, all files remain open.

XFORM_CLOSE_OPENED_FILES=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; This is the string that gets appended to the filename of a
; transformed file; that is, the output of a transformation

XFORM_FILENAME_ADDENDUM= (TRANSFORMED)
---------------------------------------------------------------


---------------------------------------------------------------
; This setting sets whether transformation element dialog boxes should 
; attempt to resolve a relative path when a source file is selected. 
; If a relative path cannot be resolved, the absolute path is used.
; Note that this setting only affects the use of transformation 
; element dialog boxes. It does not change the type of path used 
; for any existing transformation elements.

XFORM_PREFER_REL_PATHS_IN_DIALOGS=TRUE
---------------------------------------------------------------


---------------------------------------------------------------
; This setting indicates whether FrameSLT should automatically 
; adjust all relative paths used for source files in transformation 
; elements when a stylesheet document is saved to a new location.
; If a relative path cannot be resolved, such as when the document 
; is saved to a different network drive, the path is converted to 
; an absolute path. Existing absolute paths always remain absolute 
; and are unaffected by this setting.

XFORM_ADJUST_REL_PATHS_DURING_SAVE_AS=TRUE
---------------------------------------------------------------


---------------------------------------------------------------
; This setting indicates whether you can produce the editor
; for a transformation element by double-clicking it in the
; Structure View window. If set to FALSE, you must use menu
; commands to produce element editors.

XFORM_ALLOW_DBL_CLICK_EDITS=TRUE
---------------------------------------------------------------


---------------------------------------------------------------
; This setting specifies whether parameters, indicated by a
; leading dollar sign ($), are recognized in XPath expressions
; in a transformation stylesheet. If set to FALSE, all dollar signs
; are interpreted simply as normal characters. See your User Guide
; for more information on parameters.

XFORM_RECOGNIZE_PARAMS_IN_EXPRESSIONS=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; Similar to the previous setting, this setting specifies whether 
; parameters are recognized in literal strings.
; This is applicable only if parameters are enabled in expressions
; overall. For example, consider the following XPath expression:
;
;  //Heading="$ThisValue"
;
; If parameters in literal strings are not enabled, FrameSLT will 
; look for a Heading element with the text “$ThisValue”. If parameters
; are enabled, FrameSLT will attempt to resolve the parameter 
; $ThisValue and then look for a Heading element with the respective text.
; See your User Guide
; for more information on parameters.

XFORM_RECOGNIZE_PARAMS_IN_LITERALS=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; Similar to the previous setting, this setting specifies whether 
; parameters are recognized in source file paths in a 
; transformation stylesheet. If set to FALSE, all dollar signs
; are interpreted simply as normal characters. See your User Guide
; for more information on parameters.

XFORM_RECOGNIZE_PARAMS_IN_PATHS=FALSE
---------------------------------------------------------------



