If this toggle is checked, XXE will display an URL chooser dialog box rather than the standard file chooser dialog box each time the user needs to specify a file name.
Default: not checked.
Preference key: useURLChooser
; type: boolean; default: false
.
If this toggle is checked, XXE will display an URL chooser dialog box rather than the standard file chooser dialog box when the user needs to specify a file name for command Save Copy. That is, the URL chooser dialog box is always used for that command no matter whether toggle "Use URL chooser rather than file chooser" is checked or not.
Default: checked.
Preference key: useURLChooserToSaveCopy
; type: boolean; default: true
.
If this toggle is checked, when opening a document not constrained by a DTD or a schema, white space characters are stripped from elements containing child elements separated by white space.
This heuristic is generally a good one for XML data.
Default: checked.
Preference key: guessIgnorableWhitespace
; type: boolean; default: true
.
If this toggle is checked, a dynamic, non constraining, pseudo document type is used for documents not constrained by a DTD or XML Schema.
The pseudo document type simply remembers all attributes and child elements added to each element during the editing session. Thanks to this pseudo document type, the pick lists of the Edit and Attributes tools are always filled with sensible values.
Default: checked.
Preference key: useHelperDocumentType
; type: boolean; default: true
.
If this toggle is checked, xml-stylesheet processing instructions specifying which style sheets to use for the newly loaded document are ignored. If the XXE configuration associated to the newly loaded document specifies CSS style sheets, these style sheets are used instead.
Using this option is useful if <?xml-stylesheet?>
specifies a style sheet for use by a Web browser such as Mozilla and not a style sheet for use by XXE.
Default: not checked.
Preference key: ignoreStyleSheetPI
; type: boolean; default: false
.
If this toggle is checked, a dialog box with a warning is displayed if a document containing non-managed references to external entities or non-managed xi:include
elements is opened in XXE. See managed and non-managed references to external documents.
Default: checked.
Preference key: warnAboutLossOfPhysicalStructure
; type: boolean; default: true
.
If this toggle is checked, a dialog box with an information is displayed if a document containing managed references to external entities and/or managed xi:include
elements is opened in XXE. See managed and non-managed references to external documents.
Default: checked.
Preference key: infoAboutReadOnlyInclusions
; type: boolean; default: true
.
Specifies the type of lock used for the document being edited, when this document is stored on a WebDAV server (supporting locking).
Default: Exclusive
Preference key: davLockScope
; type: shared
, exclusive
or none
; default: exclusive
.
Specifies a free form string identifying you as an author of documents stored on a WebDAV server. This string is shown to other authors wishing to know who is locking documents on a WebDAV server. It is recommended to specify your email address (example: john@acme.com
).
Default: user name (example: john
)
Preference key: davLockOwner
; type: string; default: login name.
Table 1. Lock Types
Lock type | Description |
---|---|
None | The document being edited in not locked. |
Shared | The document being edited is locked using a shared lock. A shared lock does not prevent you from overwriting a document shared-locked by another author but a least, you are informed that the document is being ``used'' by this other author. (In such case, you'll generally want to contact him to decide what to do.) |
Exclusive | The document being edited is locked using an exclusive lock. An exclusive lock prevents you from overwriting a document exclusively-locked by another author. |
When an instance document conforming to a grammar (DTD, W3C XML Schema or RELAX NG Schema) is opened in XXE, the grammar is checked for validity, then the instance document is checked for validity.
Checking a grammar for validity may be a lengthy operation for a medium-size W3C XML schema and for a large DTD such as DocBook.
Therefore, if the option is enabled, XXE checks the grammar the first time it is used by an instance document and then caches it for subsequent uses. The grammar is cached
in memory,
on disk using a fast loading binary format (DTD, W3C XML Schema but not RELAX NG Schema).
The directory used to store the fast loading binary files is:
on Unix,$HOME
/.xxe/ser/
on Windows 2000/XP,%SystemDrive%
\Documents and Settings\%USERNAME%
\Application Data\XMLmind\XMLeditor\ser\
on Windows NT.%SystemDrive%
\winnt\Profiles\%USERNAME%
\Application Data\XMLmind\XMLeditor\ser\
The cache records the location and date of the source files of the grammar. If these source files are removed or modified, the cache will automatically discard the obsolete cached grammar. Of course, this forces XXE to load an up-to-date grammar from the source files.
Note that the existence and date of remote source files (that is, grammar files located on a HTTP or FTP server) are not checked by the schema cache.
Enables the behavior described above.
Disabling this option is a good idea if you exclusively use small or medium size DTDs such as XHTML.
Default: checked.
Preference key: useDocTypeCache
; type: boolean; default: true
.
Clears the cache forcing XXE to reload a grammar from its source files and to revalidate it next time it is used by an instance document.
This option is useful if you are developing grammars and using XXE to check them.
Note that the cache is automatically cleared each time you install a new version of XXE.
Specifies the encoding used for XML files saved by XXE (if save options have not been specified in an XXE configuration file -- see below).
Default: UTF-8.
UTF-8 is the default encoding of the XML files created by XXE because this encoding is compact and may be used to represent all Unicode characters.
However, if you need to deliver a XML file created by XXE to a person using a text editor to view or modify it, it is nicer to use a human-readable encoding such as ISO-8859-1 (Western character set).
Preference key: encoding
; type: any encoding supported by XXE; default: UTF-8.
If this toggle is checked, all characters not supported by the encoding are saved as entity references.
Example: the Euro sign is not supported by the ISO-8859-1 encoding. If this toggle is checked, the Euro sign is saved as "€
". If this toggle is not checked, the Euro sign is saved as "€
".
Of course, for a character to be saved as an entity reference, the corresponding entity must have been defined in the DTD.
Example: the Euro sign is not supported by the ISO-8859-1 encoding. If there is no entity defined for this currency symbol, the Euro sign is saved as "€" whether the toggle is checked or not.
Default: checked.
Preference key: saveCharsAsEntityRefs
; type: boolean; default: true
.
Specifies which characters, even if they are supported by the encoding, are always saved as entity references.
Example: the Copyright sign is supported by the ISO-8859-1 encoding but you may prefer to see it saved as "©
". In such case, specify "169"
in this text field.
This attribute contains a list of character ranges. A character range is either a single character or an actual range
.char1
:char2
A character may be specified using its Unicode character number, in decimal (example: 233
for e acute), in hexadecimal (example: 0xE9
) or in octal (example: 0351
).
Because names are easier to remember than numbers, a character may also be specified using its entity name as defined in the DocBook 4.2 DTD (example: eacute
). Note these symbolic specifications are supported whatever is the DTD or schema of the document being saved.
Examples: reg 174 0x00ae 0256 pound:yen 163:165 0xA3:0xA5 0243:0245
Default: empty.
Ignored if toggle "Save characters outside encoding as entity references" is not checked.
There is no need to specify the non-breaking space character (nbsp
= 160
= 0xa0
= 0240
) as it is always saved as "
" or as " 
".
Preference key: charsSavedAsEntityRefs
; type: specification as described above; default: empty string.
If this toggle is checked, XML files saved by XXE are indented (if save options have not been specified in an XXE configuration file -- see below).
The fields and toggles that follows in the Indent frame may be used to parametrize indentation.
Default: checked.
Specifies the number of space characters used to indent a child element relatively to its parent element.
Default: 2.
Preference key: indent
; type: integer (negative means not indented); default: 2.
Specifies the maximum line length for elements containing text interspersed with child elements.
Default: 78.
This value is only used as a hint: XML files created by XXE may contain lines much longer than the specified length.
Preference key: maxLineLength
; type: positive integer; default: 78.
If this toggle is checked, an open line is added between the child elements of a parent element (if the content model of the parent only allows child elements).
Default: checked.
Preference key: addOpenLines
; type: boolean; default: true
.
If this toggle is checked:
Empty elements having a non empty content are saved as "<tag></tag>
".
Empty elements having an empty content are saved as "<tag />
" (with a space after the tag).
Default: checked.
Preference key: favorInteroperability
; type: boolean; default: true
.
If this toggle is checked, XML files generated by XXE when saving documents not constrained by a DTD, W3C XML Schema or RELAX NG schema, are not indented, even if the Indent toggle is checked.
Note that when this toggle is not checked, XXE uses very simple heuristics to indent unconstrained documents. Indenting such documents this way may add white space to places where it is significant.
Default: not checked.
Preference key: dontIndentUnconstrainedDocs
; type: boolean; default: false
.
The above options can also be specified in a configuration file customizing XXE for a specific XML application.
If this is the case, when the configuration is in use, what has been specified in the Options dialog box is completely ignored, unless this toggle is checked.
Default: not checked.
Preference key: overrideConfiguration
; type: boolean; default: false
.
Document validity is automatically checked each time the document is saved to disk. If this toggle is checked, when validity errors are found, the Validity tool ``tab'' is automatically selected in order to display the error messages.
Default: not checked.
Preference key: showValidityPaneOnSave
; type: boolean; default: false
.
If this toggle is checked, XXE will automatically save modified documents.
Default: not checked.
A modified document will be automatically saved after specified number of modifications. Typing a character counts as a modification.
Default: 300.
Preference key: autoSaveInterval
; type: -1000000-1000000 (number of operations; negative means disabled); default: -300.
If a modified document is no longer edited during specified number of seconds, this document is automatically saved, even if the "Max. modifications before saving" count has not yet been reached.
This option allows to make the auto-save feature as non-intrusive as possible.
Default: 30.
Preference key: autoSaveTimeout
; type: 10-86400 (number of seconds); default: 30.
If this toggle is checked, a copy of the original file is made (same name but ending with '~
') before saving the modified copy.
Note that backup files are created at the beginning of the editing session and not each time a file is saved. This makes the backup files much more useful. For example a diff between foo.xml~
and foo.xml
will show you what you did during last editing session.
Default: checked.
Preference key: makeBackupFiles
; type: boolean; default: true
.
The options for the page footer are not described here because they are identical to those used for the page header (described below).
Specifies the screen resolution in DPI (Dot Per Inch) used when printing. This resolution directly determines the amount of text a printed page can contain.
Default: 100dpi.
Preference key: screenResolutionWhenPrinting
; type: 50-100; default: 100.
The page header has 3 areas: begin (the left for left-to-right languages), middle, end (right). This field specifies the text printed at the left of the page header.
Default: empty.
Each area can contain a mix of text and variables
Preference key: headerBegin
[footerBegin
]; type: text; default: empty [%F
].
Specifies the text printed at the center of the page header.
Default: empty.
Preference key: headerMiddle
[footerMiddle
]; type: text; default: empty [empty].
Specifies the text printed at the right of the page header.
Default: empty.
Preference key: headerEnd
[footerEnd
]; type: text; default: empty [%P
].
Specifies the color of the text of the page header.
Default: gray.
Note that the font used for the page header is the default font of the style sheet (see the Style options below).
Preference key: headerColor
[footerColor
]; type: 3 0-255 integers separated by spaces (specify red, green, blue); default: 128 128 128 [128 128 128].
Specifies if a thin line is to be printed below the page header [above the page footer].
Default: checked.
Preference key: underlineHeader
[overlineFooter
]; type: boolean; default: true
.
If this toggle is checked, clicking with the middle button (or with the mouse wheel) pastes the characters copied to the ``system selection''.
On platforms not supporting system selection (all but generic Unix/Linux), this action pastes the content of an internal clipboard.
Default: not checked.
Preference key: button2PastesSystemSelection
; type: boolean; default: false
.
If this toggle is checked, the editor adds gray margins at the left and at the right of the styled document views. These margins allows to trigger special, customizable, actions when the user clicks in them. By default, clicking in these margins, selects the ``block'' (paragraph, row, row group, table) in front of the click location. Clicking again without moving the mouse, selects the parent of the selected element. Clicking again without moving the mouse, selects the grand-parent, and so on.
Do not click several times too fast otherwise the editor will think you are double-clicking or triple-clicking and therefore, selecting elements that way would not work.
Default: not checked.
Preference key: addInteractiveMargins
; type: boolean; default: false
.
Allows to use the Insert dialog box rather than the Edit tab each time an element is to be inserted in the document. This also applies to the replace and convert operations.
Default: not checked.
Preference key: selectFieldUsingChooser
; type: boolean; default: false
.
Specifies how to quickly complete what is being typed in an autocompletion-enabled text field.
There is no quick way to complete what is being typed (other than using Up and Down arrows).
What is being typed is automatically completed to compose first possible suggestion.
The user needs to explicitly press on the space bar (or on Ctrl-Space, if some of the choices contain whitespaces) to complete as much as possible what has been typed.
Example: the list of choices is "aaz aaa bbz bbb ccz ccc
". The user types "b
".
Default: Manual.
Preference key: appendSuggestionMode
; type: none
, auto
or manual
; default: manual
.
If this toggle is checked, the list which displays possible choices (e.g. elements to be inserted in the document) is kept as short as possible.
Default: not checked.
By default, such list displays all possible choices, whether matching what has been typed in the autocompletion-enabled text field or not.
Example: the list of choices is "aaz aaa bbz bbb ccz ccc
". The user types "b
".
If this toggle is not checked, the list contains "aaz aaa bbz bbb ccz ccc
" and item "bbz
" is highlighted.
If this toggle is checked, the list contains "bbz bbb
" and item "bbz
" is highlighted.
Preference key: onlyShowSuggestions
; type: boolean; default: false
.
Specifies the maximum number of undo (redo) actions a user will be able to perform. Limited to 100 because a single undo action may consume a great deal of memory.
Default: 20.
Preference key: maxUndo
; type: 1-100; default: 20.
Specifies the type of document/element reference pasted after using command Edit|Document Reference|Copy as Reference.
The Paste command must always use the "reference to an external entity" mechanism. Choose this option to ease the interchange of the documents you create with XXE.
It is not possible to use the "reference to an external entity" mechanism when the referencing document (example: a book document book.xml
referencing a chapter document chap1.xml
) has no document type declaration (<!DOCTYPE>
).
The reason for this is that XXE needs to declare the referenced entities in the internal DTD subset and that XXE will not create an internal DTD subset unless the referencing document already has a <!DOCTYPE>
.
The Paste command must always use the XInclude mechanism. See http://www.w3.org/TR/xinclude/. Choose this option if your documents are constrained by W3C XML Schemas or RELAX NG schemas or if you often need to reference an element inside a document rather than the whole document.
This element more or less deeply inside the referenced document will be specified by XXE using an XPointer using the element scheme. See http://www.w3.org/TR/xptr/.
Note that you do not need to declare xi:include
elements in the DTD or in schema because XInclude processing occurs before validation. That is, xi:include
elements are already replaced by the included elements when validation begins.
The Paste command must use the "reference to an external entity" mechanism when possible (example: the referencing document has a <!DOCTYPE>
and no XPointer is being used) and the XInclude mechanism otherwise (example: the referencing document does not have <!DOCTYPE>
or an XPointer is needed).
This is the recommended option.
Default: Entity when possible, XInclude otherwise.
Preference key: inclusionType
; type: entity
, xinclude
or auto
; default: auto
.
Command Edit|Document Reference|Copy as Reference allows to copy as a reference any element, including those not having an ID.
Unless the copied reference is a reference to the root element of a document, this means that the copied reference is based on the position of the element as a child of its parent element, on the position of the parent element as a child of the grand-parent element and so on. This is what we call a hierarchical XPointer. Example: file:///usr/share/docs/xxe/doc/docbook/help.xml#element(/1/3)
.
Pasting a reference based on a hierarchical XPointer is not safe because if you modify the referenced document, your referencing document may point to an element other than the one for which a reference has been originally pasted.
This is why it is strongly recommended not to uncheck this option, which warns you each time you try to paste a reference based on a hierarchical XPointer.
Note that you'll never get a warning dialog box when you'll paste a reference to the root element of a document (example: file:///usr/share/docs/xxe/doc/docbook/help.xm
l) or when you'll paste a reference which exclusively uses an ID to locate the element (example: file:///usr/share/docs/xxe/doc/docbook/help.xml#element(parameterGroup)
) because these references are considered to be safe.
Default: checked.
Preference key: warnAboutHierarchicalXPointer
; type: boolean; default: true
.
The following options parameterize the CSS style sheet used to visualize the document or to print it.
Setting some of these preferences will have no visible effect if the style sheet author has specified the corresponding properties in the style sheet. For example, if the user's preferred background is specified in the Style section as being light yellow and if the style sheet author has specified the root element background-color
as being white, the document will be rendered with a white background.
Specifies the font family used for property value font-family:serif
.
Default: Serif (the Java™ default serif font family).
Preference key: serifFontFamily
; type: font family name; default: Serif
.
Specifies the font family used for property value font-family:sans-serif
.
Default: SansSerif (the Java™ default sans-serif font family).
Preference key: sansSerifFontFamily
; type: font family name; default: SansSerif
.
Specifies the font family used for property value font-family:monospace
.
Default: Monospaced (the Java™ default monospaced font family).
Preference key: monospaceFontFamily
; type: font family name; default: Monospaced
.
Specifies the default value for property font-family
.
Default: SansSerif.
Preference key: defaultFontIsSerif
; type: boolean; default: false
.
Specifies the default value for property font-size
.
Default: 12pt.
Preference key: defaultFontSize
; type: 10-20 (pt); default: 12.
Specifies the default value for property background-color
. (Displays standard color chooser dialog box.)
Default: white.
Preference key: defaultBackground
; type: 3 0-255 integers separated by spaces (specify red, green, blue); default: 255 255 255.
Specifies the default value for property color
. (Displays standard color chooser dialog box.)
Default: black.
Preference key: defaultForeground
; type: 3 0-255 integers separated by spaces (specify red, green, blue); default: 0 0 0.
If this toggle is checked, ignore capitalization errors.
Default: not checked.
Preference key: ignoreCase
; type: boolean; default: false
.
If this toggle is checked, do not check words containing case mixing (e.g. "SpellChecker
").
Default: not checked.
Preference key: ignoreMixedCase
; type: boolean; default: false
.
If this toggle is checked, do not check words containing digits (e.g. "b2b
").
Default: checked.
Preference key: ignoreDigits
; type: boolean; default: true
.
If this toggle is checked, ignore words looking like URLs or file names (e.g. "www.xxx.com
" or "c:\boot.ini
").
Default: checked.
Preference key: ignoreURL
; type: boolean; default: true
.
If this toggle is checked, do not signal two successive identical words as an error.
Default: not checked.
Preference key: ignoreDuplicates
; type: boolean; default: false
.
If this toggle is checked, punctuation checking is enabled: misplaced white space and wrong sequences, like a dot following a comma, are detected.
Default: not checked.
Preference key: checkPunctuation
; type: boolean; default: false
.
If this toggle is checked, all words formed by concatenating two legal words with an hyphen are accepted. If the language allows it, two words concatenated without hyphen are also accepted.
Default: checked.
Preference key: allowCompound
; type: boolean; default: true
.
If this toggle is checked, a word formed by concatenating a registered prefix and a legal word is accepted. For example if "mini-
" is a registered prefix, accepts "mini-computer
".
Default: checked.
Preference key: allowPrefixes
; type: boolean; default: true
.
If this toggle is checked, accepts any word ending with registered file extensions (e.g. "myfile.txt
", "index.html
", etc).
Default: checked.
Preference key: allowFileExtensions
; type: boolean; default: true
.
For use on a fast computer. Does not influence the number of suggestions (always limited to 15).
Default: not checked.
Preference key: maxSuggestionForce
; type: boolean; default: false
.
Specifies that spreadsheets are to be opened in auto-update mode.
In manual update mode, only newly inserted formulas are computed. To force a full calculation, the user has to explicitly use Tools|Spreadsheet|Update.
In auto-update mode, a full calculation is automatically performed, if needed to, when the editing context changes. For example: type some text in a paragraph, then click in (or tab to) another paragraph to trigger a spreadsheet calculation.
Note that in both modes, a full calculation is automatically performed, if needed to, before validating or saving the document.
Using manual update mode is recommended if you have a slow computer or if you have inserted a lot of formulas in your document or if your formulas access many external documents.
Default: checked.
Preference key: spreadsheetAutoRecalc
; type: boolean; default: true
.
Specifies the maximum number of iterations allowed for calculations in spreadsheet. This limit is used to prevent the spreadsheet engine from looping in case of cycles in formulas.
Default: 20.
Preference key: spreadsheetMaxIterations
; type: 2-2000; default: 20
.
Formulas can access external documents using XPath escapes (example: `document("tutorial/VATrates.html#france_vat",.)`
). Such access is generally slow and therefore, documents need to be cached the first time they are loaded.
However, the cache is not very smart and will often not be able to detect changes in the external document. This problem will happen if the change happens in a module included by the document or if the document is stored on a remote HTTP or FTP server. In this is case, disabling the cache and also disabling the auto-update mode are recommended.
Default: checked.
Preference key: spreadsheetCacheDocuments
; type: boolean; default: true
.
If this toggle is checked, XXE will automatically create two views for a newly opened or newly created document. That is, by default, a document tab will contain a tree view and a styled view side by side.
This option has of course no effect on documents for which no CSS style sheet is available.
Default: not checked.
Preference key: showBothViews
; type: boolean; default: false
.
If this toggle is checked, a unique instance of XMLmind XML Editor is used to open all your XML documents. For example, if you double-click on the icon of an XML document in the file ``explorer'', the running instance is used to open this XML document. When this toggle is not checked, a new instance of XXE is started in order to load the document clicked upon.
If there is no running instance of XXE, a new instance is started. If the running instance is hidden by other windows or is iconified, it is made visible before opening the requested document.
This feature also works fine from the command line. For example, on Linux, if this toggle is checked, executing "xxe mydoc.xml &
" will cause the running instance to be used to open mydoc.xml
.
If you need to change this option, make sure to close all running instances expect one. Then change the option in the last instance and close it. Then restart XXE.
Default: not checked.
Preference key: singleInstance
; type: boolean; default: false
.
Specifies the TCP/IP port used by different instances of XXE to communicate with each other. It is highly recommended to use a port in the dynamic/private range: 49152 to 65535.
Default: 49987
Preference key: singleInstancePort
; type: 1-65535; default: 49987
.
May be used to change the base font size of XXE menus and dialog boxes.
Note that this orthogonal to changing the base font size used to display styled documents.
Default: default base font size of Java™ applications.
Preference key: fontSize
; type: 10-20 or -1 (means default); default: -1.
May be used to force the language used in XXE menus and dialog boxes. For example, may be used to force the use of English on a machine where the default locale is German.
Default: default locale of the machine running XXE.
Preference key: locale
; type: language
(e.g. fr
) or language
_COUNTRY
(e.g. fr_CA
) or - (means default); default: -.
May be used to change the look and feel of XXE user interface.
Default: the system look and feel, except on Linux: Metal when Java™ 1.5 is used to run XXE; Kunststoff when Java™ 1.4 is used to run XXE.
Preference key: lookAndFeelClassName
; type: Java™ class name of a PLAF or - (means default); default: -.