Configuration

Xinc has a variety of configuration options. The Viewer will allow you to configure most options using a dialog type of interface. This dialog can be invoked by selecting 'File/Preferences' from the Viewer's menu. The viewer stores configuration information to an XML file called '.xincconfig.xml'. This file is usually located in your 'user.home' directory. (Typically 'Documents and Settings\UserName' in windows and '/home/UserName' in Linux) Please note that the Viewer will strip all comments and formatting out of this configuration file. The Viewer also maintains history and Viewer specific information in a separate file called '.xincui.properties'.

You can also manually edit and maintain your own Configurations. This is more typical if Xinc is being deployed in a server environment without the Viewer. A sample configuration file with comments is included with the product. It may be found in the 'config' subdirectory. The file is called 'SampleXincConfig.xml'.

Xinc configuration file (.xincconfig.xml)

UserAgent Section

This section specifies configurable values used by the layout engine. All numeric values represent points (1/72 of an inch) unless otherwise stated.

HyphenationCharacter

A single character which will be displayed when a word is hyphenated.

DefaultLineHeight

By default the height of a line will be set to this value times the current font size. The default value is 1.2.

BorderWidthThin

The thickness of a 'thin' border.

BorderWidthMedium

The thickness of a 'medium' border.

BorderWidthThick

The thickness of a 'thick' border.

DefaultFont

The default font name.

serif

The actual font to be used if the generic 'serif' font is specified in an XSL-FO document.

sans-serif

The actual font to be used if the generic 'sans-serif' font is specified in an XSL-FO document.

cursive

The actual font to be used if the generic 'cursive' font is specified in an XSL-FO document.

fantasy

The actual font to be used if the generic 'fantasy' font is specified in an XSL-FO document.

monospace

The actual font to be used if the generic 'monospace' font is specified in an XSL-FO document.

BaseUrl

The base URL to use when formatting a document and a base url can not be determined by any other means.

DefaultColor

The default foreground color.

PixelsPerInch

This value is used when lengths are specified in pixels and need to be converted to an absolute length in points.

DefaultImageDPI

This value is used to determine the height and width of images if a DPI value cannot be determined directly from the image.

DefaultPageWidth

The default page width in points.

DefaultPageHeight

The default page height in points.

FontSizeTable/XX_SMALL

The size in points of an XX_SMALL font.

FontSizeTable/X_SMALL

The size in points of an X_SMALL font.

FontSizeTable/SMALL

The size in points of an SMALL font.

FontSizeTable/MEDIUM

The size in points of a MEDIUM font.

FontSizeTable/LARGE

The size in points of a LARGE font.

FontSizeTable/X_LARGE

The size in points of an X_LARGE font.

FontSizeTable/XX_LARGE

The size in points of an XX_LARGE font.

RendererAwtPrint Section

This section of the configuration is optional. If specified, it is used to configure a printer. The javax.print.attribute.standard javadocs contain some additional details on these tags.

PrinterName

A string value indicating which printer to send output to.

job-name

A string value specifying the name of this print job

job-priority

An integer value between 1 and 100, with 100 specifying the highest priority.

requesting-username

A string value.

finishings

One of the following values:

none
bind
staple
saddle_stitch
edge_stitch
cover
staple_top_left
staple_bottom_left
staple_top_right
staple_bottom_right
edge_stitch_left
edge_stitch_top
edge_stitch_right
edge_stitch_bottom
staple_dual_left
staple_dual_top
staple_dual_right
staple_dual_bottom

orientation-requested

One of the following values:

portrait
landscape
reverse_landscape
reverse_portrait

copies

An integer value specifying the number of copies to print.

media-name

One of the following values:

iso_a4_white
iso_a4_transparent
na_letter_transparent
na_letter_white

media-size-name

One of the following values:

iso_a0
iso_a1
iso_a2
iso_a3
iso_a4
iso_a5
iso_a6
iso_a7
iso_a8
iso_a9
iso_a10
iso_b0
iso_b1
iso_b2
iso_b3
iso_b4
iso_b5
iso_b6
iso_b7
iso_b8
iso_b9
iso_b10
jis_b0
jis_b1
jis_b2
jis_b3
jis_b4
jis_b5
jis_b6
jis_b7
jis_b8
jis_b9
jis_b10
iso_c0
iso_c1
iso_c2
iso_c3
iso_c4
iso_c5
iso_c6
na_letter
na_legal
executive
ledger
tabloid
invoice
folio
quarto
japanese_postcard
japanese_double_postcard
a
b
c
d
e
iso_designated_long
italy_envelope
monarch_envelope
personal_envelope
na_number_9_envelope
na_number_10_envelope
na_number_11_envelope
na_number_12_envelope
na_number_14_envelope
na_6x9_envelope
na_7x9_envelope
na_9x11_envelope
na_9x12_envelope
na_10x13_envelope
na_10x14_envelope
na_10x15_envelope
na_5x7
na_8x10

media-tray

One of the following values:

bottom
envelope
large_capacity
main
manual
middle
side
top

number-up

An integer value specifying the number of pages to print on a single side of a sheet of paper. This may or may not be supported depending on your printer.

chromaticity

One of the following values:

monochrome
color

fidelity

One of the following values:

fidelity_true
fidelity_false

page-ranges

A set of integer ranges. For example: '1-5, 20-25' would indicate pages 1 through 5 and pages 20 through 25.

presentation-direction

One of the following values:

tobottom_toleft
tobottom_toright
toleft_tobottom
toleft_totop
toright_tobottom
toright_totop
totop_toleft
totop_toright

print-quality

One of the following values:

normal
draft
high

sheet-collate

One of the following values:

uncollated
collated

sides

One of the following values:

duplex
one_sided
tumble
two_sided_long_edge
two_sided_short_edge

destination

A valid URI. For example: 'http://something.com/printer1'.

Java System properties

Several Java System properties may be set which alter Xinc's default behaviour. If you wish to use any of the properties described below, they will need to be set in your batch or shell script. If you are using Xinc.exe or XincUI.exe (the Viewer), you will need to set these properties by editing the Xinc.lax or the XincUI.lax files.

To set a property, edit your batch or shell script to look like this:
java -DPropertyName=PropertyValue ...

For example, if you want to manually specify a configuration file for Xinc you can setup your batch or shell file like this:
java -Dxinc.config.filename=/tmp/xinc/CustomizedXincConfiguration.xml ...

xinc.config.home
This property specifies the directory where Xinc configuration files are located. If this property is not set, the default directory will be the 'user.home' directory as described above.

xinc.config.filename
This property specifies the complete path and file name of the Xinc configuration file. If this property is not set, the default file name will be '.xincconfig.xml' and the directory will be determined as described for 'xinc.config.home'.

xinc.config.uifilename
This property specifies the complete path and file name of the Xinc Viewer's history file. If this property is not set, the default file name will be '.xincui.properties' and the directory will be determined as described for 'xinc.config.home'.

xinc.licensefile
If defined, this property specifies the path and filename for the Xinc license file. If this property is not set, the default filename will be 'XincLicense.xml' and the directory will be the 'xinc.config.home' directory as described above.