This English dictionary is included in all the distributions of XMLmind XML Editor.

How to add more dictionaries?

1. Select menu item "Options|Install Add-ons".
   This displays the "Install Add-ons" dialog box.
2. Select one or more add-ons in the Dictionary category by clicking the corresponding checkboxes.
3. Click OK.
4. Restart XMLmind XML Editor.

This configuration is included by default in all the distributions of XMLmind XML Editor.

Uninstall this configuration using Options|Install Add-ons, Uninstall tab, if you don't need to author DITA 1.x documents using XMLmind XML Editor. Doing this should slightly improve the startup time and the memory footprint of the application. However be warned that, on some platforms, administrative privileges may be required to uninstall this configuration.

This configuration is included by default in all the distributions of XMLmind XML Editor.

Uninstall this configuration using Options|Install Add-ons, Uninstall tab, if you don't need to author DocBook 4.x documents using XMLmind XML Editor. Doing this should slightly improve the startup time and the memory footprint of the application. However be warned that, on some platforms, administrative privileges may be required to uninstall this configuration.

This configuration is included by default in all the distributions of XMLmind XML Editor.

Uninstall this configuration using Options|Install Add-ons, Uninstall tab, if you don't need to author DocBook 5.x documents using XMLmind XML Editor. Doing this should slightly improve the startup time and the memory footprint of the application. However be warned that, on some platforms, administrative privileges may be required to uninstall this configuration.

This add-on contains:

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. MathML support for the DocBook 5 configuration. This feature allows to edit MathML elements embedded in DocBook 5 documents (by the means of elements such as imagedata, equation, inlineequation, etc).

   This feature also adds "Insert MathML Character By Name" and "Parse Text As MathML" items 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/docbook5/sample.xml.

3. MathML support for the DITA Topic configuration.

   This feature offers the same functions as described above for the DocBook 5 configuration.

   A sample topic containing math is found in mathml_addon_install_dir/dita/sample.dita.

4. MathML support for the XHTML 5 configuration.

   This feature offers the same functions as described above for the DocBook 5 configuration.

   A sample XHTML 5 page containing math is found in mathml_addon_install_dir/xhtml5/sample.xhtml.

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

Add 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 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,
• ``TeX Math''.

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

This configuration, featuring a handy tool bar, allows to directly create or update a .zip file containing a packaged translation add-on. More information in "Translating the messages of XMLmind XML Editor" (PDF).

Note

Unlike all the other add-ons, this add-on will not work if XMLmind XML Editor is deployed as an applet or using Java^TM Web Start.

Three 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.
3. The XML Schema being edited is validated using XXE's built-in schema validator. This kind of validation is more comprehensive than the one performed by the XML Schema for XML Schemas alone (i.e. XMLSchema.xsd).

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

This configuration is included by default in all the distributions of XMLmind XML Editor.

Uninstall this configuration using Options|Install Add-ons, Uninstall tab, if you don't need to author XHTML documents using XMLmind XML Editor. Doing this should slightly improve the startup time and the memory footprint of the application. However be warned that, on some platforms, administrative privileges may be required to uninstall this configuration.

The 4 configurations contained in this add-on are:

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.

Installing both this plug-in and the RenderX XEP XSL-FO processor plug-in

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 does not make sense to install both plug-ins.

processFO parameters

Any of the options documented in Apache FOP: Configuration may be passed as a parameter to the processFO child element of a process command. More information in XMLmind XML Editor - Commands.

<processFO processor="FOP" file="__doc.fo" to="__doc.pdf">
  <parameter name="source-resolution">96</parameter>
</processFO>

The following pseudo parameters are also supported:

Configuration file

A configuration file, as documented in the Apache FOP: Configuration, may be used to parametrize FOP. The location of this configuration file may be specified in system property XXE_FOP_CONFIG. The value of XXE_FOP_CONFIG is expected to be the URL or the absolute filename of an existing file. The default location of this configuration file is XXE_user_preferences_directory/fop/fop.conf.

Note that the parameters of the processFO child element of a process command have priority over the options specified in the configuration file.

Modifications made by XMLmind

Note that FOP 1.1 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+.

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

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

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 does not make sense to install both plug-ins.

processFO parameters

Any of the options documented in the XEP User Guide may be passed as a parameter to the processFO child element of a process command. More information in XMLmind XML Editor - Commands.

<processFO processor="XEP" file="__doc.fo" to="__doc.ps">
  <!-- Workaround XEP bug: renderx #22766 -->
  <parameter name="VALIDATE">false</parameter>

  <parameter name="PS.LANGUAGE_LEVEL">2</parameter>
</processFO>

A parameter which starts with "OUTPUT_FORMAT." applies only to the specified output format. In the above example, parameter VALIDATE=false applies to all output formats and parameter PS.LANGUAGE_LEVEL=2 is ignored unless XEP is used to generate PostScript.

The following pseudo parameters are also supported:

Configuration file

A configuration file, as documented in the XEP User Guide, may be used to parametrize RenderX XEP. The location of this configuration file may be specified in system property XXE_XEP_CONFIG. The value of XXE_XEP_CONFIG is expected to be the URL or the absolute filename of an existing file. The default location of this configuration file is XXE_user_preferences_directory/xep/xep.conf.

Note that the parameters of the processFO child element of a process command have priority over the options specified in the configuration file.

Support of SVG and MathML graphics

The support of SVG and MathML graphics requires installing the following add-ons:

• Apache Batik image toolkit plug-in
• JEuclid image toolkit plug-in

processFO parameters

Any of the options documented in XMLmind XSL-FO Converter - User's Guide may be passed as a parameter to the processFO child element of a process command. More information in XMLmind XML Editor - Commands.

<processFO processor="XFC" file="__doc.fo" to="__doc.rtf">
  <parameter name="outputEncoding">Cp1252</parameter>
</processFO>

convertImage parameters

The following parameters may be used in the convertImage child element of a process command. More information in XMLmind XML Editor - Commands.

<convertImage from="raw/*.svg" to="resources" format="jpeg">
  <parameter name="quality">0.95</parameter>
</convertImage>

What is JEuclid?

JEuclid, a comprehensive, Open Source, MathML toolkit, may be used by all editions of XMLmind XML Editor to render MathML equations on screen, in the styled views, and to convert MathML files (.mml, .odf) to a number of image formats (PNG, JPEG, etc).

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 equation in an XML document simply means creating an image element and make it point to a MathML file. DocBook example:

<imagedata fileref="my_equation.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) equations is found in jeuclid_imagetoolkit_install_dir/sample/MathML_Sample.xml.

Now, modern document types such as DocBook 5 may embed MathML equations 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 when converting the XML document to other formats (HTML, PDF, .docx, etc). More precisely, it uses JEuclid to convert a MathML equation to an image file (PNG, JPEG, etc) compatible with the target output format.

convertImage parameters

The following parameters may be used in the convertImage child element of a process command. More information in XMLmind XML Editor - Commands.

<convertImage from="raw/*.mml" to="resources" format="png">
  <parameter name="MATHSIZE">14</parameter>
</convertImage>

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

Built on the top of XMLmind WebDAV Client v1.0.7, an Open Source class library allowing Java^TM 1.5+ applications to use the services of a WebDAV server. The distribution of XMLmind WebDAV Client also includes a simple command-line utility called dav. More information in http://www.xmlmind.com/davclient.shtml.

Built on the top of the edtFTPj/PRO 3.8.1 product (http://www.enterprisedt.com/), a Java^TM FTP library supporting secure FTP via FTPS (FTP over SSL) and SFTP (FTP over SSH).

Hunspell Spell Checker is an alternative to XMLmind Spell Checker, the spell checker which is included in all the distributions of XMLmind XML Editor.

If you don't find a dictionary for XMLmind Spell Checker or if your language poses problems to XMLmind Spell Checker (Hungarian, German, Turkish, etc), then you are welcome to install the "Hunspell Spell Checker" add-on. Note that if you do this, Hunspell will completely supersede XMLmind. That is, there is no way to use XMLmind for some languages and Hunspell for other languages.

On the other hand, if XMLmind Spell Checker satisfies you —and in our experience, this should be the case for at least English and French— it's strongly recommended not to install Hunspell Spell Checker, as XMLmind has many technical advantages over Hunspell.

How to add dictionaries?

Dictionaries of the English language, with Canada, Great Britain, USA and New Zealand variants, are included in this add-on.

In order to add more dictionaries:

1. Download the dictionary you want to add from one of the many sites where you'll find Hunspell dictionaries. For example, as Hunspell is the spell checker engine of OpenOffice, you'll find most dictionaries in http://extensions.services.openoffice.org/dictionary, packaged as .oxt files (OpenOffice extension; a Zip archive in fact).
2. Select menu item Options|Preferences.
3. In the Preferences dialog box, select the "Add-on|Hunspell Spell Checker" section.
4. Click Add to specify the .oxt or the .zip file you have downloaded.
5. Restart XMLmind XML Editor.

Pitfall

Do not use "Options|Install Add-ons" in order to install Dictionary add-ons. Dictionary add-ons are for use by XMLmind Spell Checker and not by Hunspell Spell Checker.

Options

Ignore mixed-case words

If this toggle is checked, do not check words containing case mixing (e.g. "SpellChecker"). Default: checked.

Ignore words with digits

If this toggle is checked, do not check words containing digits (e.g. "b2b"). Default: checked.

Ignore URL-like words

If this toggle is checked, ignore words looking like URLs or file names (e.g. "www.xxx.com" or "c:\boot.ini"). Default: checked.

Ignore duplicate words

If this toggle is checked, do not signal two successive identical words as an error. Default: not checked.

Allow file extensions

If this toggle is checked, accepts any word ending with registered file extensions (e.g. "myfile.txt", "index.html", etc). Default: checked.

Restrictions

Unlike XMLmind Spell Checker which is a 100% Java^TM software component, the "Hunspell Spell Checker" add-on leverages native libraries (e.g. hunspell.dll).

In practice, this means that this add-on only runs on Windows 32-bit and 64-bit, Mac OS X Intel^TM 32-bit and 64-bit, Linux Intel^TM 32-bit and 64-bit. In other words, you cannot use this add-on on any platform supporting Java^TM 1.6+ (e.g. Solaris, BSD).

More importantly, XMLmind does not officially support the "Hunspell Spell Checker" add-on when XMLmind XML Editor is deployed as an applet or using Java^TM Web Start.

XMLmind Spell Checker is included in all the distributions of XMLmind XML Editor.

If you don't find a dictionary for XMLmind Spell Checker or if your language poses problems to XMLmind Spell Checker (Hungarian, German, Turkish, etc), then you are welcome to install the alternative "Hunspell Spell Checker" add-on. Note that if you do this, Hunspell will completely supersede XMLmind. That is, there is no way to use XMLmind for some languages and Hunspell for other languages.

On the other hand, if XMLmind Spell Checker satisfies you —and in our experience, this should be the case for at least English and French— it's strongly recommended not to install Hunspell Spell Checker, as XMLmind has many technical advantages over Hunspell.

How to add dictionaries?

1. Select menu item "Options|Install Add-ons".
   This displays the "Install Add-ons" dialog box.
2. Select one or more add-ons in the Dictionary category by clicking the corresponding checkboxes.
3. Click OK.
4. Restart XMLmind XML Editor.

Options

Ignore case

If this toggle is checked, ignore capitalization errors. Default: not checked.

Ignore mixed-case words

If this toggle is checked, do not check words containing case mixing (e.g. "SpellChecker"). Default: checked.

Ignore words with digits

If this toggle is checked, do not check words containing digits (e.g. "b2b"). Default: checked.

Ignore URL-like words

If this toggle is checked, ignore words looking like URLs or file names (e.g. "www.xxx.com" or "c:\boot.ini"). Default: checked.

Ignore duplicate words

If this toggle is checked, do not signal two successive identical words as an error. Default: not checked.

Check punctuation

If this toggle is checked, punctuation checking is enabled: misplaced white space and wrong sequences, like a dot following a comma, are detected. Default: not checked.

Allow compounds words

If this toggle is checked, all words formed by concatenating two legal words with an hyphen are accepted. If the language allows it, two words concatenated without hyphen are also accepted. Default: checked.

Allow general prefixes

If this toggle is checked, a word formed by concatenating a registered prefix and a legal word is accepted. For example, if "mini-" is a registered prefix, accepts "mini-computer". Default: checked.

Allow file extensions

If this toggle is checked, accepts any word ending with registered file extensions (e.g. "myfile.txt", "index.html", etc). Default: checked.

Favor quality over speed

For use on a fast computer. Does not influence the number of suggestions (always limited to 15). Default: not checked.