# XMLmind XML Editor - Online Help

## 2. Preference keys

Key | Type | Default | Corresponding Option
--- | --- | --- | ---
`activeInputMethodClient` | boolean | `false` | Use integrated input method support
`addOpenLines` | boolean | `true` | Add open lines
`addonInstallDir` | `user`|`system`|`best` | `best` | Install add-ons in the user's preferences directory
`addonSource` | `servers`|`directory`|`both` | `servers` | Download add-ons from these servers
`addonServers` | list of URLs separated by newline characters ('`\n`') | See Download add-ons from these servers. | When `addonSource=servers`, this key specifies the list of ``servers''. See Download add-ons from these servers.
`addonDir` | the filename of an existing directory | none | When `addonSource=directory`, this key specifies the local directory. See Search add-ons in this directory.
`allowAdvancedXInclude` | boolean | `false` | Allow advanced use of XInclude
`appendSuggestionMode` | `none`, `auto` or `manual` | `manual` | Append mode
`autoCheckForUpdates` | boolean | true | Check for Updates
`autoCheckForUpdates.interval` | positive integer | 86400 (24 hours) | Specifies the minimal amount of time, in seconds, between two automated checks. See Check for Updates.
`autoCheckForUpdates.after` | integer between 10 and 14400 | 120 (2 minutes) | Specifies the amount of time, in seconds, after which the automated check is started. See Check for Updates.
`autoDiffSupport` | boolean | false | Automatically activate change detection
`autoSaveInterval` | -1000000-1000000 (number of operations; negative means disabled) | -300 | Max. modifications before saving
`autoSaveTimeout` | 10-86400 (number of seconds) | 30 | Idle time (seconds) before saving
`autoSelectAttribute` | `never`, `placeholder` or `required` | `placeholder` | Automatically select an attribute
`autoSpellCheck` | enumeration (`never`, `always`, `seeConfig`) | `seeConfig` | Activate if this is specified in the configuration file
`button2PastesSystemSelection` | boolean | `false` | Clicking with middle button pastes system selection
`charsSavedAsEntityRefs` | specification as in Always save these characters as entity references | empty string | Always save these characters as entity references
`copyDocumentTemplate` | boolean | `false` | Immediately save newly created document
`defaultBackground` | 3 0-255 integers separated by spaces (specify red, green, blue) | 255 255 255 | Default background
`defaultFontIsSerif` | boolean | `false` | Default font family
`defaultFontSize` | 8-24 (pt) | 12 | Default font size
`defaultForeground` | 3 0-255 integers separated by spaces (specify red, green, blue) | 0 0 0 | Default text color
`documentCache` | integer between 0 and 5000. Specify 0 to disable the cache. | `100` | Document cache
`dontIndentUnconstrainedDocs` | boolean | `false` | Do not indent unconstrained documents
`encoding` | any encoding supported by Java™ or "`ORIGINAL_ENCODING`" | UTF-8 | Encoding
`ensureSaveFileHasExtension` | boolean | `true` | Ensure that a save filename has an extension
`selectedFeatures` | list of feature names (`OpenFolder`, `IncludeTool`, etc), separated by newline characters | All features except `DeveloperTools` and `DocumentCacheTool`. | Section 5.11.1, “Features Options”
`filterDuplicateIDs` | boolean | `true` | Filter duplicate ID errors found in modular documents
`fontSize` | 8-24 (pt) or -1 (means: system's default) | -1 | Font size
`ftpProxyHost` | host name or host address | none | FTP proxy
`ftpProxyPort` | integer | 80 | (FTP proxy) Port
`guessIgnorableWhitespace` | boolean | `true` | When no DTD or schema, guess ignorable white space
`headerBegin` [`footerBegin`] | text | empty [`%F`] | Begin
`headerColor` [`footerColor`] | 3 0-255 integers separated by spaces (specify red, green, blue) | 128 128 128 [128 128 128] | Color
`headerEnd` [`footerEnd`] | text | empty [`%P`] | End
`headerMiddle` [`footerMiddle`] | text | empty [empty] | Middle
`helperApplications.entries` | string | see File types | File types

The format of this string is:

    entries --> ( entry ('\n' entry)* )?

    entry --> mime_types ':' extensions ':'
              magic_strings ':'
              xml_name_patterns ':'
              command

    mime_types --> ( mime_type (',' mime_type)* )?
    extensions --> ( extension (',' extension)* )?
    magic_strings --> ( magic_string (',' magic_string)* )?
    xml_name_patterns --> ( xml_name_pattern (',' xml_name_pattern)* )?

    In any of the above fields,
    character ':' must be escaped using "\072"
    and character ',' must be escaped using "\054".

    magic_string --> HEXADECIMAL_NUMBER

    xml_name_pattern --> ( '{' namespace_URI? '}' )? local_part
    One of local_part or namespace_URI
    may be equal to "*".

`helperApplications.defaultViewer` | string | see Default viewer | Default viewer
`httpProxyHost` | host name or host address | none | HTTP proxy
`httpProxyPort` | integer | 80 | (HTTP proxy) Port
`httpsProxyHost` | host name or host address | none | HTTPS proxy
`httpsProxyPort` | integer | 443 | (HTTPS proxy) Port
`indent` | integer (negative means not indented) | 2 | Indentation
`ignoreStyleSheetPI` | boolean | `false` | Ignore <?xml-stylesheet?>
`infoAboutReadOnlyInclusions` | boolean | `true` | Inform about non-editable document parts
`imageViewportMode` | `image`, `thumbnail` or `box` | `image` | Display images
`locale` | `language` (e.g. `fr`) or `language`_`COUNTRY` (e.g. `fr_CA`) or - (means default) | - | Locale
`lockLocalDocuments` | boolean | `false` | Lock documents stored on the local filesystem
`lockMode` | `shared`, `exclusive` or `none` | `exclusive` | Preferred lock mode
`lockOwner` | string | empty string which implies `user_name`@`host_name` | Identifier as a lock owner

`lockTimeout`

integer (number of seconds)

86400 (that is, 24 hours)

After specified number of seconds, a lock is to be automatically removed by the server (typically WebDAV) hosting the locked document.

A negative or null value may be used to create locks which should never expire.

Note that there is no need to create permanent locks as XXE automatically “refreshes” the lock each time the locked document is being saved.

One notable exception is Subversion, which when used through WebDAV, does not support locks having a finite lifetime.

This user preference cannot be specified using the GUI of XXE. You need to use the `-putpref` command-line option for that.

`lookAndFeelClassName` | Java™ class name of a PLAF or - (means default) | - | Style
`makeBackupFiles` | boolean | `true` | Before saving, make a backup copy of the file
`maxLineLength` | positive integer | 78 | Max. line length
`maxUndo` | 1-100 | 20 | Max. undo actions
`monospaceFontFamily` | font family name | `Monospaced` | Monospaced font family
`nonProxyHosts` | list of host names, host addresses and domain names (e.g. `.acme.com`) separated by spaces | "`localhost 127.0.0.1`" | No proxy for
`onlyShowSuggestions` | boolean | `false` | In the choice list, only show suggestions
`onUpdateDocumentSet` | one or more of `transclude`, `redraw`, `validate` separated by commas | `validate` | Section 5.2.1, “Document Set options”
`overrideConfiguration` | boolean | `false` | Override settings specified in config. files
`proxySettings` | `none`|`system`|`application` | `system` | Use system settings
`quickStartCache` | boolean | `true` | Quick Start cache
`reopenLastOpenedFile` | boolean | `false` | Automatically reopen last opened document
`saveCharsAsEntityRefs` | boolean | `true` | Save characters outside encoding as entity references
`schemaCache` | integer between 0 and 100. Specify 0 to disable the cache. | `10` | Schema cache
`screenResolutionWhenPrinting` | 50-100 (Dot Per Inch) | 100 | Screen resolution
`sansSerifFontFamily` | font family name | `SansSerif` | SansSerif font family
`serifFontFamily` | font family name | `Serif` | Serif font family
`showBothViews` | boolean | `false` | Show both tree and styled views
`showValidityPaneOnSave` | boolean | `false` | Automatically show Validity tool
`singleInstance` | boolean | `false` | Use a unique instance of XMLmind XML Editor
`singleInstancePort` | 1-65535 | `49987` | Port
`socksPassword` | encoded string | the empty string | (SOCKS) Password
`socksProxyAuthentication` | boolean | false | Authenticate SOCKS user
`socksProxyHost` | host name or host address | none | SOCKS proxy
`socksProxyPort` | integer | 1080 | (SOCKS proxy) Port
`socksUser` | string | the login name of the user | (SOCKS) User name
`spreadsheetAutoRecalc` | boolean | `true` | Open spreadsheets in auto-update mode
`spreadsheetMaxIterations` | 2-2000 | `20` | Maximum number of iterations allowed for calculations in spreadsheet
`treeViewAtRight` | boolean | `false` | Place tree view at right

`treeViewFontsAndColors`

(without a space after '`;`') "``markupFont`; `textFont`; `verbatimTextFont`; `backgroundColor`; `readOnlyColor`; `markupColor`; `elementNameColor`; `attributeNameColor`; `attributeValueColor`; `textColor`; `commentColor`; `piColor`; `textBorderColor`; `commentBorderColor`; `piBorderColor``"

(without a space after '`;`') "`SansSerif-Bold; SansSerif; Monospaced; ffffff; e0f0f0; 808080; 8b008b; 008b8b; 00008b; 000000; 8b1c62; 006400; f0f0f0; ffe0e0; e0ffe0`"

Fonts and colors

`treeViewFontSize` | 8-24 (pt) | 12 | Base font size
`treeViewShowAttribute` | boolean | `true` | Show attributes
`treeViewShowComment` | boolean | `true` | Show characters in comment nodes
`treeViewShowPI` | boolean | `true` | Show characters in processing-instruction nodes
`treeViewShowText` | boolean | `true` | Show characters in text nodes
`treeViewPercent` | 10-90 | `33` | Tree view width
`underlineHeader` [`overlineFooter`] | boolean | `true` | Underline [Overline]
`updateInclusionsOnSave` | boolean | `true` | Automatically update references in modular documents
`useHelperDocumentType` | boolean | `true` | When no DTD or schema, simulate a DTD
`useNativeFileChooser` | boolean | `true` on the Mac, `false` on the other platforms | Use the native file chooser in preference to the multi-platform file chooser
`useURLChooser` | boolean | `false` | Use the URL Chooser
`verticalSplit` | boolean | `false` | Split Windows Vertically
`warnAboutAdvancedXInclude` | boolean | `false` | Warn about advanced use of XInclude

`warnAboutCorruptedEditSession`

boolean

`true`

When the change detection has been activated for a given document and this document is modified outside XXE, the `<?xxe-serial-numbers>` processing-instruction which allows to use the Compare tool to compare two revisions of this document, becomes out of sync with the contents of the document. When this is the case, a warning dialog box is displayed informing the user that the `<?xxe-serial-numbers>` processing-instruction had to be recreated from scratch.

When this preference key is set to `false`, the warning dialog box (which may “frighten” the user) is not displayed.

This user preference cannot be specified using the GUI of XXE. You need to use the `-putpref` command-line option for that.

`wrapLongWords` | boolean | `false` | Wrap words wider than available space