﻿; This is the general settings file for the West Street InsetPlus 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 InsetPlus 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 update settings]
*************************

---------------------------------------------------------------
; This sets InsetPlus to open any necessary source files
; in order to update references, during an update
; action. Note the following behavior:
; - If a source file is in use by someone else,
;   InsetPlus will open a read-only version.
; - If the source file is a book, it will open all
;   chapters. If it cannot open all the chapters, it will
;   at least search for the inset source in the
;   chapters that are open.
; - If you have message boxes turned on for the
;   applicable update action, you will be prompted
;   before opening any file.
; - If you do not have this setting on, no files
;   will ever be opened, and you will never be
;   prompted to open them.
; - This is a "global" setting for all types of update
;   actions. The document and book update dialog
;   boxes have this setting too, and it merely
;   reflects the current state of this global setting. If
;   you change it in one of those dialog boxes, it will
;   change the current setting, but will not change
;   the preferences that are read from this file on startup.

OPEN_FILES_DURING_UPDATES=TRUE
---------------------------------------------------------------

---------------------------------------------------------------
; This setting causes InsetPlus to close
; any source files that were opened by
; the InsetPlus during the update action. Note the
; following behavior:
; - If it is a reference update, nothing should ever
;   be altered in your source files.
; - If it is a source update, InsetPlus will not close
;   any source files it opened without prompting you
;   first. To close an updated source file and
;   preserve the update, InsetPlus would have to
;   save it first, and InsetPlus should never save
;   changes without prompting you first.

CLOSE_FILES_AFTER_UPDATES=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; This setting, if enabled, allows InsetPlus to automatically
; clean up conref attribute values during inset updates,
; and then reset any attribute values that required cleanup. 
; "Cleanup" in this context refers to actions such as:
;
; - Replace backslashes with forward slashes
; - Ensure single forward slashes only (no double-slashes, etc.)
; - For insets that reference a module within the same file,
;   ensure that the "path" portion of the argument is an empty
;   string; for example:  #SomeModule
;
; Automatic cleanup is recommended. If disabled, InsetPlus will
; still attempt cleanup internally when reading a conref value,
; but will not change the attribute value in the file afterwards.

AUTO_CONREF_CLEANUP_DURING_UPDATES=TRUE
---------------------------------------------------------------



---------------------------------------------------------------
; These settings involve the copying/transfer of attribute values
; from a source element to a reference element during
; an inset update. Note that for any attribute value to be transferred,
; it must be a valid attribute in both the source and reference
; documents, according to the respective EDDs.

; This setting enables attribute transfer overall.
; If attribute transfer is disabled, no attributes on any reference element
; are ever changed, regardless of any other attribute settings.
;
; This setting is a default only, which can be changed in the
; inset update dialog box.

ALLOW_ATTR_TRANSFER=FALSE

; If attribute transfer is enabled overall (ALLOW_ATTR_TRANSFER=TRUE),
; This setting enables InsetPlus to transfer any value(s) from any attribute
; that is specified on the source element but not on the reference element.
; This setting can be overridden on an individual attribute basis with
; the ATTRS_TO_NEVER_TRANSFER below.
;
; This setting is a default only, which can be changed in the
; inset update dialog box.

TRANSFER_UNSPEC_REF_ATTRS=FALSE

; This setting indicates specific attributes that must always
; be transferred if they have values specified on the source element. 
; Any values currently existing on the reference element will be overwritten
; without any warnings. This setting can be left blank.
;
; If ALLOW_ATTR_TRANSFER=FALSE, this setting has no effect.
;
; Separate multiple attributes with commas. For example:
;
; ATTRS_TO_ALWAYS_TRANSFER=product,otherprops
;
; This setting is a default only. The list of attributes
; can be changed in the inset update dialog box.

ATTRS_TO_ALWAYS_TRANSFER=

; This setting indicates specific attributes that should never
; be transferred, regardless of any other settings. Any attributes
; in this list will never be altered on a reference element.'
; This setting can be left blank.
;
; Separate multiple attributes with commas. For example:
;
; ATTRS_TO_NEVER_TRANSFER=product,otherprops
;
; This setting is a default only. The list of attributes
; can be changed in the inset update dialog box.

ATTRS_TO_NEVER_TRANSFER=

; This setting forces the transfer of an attribute value
; if the reference attribute is specified as 
; "-dita-use-conref-target", overwriting that value.
; If value transfer is disabled overall
; (ALLOW_ATTR_TRANSFER=TRUE), this setting has no effect.

ATTR_TRANSFER_USE_DITA_RULES=FALSE


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

---------------------------------------------------------------
; This setting causes InsetPlus to refresh EDD formatting rules
; on a reference element after a single element update. 
; Only the reference element and descendants are refreshed.

REFRESH_EDD_FORMATTING_SINGLE_UPDATE=TRUE
---------------------------------------------------------------

---------------------------------------------------------------
; The following settings provide other miscellaneous defaults for
; settings in the inset update dialog box.

; Refresh EDD formatting
REFRESH_EDD_FORMATTING_FILE_UPDATE=TRUE

; Disable screen updates
DISABLE_SCREEN_UPDATES_FILE_UPDATE=FALSE

; Do source module tracking updates
DO_SRC_MODULE_TRACKING_UPDATES_FILE_UPDATE=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; This setting allows you to remove the "Update Inset Source"
; command from the inset element context (right-click) menu. 
; In most cases, users desire
; to have the command removed. If this setting is completely
; eliminated from this file, the default is to remove the command.
; See the user guide for more information.
; Note that you must restart FrameMaker for this setting to take effect

REMOVE_UPDATE_INSET_SOURCE_CMD=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; This setting allows you to remove the "Update All Referenced Sources"
; command from the main InsetPlus menu. In most cases, users desire
; to have the command removed. If this setting is completely
; eliminated from this file, the default is to remove the command.
; See the user guide for more information.
; Note that you must restart FrameMaker for this setting to take effect

REMOVE_UPDATE_ALL_SOURCES_CMD=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; This setting allows InsetPlus to "unlock" all native text insets
; in the document before any update actions, such that InsetPlus insets
; within native insets can update properly. The primary intent of this
; setting is to allow some compatibility with DITA files. When FrameMaker
; opens a DITA XML file, it automatically wraps each conref inset in a
; mechanism known as a "client-owned" inset. This mechanism is 
; effectively a text inset that is controlled by an FDK client or 
; ExtendScript only. The user is locked out of the content. So, it makes
; for a convenient method to lock up DITA conrefs and facilitate the
; features related to them.
;
; This mechanism is fine when regular conref functionality is used
; within DITA files. The problem occurs when you create an inset with
; InsetPlus, then reload the file into FrameMaker. At that time, 
; FrameMaker wraps it in one of these insets and can not access it any more.
;
; So, this setting simply tells InsetPlus to unlock all native insets
; before any update action, then lock them back up afterwards. USE IT
; AT YOUR OWN RISK. By nature, the plugin is generally incompatible
; with native text insets. It is unknown whether this setting will
; work in all situations and whether there will be any unintended side
; effects. There will be no attempt to provide comprehensive support
; for these arrangements that InsetPlus is not inherently designed to 
; support.

UNLOCK_NATIVE_INSETS_BEFORE_UPDATES=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; This setting allows FrameMaker to produce interactive dialog boxes
; when opening source files. This setting may be useful when
; user intervention is required to properly open a file. For example,
; it allows FrameMaker to produce the "Structured Application"
; selection dialog box when opening an XML file, so that you can select
; a specific application. Otherwise, FrameMaker will select a default
; application automatically, which may not be the correct application if
; multiple applications share the same DOCTYPE. In summary, a value
; of FALSE is typically appropriate unless you require manual intervention
; when opening files. A value of TRUE could cause the production
; of intrusive messaging for inconsequential issues related to file opening.

ALLOW_INTERACTIVE_SOURCE_FILE_OPENING=TRUE
---------------------------------------------------------------



******************************
[Inset configuration settings]
******************************

---------------------------------------------------------------
; This setting specifies the name of the attribute to use
; on a reference element for the reference link, typically "conref".
; This setting is very important and strictly case-sensitive.

REF_ELEM_CONREF_ATTR=conref
---------------------------------------------------------------

---------------------------------------------------------------
; This setting specifies the name of the identification attribute
; on a source element, typically "id" or similar, representing
; a unique ID attribute. This setting is strictly case-sensitive.
; If you would like InsetPlus to automatically detect a unique
; ID attribute, specify <UNIQUE_ID> (with the angle brackets).
; This setting is very important and strictly case-sensitive
; (except for the <UNIQUE_ID> option).

SOURCE_ELEM_ID_ATTR=<UNIQUE_ID>
;SOURCE_ELEM_ID_ATTR=ID
---------------------------------------------------------------

---------------------------------------------------------------
; This setting sets whether source and reference elements
; must have the same tag, similar to DITA. The inset element
; editor will automatically restrict your choices based on this
; setting.
;
; There are two very important points about this setting:
; 
; - A setting of TRUE generally results in a cleaner and
;   more intuitive workflow and is therefore highly 
;   recommended
;
; - Whatever setting you choose, if you also plan to use
;   the source module tracking feature, you should pick
;   a setting and stay with it. Toggling this setting
;   can cause source module tracking reports to become
;   unreliable, since the validity of links between 
;   sources and references can become blurry if
;   the tags are ever different. If you do change this setting,
;   you should clear out your tracking files and allow them
;   to be regenerated by whatever means you have enabled.

REQUIRE_IDENTICAL_TAGS=TRUE
---------------------------------------------------------------

---------------------------------------------------------------
; This setting specifies whether relative paths are required,
; or whether you may use absolute paths for reference insets.

REQUIRE_RELATIVE_PATHS=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; This setting specifies whether InsetPlus should
; write out fully-contextual ID
; specifications when writing the conref attribute in
; conref mode. This setting enforces some
; compliance with the DITA conref standard for
; writing contextual IDs, but it should be noted that
; InsetPlus will not use them and the setting may
; have no application unless you are using your
; content in some post-process that requires DITA
; compliance. See the User Guide for more info.

WRITE_FULL_ID_HIERARCHY=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; These settings are related to the handling of relative conref paths
; when you do a "Save As" of a document to a new path. Because saving
; a document to a new folder would cause relative paths to become broken,
; InsetPlus provides this option to automatically adjust those paths,
; much like FrameMaker does automatically for native text insets
; (and referenced graphic paths, etc.). Descriptions are as follows:
;
; - ADJUST_RELATIVE_PATHS_ON_SAVE_AS - Enables/disables 
;   the feature overall
;
; - FILE_EXTENSIONS_FOR_SAVE_AS_ADJUSTMENT - Indicates which files you want 
;   the feature to act upon, according to file extensions. 
;   Use commas to delimit multiple extensions. Any files with any extensions
;   not listed will never have paths adjusted.
;
; - WARN_ON_SAVE_AS_FAILURES - The third setting allows the plugin 
;   to produce report warnings at any
;   time the plugin is unable to adjust a path, such as a case where you
;   save a file to a different drive.
; 
; It is recommended that you keep this feature active during normal use.  

ADJUST_RELATIVE_PATHS_ON_SAVE_AS=TRUE
FILE_EXTENSIONS_FOR_SAVE_AS_ADJUSTMENT=fm,mif,xml,sgm,sgml
WARN_ON_SAVE_AS_FAILURES=TRUE
---------------------------------------------------------------



*************************
[Inset editing settings]
*************************

---------------------------------------------------------------
; This setting causes configured reference insets to behave
; similar to native insets with respect to content
; access. If set to TRUE, an inset element will become
; selected when the insertion point is placed
; anywhere within it, preventing editing of the content.
; Because this makes it easier to identify insets and
; prevent unintended editing of their content, this is a
; recommended setting. Note the following:
;
; - With this setting, content is "mostly"
;   inaccessible. There are some edit actions which
;   still may be performed, especially with the
;   Structure View. Therefore, this setting should
;   not be considered an absolute barrier to content
;   editing; rather, it is mainly intended as a
;   convenience to prevent accidental editing.
;
; - A "configured reference inset" means any element
;   with a populated conref attribute.

DISALLOW_REF_INSET_EDITING=TRUE
;DISALLOW_REF_INSET_EDITING=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; This setting allows you to specify zero or more elements
; for which you want the inset element editor to automatically
; appear upon element insertion, wrapping, or retagging actions.
; Make sure that the elements you specify here have the appropriate
; conref attribute defined. If an element does not, the editor
; will not appear.
; 
; Example:
; REF_ELEMENTS_TO_AUTO_EDIT=inset,p,li

REF_ELEMENTS_TO_AUTO_EDIT=TextInset
---------------------------------------------------------------

---------------------------------------------------------------
; This setting controls what happens when you double-click
; a reference inset; that is, an element with a configured
; conref attribute. Valid Values are:
;
; OPEN_EDITOR - Opens the inset editor
; UPDATE - Updates the inset
; JUMP_TO_SOURCE - Attempts to jump to the inset source
; NOTHING

REF_INSET_DBL_CLICK_ACTION=OPEN_EDITOR
---------------------------------------------------------------

---------------------------------------------------------------
; This setting controls whether an inset is updated
; after you click OK in the inset editor. Valid values are:
; 
; ALWAYS
; PROMPT_FIRST
; NEVER

REF_INSET_UPDATE_AFTER_EDIT=PROMPT_FIRST
---------------------------------------------------------------

---------------------------------------------------------------
; This setting controls the default path type selection in the
; inset editor. It is a default only, not a mandate.
; Valid values are ABSOLUTE and RELATIVE

REF_INSET_DEFAULT_PATH_TYPE=RELATIVE
---------------------------------------------------------------


---------------------------------------------------------------
; This setting can be used to force a clean initialization
; of the inset editor every time it is invoked. It is only applicable
; while creating and updating translated strings for a different
; language. Otherwise, you likely want it to be turned off. The 
; consequence of a clean initialization is that the scrolling position
; of the Inset IDs scroll box always defaults to the top. If the clean
; initialization is skipped, the scrolling position normally persists
; between dialog box settings.
;
; This setting is necessary due to the flexibility of the
; translation features combined with how dialog box resources
; are handled internally with the FDK.
;
; If none of the information above made sense to you, just leave
; the setting as FALSE.

FORCE_INSET_EDITOR_INITIALIZATION=FALSE
---------------------------------------------------------------


************************************
[General Warning/messaging settings]
************************************

---------------------------------------------------------------
; These settings control if and how certain warnings appear.
; Valid Values are:
;
; MSG_BOX
; REPORT
; BOTH
; NONE
;
; InsetPlus is built to work best with the default settings
; found in this file. It is recommended to keep them as-is for
; normal usage.
;

; Error/warning messaging during single inset updates,
; such as the update after working in the inset editor

WARNINGS_SINGLE_UPDATE=BOTH


; Error/warning messaging during updating an inset and any nested insets,
; initiated from an InsetPlus menu

WARNINGS_NESTED_UPDATE=REPORT


; Error/warning messaging while updating a whole document or book. This setting
; can be overridden in the file update dialog box, when doing updates.

WARNINGS_FILE_UPDATE=REPORT


; Final prompt after updating a document or book, listing total insets updated, etc.
; Valid values are MSG_BOX and NONE only.

PROMPT_POST_FILE_UPDATE=MSG_BOX
---------------------------------------------------------------


*********************************
[Source module tracking settings]
*********************************

---------------------------------------------------------------
; This setting controls whether source module tracking is
; globally enabled or disabled. See the User Guide for more information.

SRC_MOD_TRACKING_ENABLED=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; This setting specifies the folder for storing source module
; tracking data. The folder must currently exist and
; it must be specified as an absolute path.
;
; Example:
; SOURCE_MODULE_TRACKING_DATA_FOLDER=C:\MyData\InsetPlus

SRC_MOD_TRACKING_DATA_FOLDER=C:\insetplus_tracking_data
---------------------------------------------------------------

---------------------------------------------------------------
; This setting will cause a message box warning any time these
; settings are read and the folder does not appear to exist.
; This may be the only warning available that the folder is
; incorrectly specified, other than a simple failure for source
; tracking to work. If source tracking is disabled, this setting
; is not applicable.

SRC_MOD_TRACKING_FOLDER_WARNING=TRUE
---------------------------------------------------------------

---------------------------------------------------------------
; These settings control whether source tracking data is
; written automatically when a file is opened and/or closed.
; Included is a setting to enable a one-time warning about 
; each of those activities. When the warning is presented,
; you will have the opportunity to abort the process and disable
; the respective setting.

SRC_MOD_TRACKING_AUTO_ON_FILE_OPEN=FALSE
SRC_MOD_TRACKING_AUTO_ON_FILE_CLOSE=FALSE

SRC_MOD_TRACKING_AUTO_DO_FILE_OPEN_WARNING=TRUE
SRC_MOD_TRACKING_AUTO_DO_FILE_CLOSE_WARNING=TRUE
---------------------------------------------------------------

***********************************
[Source module collection settings]
***********************************

---------------------------------------------------------------
; This setting allows you to remove the source collection command
; entirely from InsetPlus menus, effectively disabling the feature.

REMOVE_SRC_COLLECTION_CMD=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; This setting determines whether FrameMaker is used to copy
; source modules files during the collection process, or whether
; a simple system call is used. If FrameMaker is used, each source
; file is opened in FrameMaker, then "saved as" to the collection
; location. If FrameMaker is not used, the copy is performed as if
; you opened a command prompt and issued "copy" commands. Using 
; FrameMaker to copy files allows the conveniences associated with
; Save As operations, such as the readjustment of paths to referenced
; objects, such as image files. However, it is typically much
; slower than system calls.
;
; This setting is a default only. You can change in the
; source module collection dialog box when launching the collection.

SRC_COLLECTION_USE_FM_TO_COPY=TRUE
---------------------------------------------------------------

---------------------------------------------------------------
; These settings controls whether the "redirect references" option
; is enabled in the source module collection dialog box. This is
; a potentially risky setting and you may want to keep it disabled
; for general usage. The first setting controls whether the setting
; is enabled and the second allows an informational warning to be
; produced about the disabled condition when you launch the source
; collection dialog box.

SRC_COLLECTION_ALLOW_REDIRECTION=TRUE
WARN_WHEN_REDIRECTION_IS_DISALLOWED=TRUE
---------------------------------------------------------------


---------------------------------------------------------------
; This setting controls whether message box warnings are 
; produced as applicable during source collection, including
; file overwrite warnings, confirmation prompts, and final status
; messaging. If disabled, it will also suppress any file opening 
; alerts such as structure application prompts, if applicable.
;
; This setting is a default only. You can change in the
; source module collection dialog box when launching the collection.

SRC_COLLECTION_DO_MSG_BOX_WARNINGS=TRUE
---------------------------------------------------------------


---------------------------------------------------------------
; This setting controls whether a report is produced
; during the source collection process. 
;
; This setting is a default only. You can change in the
; source module collection dialog box when launching the collection.

SRC_COLLECTION_DO_REPORTING=TRUE
---------------------------------------------------------------



************************
[Miscellaneous settings]
************************

---------------------------------------------------------------
; This setting allows you to remove the menu command that opens
; this file for editing. You may want to remove this command if you
; have a central settings file that a group of users use and you don't
; want anyone accidentally making changes. 
; Note that you must restart FrameMaker for this setting to take effect

REMOVE_EDIT_SETTINGS_CMD=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; This is the default color for coloring reference insets. It will appear
; as the initial choice for coloring upon startup and has no effect
; after that. 
;
; This setting is case sensitive!

DEFAULT_REF_INSET_COLOR=Red
---------------------------------------------------------------


---------------------------------------------------------------
; These settings control auto-coloring of insets when a file is
; opened and when a document is refreshed (Ctrl+L)

AUTO_COLOR_REF_INSET_ON_OPEN=FALSE
AUTO_COLOR_REF_INSET_ON_REFRESH=FALSE
---------------------------------------------------------------


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

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

---------------------------------------------------------------
; This setting controls the connfirmation prompt that appears when 
; you have invoked an action
; that requests InsetPlus 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
---------------------------------------------------------------


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

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

INSETPLUS_DEBUG_MODE=OFF
---------------------------------------------------------------

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

INSETPLUS_LICENSE_TYPE=NORMAL
---------------------------------------------------------------




