2. Contents of the installation directory
Prev | Chapter 1. Install | Next

## 2. Contents of the installation directory

### File layout when you install the `.dmg` distribution on the Mac

The `bin/` subdirectory does not exist as it is not needed. Instead, you'll find an `XMLEditor` (`XMLEditor.app`, when the file extensions are not hidden by the Finder) ``application icon''. You'll double-click on this icon to start XXE.

The`demo/`, `doc/`, `legal/` and `addon/` subdirectories are found nearby `XMLEditor.app`.

`addon/`

  The `addon/` directory is the place where XXE finds its extensions whatever their types: 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 document types: DocBook, DITA, XHTML, etc.

  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.

`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/xmltool`, `xmltool.bat`

  Scripts used to run xmltool. See The xmltool command-line utility for more information about this tool.

`bin/csscheck`, `csscheck.bat`

  Scripts allowing 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.jar` contain the code of XXE.

    `xxe_help.jar` contains the online help of XXE.

    `xsc.jar` contains the code of the spell checker engine developed by XMLmind.

  - `jh.jar` is the standard Java™ help engine.

    `xerces.jar` contains Xerces 2.9.1 XML parser. (The version included in the Java™ runtime 1.6 has bugs which have been fixed in bundled version.)

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

    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/.

    `saxon9.jar` is Michael H. Kay's XSLT 2.0 engine. See http://www.saxonica.com/.

    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.

`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.

`demo/`

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

`doc/`

  Contains XMLmind XML Editor documentation in HTML and PDF (Acrobat) formats.

`legal/`, `legal.txt`

  Contains legal information about XXE and about third-party components used in XXE.

Prev | Up | Next
1. Installing XMLmind XML Editor (XXE for short) | Home | 3. Acknowledgments