﻿; This is the general settings file for the West Street XRef Wizard 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 interface tools
;   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.



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

******************************
[Cross-reference pod settings]
******************************

---------------------------------------------------------------
; Elements to consider when populating the Targets
; scroll box; that is, the list of potential xref targets.
; Place each element name on a separate line with no blank
; lines until the end of the list. For example:
;
; XREF_POD_VALID_TARGET_ELEMENTS
; title
; heading
; 
; To consider all elements with a unique ID attribute, specify ALL,
; for example:
;
; XREF_POD_VALID_TARGET_ELEMENTS
; ALL

XREF_POD_VALID_TARGET_ELEMENTS
ALL

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

---------------------------------------------------------------
; Working in conjunction with the previous setting,
; this setting specifies whether the pod should consider 
; potential targets that have a unique ID attribute but no
; unique ID currently assigned. If set to FALSE, the Targets
; scroll box will not show any elements that do not have
; a populated unique ID attribute.
; Valid values are TRUE and FALSE.

XREF_POD_CONSIDER_TARGETS_WITH_NO_ID=TRUE
---------------------------------------------------------------

---------------------------------------------------------------
; This setting specifies whether the pod automatically launches
; when you:
; 
;   - Attempt to insert a cross-reference element from the
;     element catalog.
;   - Double-click a cross-reference.
;
; In both cases, if set to TRUE, the XRef Wizard pod
; will replace the native FrameMaker Cross-Reference pod
; and the native pod will not appear at all during those actions.
; If you set this
; to FALSE, the XRef Wizard pod will never appear unless
; you invoke it from the XRef Wizard menu.
;
; Note that with a setting of TRUE, you can still access the
; the native pod by selecting Special > Cross-Reference.
;
; Valid values are TRUE and FALSE.
;

XREF_POD_REPLACE_NATIVE_POD=TRUE
---------------------------------------------------------------

---------------------------------------------------------------
; This setting specifies how each item should appear
; in the Targets scroll box. You can use any nature of
; static text combined with any of the following building
; blocks:
; 
; - <TAG> (element tag)
; - <CONTEXT_LABEL> (context label, as assigned by the EDD)
; - <TEXT> (element text, subject to XREF_POD_TARGET_TEXT_MAX_LENGTH, below)
; - <PREFIX> (prefix string, as assigned by the EDD)
; - <NUMBERING> (paragraph numbering, including bullets, etc., from the template)
; - <ID> (element unique ID)
; - <NESTING> (nesting level, as referenced to the highest-level element)
;
; For example, the following setting will show the element tag
; and context label for each target, along with the
; element text (with autonumbering) in quotes:
;
; XREF_POD_TARGET_SYNTAX=<<TAG>(<CONTEXT_LABEL>)> - "<NUMBERING><TEXT>"

XREF_POD_TARGET_SYNTAX=<<TAG>(<CONTEXT_LABEL>)> - "<NUMBERING><TEXT>"
---------------------------------------------------------------

---------------------------------------------------------------
; When the XREF_POD_TARGET_SYNTAX setting includes <TEXT>,
; this is the maximum length of that text. The valid range
; is 1 to 100 characters

XREF_POD_TARGET_TEXT_MAX_LENGTH=25
---------------------------------------------------------------

---------------------------------------------------------------
; This setting specifies the format of text in the "extended view" 
; box at the bottom of the pod. It follows the same model as
; XREF_POD_TARGET_SYNTAX, except that the maximum length for <TEXT>
; is not used. In other words, if you put <TEXT>, the label will
; show the entire element text, as space is available.

XREF_POD_EXT_VIEW_SYNTAX=<NUMBERING> <TEXT>
---------------------------------------------------------------

---------------------------------------------------------------
; This is the string that is used to indent items in the
; Targets scroll box based on structural hierarchy. For each
; level of nesting, this string gets prepended to the target label.
;
; If you want whitespace to be considered, enclose the string in
; straight quotes, for example:
;
; XREF_POD_TARGET_INDENT_STRING="  "
;
; To disable hierarchical indents entirely, use an empty set
; of quotes, for example:
;
; XREF_POD_TARGET_INDENT_STRING=""

XREF_POD_TARGET_INDENT_STRING="  "
---------------------------------------------------------------

---------------------------------------------------------------
; This setting determines whether full paths or just
; filenames appear in the Files list. Valid values
; are TRUE and FALSE;

XREF_POD_SHOW_FULL_PATHS=FALSE
---------------------------------------------------------------

---------------------------------------------------------------
; This setting determines whether you will be able to
; intervene when an ID needs to be set on a target element.
; If set to TRUE and a cross-reference is created to an
; element that currently has no ID, the unique ID editor
; will appear and allow you to control the ID is set. If
; set to FALSE, the plugin sets an 8-character random value
; automatically, similar to native FM behavior when you
; create a cross-reference to a target with no ID.

XREF_POD_ALLOW_ID_INTERVENTION=TRUE
---------------------------------------------------------------

---------------------------------------------------------------
; This is the default cross-reference format that appears in the
; Format list when the pod is first launched. If this format does
; not exist in the active template, this setting is ignored.

XREF_POD_DEFAULT_FORMAT=Heading & Page
---------------------------------------------------------------

---------------------------------------------------------------
; This is the default element tag that appears in the
; Element tag list when the pod is first launched. If this tag does
; not exist in the active template, this setting is ignored.

XREF_POD_DEFAULT_TAG=xref
---------------------------------------------------------------

---------------------------------------------------------------
; This setting enables/disables the automatic refreshing
; of the pod when typing in the Search text box. If disabled,
; you must click the Search button to refresh the pod, according
; to the current string in the Search text box.

XREF_POD_AUTO_REFRESH_WHILE_TYPING_SEARCH=TRUE
---------------------------------------------------------------




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

---------------------------------------------------------------
; This setting is the path to your Notepad application EXE file.
; You may need to edit this setting if the plugin is not able to find Notepad
; when it attempts to open files for editing such as this settings file.

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.

XRW_DEBUG_MODE=Off
---------------------------------------------------------------

---------------------------------------------------------------
; License key. Upon a software purchase, you will be provided
; a key which should be specified here.

XRW_LICENSE_KEY=SolidRockAndRoll
---------------------------------------------------------------


