config

<config version="1.0" xmlns="http://www.xopus.com/xmlns/config"/> is the root of an Xopus Local Configuration. It specifies the uri of the xml document to be loaded, its xml schema and what xsl files should be used to render the views.

If some settings are not specified their default values will be used as specified in the xopus/config/default-config.xml file.

Example

    <div xopus="true" autostart="true">
      Starting Xopus...
      <xml>
        <config version="1.0" xmlns="http://www.xopus.com/xmlns/config">

          <import src="config.xml"/>

          <pipeline xml="xml/doc.xml" xsd="xsd/schema.xsd">
            <view name="WYSIWYG View">
              <transform xsl="xsl/presentation.xsl"/>
            </view>
            <view name="Tree View">
              <treeTransform/>
            </view>
          </pipeline>

        </config>
      </xml>
    </div>

Elements and Attributes

Parent Elements

Element	Description
xml	The xml attribute refers the xml document to edit. The `<xml>` element is an xml island within html. The contents of the `<xml>` element must be well formed xml. So empty elements must be closed: `<empty/>` and `&`, `<` and `>` must be escaped: `&`, `<` and `>`.

A config element can also be the root of an Xopus Local Configuration file. Such a file can be imported using the import element.

Child Elements

Element	Description
import	The `<import/>` element can import settings from an external Xopus Local Configuration file. The root element of that file is a config element.
lookupConfig	The `lookupConfig` element contains lookup element. Each `lookup` element specifies an attribute and a url. The url points to an html page that can generate a list of value from which the user can pick one.
roleMapping	The `roleMapping` element contains all `attribute` and `element` elements for which a role is specified.
toolbar	The toolbar element contains specific settings for the Xopus toolbar. The toolbar element contains specific settings for the Xopus toolbar.
validation	Contains schema validation specific settings.
advanced	The <advanced/> contains the advanced options for the configuration. The contains the advanced options for the configuration.

Attributes

Attribute	Use	Description
version	Required	The version attribute specifies the version of the global configuration format. The version attribute specifies the version of the Xopus Local Configuration format used.

Attribute

Use

Description

version

Required

The version attribute specifies the version of the global configuration format.

The version attribute specifies the version of the Xopus Local Configuration format used.

Title	Description
version	The version attribute specifies the version of the global configuration format.
advanced	The <advanced/> contains the advanced options for the configuration.
miscellaneous	The `<miscellaneous/>` element contains miscellaneous settings.
spellChecker	The `spellChecker` element contains spellchecker API related settings. Xopus has a spellchecker built in. It offers the user interface for a spellchecker.
toolbar	The toolbar element contains specific settings for the Xopus toolbar.

Related Topics

Title	Description
src	The `src` attribute refers to a file on the server.
version	The version attribute specifies the version of the Xopus Local Configuration format used.
advanced	The contains the advanced options for the configuration.
import	The `<import/>` element can import settings from an external Xopus Local Configuration file. The root element of that file is a config element.
javascript	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 access to the Xopus API.
lookupConfig	The `lookupConfig` element contains lookup element. Each `lookup` element specifies an attribute and a url. The url points to an html page that can generate a list of value from which the user can pick one.
pipeline	The pipeline element defines the xml pipeline. It specifies the xml document to load and the xml schema to use for validation.
roleMapping	The `roleMapping` element contains all `attribute` and `element` elements for which a role is specified.
tableEditor	The tableEditor element contains specific settings for the table editor.
toolbar	The toolbar element contains specific settings for the Xopus toolbar.
validation	Contains schema validation specific settings.
xml	The `<xml>` element is an xml island within html. The contents of the `<xml>` element must be well formed xml. So empty elements must be closed: `<empty/>` and `&`, `<` and `>` must be escaped: `&`, `<` and `>`.
Configuration Files	Xopus has two types of configuration files:

config

Example

Elements and Attributes

Parent Elements

Child Elements

Attributes

Related Topics

Related Topics

Login