Elements

The <advanced> element contains the advanced options for the configuration.

If set to False the user is not allowed to accept changes in the changeTracking panel.

The <allowPersonalisation> element specifies if the user can show or hide buttons or button groups in the toolbar using the context menu.

If set to False the user is not allowed to reject changes in the changeTracking panel.

The reproducer is a handy tool for sharing your editing environment with the Xopus support staff, so they can see a bug you encounter themselfes, and make sure the bug is fixed.

The attention borders can be disabled by setting this element to true.

The <attribute> element is used to specify the role of a certain attribute in the current document format.

This configuration option, when set to True, will force a document to become valid when loaded. This feature applies the makeValid function when loading the document.

This contains the setting for change tracking.

<config /> is the root of an Xopus Configuration. It usually specifies the location of the XML document to be loaded, its XML Schema and what XSL Stylesheets should be used to render the views.

The <debugMode> element specifies whether Xopus runs in user debug mode. In that mode more thorough checks are performed which allows Xopus to show more detailed error messages. This does have a performance penalty.

The <defaultLanguage> element is used to declare the language to be used by the spell checker when no language has been declared through the xml:lang attribute on the document itself.

Configure the description used in the UI for an element or attribute, displayed as a tooltip in the interface.

The HTML<div> element with its nested XML Data island element becomes an editable Xopus Canvas when it has xopus="true" set. It wraps the Xopus configuration directives for an Canvas inside an ordinary HTML webpage.

You can create more complex buttons using a drop down button.

The <element> element is used to specify the role of a certain element in the current XML format.

This element can be configured to enable Change Tracking in the editor.

Use the enumeration element to provide translated labels for enumeration values on nodes.

Using <exitURL> you can specify a URL where Xopus should exit when the exit button is pressed. This button only exists if the URL has been set.

Elements with certain roles will be hidden from the insert menu by default. This option allows you make them visible again.

This option can be used to hide the maximize viewport button. Implementations can use their own buttons without confusing the end-user.

Hide the property panel completely, including the options to open the panel in the toolbar and context menus.

If <hideStatusbar> is set to true Xopus will not show the statusbar.

if <hideToolbar> is set to True Xopus will not show the toolbar.

Xopus allows users to surf to other pages in its content frame. If such a new page does not contain an Xopus Canvas, Xopus will go to standby mode. This element controls if Xopus should hide itsself in that case or if it should just disable its toolbar and status bar.

If <ignoreUnsavedChanges> is set to true Xopus will exit without a warning even if the user has unsaved changes.

The <import> element can import settings from an external Xopus Configuration file. The root element of that file is a <config> element.

This can be used to override the input UI type, not the validation, in the properties panel of an attribute or element.

Configure an invalid value message for items in the property panel.

The <javascript> element points to a JavaScript file that is executed when Xopus activates an Xopus Canvas. The script is executed after the configuration is loaded but before any associated files are loaded. The script has full access to the Xopus API.

This element is a placeholder for configurations of the localizations.

A <lookup> element can be used to specify an external source of values for attributes or elements. The source can be any HTML document. The document will be opened by Xopus when a value for the attribute can be specified. The HTML document can return its value using script.

The <lookupConfig> element contains lookup element. Each <lookup> element specifies an attribute and a URI, which points to an HTML page that can generate a list of value from which the user can pick one.

The <maxInsertSize> element specifies the size of table insert dialog.

This element is a child of dropdown-button, as a container for the items in the dropdown.

The menu group element is used to group menu-items together.

Menu items are used in dropdown menus in the Xopus interface.

The <miscellaneous> element contains miscellaneous settings.

Configure the name used in the UI for an element or attribute.

node can be used to configure a node, element or attribute in different ways, such as role, pretty name, placeholder and templates.

With <nodeConfig> you can configure elements and attributes.

An overlay is used to describe extra UI elements in the Xopus user interface.

A <param> element can be used to pass information to the XSL stylesheet.

A space seperated list of HTML elements which can be pasted with a special command. This can be useful when migrating content from an existing site.

The pipeline element defines the XML pipeline. It specifies the document to load and the XML Schema to use for validation.

A placeholder is a little piece of text that Xopus adds to a newly created element so that the author can see where the new element is created. When the author types some text, the placeholder immediately disappears.

Xopus can also resolve XIncludes. An <xi:include> elements points to an XML fragment at a certain URI. Resolving it will replace the <xi:include> element with the fragment it refers to.

This configuration settings allows to reduce the number of languages in the Language menu. Its value must be a list of language codes. It must be placed within the localization element.

Roles are used for mapping toolbar buttons and behavior in the editor. For example, when the author presses Enter, Xopus will try to insert the paragraph-role element. Roles are used as hints, however, as Xopus will always follow the rules specified in the schema.

The <roleMapping> element contains all <attribute> and <element> elements for which a role is specified.

If set to False the changetracking markup is turned off by default.

This configuration option can be used to stop Xopus from calculating schema states for a specific namespace.

The <spellChecker> element contains spellchecker API related settings. Xopus has a spellchecker built in. It offers the user interface for a spellchecker.

The <spellCheckerServer> element specifies the location of the spell checker server used by Xopus. Due to browser security restrictions, the server application must run on the same host and port as the web server from which Xopus was started.

Possible values: never, always and once. The value never is not yet supported, and it's behavior is currently equivalent to once.

The <subCanvasMode> element specifies whether Xopus should make the entire document contentEditable or just the parts that marked with contentEditable="true". By default, the whole document is editable.

The <tableEditor> element contains specific settings for the "Insert Table" menu.

The template element can be used to define template content for the element when it is inserted. This may include attributes, child-elements, and default text.

The templates element is a container for templates that should be inserted when a node is inserted into a document.

The toolbar element contains specific settings for the Xopus toolbar.

A custom button the in Xopus user interface.

The toolbar group element can be used to create a custom group in the toolbar.

A <transform> action transforms the incoming XML document using a specified XSL Stylesheet.

The <treeTransform> element is a special element to be used within views on the pipeline. It uses an XSL and some other files to draw your XML as XML as it would look in Internet Explorer. The output however is still XHTML and editable. It is a WYSIWYG view like any other, made to look like XML.

Schema element types can be grouped together in the user interface. This makes it easier to find related elements and shortens lists of elements or attributes such as in the Insert menu or the Properties panel. For example, attributes can be grouped for a particular user role (e.g. editorial, authoring, styling).

The useSchemaOrderInUI element can be used to configure Xopus to display elements in their schema order in User Interface elements.

When validateOnLoad is set Xopus will validate the whole document when it is loaded. By default Xopus will assume that the loaded document is schema valid.

The <validateSimpleTypes> settings can be used to prevent Xopus from validating simple schema types. Each value will be treated as though it was defined as generic string type.

Contains schema validation specific settings.

A view consists of one or more actions to be performed consecutively on the xml. The user can choose the preferred view from the Xopus menu.

If set to false with changeTracking enabled, the author will be making changes to the document, but not see the UI involved in the changeTracking feature.