http://www.xmlmind.com/xmleditor Contents Features Tutorial APPENDIX D: Enhancements and bug fixes

3 Install

3.1 Installing XXE

3.1.1 Requirements

Note that some Java runtimes may be very slow and/or have very severe bugs. So if you experiment extreme slowness or weird behaviors (especially those related to the GUI) with XXE, do not hesitate to upgrade your Java runtime.

XXE has been tested with:

3.1.2 Install on Unix

Procedure:

  1. Unpack the XXE distribution somewhere.
    $ cd 
    $ gzip -d -c xxe-m13p2-bin.tgz | tar xvf -
    $ ls xxe-m13p2-bin
    aptparser.jar
    css/
    dict/
    docs/
    dtd/
    azcheck.jar
    jaxp.jar
    regexp.jar
    sax2.jar
    xp.jar
    template/
    xxe
    xxe.bat
    xxe.jar
    ...
  2. XXE can be directly used from the xxe-m13p2-bin/ directory.

    If for some reasons, you do not want to use XXE from its distribution directory, copy the xxe shell script, *.jar and the dict/ subdirectory to a directory referenced in your path (example /usr/local/bin).

    $ su
    $ cp ~/xxe-m13p2-bin/xxe /usr/local/bin
    $ cp ~/xxe-m13p2-bin/*.jar /usr/local/bin
    $ cp -r ~/xxe-m13p2-bin/dict /usr/local/bin
    $ chmod a+rx /usr/local/bin/xxe
    $ chmod a+r /usr/local/bin/*.jar
    $ chmod a+rwx /usr/local/bin/dict
    $ chmod a+r /usr/local/bin/dict/*

3.1.3 Manual install on Windows

Manual install on Windows NT is similar to the install on Unix but under Windows you'll have to copy xxe.bat rather than the xxe shell script.

You'll also have to manually edit this .bat file and modify the line:

set dist=D:\src\xmledit\distrib

by replacing D:\src\xmledit\distrib by the name of the actual directory containing the xxe.bat and all the .jar files.

3.2 Content of the distrib/ directory

docs/
Contains this user 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 load them into XXE in order to evaluate the editor.

dict/
Contains the dictionaries used by the spell-checker. A dictionary is a Jar file whose name is LL.jar, where LL is an ISO code for a language.

Dictionaries downloaded from the XMLmind Web site must be copied to this subdirectory.

dtd/
Contains 3 DTDs (Document Type Definition):
css/
Contains 2 CSS style sheets:
template/
Contains 4 document templates:
xxe, xxe.bat
Scripts used to start XXE. (Use xxe on any Unix system. Use xxe.bat on Windows NT.)
*.jar
All the (non-system) Java class libraries needed to run XXE:

3.3 Deploying XXE

3.3.1 Creating new document templates

A document template is simply an almost empty document containing:

<?xml version='1.0' encoding='UTF-8'?>
<?xml-stylesheet type="text/css" href="../css/xhtml.css"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"../dtd/xhtml/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head><title></title></head>
  <body><p></p></body>
</html>
  1. The XML declaration (line 1).
  2. The xml-stylesheet Processing Instruction (PI) used to associate a style sheet to an XML document. (line 2).

    This PI is specified in the W3C recommendation: Associating Style Sheets with XML documents (http://www.w3.org/TR/xml-stylesheet/).

    Using several of these PIs, it is possible to associate alternate style sheets to an XML document, each one having its own descriptive title. Example:

    <?xml-stylesheet href="bigfonts.css" type="text/css" alternate="yes" 
    title="Big fonts" ?>
    <?xml-stylesheet href="colorful.css" type="text/css" alternate="yes" 
    title="Important things in red" ?>
    <?xml-stylesheet href="normal.css" type="text/css" ?>
  3. The document type declaration (lines 3-4, note that the root element is specified to be html).
  4. The skeleton of the root element specified in the document type declaration (line 5 to end).

    This skeleton must contain a valid content.

Such template must be created using a text editor. After creating it, validate its content by loading it in XXE as an existing document (i.e. using the File->Open menu command).