HTML Configuration

Top  Previous  Next

 

When generating HTML documents, UnForm uses several configuration elements to structure the output.  Most of these are created in UnForm's parameter file, which is named "ufparam.txt".  Note that you can create a custom parameter file for your site that will not be overwritten during an update of UnForm by copying "ufparam.txt" to "ufparam.txc".  Then make any changes to the custom version.

 

A section in the configuration file headed by "[html]" controls HTML configuration.  It will look like this:

 

[html]

page=page.htm

toc=toc.htm

both=both.htm

frame=frame.htm

pagenum=Page number

imagelib=

imageurl=

complete=Report Complete

incomplete=Report not complete (reload page to view again)

 

The following table describes each parameter:

 

Element

Description

page=filename

toc=filename

both=filename

frame=filename

These elements point to HTML template files in UnForm's home directory.  These files are used by UnForm based on the style of output being generated.

 

To create custom templates for your site, you should copy each file to some other name, modify the file names identified in these four elements, and edit the templates for your needs.

 

See "HTML OUTPUT TEMPLATES", below, for more information.

colwidth=text

The default column cell width is text.  This can be a pixel value, such as "colwidth=9", or any other value accepted by a <td width=value> tag in HTML.  If no value is specified, UnForm uses "2em", which indicates 2 half-characters, based on the average width of a character in the default font.  This value can also be specified for individual reports using the colwidth keyword in a rule set.

pagenum=text

This text is used to generate the default table of contents' values.  A space and the page number follow the text.

imagelib=directory

This points to a directory where image files are physically stored on disk.  If any column definition has an option indicating it contains image file names, then the files in the column are searched for first as named, and then in this directory.  If the image can be found, then the image tag can be generated with width and height parameters, which normally speeds up the page rendering speed by the browser.

imageurl=url-prefix

When image tags are generated in a column, the url-prefix is placed in front of the file name.  This allows the Web server to map the name to a physical location on the server.

complete=text

incomplete=text

One of these values is placed in the "$status" global string at the end of each page, depending on whether the job is complete or not.  You can then place the value in the HTML template files by embedding the tag "[$status]" in the template.