1. Structure of a configuration file customizing an existing configuration
Prev | Chapter 5. Customizing an existing configuration | Next

## 1. Structure of a configuration file customizing an existing configuration

### Important

If you create a configuration file with a text editor, do not forget to check its validity before deploying it because, for performance reasons, XXE does not thoroughly validates its configuration files at start-up time. The simplest way to do that is to open the configuration file in XXE.

Excerpt of the sample customization, `mydocbook.xxe`, of the stock DocBook configuration:

    <?xml version='1.0' encoding='ISO-8859-1'?>
    <configuration name="DocBook"
      xmlns="http://www.xmlmind.com/xmleditor/schema/configuration"
      xmlns:cfg="http://www.xmlmind.com/xmleditor/schema/configuration">

      <include location="xxe-config:docbook/docbook.xxe"/>

          .
        customization items
          .
          .

    </configuration>

- The configuration file must have a "`.xxe`" extension.

- The `configuration` element must have a `name` attribute and the value of this `name` attribute must be the same as the value of the `name` attribute of the overridden configuration.

- The customized configuration must include the overridden configuration using configuration element include.

- If you need to refer to a file found in ``XXE_install_dir`/addon/config/`, it is recommended to use a relative URI which begins with string "`xxe-config:`".

  ### Note

  The following rule has been added to the XML catalog bundled with XXE, ``XXE_install_dir`/addon/config/catalog.xml`:

      <rewriteURI uriStartString="xxe-config:" rewritePrefix="." />

  This means that any URI which starts with string "`xxe-config:`" is understood as being relative to ``XXE_install_dir`/addon/config/`.

Prev | Up | Next
Chapter 5. Customizing an existing configuration | Home | 2. Customization items