Chapter 2. Writing a configuration file for XXE

Table of Contents

1. DTD example
2. W3C XML Schema example
3. RELAX NG example

Important

If you are writing a configuration file for XXE, please do not forget to temporarily disable the Quick Start and Schema caches by unchecking the corresponding checkboxes in OptionsPreferences, Advanced|Cached Data section. More information about these caches in Section 5.11.1, “Cached data options” in XMLmind XML Editor - Online Help.

A configuration file is an XML file[2] that customizes XXE for a specific XML application. XXE is bundled with configurations for a few XML applications: DITA, DocBook, XHTML, etc. More configurations (e.g. Slides) are available but they need the user to download and install the corresponding add-on[3].

This section describes how to write a configuration for a custom DTD, for a custom W3C XML Schema and for a custom RELAX NG schema.

The configurations used as examples are minimal configurations. The following configuration items are not described in this section:

Please read Configuration elements if you need to use any of these customization items.

Some sample configurations are found in XXE_install_dir/doc/configure/samples/:

example1/

The DTD example below.

example2/

The W3C XML Schema example below.

example3/

The RELAX NG example below.

imagedemo/

Another configuration, using W3C XML schemas like example2 but much more comprehensive. This configuration has been created to explain how to cope with XML documents containing embedded binary (i.e. TIFF, PNG, etc) or XML (i.e. SVG) images. However, it is also useful as an example of an XXE configuration.

topic_plus_tag/

A configuration for a DITA topic specialization. This specialization adds a tag element to the topic DTD. A tag element has a required kind attribute. The values allowed for the kind attribute are: attribute, attvalue, element, emptytag, endtag, genentity, localname, namespace, numcharref,paramentity, pi, prefix, comment, starttag.

This configuration has been created by customizing the stock DITA topic configuration as explained in Chapter 5, Customizing an existing configuration.



[2] Conforming to W3C XML Schema configuration.xsd available after downloading and installing add-on called "XMLmind XML Editor Configuration Pack".

[3] Simply use OptionsInstall Add-ons for that.