Chapter 3. Command-line executables

Format of the output file: rtf, wml, docx or odt. Default: rtf. Note that command-line utility fo2wml automatically sets outputFormat to wml, fo2docx automatically sets outputFormat to docx and fo2odt automatically sets outputFormat to odt.

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

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.

Image scaling policy. true or false. Default: false.

Specify prescaleImages=true to minimize output document size. By default (prescaleImages=false), the original size of images is preserved and scaling directives are inserted in the output document.

Note that:

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: "-genericFontFamilies=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.

Sets parameter parameter_name on graphic factory called graphic_factory_name (case-insensitive). A graphic factory is a software component in charge of processing one or more graphic formats. Examples of such graphic factories: ImageIO, WMF, EMF, SVG, MathML. Only few graphic factories may be parameterized this way.

Examples:

-set.svg.resolution=300
-set.MathML.mathsize=11
-set.mathml.resolution=300

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 set to true to force a single-sided page layout.

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).

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.10, “Special support for East Asian fonts”.

Syntax:

map -> entry [',' entry]*

entry -> east_asian_family '=' western_family

Example: "-eastAsiaFontFamilies=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".

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

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.

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

Default value: 96.

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.

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.

Boolean (false or true) specifying whether images contained in Office Open XML (.docx) files should be represented using the deprecated VML markup rather than the DrawingML markup.

Default: false.

Value: MS-Word_major_version [ strict ]?. Examples: 14, 15, 15strict.

Marks generated DOCX files as being compatible with MS-Word having specified major version. Any major version other than 14 (MS-Word 2010), 15 (MS-Word 2013), 16 (MS-Word 2016) is currently ignored.

Moreover suffix "strict" (supported only when MS-Word_major_version >= 15) may be used to generate DOCX files marked as being "Strict Open XML".

Default: None. The generated DOCX files are not marked as being compatible with a specific version of MS-Word.

	Specifying -docx.variant=15 suppresses the "[Compatibility Mode]" text appearing in the title bar of MS-Word 2013 and 2016.

	Specifying -docx.variant=15 does not prevent the generated DOCX file from being opened in MS-Word 2007 and 2010. However specifying -docx.variant=15strict generates "Strict Open XML" files which are not supported by MS-Word 2007 and 2010.

Specifies whether input JPEG and SVG graphics should be converted to PNG in the output file.

true or false. Default: true. If false, 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 -detectLists=false 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.

Specifies a metadata to be added to the document information section of the generated document. More information in Section 4.7, “Adding metadata to the documents created by XFC”.

Examples: "-meta.lastModifiedBy=john@acme.com", "-meta.xfc:final=true".

Specifies how the generated document is to be restricted in terms of editing and/or formatting. Restrictions syntax is:

'unrestricted' | 'limited-formatting' |
('read-only'|'comments-only'|'fill-forms-only'|'tracked-changes-only' 
 [ '+limited-formatting' ]?)

Examples: "-protection=comments-only", "-protection=limited-formatting", "-protection=tracked-changes-only+limited-formatting".

Use "" or "unrestricted" to discard any existing edit restriction. More information in Section 4.8, “Restricting editing in the documents created by XFC”.

This clear text password lets the user of the word processor remove the edit restrictions. By default, the document protection is not enforced using a password.

Use "" to discard any existing password. More information in Section 4.8, “Restricting editing in the documents created by XFC”.