The DITA configuration for XMLmind XML Editor aims to provide the user with a good authoring environment for creating topics, maps and bookmaps.

This configuration comes with its own copy of the DITA Open Toolkit 1.4.2.1. Therefore there is no need to separately install it if you want to convert your DITA topics and maps to HTML, PDF, etc.

After installing this configuration, its full documentation is available using the online help system of XMLmind XML Editor (that is, using menu item Help|Help). It is also available on the XMLmind XML Editor web site in HTML and PDF formats.

1. A configuration which allows to create standalone documents conforming to the MathML 2 schema (presentation markup only, content markup is not supported).

   Such standalone documents are typically used the way graphics files are. DITA example: <image href="math/Equation5.mml"/>.

   Note that this configuration adds not only a MathML menu to the GUI, but also a MathML tool just below the Edit tool, at the top/right of the main window.

2. A dummy configuration which is applied when you attempt to edit in XMLmind XML Editor documents conforming to the MathML 2 DTD

   The MathML 2 DTD is absolutely not supported by XMLmind XML Editor. This configuration is just here to catch possible errors.

3. A customization of the DocBook 5 configuration. This customization allows to edit MathML elements embedded in DocBook 5 documents (by the means of elements such as imagedata, equation, inlineequation, etc).

   This customization also adds a "Insert MathML Character by Name" item to the DocBook menu and extends the table editing commands in order to support the mml:mtable element and its descendants.

   A sample DocBook 5 document containing math is found in mathml_addon_install_dir/db5mml/sample.xml.

4. An image toolkit similar to the one based on JEuclid.

   Note that installing this add-on also requires installing the add-on called "JEuclid image toolkit plug-in". That gives us two image toolkits which allow to convert MathML to a variety of graphics formats:

   • The ``internal'' image toolkit is needed to render the contents of the MathML tool. (Yes, just the contents of the MathML tool.)
   • The JEuclid This image toolkit is used when XML documents embedding MathML or referencing MathML files are converted to formats such as HTML, PDF, RTF, etc.

After installing this add-on, its full documentation is available using the online help system of XMLmind XML Editor (that is, using menu item Help|Help). It is also available on the XMLmind XML Editor web site in HTML and PDF formats.

Compatibility with other customizations of the DocBook 5 configuration

Because this add-on customizes the stock DocBook 5 configuration bundled with XMLmind XML Editor, it is not possible to install it in conjunction with other add-ons which also customize the DocBook 5 configuration. An example of such add-on is "Customization of the DocBook 5 configuration allowing to edit <xi:include> elements by hand".

Add highly useful macro-commands and their bindings

This customization file adds to XXE the following bindings:

Add support for even more image formats

If you have Ghostscript 8+ and/or TeX and/or netpbm installed on your machine, uncomment this line (found at the end of customize.xxe):

<!--
  <include location="imagetoolkits.incl" />
-->

and you'll add to XXE support for:

• EPS, PDF graphics,
• PBM, PGM, PPM images,
• ``TeX Math''.

Open XXE_install_dir/demo/docbook-image.xml to test these newly added image toolkit plug-ins.

Two good reasons to use XMLmind XML Editor for your W3C XML Schema:

1. You are in the process of learning W3C XML Schema. XMLmind XML Editor remembers the syntax for you. You can build your schema simply by clicking on buttons and filling form fields.
2. You need to embed in your schema xs:documentation elements containing XHTML. XMLmind XML Editor makes you productive at doing that and allows you to concentrate on your documentation by displaying nicely formatted XHTML.

A sample W3C XML Schema, documented in XHTML, is found in XXE_addon_install_dir/wxs_config/sample.xsd.

XMLmind XML Editor Configuration

This configuration is needed to create .xxe files. A .xxe file is an XML file containing a configuration (e.g. Simplified DocBook support, Slides support, etc) for XMLmind XML Editor. Example: xxe_config_pack_install_dir/spreadsheet/functions.xxe.

More information in XMLmind XML Editor - Configuration and Deployment.

XMLmind XML Editor Spreadsheet Functions

This configuration is needed to create XML files containing definitions of custom spreadsheet functions. Example:xxe_config_pack_install_dir/spreadsheet/sample.xml.

More information in XMLmind XML Editor - Using the Integrated Spreadsheet Engine.

XMLmind XML Editor GUI

This configuration is needed to create .xxe_gui files. A .xxe_gui file is an XML file containing the description of a GUI for XMLmind XML Editor. Such description consists in an assembly of predefined or custom GUI parts.

More information in XMLmind XML Editor - Customizing the User Interface.

XMLmind XML Editor Add-on

This configuration is needed to create .xxe_addon files. A .xxe_addon file is an XML file containing the description of an add-on for XMLmind XML Editor. Example: xxe_config_pack_install_dir/xxe_config_pack.xxe_addon (the description of this add-on).

More information in How to package an add-on as a .zip archive.

Modifications made by XMLmind

Note that FOP 0.94 has been slightly modified by XMLmind to make it run with Saxon (integration problem when SVG instream-foreign-objects are found in the XSL-FO source).

This plug-in is not self-contained

Unlike all other plug-ins, the XEP plug-in downloaded from XMLmind is not self-contained.

You need to have access to a working RenderX XEP 4.0+ installation in order to finish the installation of the plug-in.

If you don't have a working RenderX XEP installation, you need to purchase this product from RenderX web site (http://www.renderx.com/) and install it on your computer.

The very first time you'll attempt to use this plug-in (that is, by converting an XML document to PDF or to PostScript^TM), the plug-in will display a simple dialog box asking you where you have installed the RenderX XEP product and, after that, it will ask you to restart XXE.

Note

During the above post-installation step, the plug-in copies all the files needed to its good functioning from the RenderX XEP installation directory to a newly created addon/xep_foprocessor/xep/ subdirectory.

After that, you no longer need to have access to the RenderX XEP installation directory in order to be able to convert XML documents to PDF or to PostScript^TM using the menus of XXE.

You can even build your own self-contained XEP plug-in distribution by zipping the content of directory addon/xep_foprocessor/.

Compatibility between XEP and XXE

Requires XEP 4.0+. Will not work with XEP 3.7+.

Any edition of RenderX XEP should be compatible with the plug-in: Personal, Trial, Client Stamped, Client, etc.

Installing both this plug-in and any of the Apache FOP XSL-FO processor plug-ins

Apache FOP and RenderX XEP do the same job: render XSL-FO as PDF or PostScript. When both plug-ins are installed, the RenderX XEP plug-in supersedes the Apache FOP plug-in. Therefore, it generally does not make sense to install both plug-ins.

How it works

In order to use this image toolkit plug-in, you must consider that MathML files are in fact a special kind of vector graphics files.

Therefore, referring to a MathML formula in an XML document simply means creating an image element and make it point to a MathML file. DocBook example:

<imagedata fileref="my_formula.mml"/>.

Note that, in order to be recognized, a MathML file must have a .mml or .odf extension.

A DocBook 4 sample containing MathML (.mml) and OpenDocument (.odf) formulas is found in jeuclid_imagetoolkit_install_dir/sample/MathML_Sample.xml.

Now, modern document types such as DocBook 5 may embed MathML formulas as if they were vector graphics. DocBook 5 example:

<imagedata>
  <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML">
    ...
  </mml:math>
</imagedata>

In the above case, XMLmind XML Editor also uses the services of JEuclid through this plug-in to properly render the formula on screen and, when converting the XML document to other formats (HTML, PDF, .docx, etc), to convert the formula to an image file compatible with the target format.

A DocBook 5 sample embedding MathML formulas is found in XXE_install_dir/demo/docbook5-sample.xml.

History

This plug-in, previous called "JEuclid MathML / ODF image plug-in", has been created by Max Berger who is also the maintainer of JEuclid.

As of version 3.0.1_01, the name of this plug-in becomes "JEuclid image toolkit plug-in" and its code is maintained by XMLmind.

This plug-in is released under the same license as JEuclid: Apache Software License Version 2.0.

The source code of this plug-in, as well as an ant build.xml file allowing to rebuild jeuclid_imagetoolkit.jar, are found in jeuclid_imagetoolkit_install_dir/project/.

Note that TIFF support is native on Mac and that BMP support is native when using Java^TM 1.5.

Built on the top of http.jar v0.3-3E which contains the code of Ronald Tschalär's excellent HTTP client. See http://www.innovation.ch/.

Built on the top of ftp.jar v1.5.2 which contains the code of Bruce Blackshaw's excellent FTP client. See http://www.enterprisedt.com/.