Chapter 12. Support file formats

1. stdfonts.config
1.1. Properties and Values
1.2. File structure
1.3. Matching Algorithm
2. Custom Encodings
2.1. How it works
2.2. Associating a Font with an Encoding
2.3. File format
3. base.css
4. XML Catalog

1. stdfonts.config

RTF files need to specify which encoding a font to be used is using and what properties it has. This is used by a rendering application to determine the best matching font on a platform where the exact specified font is not available. Additionally, the encoding a font is in is used by the rendering application to correctly interpret the characters found in the RTF file. Since you currently can only specify the font family name in the CSS2, downCast needs a mapping table of font names to their respective font encoding and properties.

This is what the stdfonts.config file is for. downCast comes with a default file embedded in the application JAR. You may extend and/or override it by providing a custom stdfonts.config file, to be located in the application's support directory in the Encodings directory. Here, you can specify standard font properties based on the font name.

downCast currently does not support the CSS3 Module: Web Fonts, nor does our upCast companion application as a possible data generating source.

stdfonts.config can be found at the following location in the package hierarchy in the downcast.jar JAR file:

/de/infinityloop/resources/config/stdfonts.config

You can modify this file to your liking and requirements, or supply on override file in the location mentioned above. Follows an informal description of the file format and the necessary properties, followed by the search algorithm used by downCast to find the properties for a given font in a CSS rule.

1.1. Properties and Values

The following special properties are used in the stdfonts.config file:

1.1.1. -ilx-rtf-font-family

Determines the general RTF font family a font belongs to based on its design. An RTF rendering application will use this information to find a font with similar appearance when an exact match cannot be found.

Supported values: roman, swiss, symbol, modern, script, decor, tech, bidi

1.1.2. -ilx-codepage

This indicates the Windows codepage the font uses for its encoding.

Supported values: codepageAsInteger, -1, 10000, 32001, 32002, 32004

The special values have the following meaning:

-1

Uses the default encoding. This is the best choice for normal fonts.

10000

Identifies the Mac Roman encoding.

32001

Identifies the standard encoding of the Symbol font.

32002

Identifies the encoding of the Wingdings font.

32004

Identifies the encoding of the Zapf Dingbats font.

1.2. File structure

The file structure is line based. Each line identifies a set of font names with a set of properties:

fontlist ::= propertyset
fontlist ::= font ( ', ' font)*
font ::= fontname | '"' fontname '"'
propertyset ::= '\-ilx-rtf-font-family: ' ffval '; \-ilx-codepage: ' [0-9]+ ';'
ffval ::= 'roman' | 'swiss' | 'symbol' | 'modern' | 'script' | 'decor' | 'tech' | 'bidi'
fontname ::= name of font

Note

Note that you must use CSS style escapes (or numerical character entities of the form &#...;) to generate Unicode characters for specifying font names using characters outside the ASCII range. Examples for this can be seen in the file packaged default stdfonts.config file.

All lines starting with // denote a comment line, as do empty lines.

1.3. Matching Algorithm

To avoid having to explicitly define every font in the stdfonts.config file which might ever occur in a stylesheet, downCast employs a multi-stage search algorithm for a matching property definition entry as follows:

First, a potentially existing user supplied stdfonts.config is prepended to the default one supplied by downCast. Within this concatenated, big file, the following search algorithm is employed:

  1. A search for the exact name (considering case) is performed. The first matching entry is is used if it exists.

  2. A search for the exact name, but ignoring case, is performed. The first matching entry is is used if it exists.

  3. A search for a font name is performed that matches the start of the actual name. So if the characteristics for "Univers Bold" are requested, and there is an entry "Univers" in stdfonts.config, then its properties are used. Case is ignored.

  4. A search for a font name is performed that is contained in the actual name. So if the characteristics for "L Univers 44" are requested, and there is an entry "Univers" in stdfonts.config, then its properties are used because the string "Univers" is contained in the actual font name. Case is ignored.

2. Custom Encodings

2.1. How it works

downCast comes complete with virtually all default encodings you can use in RTF resp. Word, including many two-byte ones. This means that normally, you do not need to provide a custom encoding.

The default encodings are hard-coded with optimizations done for each specific encoding to provide efficient access, since the mapping functions are called for each character that passes through downCast. These default encodings are therefore not directly user-accessable. However, there are sometimes occasions where you'll need to use a custom encoding, especially when you are using custom fonts.

downCast provides a custom encoding loader and handler which lets you specify your own mappings from character codepoint in the font to Unicode by means of a simple text file. Both, one-byte and two-byte encodings can be specified in this way.

To create a custom encoding, you need to create an ASCII text file with the extension .encoding which specifies both the mapping of the individual codepoints to Unicode and also states which codepage it implements. You can also give it a name for easily spotting it in the UI portions of the application. downCast looks for custom encoding files in the <application-support>/Encodings/ directory at startup. All encodings it finds are added to the internal set of default encodings. By specifying a codepage in a custom encoding that has a default equivalent, you may override any of the factory-supplied encodings.

Since the mapping is built on the fly, specific optimizations cannot be performed and the use of custom encodings may slow-down processing slightly.

Note

downCast automatically inverts the supplied encoding for mapping the incoming Unicode characters to the font's encoding. Please not that this can only work if the mapping is unambigous.

2.2. Associating a Font with an Encoding

A custom encoding per se is not tied to anything but the codepage it implements. To tie a codepage to a specific font, you need to extend or override the stdfonts.config file. In this mapping file, you simply list the font's name and associate it with a codepage using the keywords as described.

It is recommended to use codepage values greater than 40000 for custom encodings, as downCast will not use these codepages internally. Which you use for custom encodings is up to you. downCast reserves the range from 32000 to 35000 for internal use, so you should not use these. Also note that when you override a default encoding, every font that is specified to use that encoding will use the custom one.

2.3. File format

File names can be arbitrary, must however have an extension of .encoding. They should be placed into <application-support>/Encodings/ for downCast to scan and load them automatically at startup.

The file structure is simple: one mapping entry per line, and all lines starting with #, // or ; are treated as comments. To create a two-byte encoding, separate the two bytes by a comma.

A mapping entry has the form (notation similar to BNF):

mapping ::= <srcbyte> [',' <srcbyte>] '=' <unicodechar>

with:

srcbyte ::= hexNumber | decimalNumber
unicodechar ::= hexNumber | decimalNumber
hexNumber ::= ('0x' | '0X' | '$')[0-9A-Fa-f]+
decimalNumber ::= [0-9]+

Follows a rather silly example, which maps what in codepage 1252 fonts is a space to the at-sign:

@codepage 42001
@encodingname Silly Encoding
$20=$40

Options. Two special options are supported:

@codepage decimalNumber

This specifies the codepage this encoding represents.

You can specify either an existing encoding to override its definition, or create custom codepages for specific fonts, in which case you should choose codepage number higher than 40000.

@encodingname asciistring

This is a descriptive name for the encoding so you can easily spot it in downCast's UI.

Note

It is recommended to use codepage values greater than 40000 for custom encodings, as downCast will not use these codepages internally. Which you use for custom encodings is up to you.

downCast reserves the range from 32000 to 35000 for internal use, so you should not use these. Also note that when you override a default encoding, every font that is specified to use that encoding will use the custom one.

3. base.css

downCast provides a default stylesheet which specifies some common properties which are tedious to specify for each element. This stylesheet is bundled in the application JAR at the following package location:

/de/infinityloop/downcast/resources/config/base.css

If required, you may change it to your desire. It is the first stylesheet read for every document conversion. A typical sample base stylesheet is the following:

/*
 * The downCast Base (=User-) Stylesheet
 */

/*
 * Document page size and margins 
 */
@page DefaultPageStyle { 
  size: 210mm 297mm; /* A4 */
  margin-top: 1.0in; 
  margin-bottom: 0.7in; 
  margin-left: 1.0in; 
  margin-right: 1.0in; 
}

document {
  page: DefaultPageStyle;
  orphans: 2;
  widows: 2;
  \-ilx-footnote-style-type: decimal;
  \-ilx-footnote-numbering-policy: continuous;
  \-ilx-footnote-position: pagebottom;
  \-ilx-font-family-default: Times;
}

part {
  page-break-before: auto;
}

textbox {
  float: left;
  width: 3cm;
  height: 2cm;
  position: static;
  float: none;
  top: 0cm;
  left: 0cm;
  right: 0cm;
  bottom: 0cm;
  z-index: 0;
  border-style: none;
}

4. XML Catalog

downCast supports the use of a Catalog file. A Catalog file is basically a mapping definition between PUBLIC DTD identifiers and the location of a physical copy of that specific DTD (or more general, Entity). The application supports the Catalog file format as defined in

http://www.oasis-open.org/specs/tr9401.html

Catalog files need to reside in the Application Support folder and have the name catalog for downCast to be able to find and use them.

Note

upCast will ask you at first launch whether you want to install a default catalog file (if there isn't already one installed). It is highly recommended to have this default installed, as it places a copy of the upCast DTD locally on your machine and lets you validate the XML (upCast DTD) filter output without requiring an active connection to the internet.

During this initial procedure, you get also the choice to specify a different default XML Catalog to use by upCast. Choose the respective option in the presented dialog and pick the catalog using a standard file chooser.

You can also change the XML Catalog used by selecting Extras > Choose XML Catalog... any time during executing upCast.

Tip

You may wish to add an entry to the catalog for any custom DTD you're using as well and place a copy of it on your local machine to be able to validate input files that are fed into the XSLT processor. Such an entry might look like this (the XHTML 1.0 strict DTD):

PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "file:///localpath/to/xhtml1-strict.dtd"