Chapter 3. Command-line executables

About Evaluation Edition

Do not be surprised because XMLmind XSL-FO Converter Evaluation Edition generates output containing random duplicate letters. Of course, this does not happen with Professional Edition!

Four command-line executables are provided: fo2rtf, fo2wml, fo2docx and fo2odt, to convert an XSL-FO file to RTF, WML, Open XML (.docx) and OpenDocument (.odt) 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. Available options are described below.

Commonly used options:

/e encoding

Specifies the output encoding. Supported values depend on the target output format:

  • For RTF output, supported encodings are US-ASCII, windows-1250 (Windows Eastern European), windows-1251 (Windows Cyrillic) and windows-1252 (Windows Latin-1). The default value is windows-1252.

  • For WML output, all the encodings available in the runtime are supported. The default value is windows-1252 (Windows Latin-1).

  • For Open XML output (.docx), supported encodings are UTF-8 and UTF-16. The default value is UTF-8.

  • For OpenDocument output (.odt), all the encodings available in the runtime are supported. The default value is UTF-8.

/r DPI

Default image resolution in DPI. A positive integer. Used to compute the intrinsic size of an image, but only when an image file does not contain resolution or absolute size information.

Default value: 96.

/pi

Prescale images to minimize output document size. By default, the original size of images is preserved and scaling directives are inserted in the output document.

Note that:

  • This option will never create an image which has larger dimensions than the original image. It can only create an image which has smaller dimensions than the original image.

  • The /pi option is honored only for true raster graphics. Vector graphics (WMF, EMF) are never prescaled. Pre-rasterized vector graphics (SVG, MathML) are always prescaled (by the competent renderer, e.g. Batik or JEuclid, not by XMLmind XSL-FO Converter itself).

/f map

May be used to map the generic font families serif, sans-serif, monospace, fantasy and cursive to actual font families.

Syntax:

map -> entry [',' entry]*

entry -> generic_family '=' actual_family

generic_family -> 'serif' | 'sans-serif' | 'monospace'
                  | 'cursive' | 'fantasy'

Example: /f "fantasy=Impact,cursive=Comic Sans MS".

The default mapping depends on the output format: the generic font families serif, sans-serif, monospace are mapped to "Times New Roman", Arial, "Courier New" for RTF, WML and Open XML (.docx) and to "DejaVu Serif", "DejaVu Sans", "DejaVu Sans Mono" for OpenDocument (.odt).

Note that by default, generic font families fantasy and cursive are not mapped.

/s

Specifies single-sided page layout. By default RTF, WML and Open XML (.docx) output documents are given a double-sided page layout regardless of the input document properties. This option may be used to force a single-sided page layout.

/sty URL_or_filename

Specifies the location of an XML file containing the set of user styles to be used during the conversion. More information about user styles in Chapter 6, XSL-FO extension for generating named styles.

This location is an URL in its string form (e.g. "file:///C:/My%20Folder/styles.xfc") or a filename (e.g. "C:\My Folder\styles.xfc"). A relative filename is relative to the current working directory.

The XML file must conform to the styles.xsd schema.

By default, XMLmind XSL-FO Converter generates only direct formatting (RTF, WordprocessingML, .docx) or automatic styles (.odt).

Rarely used options:

/eaf map

May be used to map East Asian font families to Western font families. Such East Asian fonts are used to render mainly CJK (Chinese Japanese Korean) text, possibly mixed with Western text. More information in Section 4.8, “Special support for East Asian fonts”.

Syntax:

map -> entry [',' entry]*

entry -> east_asian_family '=' western_family

Example: /eaf "MS UI Gothic=Times New Roman,Meiryo=Calibri".

For compatibility with previous versions of XMLmind XSL-FO Converter, the default value of this property is "Arial Unicode MS=Arial".

Important

This property is supported by the ODT, WML and DOCX output formats, but not by the RTF output format.

/l

List supported encodings.

/rr DPI

Default image resolution in DPI. A positive integer. Used to compute the intrinsic size of an image, according to the image renderer (that is, MS-Word or OpenOffice), when an image file does not contain resolution or absolute size information.

The default value depends on the output format. Generally 96. It is strongly recommended to use this default value.

/sr DPI

Screen resolution in DPI. A positive integer. Used to convert px lengths to other units (in, mm, cm, pt, etc).

Default value: 96.

/b URL

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.

/w

Specifies MS-Word as target RTF viewer. 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 used, XFC will swap top and left padding values in table cells to work around this bug.

/vml

Specifies that images contained in Office Open XML (.docx) files must be represented using the deprecated VML markup rather than the DrawingML markup.

By default, images contained in Office Open XML (.docx) files are represented using DrawingML markup.

/png

Specifies that input JPEG images must be converted to PNG in the output file.

/nolist

Do not attempt to create proper lists by inferring the numbering style of the list from the label of its first item. (By default, XFC attempts to create proper lists by inferring he numbering style of the list from the label of its first item.)

Note that even when this option is used, it's still possible to instruct XFC to create proper lists by specifying extension attribute xfc:label-format in the XSL-FO input file.