Chapter 1 of the IREn User Guide
Preface
1.1. What's in this Document?
The RenderX User Guide provides background information about what IREn does and explains how to use the product. The manual is divided into the following sections:
- Overview
- IREn Assistant
- Using the Command Line
- Configuring IREn
- IREn AFP Generator
- IREn SVG Generator
- IREn XPS Generator
- IREn XHTML (XForms) Generator
- IREn PPML Generator
1.2. Prerequisites
Operating systems
IREn runs on most systems where Java Virtual Machine 1.8 or newer is available. This includes:
-
Unixes;
-
Microsoft Windows;
-
Linux;
-
Mac OS X;
-
Other platforms and Operation Systems.
Java Runtime
IREn requires a Java Runtime (JRE) version 1.8 or later.
The latest version to support JRE 1.4 was IREn 4.28.
IREn demonstrates best performance running under the newest JRE available to the date. JRE is not shipped within IREn distributions.
AFP Backend requires charsets.jar module to be installed with JRE. By default, JRE is installed without this module. In order to add the module during the JRE installation, run JRE installer and check the "additional languages support" checkbox.
Note: Actual checkbox name may vary for different versions and localizations of JRE.
Third Party Software
In order to run, IREn requires an XSLT processor. Technically, any XSLT processor is suitable, provided that it supports JAXP (https://docs.oracle.com/javase/8/docs/technotes/guides/xml/jaxp/index.html), e.g. it implements javax.xml.parsers.SAXParserFactory and javax.xml.transform.TransformerFactory.
IREn is optimized for and most thoroughly tested with the SAXON XSLT Processor by Michael Kay (http://saxon.sourceforge.net).
IREn distribution includes Saxon version 6.5.5.
Apache Crimson, XSLT processor (https://xml.apache.org/crimson/), crimson.jar, is used internally for performance considerations.
Optional. Apache XML Entity and Catalog Resolver, (https://xerces.apache.org/xml-commons/components/resolver/), resolver.jar, can be used for XML Entity and XML Catalog. See Section 5.3 and Section J.2 for further details.
For barcode generation IREn uses ZXing ("Zebra Crossing") barcode scanning library. The library is distributed with IREn. It is available from Github under the terms of Apache License. To enable barcode generation functionality, the IREn ClassPath must include a reference to the library (e.g. ZXing-core-3.3.2.jar)
Charts downloads and installs Node.js framework and the files related to specific Chart generation library defined in documents being processed.
Supplementary Software
In order to view PDF output, a viewer is required. Adobe provides a free Adobe Acrobat Reader which can be downloaded and installed from the Adobe website.
To view PostScript files, one option is to use GhostView, which may be used for viewing PDF as well. Versions are available for most operating systems.
1.3. Licensing
IREn requires a license to run. There are two types of licenses: Full and Trial. License is stored in a file, typically license.xml residing in IREn installation directory. The corresponding variable in IREn configuration file points to the location of the license file. See Section 5.1.1 for more details.
IREn license has modular structure. Some features are controlled by a special key and therefore require such key in license.xml license file in order to work.
Note: Since the Trial license automatically generated on RenderX site contains no special keys, the corresponding features will be disabled by default. If you are evaluating IREn and need the Trial version to process documents that require these features, please contact RenderX Sales department.
Features that require a special key in license file
1.4. Acronyms
The following table lists acronyms used in this manual:
Table 1.1. Acronyms
| Acronym | Full Term |
|---|---|
| CJK | Chinese Japanese Korean (Unicode UTF-8 encoding standard for Asian character set) |
| CMYK | Cyan-Magenta-Yellow-Key/blacK (4-color ink model used for printing) |
| DTD | Document Type Definition |
| IPA | Internet Protocol Address |
| PODi | The Digital Printing Initiative |
| PPML | Personalized Print Markup Language |
| SMIL | Synchronized Multimedia Integration Language |
| SVG | Scalable Vector Graphics |
| SWF | Small Web Format. Flash Format File (Adobe Systems Incorporated) |
| XPS | XML Paper Specification |
| XHTML | Extensible HyperText Markup Language |
| URL | Uniform Resource Locater (world wide web address) |
| W3C | World Wide Web Consortium |
| XML | eXtensible Markup Language |
| XSL | eXtensible Stylesheet Language |
| XSL-FO | eXtensible Stylesheet Language Formatting Objects |
| JRE | Java Runtime Environment |
| JDK | Java Development Kit |
1.5. Technical Support
You can contact RenderX technical support by:
-
Using the RenderX support portal at the RenderX support pages
-
Sending an email to support@renderx.com
-
Calling 1 (650) 328-8000