Chapter 1. Install

Table of Contents

1. Installing XXE
1.1. Requirements
1.2. Install on Linux (or manual install on the Mac)
1.3. Manual install on Windows
2. Content of the installation directory
3. Acknowledgments

1. Installing XXE

1.1. Requirements

  • Sun or Apple Java™ runtime 1.4.1 or above.

  • At least 256Mb of memory and a 600MHz CPU (1GHz CPU if options such as text anti-aliasing or on-the-fly spell checking are turned on).

  • 60Mb of free disk space, 120Mb for a self-contained distribution which includes a Java™ 1.5 runtime.

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

XXE has been tested with:

  • Sun Java runtime 1.4.1+ (up to 1.6.0_01) under Windows 2000, XP, Vista, openSUSE Linux 9.0, 9.3, 10.2.

  • Mac OS X 10.4.9 (Tiger) and Java™ 1.5.0_07.

  • Apache HTTP server 2.0.44 + mod_dav with mod_dav_fs and mod_dav_svn (Subversion) backends.

  • Apache Tomcat WebDAV servlet.

  • Various Unix FTP servers.

  • Windows 2003 IIS HTTP server + its WebDAV extension.

  • Windows 2003 FTP server.

1.2. Install on Linux (or manual install on the Mac)

Tip

On the Mac, it is strongly recommended to download and install the auto-installable .dmg file.

  1. Make sure that the Javabin/ directory is referenced in the $PATH and, at the same time, check that the Java™ runtime in the $PATH has the right version:

    $ java -version
    java version "1.6.0"
    Java(TM) SE Runtime Environment (build 1.6.0-b105)
    Java HotSpot(TM) Client VM (build 1.6.0-b105, mixed mode, sharing)
    
  2. Unpack the XXE distribution inside any directory you want:

    $ cd 
    $ tar zxvf xxe-perso-3_6_1.tar.gz
    $ ls xxe-perso-3_6_1
    addon/
    bin/
    demo/
    doc/
  3. XXE is intended to be used directly from the xxe-perso-3_6_1/ directory. That is, you can start XXE by simply executing:

    $ xxe-perso-3_6_1/bin/xxe &

    After that, you may want to add xxe-perso-3_6_1/bin/ to your $PATH.

1.3. Manual install on Windows

Tip

On Windows, it is strongly recommended to download and install one of the two auto-installable setup.exe files.

  1. Make sure that you have a Java™ 1.4.1+ runtime installed on your machine. To check this, open a command window and type "java -version" followed by Enter. You should get something looking like this:

    C:\> 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. Use a tool like WinZip, 7-Zip or Info-Zip [2] to unzip the XXE distribution inside any directory you want:

    C:\> mkdir XMLmind
    C:\> cd XMLmind
    C:\XMLmind> unzip xxe-perso-3_6_1.zip
    C:\XMLmind> dir xxe-perso-3_6_1
    ... <DIR> addon
    ... <DIR> bin
    ... <DIR> demo
    ... <DIR> doc
  3. XXE is intended to be used directly from the xxe-perso-3_6_1/ directory. That is, you can start XXE by simply executing:

    C:\XMLmind> xxe-perso-3_6_1\bin\xxe.exe

    After that, you may want to add a shortcut to "C:\XMLmind\xxe-perso-3_6_1\bin\xxe.exe" on your desktop.

    Note that the bin directory contains, not only xxe.exe, but also a equivalent xxe.bat which may be handy if you intend to customize the way XXE is started.

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. File 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™ 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 Section 3.1, “The deploywebstart command-line tool” in XMLmind XML Editor - Configuration and Deployment.

bin/xsdvalid, dtdvalid, rngvalid, schvalid, xsdvalid.bat, dtdvalid.bat, rngvalid.bat, schvalid.bat

Scripts used to run xsdvalid, dtdvalid, rngvalid and schvalid. See XMLmind Validation Toolset User's Guide for more information about these tools.

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 Section 3, “The convertdoc command line tool” in XMLmind XML Editor - Commands for more information about this tool.

bin/*.jar

All the (non-system) Java™ class libraries needed to run XXE:

  • xxe_app.jar and xxe.jar contain the code of XXE.

    xxe_help.jar contains the online help of XXE.

    xsc.jar is XMLmind Spell-Checker product, the best buy for spell-checker written entirely in the Java™ language. For more information, please visit http://www.xmlmind.com/spellchecker/.

  • jh.jar is the standard Java™ help engine.

    resolver.jar contains Apache XML Commons Resolver which implements catalog-based entity and URI resolution.

    xp.jar is James Clark's XML parser. See http://www.jclark.com/.

    Substantial parts of xsdregex.jar, James Clark's XSD to Java Regular Expression Translator, have been directly added to xxe.jar (which is why file xsdregex.jar is not included in the distribution). Download original package from http://www.thaiopensource.com/download/.

    Package com.jclark.xsl.expr contains the implementation of XPath 1.0 used by XT, James Clark's XSLT engine. A modified version of this package, renamed com.xmlmind.xmledit.xpath, has been directly added to xxe.jar (which is why file xt.jar is not included in the distribution). Download full XT from http://www.jclark.com/xml/xt-old.html or from http://www.blnz.com/xt/index.html.

    relaxng.jar is Jing version 20030619, James Clark's RELAX NG validator, slightly modified for use in XXE. The details of the modifications are found in relaxng.README.

    saxon.jar is Michael H. Kay's XSLT 1 engine. See http://saxon.sourceforge.net/.

    These excellent packages have not been developed by XMLmind. Copyright information is contained in the corresponding .LICENSE file. Read the corresponding .README file to have more details about these packages.

    In general, theses packages are not the most widely used/most well-known tools of their category. But we have also tested the most widely used/most well-known tools of their category and have found the packages listed above to be smaller, faster and more reliable than the big names. Many, many thanks to the authors of these packages.

bin/legal/, legal.txt

Contains legal information about XXE and about third-party components used in 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 a few XML applications: DocBook, XHTML, W3C XML Schema, etc.

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

addon/spell/

Contains the bundled 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.

The distribution of XXE only contains an English dictionary (with CA, GB, US variants). Additional dictionaries, German, French, Spanish, can be downloaded and installed using Options|Install Add-ons.

Moreover, you can add user-contributed dictionaries to the list of available add-ons by dragging and dropping this URL http://www.xmlmind.net/spellchecker/_download/list.xxe_addon to the list displayed by the Preferences dialog box (Options|Preferences, Install add-ons section).

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 source of the User's Guide is also available in DocBook format (userguide.xml) in case you want to open it in XXE.

demo/

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

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.



[1] Note that XXE is no longer officially supported on Windows NT 4 and on Mac OS X 10.3 (Panther).

[2] Note that Windows XP has built-in support for .zip archives.