XMLmind XSL-FO Converter XXE-specific Edition 4.3.1 XMLmind XSL-FO Converter - User's Guide Jean-Yves Belmonte Hussein Shafie, Pixware <xfc-support@xmlmind.com> XMLmind XSL-FO Converter - User's Guide by Jean-Yves Belmonte and Hussein Shafie Publication date December 4, 2009 1. Introduction PAGEREF intro 0 2. Installing XMLmind XSL-FO Converter PAGEREF install_java 0 1. System requirements PAGEREF system_requirements 0 2. Installation PAGEREF installation 0 3. Contents of the installation directory PAGEREF contents_install_dir 0 3. Command-line executables PAGEREF command_line_java 0 4. Integrating XMLmind XSL-FO Converter in your application PAGEREF programming_java 0 1. Compiling and running the code samples PAGEREF compiling_java 0 2. Converting an XSL-FO file to RTF PAGEREF sample1_java 0 3. Converting an XML document to RTF PAGEREF sample2_java 0 5. Support of the XSL-FO v1.0 standard PAGEREF fo_support 0 1. Features PAGEREF features 0 2. Limitations PAGEREF limitations 0 3. Conformance statement PAGEREF conformance 0 4. Implementation specificities PAGEREF implementation 0 4.1. Page references PAGEREF page_ref 0 4.1.1. RTF/WML/OOXML PAGEREF page_ref_rtf 0 4.1.2. OpenDocument PAGEREF page_ref_odt 0 4.2. Leaders PAGEREF leaders 0 4.3. Special characters PAGEREF specialchars_java 0 4.4. Special characters PAGEREF specialchars_dotnet 0 4.5. Multiple page layouts PAGEREF page_layout 0 4.6. Expressions PAGEREF expressions 0 6. XSL-FO extension for Office Open XML PAGEREF sdt_2D_extension 0 1. What it is PAGEREF sdt_2D_what 0 2. How it works PAGEREF sdt_2D_how 0 2.1. Text field example PAGEREF std_2D_text_field_example 0 2.2. Drop-down list example PAGEREF sdt_2D_list_example 0 2.3. Specifying a Custom XML Data template PAGEREF std_2D_data_template 0 2.4. Extracting the Custom XML Data part PAGEREF std_2D_extract_data 0 3. Reference Material PAGEREF sdt_2D_reference 0 3.1. Generic attributes PAGEREF sdt_2D_attributes 0 3.2. sdt:text-field PAGEREF std_2D_text_field 0 3.3. sdt:drop-down-list PAGEREF sdt_2D_list 0 3.4. sdt:list-entry PAGEREF sdt_2D_list_entry 0 3.5. sdt:combo-box PAGEREF sdt_2D_combobox 0 3.6. sdt:date PAGEREF sdt_2D_date 0 3.7. sdt:picture PAGEREF sdt_2D_picture 0 3.8. sdt:image-data PAGEREF sdt_2D_image_data 0 3.9. sdt:configuration PAGEREF std_2D_configuration 0 XMLmind XSL-FO Converter - User's Guide XMLmind XSL-FO Converter - User's Guide Chapter 1. Introduction XMLmind XSL-FO Converter (XFC for short) is an XSL-FO processor similar to Apache FOP , RenderX XEP or Antenna House XSL Formatter . Unlike the aforementioned processors which all renders XSL-FO as PDF and PostScript®, XMLmind XSL-FO Converter converts XSL-FO v1.0 to the following formats: RTF (Word 2000+), WordprocessingML (Word 2003+), Office Open XML ( .docx , Word 2007+), OpenOffice ( .odt , OpenOffice.org 2+). That is, XMLmind XSL-FO Converter translates one format, XSL-FO v1.0, to the file formats of the two most commonly used word processors, Microsoft Word and OpenOffice.org Writer. Working at a higher level than the other XSL-FO processors, XMLmind XSL-FO Converter has intrinsic limitations which are detailed in Section 2, “Limitations” . Despite these limitations, XMLmind XSL-FO Converter allows to process very elaborate XSL-FO files. In practice, you should be able to reuse as is the XSLT style sheets (which generate XSL-FO) that you have developed to convert your XML documents to PDF. Note The target audience of this document is a developer or an integrator, that is, a technical person and not an end user. End users, that is persons who need to convert XML documents to a variety of formats, are more likely to use XMLmind XSL Utility , a handy graphical tool, which is available in a separate, self-contained, distribution. Introduction Introduction Chapter 2. Installing XMLmind XSL-FO Converter 1. System requirements Sun or Apple Java ™ runtime 1.4 or above. 50Mb of free disk space. XMLmind XSL-FO Converter is officially supported on Windows XP/Vista/7, on Linux 2.6 and on Mac OS X 10.4 (Tiger), 10.5 (Leopard), 10.6 (Snow Leopard). It is possible to use it on other Java ™ 1.4+ platforms (e.g. Solaris), but without support from XMLmind. 2. Installation Simply unzip the distribution somewhere. Linux/Mac example: ~$ cd /opt /opt$ unzip /tmp/xfc-4_3_2.zip /opt$ ls xfc-4_3_2 bin/ doc/ legal.txt legal/ samples/ This means that uninstalling XMLmind XSL-FO Converter simply consists in deleting the directory created by unzipping its distribution. 3. Contents of the installation directory bin/fo2rtf.bat , fo2wml.bat , fo2docx.bat , fo2odt.bat .bat files used to run XMLmind XSL-FO Converter on Windows. bin/fo2rtf , fo2wml , fo2docx , fo2odt Shell scripts used to run XMLmind XSL-FO Converter on the Mac and on Linux. bin/xfc.jar The class library containing the XMLmind XSL-FO Converter engine. Add it to your CLASSPATH if you are integrating XMLmind XSL-FO Converter in your application. doc/index.html Points to copies of this document in HTML, PDF, RTF, WordprocessingML, Office Open XML and OpenOffice formats. Also points to the reference manual of the API (generated using Javadoc TM ) of XMLmind XSL-FO Converter. legal.txt , legal/ Contains XMLmind XSL-FO Converter licences. samples/ A few XSL-FO sample files, in case you want to test the installation of XMLmind XSL-FO Converter by running samples/make_samples.bat ( samples/make_samples on Linux/Mac). Installing XMLmind XSL-FO Converter Installing XMLmind XSL-FO Converter Chapter 3. Command-line executables Four command-line executables are provided: fo2rtf , fo2wml , fo2docx and fo2odt , to convert an XSL-FO file to RTF, WML, Open XML and OpenDocument respectively. The general syntax of a command line is: fo2rtf [<options>] <input> [<output>] where <input> is the input XSL-FO file name and <output> the output file name. If no output file is specified the conversion output is written to the standard output stream. Options are specified as: -<name>=<value> where <name> is the option name and <value> the option value. Option names and values are described below. baseURL Specifies the base URL of relative paths in attribute values (typically the src attribute of the external-graphic element). By default, paths are taken relative to the input source URL. imageResolution Specifies the source image resolution in dots per inch. This option value is used to compute the intrinsic size of external-graphic elements, which determines the actual content size when the content-height and content-width attributes are not set to absolute values. The default value is 96. outputEncoding Specifies the output encoding. Supported values depend on the target output format: For RTF output supported values are ASCII , Cp1250 (Windows Eastern European), Cp1251 (Windows Cyrillic) and Cp1252 (Windows Latin-1). The default value is Cp1252 (Windows Latin-1). For WML output all encodings available in the current JVM are supported. The option value may be either the encoding name (e.g. ISO8859_1 ) or the charset name (e.g. ISO-8859-1 ). The default value is Cp1252 (Windows Latin-1). For Open XML output this option specifies the encoding of XML content in the output document. Supported values are UTF-8 and UTF-16 . The default value is UTF-8 . For OpenDocument output this option specifies the encoding of XML content (files styles.xml and content.xml ) in the output document. All encodings available in the current JVM are supported. The option value may be either the encoding name (e.g. ISO8859_1 ) or the charset name (e.g. ISO-8859-1 ). The default value is UTF8 . prescaleImages Specifies image scaling policy. By default images are prescaled to minimize output document size. If this option is set to false the original size of images is preserved and scaling directives are inserted in the output document. rtf.target Specifies the target RTF viewer. Currently the only supported value is MSWord . This option may be needed to circumvent an obscure bug in the RTF loader of MS-Word, which does not handle table cell padding tags correctly. When this option is set to MSWord , XFC will swap top and left padding values in table cells to work around this bug. singleSidedLayout Specifies single-sided page layout. By default RTF, WML and Open XML output documents are given a double-sided page layout regardless of the input document properties. This option may be set to true to force a single-sided page layout. Command-line executables Command-line executables Chapter 4. Integrating XMLmind XSL-FO Converter in your application 1. Compiling and running the code samples All the code samples used to illustrate this document are found in the samples/java/ subdirectory. Ant , a Java-based build tool ( “in theory, it is kind of like make , without make's wrinkles” say its authors), is needed to build and run these code samples. build.xml , the ant build file needed to compile and run code samples, has been tested with ant version 1.7. Compile the two samples by executing ant in the samples/java/ directory. Run the first sample by executing ant tsample1 in the samples/java/ directory. Run the second sample by executing ant tsample2 in the samples/java/ directory. 2. Converting an XSL-FO file to RTF This first sample consists in a single step: invoke XMLmind XSL-FO Converter to convert the XSL-FO input file to RTF. Note that converting XSL-FO to other formats is simply a matter of changing the value of the outputFormat property. The possible values for this property are: rtf , wml , docx , odt . Excerpts of samples/java/Sample1.java : import org.xml.sax.InputSource; import com.xmlmind.fo.converter.OutputDestination; import com.xmlmind.fo.converter.Converter; ... Converter converter = new Converter(); iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAABjSURBVHja VY6xDcAwCAS/pPQaLim9QmajdOk2I2SNrMEIlARIoigU8Cek/4e7zdHaWOYOVwaoA6wOCw05Y7FB gE0tIWQ+sBcwKM8qoD/wB5wGL8hjfdzWrh01GRp1hInGjDoXwHgsFuzBVLQAAABDdEVYdFNvZnR3 YXJlAEAoIylJbWFnZU1hZ2ljayA0LjIuOCA5OS8wOC8wMSBjcmlzdHlAbXlzdGljLmVzLmR1cG9u dC5jb22RuiG4AAAAKnRFWHRTaWduYXR1cmUANThhMDcyZTA3MGRhMjJmNjEzNWNiZDNlNDE0NTQ2 ZjloaiHtAAAADnRFWHRQYWdlADEyeDEyKzArMIRtu30AAAAASUVORK5CYII= converter.setProperty("outputFormat", "rtf"); iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAAB7SURBVHja HY6hFcMwDEQ/NDQsNSwU9Apdo7Cw0CsIBoZmhKzQEQJLDQsFVclHpHu693W429Zr7bu541Pg3kCm Y0K75u9TEUPhuGgWU4mQDvieEaSQEnsT6zKPeZY0EUNtrHMCXvYUuSUg0PsMjUSvpysUT6OOSil9 izp/VNk1YJ8vf6MAAABDdEVYdFNvZnR3YXJlAEAoIylJbWFnZU1hZ2ljayA0LjIuOCA5OS8wOC8w MSBjcmlzdHlAbXlzdGljLmVzLmR1cG9udC5jb22RuiG4AAAAKnRFWHRTaWduYXR1cmUAODBlYWU1 MjljOTRhN2Y0N2RlY2NmYWRhMjhhY2I5ZGblb7ENAAAADnRFWHRQYWdlADEyeDEyKzArMIRtu30A AAAASUVORK5CYII= converter.setProperty("outputEncoding", "Cp1252"); converter.setProperty("imageResolution", "120"); InputSource src = new InputSource(inFile.toURI().toASCIIString()); iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAAB4SURBVHja JU6rFcNADBM09BqBhl6ltDCwKxQeDOwKB7tGYGCoYaChK6cmlt7TD1W5uap/sgoVBnEXWBTSoOdx 7gpLDOAVorWC0ABdcBPqwZtx8Muf+DPXJpQ96Nu/LSMYl/n17oCOnplTOrpiwW3sUs4ZJmob5/wA Ubg1Y/zrjUwAAABDdEVYdFNvZnR3YXJlAEAoIylJbWFnZU1hZ2ljayA0LjIuOCA5OS8wOC8wMSBj cmlzdHlAbXlzdGljLmVzLmR1cG9udC5jb22RuiG4AAAAKnRFWHRTaWduYXR1cmUAODBiYmRhMjcy NmRkYWNlOGFiOGEwMWY1OWRlMmViZGII/Q51AAAADnRFWHRQYWdlADEyeDEyKzArMIRtu30AAAAA SUVORK5CYII= OutputDestination dst = new OutputDestination(outFile.getPath()); iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAABzSURBVHja HY0hEoUwEEMjkZVYZGVlr1CJxCKRXKPyy28reyVsZeXKsCFi573ZzAQk+x5jaQ6gFQAxIA8XceEN ZEN3DkOCH/TobUoSVuAYwSSLyzbvaHWVFJxUmmp+PF+twrLkuXzLwPmZ8+OjtH8KS6pGvuoGNo5b 6rzDAAAAQ3RFWHRTb2Z0d2FyZQBAKCMpSW1hZ2VNYWdpY2sgNC4yLjggOTkvMDgvMDEgY3Jpc3R5 QG15c3RpYy5lcy5kdXBvbnQuY29tkbohuAAAACp0RVh0U2lnbmF0dXJlADlmODJmY2FjOWUwMzlj YmRiNzIzODBhNDU5MTMyNGY1gLv4dgAAAA50RVh0UGFnZQAxMngxMiswKzCEbbt9AAAAAElFTkSu QmCC converter.convert(src, dst); iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAAB2SURBVHja FY6hEcQwDAQPChqGGhoaqgWX8PUYBhqGBn4rX0JooKDh/UlsZ3b2BJKXH8XPTYLh1lpt1h+BwxkR A23jhsCQd2IkfH9T3HEkzPFegCXUKSUSpJUPsN7UFOgc9VkZUBoz9l0yrVHZarUcJZeb9XznDyNb Ny9CX3/7AAAAQ3RFWHRTb2Z0d2FyZQBAKCMpSW1hZ2VNYWdpY2sgNC4yLjggOTkvMDgvMDEgY3Jp c3R5QG15c3RpYy5lcy5kdXBvbnQuY29tkbohuAAAACp0RVh0U2lnbmF0dXJlAGZlNjkwNDYzMzc5 ZWIyNWU1NjJmY2M4Y2M5YjNjN2Uw37I5ngAAAA50RVh0UGFnZQAxMngxMiswKzCEbbt9AAAAAElF TkSuQmCC ... iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAABjSURBVHja VY6xDcAwCAS/pPQaLim9QmajdOk2I2SNrMEIlARIoigU8Cek/4e7zdHaWOYOVwaoA6wOCw05Y7FB gE0tIWQ+sBcwKM8qoD/wB5wGL8hjfdzWrh01GRp1hInGjDoXwHgsFuzBVLQAAABDdEVYdFNvZnR3 YXJlAEAoIylJbWFnZU1hZ2ljayA0LjIuOCA5OS8wOC8wMSBjcmlzdHlAbXlzdGljLmVzLmR1cG9u dC5jb22RuiG4AAAAKnRFWHRTaWduYXR1cmUANThhMDcyZTA3MGRhMjJmNjEzNWNiZDNlNDE0NTQ2 ZjloaiHtAAAADnRFWHRQYWdlADEyeDEyKzArMIRtu30AAAAASUVORK5CYII= Create a new Converter object. iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAAB7SURBVHja HY6hFcMwDEQ/NDQsNSwU9Apdo7Cw0CsIBoZmhKzQEQJLDQsFVclHpHu693W429Zr7bu541Pg3kCm Y0K75u9TEUPhuGgWU4mQDvieEaSQEnsT6zKPeZY0EUNtrHMCXvYUuSUg0PsMjUSvpysUT6OOSil9 izp/VNk1YJ8vf6MAAABDdEVYdFNvZnR3YXJlAEAoIylJbWFnZU1hZ2ljayA0LjIuOCA5OS8wOC8w MSBjcmlzdHlAbXlzdGljLmVzLmR1cG9udC5jb22RuiG4AAAAKnRFWHRTaWduYXR1cmUAODBlYWU1 MjljOTRhN2Y0N2RlY2NmYWRhMjhhY2I5ZGblb7ENAAAADnRFWHRQYWdlADEyeDEyKzArMIRtu30A AAAASUVORK5CYII= Parameterize the Converter using setProperty or setProperties . Note that specifying property outputEncoding is really useful only in the case of the RTF format. All the other formats are XML-based and thus, the default value of outputEncoding , generally UTF-8 , should work fine in all cases. iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAAB4SURBVHja JU6rFcNADBM09BqBhl6ltDCwKxQeDOwKB7tGYGCoYaChK6cmlt7TD1W5uap/sgoVBnEXWBTSoOdx 7gpLDOAVorWC0ABdcBPqwZtx8Muf+DPXJpQ96Nu/LSMYl/n17oCOnplTOrpiwW3sUs4ZJmob5/wA Ubg1Y/zrjUwAAABDdEVYdFNvZnR3YXJlAEAoIylJbWFnZU1hZ2ljayA0LjIuOCA5OS8wOC8wMSBj cmlzdHlAbXlzdGljLmVzLmR1cG9udC5jb22RuiG4AAAAKnRFWHRTaWduYXR1cmUAODBiYmRhMjcy NmRkYWNlOGFiOGEwMWY1OWRlMmViZGII/Q51AAAADnRFWHRQYWdlADEyeDEyKzArMIRtu30AAAAA SUVORK5CYII= Specify the input source of the Converter by the means of a SAX InputSource object. Here we use the most high-level specification: we specify an URL. In production, you'll generally specify an InputStream or a Reader . Note that when you'll specify an InputStream or a Reader , the Converter will not automatically close it at the end of the conversion. You'll have to do that yourself. The rule here is: the code which has opened an InputStream or a Reader has the responsibility to close it. iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAABzSURBVHja HY0hEoUwEEMjkZVYZGVlr1CJxCKRXKPyy28reyVsZeXKsCFi573ZzAQk+x5jaQ6gFQAxIA8XceEN ZEN3DkOCH/TobUoSVuAYwSSLyzbvaHWVFJxUmmp+PF+twrLkuXzLwPmZ8+OjtH8KS6pGvuoGNo5b 6rzDAAAAQ3RFWHRTb2Z0d2FyZQBAKCMpSW1hZ2VNYWdpY2sgNC4yLjggOTkvMDgvMDEgY3Jpc3R5 QG15c3RpYy5lcy5kdXBvbnQuY29tkbohuAAAACp0RVh0U2lnbmF0dXJlADlmODJmY2FjOWUwMzlj YmRiNzIzODBhNDU5MTMyNGY1gLv4dgAAAA50RVh0UGFnZQAxMngxMiswKzCEbbt9AAAAAElFTkSu QmCC Specify the output destination of the Converter by the means of a OutputDestination object. Here we use the most high-level specification: we specify an File . In production, you'll generally specify an OutputStream or a Writer . As explained before, when you'll specify an OutputStream or a Writer , the Converter will not automatically close it at the end of the conversion. Tip Do not use OutputDestination.setEncoding to specify the encoding of the output of the Converter . Using property outputEncoding is much easier to spot. iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAAB2SURBVHja FY6hEcQwDAQPChqGGhoaqgWX8PUYBhqGBn4rX0JooKDh/UlsZ3b2BJKXH8XPTYLh1lpt1h+BwxkR A23jhsCQd2IkfH9T3HEkzPFegCXUKSUSpJUPsN7UFOgc9VkZUBoz9l0yrVHZarUcJZeb9XznDyNb Ny9CX3/7AAAAQ3RFWHRTb2Z0d2FyZQBAKCMpSW1hZ2VNYWdpY2sgNC4yLjggOTkvMDgvMDEgY3Jp c3R5QG15c3RpYy5lcy5kdXBvbnQuY29tkbohuAAAACp0RVh0U2lnbmF0dXJlAGZlNjkwNDYzMzc5 ZWIyNWU1NjJmY2M4Y2M5YjNjN2Uw37I5ngAAAA50RVh0UGFnZQAxMngxMiswKzCEbbt9AAAAAElF TkSuQmCC Perform the conversion by invoking Converter.convert . 3. Converting an XML document to RTF This second sample consists in three steps: Compile the XSLT style sheet for all subsequent uses. Invoke the XSLT engine to convert the input XML document to XSL-FO. Invoke XMLmind XSL-FO Converter to convert the temporary XSL-FO file generated by second step to RTF. Excerpts of samples/java/Sample2.java : import javax.xml.transform.TransformerFactory; import javax.xml.transform.Transformer; import javax.xml.transform.Templates; import javax.xml.transform.stream.StreamSource; import javax.xml.transform.stream.StreamResult; import org.xml.sax.InputSource; import com.xmlmind.fo.converter.OutputDestination; import com.xmlmind.fo.converter.Converter; ... TransformerFactory factory = TransformerFactory.newInstance(); Templates compiledStylesheet = factory.newTemplates(new StreamSource(xslFile)); iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAABjSURBVHja VY6xDcAwCAS/pPQaLim9QmajdOk2I2SNrMEIlARIoigU8Cek/4e7zdHaWOYOVwaoA6wOCw05Y7FB gE0tIWQ+sBcwKM8qoD/wB5wGL8hjfdzWrh01GRp1hInGjDoXwHgsFuzBVLQAAABDdEVYdFNvZnR3 YXJlAEAoIylJbWFnZU1hZ2ljayA0LjIuOCA5OS8wOC8wMSBjcmlzdHlAbXlzdGljLmVzLmR1cG9u dC5jb22RuiG4AAAAKnRFWHRTaWduYXR1cmUANThhMDcyZTA3MGRhMjJmNjEzNWNiZDNlNDE0NTQ2 ZjloaiHtAAAADnRFWHRQYWdlADEyeDEyKzArMIRtu30AAAAASUVORK5CYII= Transformer transformer = compiledStylesheet.newTransformer(); foFile = File.createTempFile("sample2_", ".fo"); transformer.transform(new StreamSource(xmlFile), iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAAB7SURBVHja HY6hFcMwDEQ/NDQsNSwU9Apdo7Cw0CsIBoZmhKzQEQJLDQsFVclHpHu693W429Zr7bu541Pg3kCm Y0K75u9TEUPhuGgWU4mQDvieEaSQEnsT6zKPeZY0EUNtrHMCXvYUuSUg0PsMjUSvpysUT6OOSil9 izp/VNk1YJ8vf6MAAABDdEVYdFNvZnR3YXJlAEAoIylJbWFnZU1hZ2ljayA0LjIuOCA5OS8wOC8w MSBjcmlzdHlAbXlzdGljLmVzLmR1cG9udC5jb22RuiG4AAAAKnRFWHRTaWduYXR1cmUAODBlYWU1 MjljOTRhN2Y0N2RlY2NmYWRhMjhhY2I5ZGblb7ENAAAADnRFWHRQYWdlADEyeDEyKzArMIRtu30A AAAASUVORK5CYII= new StreamResult(foFile)); Converter converter = new Converter(); iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAAB4SURBVHja JU6rFcNADBM09BqBhl6ltDCwKxQeDOwKB7tGYGCoYaChK6cmlt7TD1W5uap/sgoVBnEXWBTSoOdx 7gpLDOAVorWC0ABdcBPqwZtx8Muf+DPXJpQ96Nu/LSMYl/n17oCOnplTOrpiwW3sUs4ZJmob5/wA Ubg1Y/zrjUwAAABDdEVYdFNvZnR3YXJlAEAoIylJbWFnZU1hZ2ljayA0LjIuOCA5OS8wOC8wMSBj cmlzdHlAbXlzdGljLmVzLmR1cG9udC5jb22RuiG4AAAAKnRFWHRTaWduYXR1cmUAODBiYmRhMjcy NmRkYWNlOGFiOGEwMWY1OWRlMmViZGII/Q51AAAADnRFWHRQYWdlADEyeDEyKzArMIRtu30AAAAA SUVORK5CYII= converter.setProperty("outputFormat", "rtf"); converter.setProperty("outputEncoding", "Cp1252"); converter.setProperty("imageResolution", "72"); converter.setProperty("baseURL", xmlFile.toURI().toASCIIString()); iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAABzSURBVHja HY0hEoUwEEMjkZVYZGVlr1CJxCKRXKPyy28reyVsZeXKsCFi573ZzAQk+x5jaQ6gFQAxIA8XceEN ZEN3DkOCH/TobUoSVuAYwSSLyzbvaHWVFJxUmmp+PF+twrLkuXzLwPmZ8+OjtH8KS6pGvuoGNo5b 6rzDAAAAQ3RFWHRTb2Z0d2FyZQBAKCMpSW1hZ2VNYWdpY2sgNC4yLjggOTkvMDgvMDEgY3Jpc3R5 QG15c3RpYy5lcy5kdXBvbnQuY29tkbohuAAAACp0RVh0U2lnbmF0dXJlADlmODJmY2FjOWUwMzlj YmRiNzIzODBhNDU5MTMyNGY1gLv4dgAAAA50RVh0UGFnZQAxMngxMiswKzCEbbt9AAAAAElFTkSu QmCC InputSource src = new InputSource(foFile.toURI().toASCIIString()); OutputDestination dst = new OutputDestination(rtfFile.getPath()); converter.convert(src, dst); iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAAB2SURBVHja FY6hEcQwDAQPChqGGhoaqgWX8PUYBhqGBn4rX0JooKDh/UlsZ3b2BJKXH8XPTYLh1lpt1h+BwxkR A23jhsCQd2IkfH9T3HEkzPFegCXUKSUSpJUPsN7UFOgc9VkZUBoz9l0yrVHZarUcJZeb9XznDyNb Ny9CX3/7AAAAQ3RFWHRTb2Z0d2FyZQBAKCMpSW1hZ2VNYWdpY2sgNC4yLjggOTkvMDgvMDEgY3Jp c3R5QG15c3RpYy5lcy5kdXBvbnQuY29tkbohuAAAACp0RVh0U2lnbmF0dXJlAGZlNjkwNDYzMzc5 ZWIyNWU1NjJmY2M4Y2M5YjNjN2Uw37I5ngAAAA50RVh0UGFnZQAxMngxMiswKzCEbbt9AAAAAElF TkSuQmCC ... iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAABjSURBVHja VY6xDcAwCAS/pPQaLim9QmajdOk2I2SNrMEIlARIoigU8Cek/4e7zdHaWOYOVwaoA6wOCw05Y7FB gE0tIWQ+sBcwKM8qoD/wB5wGL8hjfdzWrh01GRp1hInGjDoXwHgsFuzBVLQAAABDdEVYdFNvZnR3 YXJlAEAoIylJbWFnZU1hZ2ljayA0LjIuOCA5OS8wOC8wMSBjcmlzdHlAbXlzdGljLmVzLmR1cG9u dC5jb22RuiG4AAAAKnRFWHRTaWduYXR1cmUANThhMDcyZTA3MGRhMjJmNjEzNWNiZDNlNDE0NTQ2 ZjloaiHtAAAADnRFWHRQYWdlADEyeDEyKzArMIRtu30AAAAASUVORK5CYII= Compile the XSLT style sheet. About the thread safety of XMLmind XSL-FO Converter A Converter instance must not be shared by different threads. In the above code, only the Templates object can be shared between different threads. Transformer and Converter instances cannot. iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAAB7SURBVHja HY6hFcMwDEQ/NDQsNSwU9Apdo7Cw0CsIBoZmhKzQEQJLDQsFVclHpHu693W429Zr7bu541Pg3kCm Y0K75u9TEUPhuGgWU4mQDvieEaSQEnsT6zKPeZY0EUNtrHMCXvYUuSUg0PsMjUSvpysUT6OOSil9 izp/VNk1YJ8vf6MAAABDdEVYdFNvZnR3YXJlAEAoIylJbWFnZU1hZ2ljayA0LjIuOCA5OS8wOC8w MSBjcmlzdHlAbXlzdGljLmVzLmR1cG9udC5jb22RuiG4AAAAKnRFWHRTaWduYXR1cmUAODBlYWU1 MjljOTRhN2Y0N2RlY2NmYWRhMjhhY2I5ZGblb7ENAAAADnRFWHRQYWdlADEyeDEyKzArMIRtu30A AAAASUVORK5CYII= Transform the XML input file to a temporary output file created in the system-dependant temporary file directory (e.g. /tmp on Unix). iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAAB4SURBVHja JU6rFcNADBM09BqBhl6ltDCwKxQeDOwKB7tGYGCoYaChK6cmlt7TD1W5uap/sgoVBnEXWBTSoOdx 7gpLDOAVorWC0ABdcBPqwZtx8Muf+DPXJpQ96Nu/LSMYl/n17oCOnplTOrpiwW3sUs4ZJmob5/wA Ubg1Y/zrjUwAAABDdEVYdFNvZnR3YXJlAEAoIylJbWFnZU1hZ2ljayA0LjIuOCA5OS8wOC8wMSBj cmlzdHlAbXlzdGljLmVzLmR1cG9udC5jb22RuiG4AAAAKnRFWHRTaWduYXR1cmUAODBiYmRhMjcy NmRkYWNlOGFiOGEwMWY1OWRlMmViZGII/Q51AAAADnRFWHRQYWdlADEyeDEyKzArMIRtu30AAAAA SUVORK5CYII= Create and parameterize a Converter object as explained in Section 2, “Converting an XSL-FO file to RTF” . iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAABzSURBVHja HY0hEoUwEEMjkZVYZGVlr1CJxCKRXKPyy28reyVsZeXKsCFi573ZzAQk+x5jaQ6gFQAxIA8XceEN ZEN3DkOCH/TobUoSVuAYwSSLyzbvaHWVFJxUmmp+PF+twrLkuXzLwPmZ8+OjtH8KS6pGvuoGNo5b 6rzDAAAAQ3RFWHRTb2Z0d2FyZQBAKCMpSW1hZ2VNYWdpY2sgNC4yLjggOTkvMDgvMDEgY3Jpc3R5 QG15c3RpYy5lcy5kdXBvbnQuY29tkbohuAAAACp0RVh0U2lnbmF0dXJlADlmODJmY2FjOWUwMzlj YmRiNzIzODBhNDU5MTMyNGY1gLv4dgAAAA50RVh0UGFnZQAxMngxMiswKzCEbbt9AAAAAElFTkSu QmCC Setting the baseURL property to the URL of the XML input file is really needed in our case: If the XML input file references graphics files using relative URLs (example: images/screenshot1.png ), then the generated XSL-FO file is likely to contain fo:external-graphic objects referencing the same graphics files using the same relative URLs. The problem is that, in our case, the XSL-FO file is not generated in the same directory as the XML input file. Therefore, without the baseURL property, these relative URLs would be resolved incorrectly by XMLmind XSL-FO Converter. An advanced alternative to specifying a baseURL property, is to specify an UriResolver object using Converter.setUriResolver . iVBORw0KGgoAAAANSUhEUgAAAAwAAAAMCAAAAABzHgM7AAAAAmJLR0QAAKqNIzIAAAB2SURBVHja FY6hEcQwDAQPChqGGhoaqgWX8PUYBhqGBn4rX0JooKDh/UlsZ3b2BJKXH8XPTYLh1lpt1h+BwxkR A23jhsCQd2IkfH9T3HEkzPFegCXUKSUSpJUPsN7UFOgc9VkZUBoz9l0yrVHZarUcJZeb9XznDyNb Ny9CX3/7AAAAQ3RFWHRTb2Z0d2FyZQBAKCMpSW1hZ2VNYWdpY2sgNC4yLjggOTkvMDgvMDEgY3Jp c3R5QG15c3RpYy5lcy5kdXBvbnQuY29tkbohuAAAACp0RVh0U2lnbmF0dXJlAGZlNjkwNDYzMzc5 ZWIyNWU1NjJmY2M4Y2M5YjNjN2Uw37I5ngAAAA50RVh0UGFnZQAxMngxMiswKzCEbbt9AAAAAElF TkSuQmCC Perform the conversion by invoking Converter.convert . Integrating XMLmind XSL-FO Converter in your application Integrating XMLmind XSL-FO Converter in your application Chapter 5. Support of the XSL-FO v1.0 standard 1. Features XFC preserves the structure of source documents, as well as most of the presentation information. Below is a list of key features of XFC. Paragraph attributes Most paragraph attributes (e.g. indentation) are supported. Vertical spacing is handled reasonably in most cases. Font attributes Most font attributes (family, size, weight, etc) are supported. Lists Both bulleted and numbered lists are supported. XFC tries to infer the numbering style from the label of the first list item. If the numbering style cannot be recognized list items are output as plain paragraphs. Nested lists are supported. Tables XFC supports both the fixed and automatic table layout, as well as the two border models defined in the W3C recommendation. The implementation of the collapsing border model does not strictly conforms to the CSS2 specification, but should give the expected result in most cases. Images Image support is achieved through the use of external converter classes. XFC comes with a simple converter class that supports the GIF, JPEG and PNG formats. Image scaling is supported. Headers and footers static-content elements associated with the before and after regions are converted to page headers and footers respectively. Page references Page references ( page-number-citation elements) are supported. Hypertext links Both internal and external links are supported. For a complete list of supported objects/properties, see the conformance statement . In addition, XFC supports an XSL-FO extension to generate structured document tags (SDTs) in an Office Open XML document. This extension makes it possible to produce simple forms that can be loaded and filled in MS-Word 2007. 2. Limitations Though XFC implements the greater part of the W3C recommendation, it does not support all XSL-FO features. Below is a list of the current major limitations of XFC. The leader element is only partly supported. The instream-foreign-object element is not supported. The float and marker elements are not supported. The writing-mode property is not supported (value lr-tb is assumed). The conformance level of XFC may be improved in future versions, however it must be stressed that a full conformance cannot be achieved due to the own limitations of its output formats. 3. Conformance statement The W3C Extensible Stylesheet Language (XSL) v1.0 Recommendation defines three levels of conformance for an XSL-FO processor: basic, extended and complete. Since XMLmind XSL-FO Converter currently does not conform to any of these levels, this document provides a complete list of supported objects/properties, along with additional information for objects/properties that are not fully supported. In the following tables, the background color (white, light grey or dark grey) of each entry in the tables below indicates the level of conformance (basic, extended or complete) of that particular object/property, as specified by the Recommendation. Object Supported Comments Declarations and Pagination and Layout Formatting Objects root yes   declarations no   color-profile no   page-sequence yes   layout-master-set yes   page-sequence-master yes   single-page-master-reference yes   repeatable-page-master-reference yes   repeatable-page-master-alternatives yes   conditional-page-master-reference yes Limited support. See Section 4.5, “Multiple page layouts” for further information. simple-page-master yes   region-body yes   region-before yes   region-after yes   region-start no Output format limitation. region-end no Output format limitation. flow yes   static-content yes Supported regions: body, before and after. title no   Block-level Formatting Objects block yes Not supported inside inline-level objects (output format limitation). block-container no Treated like a block object. Inline-level Formatting Objects bidi-override no   character no   initial-property-set no   external-graphic yes Supported image formats: GIF, JPEG and PNG. instream-foreign-object no   inline yes   inline-container no   leader yes Limited support (most properties ignored). See Section 4.2, “Leaders” for further information. page-number yes   page-number-citation yes   Formatting Objects for Tables table-and-caption yes Not supported inside inline-level objects (output format limitation). table yes table-column yes   table-caption yes   table-header yes   table-footer yes   table-body yes   table-row yes   table-cell yes   Formatting Objects for Lists list-block yes Not supported inside inline-level objects (output format limitation). list-item yes   list-item-body yes   list-item-label yes Multiple block-level descendants not supported. Link and Multi Formatting Objects basic-link yes Can only contain text and inline-level objects. multi-switch no   multi-case no   multi-toggle no   multi-properties no   multi-property-set no   Out-of-line Formatting Objects float no   footnote yes   footnote-body yes   Other Formatting Objects wrapper yes   marker no   retrieve-marker no   Property Supported Comments Common Accessibility Properties source-document no   role no   Common Absolute Position Properties absolute-position no   top no   right no   bottom no   top no   Common Aural Properties azimuth n/a   cue-after n/a   cue-before n/a   elevation n/a   pause-after n/a   pause-before n/a   pitch n/a   pitch-range n/a   play-during n/a   richness n/a   speak n/a   speak-header n/a   speak-numeral n/a   speak-punctuation n/a   speech-rate n/a   stress n/a   voice-family n/a   volume n/a   Common Border, Padding and Background Properties background-attachment no   background-color yes   background-image no   background-repeat no   background-position-horizontal no   background-position-vertical no   border-before-color yes Not supported on block-level objects that contain other block-level objects (output format limitation). Not supported on inline objects that contain other objects (output format limitation). border-before-style yes border-before-width yes border-after-color yes border-after-style yes border-after-width yes border-start-color yes border-start-style yes border-start-width yes border-end-color yes border-end-style yes border-end-width yes border-top-color yes Not supported on block-level objects that contain other block-level objects (output format limitation). Not supported on inline objects that contain other objects (output format limitation). border-top-style yes border-top-width yes border-bottom-color yes border-bottom-style yes border-bottom-width yes border-left-color yes border-left-style yes border-left-width yes border-right-color yes border-right-style yes border-right-width yes padding-before yes Not supported on block-level objects that contain other block-level objects (output format limitation). Not supported together with border-*-style="none" or border-*-style="hidden" (output format limitation). padding-after yes padding-start yes padding-end yes padding-top yes Not supported on block-level objects that contain other block-level objects (output format limitation). Not supported together with border-*-style="none" or border-*-style="hidden" (output format limitation). padding-bottom yes padding-left yes padding-right yes Common Font Properties font-family yes   font-selection-strategy no   font-size yes   font-stretch no   font-size-adjust no   font-style yes Value backslant not supported (output format limitation). font-variant yes   font-weight yes   Common Hyphenation Properties country no   language no   script no   hyphenate no   hyphenation-character no   hyphenation-push-character-count no   hyphenation-remain-character-count no   Common Margin Properties - Block margin-top yes Percentages and value auto not supported. margin-bottom yes margin-left yes margin-right yes space-before yes Conditionality not supported. space-after yes start-indent yes Percentages not supported. end-indent yes Common Margin Properties - Inline space-end no   space-start no   Common Relative Position Properties relative-position no   Area Alignment Properties alignment-adjust no   alignment-baseline no Values middle , before-edge and after-edge supported on external-graphic objects. baseline-shift yes   display-align no Supported on table-cell and external-graphic objects. dominant-baseline no   relative-align no   Area Dimension Properties block-progression-dimension no Supported on table-row and external-graphic objects. content-height yes   content-width yes   height no Supported on table-row and external-graphic objects.