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.3. 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.
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.
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.
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:
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.
This customization file adds to XXE the following bindings:
| Keyboard shortcut | Command |
| Esc t | Swaps the character before the caret with the character after the caret. Useful if you are a bit dyslexic. |
| Esc ! | Inserts before caret the output of an external command. |
| ) , ] or } | Highlights matching (, [ or {. Beeps if matching character is not found. |
| Esc / | Collapses nearest collapsible view if it is expanded and expands nearest collapsible view if it is collapsed. |
| Esc + | Expands nearest collapsible view and then, recursively expands all its collapsible descendant views. |
| Esc - | Collapses nearest collapsible view and then, recursively collapses all its collapsible descendant views. |
| Esc 1 | Is equivalent to Esc - followed by Esc /. Very useful just after you open a large document to see its outline. |
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:
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:
A sample W3C XML Schema, documented in XHTML, is found in XXE_addon_install_dir/wxs_config/sample.xsd.
More information in XMLmind XML Editor - Configuration and Deployment.
More information in XMLmind XML Editor - Using the Integrated Spreadsheet Engine.
More information in XMLmind XML Editor - Customizing the User Interface.
More information in How to package an add-on as a .zip archive.
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:
| Parameter | Value | Description |
|---|---|---|
| renderer | pdf | ps | pcl | svg | xml | mif | txt | Specifies which renderer to use. If this pseudo-parameter is absent, which renderer to use is guessed from the extension of the output file name. |
| configuration | Absolute URL or filename | Specifies the absolute URL or filename of a FOP user configuration file. Such configuration files are useful to specify font metrics, hyphenation files, etc. |
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.
Note that FOP 0.95 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).
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 PostScriptTM), 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 PostScriptTM 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/.
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.
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.
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.pdf"> <parameter name="PS.LANGUAGE_LEVEL">2</parameter> </processFO>
The following pseudo parameters are also supported:
| Parameter | Value | Description |
|---|---|---|
| OUTPUT_FORMAT | pdf | ps | Specifies the target format of XEP. If this pseudo-parameter is absent, which target format to use is guessed from the extension of the output file name. |
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.
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>
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>
| Parameter | Applies to output format | Value | Description |
|---|---|---|---|
| pxtomm | PNG, JPEG | A positive number. | Specify the size of a px CSS unit in millimeters. Default: 0.264583. |
| dpi | PNG, JPEG | A positive number. | Number of dots (that is, pixels) per inch. Similar to pxtomm, just easier to use. Default: 96. |
| background | PNG, JPEG | Color specified using the CSS syntax. Examples: rgb(255,0,0), #FF0000, red. |
Specify the background color to use. Default: none (transparent background). |
| forceTransparentWhite | PNG, JPEG | true | false | A fully transparent pixel should be fully transparent black. However, this is rarely well supported by applications (FOP, XEP, etc) that render the converted image. That's why by default, a fully transparent pixel is fully transparent white. Setting the forceTransparentWhite parameter to false allows to remove this workaround. Default: true. |
| quality | JPEG | Number between 0 and 1. | Controls the tradeoff between file size and image quality . Default: 0.8. |
| indexed | PNG | 1 | 2| 4 | 8 | If specified, the generated image will be an indexed PNG having the specified color bit depth (1-bit=2 colors, 2-bit=4colors, etc). Default: none (generate true color PNG). |
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.
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>
| Parameter | Value | Description |
|---|---|---|
| ANTIALIAS | true | false | Anti-alias mode for rendering. Default: true. |
| ANTIALIAS_MINSIZE | Font size in points | Minimum font size for which anti-alias is turned on. Defaults to 10.0. |
| DEBUG | true | false | Debug mode. If true, elements will have borders drawn around them. |
| DISPLAY | BLOCK | INLINE | Display style. |
| FONTS_DOUBLESTRUCK | Comma separated list of font families | List of font families for double-struck. |
| FONTS_FRAKTUR | Comma separated list of font families | List of font families for fraktur. |
| FONTS_MONOSPACED | Comma separated list of font families | List of font families for monospaced. |
| FONTS_SANSSERIF | Comma separated list of font families | List of font families for sans-serif. |
| FONTS_SCRIPT | Comma separated list of font families | List of font families for script. |
| FONTS_SERIF | Comma separated list of font families | List of font families for serif. |
| MATHBACKGROUND | Color specified using the CSS syntax | transparent Examples: rgb(255,0,0), #FF0000, red. |
Default background color. |
| MATHCOLOR | Color specified using the CSS syntax. |
Default foreground color. |
| MATHSIZE | Font size in points | Font size used for the output. Defaults to 12.0. |
| MFRAC_KEEP_SCRIPTLEVEL | true | false | If true, the mfrac element will never increase children's scriptlevel (in violation of the spec); otherwise it will behave in accordance to the spec. |
| SCRIPTLEVEL | Integer | Script level. Defaults to 0. |
| SCRIPTMINSIZE | Font size in points | Font size for smallest script used. Defaults to 8.0. |
| SCRIPTSIZEMULTIPLIER | Number | Script size multiplier. Defaults to 0.71. |
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/.
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/*.tiff" to="resources" format="jpeg"> <parameter name="quality">75</parameter> </convertImage>
| Parameter | Applies to output format | Value | Description |
|---|---|---|---|
| quality | JPEG | Number between 0 and 100. | Controls the tradeoff between file size and image quality. |
| compression | PNG | none | default | fast | max | Controls the tradeoff between the file size and the speed of compression. |
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 the edtFTPj/PRO 2.1.3 (February 13, 2009) product (http://www.enterprisedt.com/), a JavaTM FTP library supporting secure FTP via FTPS (FTP over SSL) and SFTP (FTP over SSH).