http://www.xmlmind.com/xmleditor Contents XMLmind XML Editor
User's Guide
V3.0 Tutorial: basics Being productive with XXE

1 Install

1.1 Installing XXE

1.1.1 Requirements

XXE is officially supported on Windows NT/2000/XP, on Linux 2.4 and on Mac OS X 10.3/10.4. It is possible to use it on other Java[tm] 1.4.1+ platforms (e.g. Solaris), but without support from XMLmind.

XXE has been tested with:

1.1.2 Install on Unix

Procedure:

  1. Make sure that the Java[tm] bin/ directory is referenced in the $PATH and, at the same time, check that the Java[tm] runtime in the $PATH has the right version:
    $ java -version
    java version "1.5.0_04"
    Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_04-b05)
    Java HotSpot(TM) Client VM (build 1.5.0_04-b05, mixed mode, sharing)
  2. Unpack the XXE distribution somewhere.
    $ cd 
    $ tar zxvf xxe-std-30.tar.gz
    $ ls xxe-std-30
    addon/
    bin/
    demo/
    doc/
  3. XXE is intended to be used directly from the xxe-std-30/ directory. That is, you can add xxe-std-30/bin/ to your $PATH.
    $ xxe-std-30/bin/xxe &

1.1.3 Manual install on Windows

Manual install on Windows is similar to the install on Unix. XXE must be started using xxe-std-30\bin\xxe.bat rather than the xxe-std-30/bin/xxe shell script.

1.2 Content of the installation directory

bin/
Contains XXE code (.jar files) and many scripts used to start XXE and its associated utilities.
bin/xxe, xxe.bat
Scripts used to start XXE. Use xxe on any Unix system. Use xxe.bat on Windows.
bin/xxe.exe, xxe.jstart
Only when installing XXE on Windows using any of the *setup*.exe distributions. Xxe.exe is XXE launcher and xxe.jstart is its (plain text, UTF-8 encoded) associated parameter file.
bin/deploywebstart, deploywebstart.bat
Scripts used to generate a Java[tm] Web Start configuration (.jnlp file, signed jars, etc) from a possibly customized XXE distribution. Use deploywebstart on any Unix system. Use deploywebstart.bat on Windows.

The deploywebstart command-line tool is documented in the XMLmind XML Editor - Configuration and Deployment.

bin/xsdvalid, dtdvalid, dtdtoxsd, xsdvalid.bat, dtdvalid.bat, dtdtoxsd.bat
Scripts used to run xsdvalid, dtdvalid and dtdtoxsd. See XMLmind Xsdvalid Toolset User's Guide for more information about these tools.
bin/rngvalid, rngvalid.bat
Scripts used to run Jing, James Clark's RELAX NG validator.
bin/rngdoc, rngdoc.bat
Scripts used to generate a simple reference manual from a RELAX NG schema.

The generated reference manual is intended to help content authors create instances conforming to a given schema. This manual is not intended to help schema authors document their design.

bin/csscheck, csscheck.bat
Scripts used to check the syntax of CSS style sheets written for XXE.
bin/convertdoc, convertdoc.bat
Scripts used to run convertdoc. This tool allows to execute XXE process commands from the command line, exactly as if these process commands were executed from XXE.

See XMLmind XML Editor - Commands for more information about this tool.

bin/*.jar
All the (non-system) Java[tm] class libraries needed to run XXE:
bin/icons/
Contains desktop icons for XXE.
bin/mac/
Contains files (e.g. Info.plist) used on the Mac to create XMLEditor.app from a .zip or a .tar.gz distribution.
addon/
The addon/ directory is the place where XXE finds its extensions, whatever is the type of this extension: configurations, plug-ins, translations to languages other than English, spell-checker dictionaries.

This addon/ directory is recursively scanned by XXE at startup time. Therefore, feel free to organize it as you want.

addon/config/
Contains configuration files for the following XML applications: DocBook, Simplified DocBook, Slides, XHTML, XXE Configuration, W3C XML Schema.

The content of a configuration file, which specifies a customization of XXE for a specific XML application, is described in detail in XMLmind XML Editor - Configuration and Deployment.

addon/spell/
Contains the dictionaries used by the spell-checker. A dictionary is a file whose name is LL.dar, where LL is an ISO code for a language.
addon/translate/
Each .jar file found in this directory contains XXE messages translated to a language other than English. Fr.jar contains French messages, de.jar contains German messages, etc.
doc/
Contains XMLmind XML Editor documentation in HTML and PDF (Acrobat) formats.

Note that:

doc/user/
Contains this user's guide in HTML and PDF (Acrobat) formats.

The DocBook (userguide.xml) and XHTML (userguide.xhtml) versions are provided too because it may be useful to open them in XXE in order to evaluate the editor.

demo/
Contains XML documents that can be opened in XXE to demo some of its features.

1.3 Acknowledgments

On Windows, XMLmind XML Editor installer (i.e. *setup*.exe) is built using Inno Setup by Jordan Russell's software. XMLmind highly recommends this excellent and free-to-use tool.