The RenderX User Guide provides background information about what XEP does and explains how to use the product. The manual is divided into the following sections:

XEP runs on most systems where Java Virtual Machine 1.1.8 or newer is available. This includes:

XEP requires a Java Runtime (JRE) version 1.8 or later.

The latest version to support JRE 1.4 was XEP 4.28.

XEP 4.30.1086 demonstrates best performance running under the newest JRE available to the date. JRE is not shipped within XEP distributions.

AFP Backend requires charsets.jar to be installed with JRE. By default, JRE is installed without charsets.jar file. Please run JRE installer and check the "additional languages support" checkbox.

The Barcode library requires ZXing ("Zebra Crossing") barcode scanning library for Java version 3.3.2 or later. The library is NOT distributed with XEP. It is available from Github under the terms of Apache License. Its binaries are downloadable, too. In order to make it work, put ZXing-core-3.3.2.jar in the ClassPath.

In order to view PDF output, a viewer is required. Adobe provides a free one 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.

The following table lists acronyms used in this manual:

You can contact RenderX technical support by:

XEP is a library of Java classes that converts XML data to printable formats, such as PDF, PostScript, AFP, PPML. It can also produce SVG, XPS and XHTML files. XEP accepts either an XSL-FO file, or an XML file paired with an XSL stylesheet, as input. The XSL stylesheet can be specified via -xsl command line parameter or via xml-stylesheet processing instruction. In the case of XML with XSL input, XEP uses an internal XSLT transformer to preprocess the XML file according to the XSL stylesheet, thereby converting it to an XSL-FO file. The XEP engine then processes the XSL-FO file.

The logical flow of document processing can be divided into three phases, as illustrated in the following figure:

Figure 2.1. Three-step process

XEP can be run in three different environments:

Figure 2.2. XEP

XEP can be configured to allow users to apply settings, such as fonts, languages and formatting options, according to their preferences. For a detailed reference please refer to Chapter 5.

This section provides an introduction to the basic terms that are used throughout this documentation.

XEP contains a user-friendly GUI tool, called XEP Assistant. Use of XEP Assistant simplifies rendering from XML or XSL-FO into the desired output format.

To open XEP Assistant, browse to the XEP Installation directory and launch x4u.bat or x4u bash script.

XEP can be run from the command line, as follows:

To learn more about the xep.bat batch file or the xep bash script, open the file in a text editor. These files use standard scripting features available in the operating system.

The syntax of the Java command is:

java com.renderx.xep.XSLDriver {options} {switches} {arguments}

The above syntax has been simplified by assuming that the directory containing the Java executable is specified in your PATH environment variable, and that the full path of the xep.jar file is in your CLASSPATH environment variable. If you specify an XSL file to convert an XML source document into XSL-FO, then it is assumed that saxon.jar or xt.jar are also specified in your CLASSPATH environment variable.

The syntax of the Windows batch and Linux/MAC shell command is:

xep {options} {switches} {arguments}

The above syntax assumes that the full path to the Windows batch file xep.bat or the Linux/MAC shell script xep is specified in the PATH environment variable, or that the current directory is the directory containing the Windows batch file or Linux/MAC shell script.

The options, switches, and arguments are the same whether XEP is run via Java, via a Windows batch file, or via a Linux/MAC shell script.

The XEP options are used to configure and customize the behavior of the XEP rendering engine.

XEP requires a configuration file in order to run. By default, the formatter looks for a file named xep.xml in the current directory. If a different configuration file is used, the path to the configuration file must be specified on the command line.

XEP is a flexible tool in which the configuration can be customized according to your preferences. There are several methods to customize XEP. These methods are summarized in the following table:

The XEP switches configure the behavior of the command line utility.

The XEP arguments instruct XEP how to process a file. For example, arguments may specify the input file, the target format to render to, and the output filename. When multiple arguments are specified, they must be specified in the following order:

( [-xml] <infile> [-xsl <stylesheet>] {-param <name=value>}
         | -fo <infile>
         | -xep <infile> )
[-format]
[[-<output format>] <outfile>]

The XEP arguments are described in the following table.

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="<stylesheet>"?>
...
                

This section presents a number of examples of how to run XEP from the command line.

This section describes how to configure XEP according to your preferences by using XEP Assistant.

5.1.1. Configuring Main Settings

The default configuration settings can be set in the Main tab.

Figure 5.1. XEP Configuration Main tab

Table 5.1. XEP Configuration Main Tab Parameters

Parameter	Possible Values	Description
Base Path	free text	The location of the configuration file (XEP.xml). The Base path is used to resolve relative URLs where parameters accept URLs as values. Click Change to select the location of the configuration file.
Default Language	all supported languages, unspecified. Default: English (US)	Select the language to use when no language is specified.
Default font family	all supported font families, unspecified.	Select the font family to use when no font family is specified.
License	free text	The location of the XEP license file. Click Browse to select the location of the license file.
Use temp folder	checked, unchecked Default: unchecked	Check to enable writing temporary files to disk. Once checked, click Browse to set the path to the directory where the temporary files are written.

5.1.2. Configuring Backends

Using Backends, you can control certain properties in the output documents. There are different available properties for each output type. Select the output type and then configure the properties for the specific output type selected. Refer to the appropriate figure and table for more information on each output type.

To select the output type:

1. On the Backends tab, click Select backend.

2. Select PDF, PostScript, AFP, SVG, HTML or PPML.

   The Backend Parameters screen populates with parameters based on the selected backend.

For	See
PDF	the section called “Configuring the Backend for PDF Files”
PostScript	the section called “Configuring the Backend for PostScript Files”
AFP	the section called “Configuring the Backend for AFP Files”
SVG	the section called “Configuring the Backend for SVG Files”
XHTML	the section called “Configuring the Backend for XHTML Files”
PPML	the section called “Configuring the Backend for PPML Files”

Configuring the Backend for PDF Files

Figure 5.2. XEP Configuration Backend's tab for PDF files

Table 5.2. XEP Configuration Backends Tab PDF Parameters

Parameter	Possible Values	Description
Select backend	PDF, PostScript, AFP, SVG, HTML, PPML Default: PDF	Select the output type for which you are configuring the backend.
Backend Parameters
Drop unused destination	checked, unchecked Default: checked	Specify whether named destinations are created for objects not referenced within the document.
UNICODE annotations	checked, unchecked Default: checked	Enable or disable use of Unicode to represent PDF annotations strings, such as bookmark text and document info.
Set initial view mode	auto - If there are bookmarks in the document, the bookmark pane is displayed. Otherwise, all auxiliary panes are hidden. show-none - All auxiliary panes are hidden. show-bookmarks - The bookmarks pane is displayed. show-thumbnails - The thumbnails pane is displayed. full-screen - The document is displayed in full-screen mode. Default: auto	Set the view mode to be activated in the PDF viewer when the PDF file is rendered and viewed.
Set initial zoom value	auto - Page scaling is not specified. fit - The page is scaled to fit completely into the view port. fit-width - The page is scaled so that its width matches the width of the view port. fit-height - The page is scaled so that its height matches the height of the view port. number-or-percentage - The page is scaled by the number or percentage specified in the enabled box. Default: auto	Specify the magnification factor to be applied when the file is first opened in the PDF viewer.
Set owner password	checked, unchecked Default: unchecked If the check box is checked, then the text box is enabled so that you can type in a password.	Select this option to set an owner password for the PDF document. Owner passwords give the owner full control over the PDF document.
Set user password	checked, unchecked Default: unchecked If the check box is checked, then the text box is enabled so that you can type in a password.	Select this option to set a user password for the PDF document. Holders of user passwords are subject to access restrictions specified in User Privileges.
User Privileges	annotate - Enables adding annotations to the document and changing form field values. copy - Enables copying text and images from the document onto the clipboard. modify - Enables editing the document. Print - Enables printing the document. Default: annotate	Select the privilege for users accessing the resulting document with user password.
Use PDF compression	checked, unchecked Default: checked	Check to compress content streams in PDF using Flate algorithm.
Use PDF linearization	checked, unchecked Default: unchecked	Check to linearize (or optimize for the Web) the PDF output.

Configuring the Backend for PostScript Files

Figure 5.3. XEP Configuration Backends tab for PostScript files

Table 5.3. XEP Configuration Backend Tab for Configuring PostScript Parameters

Parameter	Possible Values	Description
Select backend	PDF, PostScript, AFP, SVG, HTML, PPML Default: PDF	Select the output type for which you are configuring the backend.
Backend Parameters
Drop unused destination	checked, unchecked Default: checked	Specify whether named destinations are created for objects not referenced within the document. This information is utilized when the file is further converted to PDF.
UNICODE annotations	checked, unchecked Default: checked	Enable or disable use of Unicode to represent PDF annotations strings, such as bookmark text, and document info. This information is utilized when the file is further converted to PDF.
Set initial view mode	auto - If there are bookmarks in the document, the bookmarks pane is displayed. Otherwise, all auxiliary panes are hidden. show-none - All auxiliary panes are hidden. show-bookmarks - The bookmarks pane is displayed. show-thumbnails - The thumbnails pane is displayed. full-screen - The document is displayed in full-screen mode. Default: auto	The PDF document may contain definition of default view mode which is activated by the PDF viewer upon rendering and viewing the file. This option allows specifying this mode. This information is utilized when the file is further converted to PDF.
Set initial zoom value	auto - Page scaling is not specified. fit - The page is scaled to fit completely into the view port. fit-width - The page is scaled so that its width matches the width of the view port. fit-height - The page is scaled so that its height matches the height of the view port. number-or-percentage - The page is scaled by the number or percentage specified in the enabled box. Default: auto	Specify the magnification factor to be activated when the file is first opened in the PDF viewer. This information is utilized when the file is further converted in PDF.
Select PS Level	2,3 Default: 3	Select the target PostScript language level. Note: If the language level is set to 2, some advanced features and improved font definitions are not available.
Clone EPS images	checked - EPS graphics are pasted into the output stream at each occurrence. This may lead to a substantial growth of the resulting file size. unchecked - EPS graphics are posted into the PostScript form. This minimizes the file size, however, some EPS images cannot be processed this way and it may corrupt the PostScript code. Default:checked	Specify whether EPS graphics are included in the PostScript output using the forms mechanism, or by pasting their contents at each occurrence.

Configuring the Backend for AFP Files

Figure 5.4. XEP Configuration Backends tab for AFP files

Table 5.4. XEP Configuration Backends Tab AFP Parameters

Parameter	Possible Values	Description
Select backend	PDF, PostScript, AFP, SVG, HTML, PPML Default: PDF	Select the output type for which you are configuring the backend.
Backend Parameters
Log Level	0,1,2 Default: 0 (Nothing)	Select a number to determine the level of log detail. 0 - Nothing 1 - Warnings only 2 - Warnings and information messages
Resolution	positive integer Default: 1440	Defines which document resolution will be output within the document. It must be positive integer value supported by target AFP device
Convert images to gray	checked, unchecked Default: unchecked	If checked, turns on embedding of raster images as grayscale images, 8 bit per pixel, uncompressed. Unchecked - embed raster images in their original format
Use shading patterns	checked, unchecked Default: checked	Specifies whether grayscale-filled areas should be filled with bi-level pattern. Percentage rate of black points will be closest match to required grayscale value. Checked - shading patterns will be used Unchecked - shading patterns will not be used
Use replicate and trim	checked, unchecked Default: unchecked	property specifies whether the "replicate-and-trim" feature will be used for shading patterns. Checked - "replicate-and-trim" is used Unchecked - "replicate-and-trim" is not used
Shading pattern resolution	floating point number Default: 1.0	Defines zoom factor for shading pattern raster.
Try using TIFF compression	checked, unchecked Default: checked	This option allows the user to specify whether AFP backend attempts to compress shading patterns raster images with TIFF encoding. Checked - AFP Backend attempts compressing shading pattern rasters Unchecked - AFP Backend does not attempt compressing shading pattern rasters
Use BC:OCA	checked, unchecked Default: checked	Defines the upper level of BC:OCA commands subset. Unchecked - Do not use BC:OCA commands Checked - Use Level 1 only
Use G:OCA	checked, unchecked Default: checked	Defines the upper level of G:OCA commands subset. Unchecked - Do not use G:OCA commands Checked - Use Level 1 only

Please refer to Section 6.8 of this document for details.

AFP Fonts

To view and edit an AFP font and its sub values:

1. Click the AFPFonts drop down box (see Figure 5.4).

2. Select the font you wish to view/edit.

   Note:

   AFP font names are comprised of the word <AFPFont> followed by a comma and the XEP font name, such as <AFPFont, Verdana>.

   All sub values are populated based on the font selected.

3. View or edit all AFP font sub values.

To add an AFP font:

1. Click AddAFPFont (see Figure 5.4).

   A dialog box opens containing a list of all supported fonts as displayed in the following figure:

   Figure 5.5. Add Font

   
   
   

2. Select the font you wish to add to the AFP fonts.

3. Click OK to add the font or Cancel to close the box without adding a new font.

   The selected font is added.

To remove an AFP font:

1. From the AFPFonts drop down box, select the font you wish to remove (see Figure 5.4).

2. Click RemoveAFPFont.

   The selected font is removed.

Configuring the Backend for SVG Files

Figure 5.6. XEP Configuration Backend's tab for SVG files

Table 5.5. XEP Configuration Backends Tab SVG Parameters

Parameter	Possible Values	Description
Select backend	PDF, PostScript, AFP, SVG, HTML, PPML Default: PDF	Select the output type for which you are configuring the backend.
Backend Parameters
Embed images	checked, unchecked Default: unchecked	If checked, generator embeds external images referenced in the document in the resulting document instance as Base64 strings. Note: SVG images are always embedded as inline SVG. XEPOUT images content will be converted into appropriate SVG elements
Generate each page in separate file	checked, unchecked Default: unchecked	If checked, output document is a zip files with collection of SVG files, where each file represents a separate page.
Generate first N pages	number of pages Default: 0	Specifies how many pages to generate (0 means all pages).

Configuring the Backend for PPML Files

Figure 5.7. XEP Configuration Backend's tab for PPML files

Table 5.6. XEP Configuration Backends Tab PPML Parameters

Parameter	Possible Values	Description
Select backend	PDF, PostScript, AFP, SVG, HTML, PPML Default: PDF	Select the output type for which you are configuring the backend.
Backend Parameters
Select target format	PDF, PS Default: PS (PostScript)	Select format for internal pages. PS - PostScript PDF - PDF
Select Graphic Arts Conformance level	-1,0,1,2 Default: 0	Define wich image-files added to internal resiurces "as is" and wich will be rendered. 0 - Add all files, according to PPML 2.2 Specification. 1 - Add only TIFF and JPEG files as level 1 2 - Add only TIFF and JPEG files as level 2

Configuring the Backend for XHTML Files

Figure 5.8. XEP Configuration Backend's tab for XHTML files

Table 5.7. XEP Configuration Backends Tab XHTML Parameters

Parameter	Possible Values	Description
Select backend	PDF, PostScript, AFP, SVG, HTML, PPML Default: PDF	Select the output type for which you are configuring the backend.
Backend Parameters
Embed images	checked, unchecked Default: unchecked	If checked, generator embeds external images referenced in the document in the resulting document instance as Base64 strings. Note: SVG images are always embedded as Base64 strings.
Generate each page in separate file	checked, unchecked Default: unchecked	If checked, output document is a zip files with collection of XHTML files, where each file represents a separate page. The archive does also contain pages index.
Generate first N pages	number of pages Default: 0	Specifies how many pages to generate (0 means all pages).
Generate XForms	checked, unchecked Default: unchecked	Specifies whether the XHTML backend generates XForms.

5.1.3. Configuring Languages

Languages can be configured in the Languages tab.

Figure 5.9. XEP Configuration Languages tab

Table 5.8. XEP Configuration Languages Tab

Parameter	Possible Values	Description
Supported Languages
Codes	free text	A list of codes used to refer to the language in the XSL-FO input data. Note: Separate multiple codes with spaces.
Pattern File	free text	The location of the Pattern file associated with the language selected. Click Browse to select the location of the Patten file.
Encoding	Default: ISP-8859-1	The encoding of the pattern file.
Font Aliases	Font aliases are activated when the language which is associated with them is selected. They take precedence over the aliases specified in the fonts section and may mask them.
Alias	free text	Provide an alternate name for a font family.
Font Family	free text	Select the font family corresponding to the alias.
Add alias		Click to add a new alias.
Delete alias		To delete an alias, highlight the alias you wish to delete and click Delete alias.

5.1.4. Configuring Fonts

Fonts are categorized into families, which is the basic configuration unit in XEP, and then further into groups. A font family is a set of fonts that share a common design but differ in stylistic attributes, such as upright or italic, light or bold. A group consists of several font families wrapped into one container element. Groups can be nested, forming complex font hierarchies.

In the left column, there is the font hierarchy that contains groups, families, and fonts. Click on a node to display and edit its common attributes. Double-click a node to open its children.

Figure 5.10. XEP Configuration Fonts tab

Table 5.9. XEP Configuration - Fonts Tab Parameters

Parameters	Possible Values	Description
Supported Fonts
Common Attributes
Base Path	free text	Specifies a common base directory for a group of font families that form a package. Click Browse to select a file location.
Embedded	unspecified, true, false	Specifies whether the font is embedded in the document or it is external to the file. Note: If the font is external, the rendered file can only be viewed on systems that have the font configured for use with viewing or printing the application.
Subsetted	unspecified, true, false	Specifies whether the font is subsetted. Note: If a font is subsetted, the file is not editable.
Font Aliases
Alias	free text	Provide an alternate name for a font family.
Font Family	all font families defined	Select the font family corresponding to the alias.
Add alias		Click to add a new alias.
Delete alias		To delete an alias, highlight the alias you wish to delete and click Delete alias.
New Group		Click to create a new group.
New Family		Click to create a new family.
New Font		Click to create a new font.
Delete Node		Click on the node you wish to delete and click Delete Node to delete.

This topic describes in detail how to configure XEP by creating or modifying an XEP configuration file.

<?xep-pdf-unicode-annotations value?>
<?xep-postscript-unicode-annotations value?>

<?xep-pdf-initial-zoom value?>
<?xep-postscript-initial-zoom value?>

<?xep-pdf-view-mode value?>
<?xep-postscript-view-mode value?>

<?xep-pdf-logical-page-numbering value?>

<?xep-pdf-page-layout value?>

<?xep-pdf-viewer-preferences value?>

<?xep-pdf-drop-unused-destinations value?>
<?xep-postscript-drop-unused-destinations value?>

<?xep-pdf-icc-profile URL?>

<?xep-pdf-pdf-x value?>

<?xep-pdf-pdf-a value?>

<?xep-pdf-crop-offset value?>
<?xep-postscript-crop-offset value?>

<?xep-pdf-bleed value?>
<?xep-postscript-bleed value?>

<?xep-pdf-crop-mark-width value?>
<?xep-postscript-crop-mark-width value?>

<?xep-pdf-bleed-mark-width value?>
<?xep-postscript-bleed-mark-width value?>

<?xep-pdf-printer-mark URL?>
<?xep-postscript-printer-mark URL?>

<?xep-pdf-pdf-version value?>

<?xep-pdf-compress value?>

<?xep-pdf-linearize value?>

<?xep-pdf-ownerpassword value?>

<?xep-pdf-userpassword value?>

<?xep-pdf-userprivileges value?>

<?xep-postscript-language-level value?>

<?xep-postscript-clone-eps value?>

<?xep-postscript-page-device entryname entryvalue?>

<?xep-afp-invoke-medium-map name="map-name" [force="true"]?>

<?xep-postscript-page-label value?>

<?xep-postscript-custom-comment value?>

<?xep-postscript-image-inline-threshold value?>

<?xep-out-embed-images value?>

<?xep-svg-embed-images value?>

<?xep-html-embed-images value?>

<?xep-svg-break-pages value?>

<?xep-html-break-pages value?>

<?xep-svg-generate-first-n-pages value?>

<?xep-html-generate-first-n-pages value?>

<?xep-html-xforms value?>

<fo:page-sequence rx:insert-document="url(documentname.pdf)">

<fo:page-sequence rx:insert-document="url(documentname.pdf)" initial-page-number="45" >

<font-family name="Courier">
    <font>
        <font-data afm="Courier.afm"/>
    </font>
    <font style="oblique">
        <font-data afm="Courier-Oblique.afm"/>
    </font>
    <font weight="bold">
        <font-data afm="Courier-Bold.afm"/>
    </font>
    <font weight="bold" style="oblique">
        <font-data afm="Courier-BoldOblique.afm"/>
    </font>
</font-family>

<font-family name="AfpFont"
  codepage-name="T1EDO500"
  codepage-file="T1EDO500.CDP"
  encoding="Cp1146">
  <font size="10" style="italic">
    <font-data charset-name="C0V08000" charset-file="C0V08000.CHS"/>
  </font>
  ...
</font-family>

XEP can be configured to use a specific entity resolver for all SAX parsing calls inside it. The resolver class is specified by a Java system property com.renderx.sax.entityresolver. It must have a public constructor with no arguments, and implement org.xml.sax.EntityResolver interface.

Similarly, XEP can assign a user-defined class to resolve URIs in calls to document() function, <xsl:import>, and <xsl:include> XSLT directives. The class name is specified in com.renderx.jaxp.uriresolver system property; it must provide a public default constructor, and implement javax.xml.transform.URIResolver interface.

The principal use of these features is to add support for XML catalogs to XEP, to avoid repeated loading of common DTDs and stylesheets from the internet. For example, the following setting configures XEP to use XML entity and URI resolver from Apache project (provided that you have included resolver classes in the classpath, and properly configured it):

java 
	-Dcom.renderx.sax.entityresolver=org.apache.xml.resolver.tools.CatalogResolver
	-Dcom.renderx.jaxp.uriresolver=org.apache.xml.resolver.tools.CatalogResolver
   …

XML catalogs resolver is included into xml-commons tools available as a part of Apache project. For further information about catalogs and entity resolution, and for resolver download please proceed to Apache website: http://xml.apache.org/commons/components/resolver/index.html.

AFP documents can be generated through the following:

Non-CID OTF fonts are currently supported which allows for higher AFP standard conformance. Fonts larger than 36 pt can be processed as well, which produces better AFP documents.

Highlight color is a special case of color encoding, when a solid colorant used (contrary to other schemes like RGB, CMYK, etc). In XSL-FO, this kind of encoding is called Spot Color. XEP AFP Backend treats spot color in source document and produces AFP Highlight Color instructions within the MO:DCA-P stream.

Highlight Color has the following major attributes:

AFP Generator uses the following algorithm of Spot Colors identification:

Scalable Vector Graphics (SVG) is a language for describing two-dimensional vector graphics in XML.

AFP Backend 4.30.1086 has limited support of SVG primitives. They are rendered as instructions listed within G:OCA command set.

The following G:OCA objects are currently supported:

Filled areas may be formed by any combination of lines, arcs, and B?zier curves. AFP Generator correctly processes such case of svg:path and makes areas filled correctly.

Coordinate system transformations are also supported.

A new user space can be established by specifying transformations in the form of a "transform" attribute on a container element or graphics element or "viewBox" attribute on an "svg", "symbol", "marker", "pattern" and the "view" element.

The "transform" and "viewBox" attributes transform user space coordinates and lengths on sibling attributes on the given element and all of its descendants.

The following logic elements are currently supported:

Not supported or limited support:

A barcode is a machine-readable representation of information in a visual format.

Most types of barcodes stores data in the width and spacings of printed parallel lines.

Barcodes are simple to represent as black rectangles separated by white spaces, but they have proved to be difficult to generate accurately. Bar and space widths are often computed in a complex manner and checking digits additionally complicates the process.

AFP Backend uses XSLT stylesheets to implement the computational part and SVG to draw the image and text. These stylesheets are available for free download from RenderX site:

http://www.renderx.com/demos/barcodes.html

As soon as XSL-FO 1.0 does not have native support of barcodes, technical implementation of them is based on SVG. These stylesheets render barcodes as SVG primitives, including additional <desc> tag containing the value and parameters of barcode rendered.

Starting with version 4.29, XEP contains its own extension <rx:barcode> to XSL-FO for Barcode support. Please refer Section A.3.24 for more details about its implementation.

AFP Backend processes this tag and decides whether it is barcode or another SVG graphic.

If barcode tag is found, the barcode is rendered with BC:OCA or G:OCA, depending on which is enabled. This is done with USE_BCOCA_LEVEL and USE_GOCA_LEVEL configuration parameters. If both BC:OCA and G:OCA are enabled, BC:OCA overrides. Please refer configuration parameters section about configuring BC:OCA and G:OCA.

Please refer Section 6.5 section for more information about G:OCA implementation.

Currently, the following types of Barcodes are supported by AFP Backend:

Please refer Section 6.11 for more details about AFP Backend limitations.

For example:

<svg:svg xmlns:svg="http://www.w3.org/2000/svg"
  width="34.98mm" height="27.39mm">
  <desc xmlns:mydoc="http://example.org/mydoc">
    <barcode value="9780444505156" type="EAN-13"/>
  </desc>
  <svg:rect y="0" height="24.915mm" x="3.63mm"
    width="0.33mm" style="fill: black;"/>
  <svg:rect y="0" height="24.915mm" x="4.29mm"
    width="0.33mm" style="fill: black;"/>
  ...
  <svg:rect y="0" height="23.1mm" x="4.95mm"
    width="0.99mm" style="fill: black;"/>
</svg:svg>

desc tag must have single child node <barcode/>. The following attributes are available for <barcode/> tag:

Configuration of the AFP generator is performed in a usual way all XEP generators are configured.

<option name="MERGE_WHITE_SPACE" value="false"/>
<option name="LTF" value="1000"/>

<option name="OPTION_NAME" value="OPTION_VALUE"/>.

In this section, all parameters will be described in Configuration file format.

AFP generator's prefix for Generator options is H4AFP. So, RESOLUTION parameter will look like this:

-DH4AFP.RESOLUTION=1440

AFP generator's prefix for Processing instructions is xep-afp-. So, RESOLUTION parameter will look like this:

<?xep-afp-resolution 1440?>

Processing Instruction may appear at document level or page level. Every time the page level parameter is set, it applies until the same parameter is set to another value. For example, if RESOLUTION option is set to: 1440 in config file; to 720 for page #5; and to 1440 for page #10 - the value of 720 will apply for ALL pages ##5 till 9.

<generator-options format="AFP">
  <charsets>
  <!--languages-->
  <charset name="Latin">
    <code-range from="0x0000" to="0x007F"/>
    <codepage name="Cp500" ibm-name="T1V10500" forcelatin="true"
      desc="Base Latin"/>
  </charset>
  <charset name="Latin_1">
    <code-range from="0x0080" to="0x00FF"/>
    <codepage name="Cp819" ibm-name="T1000819" forcelatin="true"
      desc="Latin_1"/>
  </charset>
  <charset name="Cyrillic">
    <code-range from="0x0400" to="0x04FF"/>
    <codepage name="Cp866" ibm-name="T1000866" forcelatin="true"
      desc="ANSI Cyrillic"/>
  </charset>
  <charset name="Chinese">
    <code-range from="0x4E00" to="0x9FFF"/>
    <codepage name="Cp950" ibm-name="T1094700" forcelatin="false"
      desc="Chinese"/>
  </charset>
  <charset name="Hebrew">
    <code-ranges>
      <code-range from="0x0590" to="0x05FF"/>
    </code-ranges>
    <codepage name="Cp424" ibm-name="T1000424" forcelatin="true"
      desc="Hebrew"/>
  </charset>
  <charset name="Greek">
    <code-ranges>
      <code-range from="0x0370" to="0x03ff"/>
    </code-ranges>
    <codepage name="Cp875" ibm-name="T1000875" forcelatin="false"/>
  </charset>
  <!--symbol-->
  <charset name="Symbols00259">
    <code-ranges>
      <code-range from="0x03C0" to="0x03C0"/>
      <code-range from="0x2020" to="0x2020"/>
      <code-range from="0x003C" to="0x003C"/>
      <code-range from="0x02C6" to="0x02C6"/> 
      <code-range from="0x00B0" to="0x00B0"/> 
      <code-range from="0x25CF" to="0x25CF"/>
      <code-range from="0x25C6" to="0x25C6"/> 
      <code-range from="0x25A1" to="0x25A1"/>
      <code-range from="0x2341" to="0x2341"/>
      <code-range from="0x25BA" to="0x25BA"/>
    </code-ranges>
    <character-mapping> 
      <character unicode="0x03C0" afp="0x46" desc="pi small"/>
      <character unicode="0x2020" afp="0x4b" desc="dagger"/>
      <character unicode="0x003C" afp="0x4c" desc="less"/>
      <character unicode="0x02C6" afp="0x5f" desc="circumflex accent"/> 
      <character unicode="0x00B0" afp="0x7c" desc="degree symbol"/> 
      <character unicode="0x25CF" afp="0xbc" desc="large bullet"/>
      <character unicode="0x25A1" afp="0xda" desc="open square"/>
    </character-mapping>
    <codepage name="Cp259" ibm-name="T1000259" forcelatin="false"/>
  </charset>
  <charset name="Cp437">
    <code-ranges>
      <code-range from="0x2022" to="0x2022"/>
      <code-range from="0x266A" to="0x266A"/>
    </code-ranges>
    <character-mapping>
      <character unicode="0x266a" afp="0x0d" desc="musical note"/>
      <character unicode="0x2022" afp="0x07" desc="bullet"/>
    </character-mapping>
    <codepage name="Cp437" ibm-name="T1000437" forcelatin="false"/>
  </charset>
  <charset name="Cp423">
    <code-ranges>
      <code-range from="0x03CA" to="0x03CA"/>
    </code-ranges>
    <character-mapping> 
      <character unicode="0x03CA" afp="0xb4" desc="acute accent"/>
    </character-mapping>
    <codepage name="Cp423" ibm-name="T1000423" forcelatin="false"/>
  </charset>
  <charset name="APL Graphic Escape">
    <code-ranges>
      <code-range from="0x25CA" to="0x25CA"/>
      <code-range from="0x25A0" to="0x25A0"/>
      <code-range from="0x203E" to="0x203E"/>
    </code-ranges>
    <character-mapping> 
      <character unicode="0x25CA" afp="0x70" desc="acute accent"/>
      <character unicode="0x25A0" afp="0xC3" desc="down caret"/>
      <character unicode="0x203E" afp="0xA0" desc="overbar"/>
    </character-mapping>
    <codepage name="Cp310" ibm-name="T1000310" forcelatin="true"/>
  </charset>
  </charsets>
</generator-options>

<option name="highlightcolor,0x301" value="PANTONE Orange 021 M" />

<option name="highlightcolor,769" value="PANTONE Orange 021 M" />

<data-types default-name="G4 MMR">
  <data-type name="Uncompressed" allow-instream="true"
    compression-code="0x03" recording-code="0x01">
  </data-type>
  <data-type name="G4 MMR" allow-instream="true"
    compression-code="0x82" recording-code="0x01">
  </data-type>
  <data-type name="JPEG" allow-instream="true"
    compression-code="0x83" recording-code="0x01">
    <mime-type code="image/jpeg" />
    <mime-type code="jpeg" />
  </data-type>
</data-types>
      

AFP Backend supports several ways to produce bulleted text.

Other approaches have not been tested and are not supported. Please refer Section 6.11 for more details.

AFP Generator for XEP has multilanguage support. For each character in text blocks, it detects Character Set the character belongs to (out of character sets listed in configuration file). After that, it uses conversion table to convert the character to the CodePage that AFP device is capable to process.

Here is the description how AFP generator for XEP finds out which Codepage to use.

The source Unicode string is analyzed by characters. For each of them, AFP generator determines Character Set (<character> element in config file) the character belongs to (using the Code Ranges listed in configuration file specified in <code-range> elements). If the range not found, the first configured range is assumed (normally, Base Latin). After the range is found, AFP generator checks whether the character is specified within the list of specially translated characters (<character-mapping> element). If so, the character is translated according to the mapping table (afp attribute). If not, AFP generator uses Java libraries to map the character to the corresponding code page (<codepage> element, (name attribute). After that, it determines if the character belongs the same code page as the previous one in the same text block. For instance, Chinese and Cyrillic characters cannot reside in the same AFP tect block due to different encodings. However, Base Latin may follow the Cyrillic character since Cyrillic code pages usually contain Latin characters in lower half of codes (0x00-0x7F). This approach is determined by forcelatin attribute. Finally, after the string of the same code page is composed, it becomes assigned with IBM encoded name (ibm-name attribute) and placed to AFPDS stream.

The complete list of Unicode character sets can be found at W3C Web site. Here is the list of most common Unicode Character sets:

Please refer Section 6.8.1 for more details.

SVG documents can be generated through the following:

SVG generator supports PNG, JPEG, GIF, SVG/SVGZ and XEPOUT images.

Notes on SVG support in SVG generator:

CMYK, grayscale, spot and registration colors will be rendered into RGB equivalent

Configuration of the SVG generator is performed in a usual way all XEP generators are configured. All configuration options for SVG generator are child elements of XEP configuration file element <generator-options format="SVG">. Each SVG generator configuration option is an element option and looks like

<option name="OPTION_NAME" value="OPTION_VALUE"/>.

EMBED_IMAGES, BREAK_PAGES and GENERATE_FIRST_N_PAGES options can be passed to SVG generator.

SVG generator's prefix for Generator options is H4SVG. So, EMBED_IMAGES parameter will look like this:

-DH4SVG.EMBED_IMAGES=true

SVG generator's prefix for Processing instructions is xep-svg-. So, EMBED_IMAGES parameter will look like this:

<?xep-svg-embed-images true?>

Processing Instruction may appear at document level or page level.

XPS documents can be generated through the following:

XPS generator supports PNG, TIFF, JPEG and SVG image formats.

CMYK, grayscale, spot and registration colors will be rendered into RGB equivalents

XPS generator does not support any options.

XHTML documents can be generated through the following:

XHTML generator supports PNG, JPEG, GIF, SVG/SVGZ, XEPOUT images.

Notes on SVG/SVGZ support in XHTML generator:

CMYK, grayscale, spot and registration colors will be rendered into RGB equivalent.

Starting with version 4.19, XEP is able to produce XHTML with XForms 1.1. This feature is controlled by a special license key file.

The <pdf-form-field> extension element with it's descendants describes a single field in the XForm. See the Section A.3.18 part for more information.

In case of XForms value of js-* attributes is required to match the value of its related properties in XForm specification (i.e. XPath expression). Input attributes js-format and js-keystroke correspond to the property type in the field's binding element of the output XForm model. The attribute js-validate corresponds to the property constraint, and the attribute js-calculate - to the property calculate in the field's binding element of the output XForm model.

Since all form fields are collected in fields root element at output XForm model, addressing to the form's field should be /fields/user_field_name or ../user_field_name in XPath expressions.

Configuration of the XHTML generator is performed in a usual way all XEP generators are configured. All configuration options for XHTML generator are child elements of XEP configuration file element <generator-options format="HTML">. Each XHTML generator configuration option is an element option and looks like

<option name="OPTION_NAME" value="OPTION_VALUE"/>.

EMBED_IMAGES, BREAK_PAGES, GENERATE_FIRST_N_PAGES and XFORMS options can be passed to XHTML generator.

XHTML generator's prefix for Generator options is H4HTML. So, EMBED_IMAGES parameter will look like this:

-DH4HTML.EMBED_IMAGES=true

XHTML generator's prefix for Processing instructions is xep-html-. So, EMBED_IMAGES parameter will look like this:

<?xep-html-embed-images true?>

Processing Instruction may appear at document level or page level.

PPML documents can be generated through the following:

PPML generator supports all image formats, which are supported by the chosen target format generator.

Notes on Graphic Arts Level:

Configuration of the PPML generator is performed in a usual way all XEP generators are configured. All configuration options for PPML generator are child elements of XEP configuration file element <generator-options format="PPML">. Each PPML generator configuration option is an element option and looks like

<option name="OPTION_NAME" value="OPTION_VALUE"/>.

TARGET_FORMAT and GA_LEVEL options can be passed to PPML generator.

PPML generator's prefix for System properties is H4PPML. So, TARGET_FORMAT parameter will look like this:

-DH4PPML.TARGET_FORMAT="PDF"

PPML generator's prefix for processing instructions is xep-ppml-. So, TARGET_FORMAT processing instruction will look like this:

<?xep-ppml-target-format PDF?>

Processing Instruction may appear only at document level, before <fo:root>.