Handler - passAsHTMLIndex

 

Description

Builds an HTML index of its input products.

Note: This is intended to be used on the output of an archive handler agent. Otherwise, the files referenced by HTML links will probably have been deleted by the time an end user selects them for viewing. The archive juggler will ensure that the referenced products are not deleted for a specified period.

 

Configuration Variables

copySupportFiles
Defaults to false. If set to true causes all support files (images that are referenced from the generated index page) to be copied into the same directory as the index page and added to the created product. When false these files are not copied but referenced as fully qualified URLs to the support directory as served by iPAM.

fileNameOfIndexPage

Optional. Allows you to specify the file name to be used for the index page

serveRemotely

Defaults to true. Set if index will be used in such a way that fully qualified URLs are required. If false, only relative URLs are used.

Product

Product is an HTML "index" page that matches the structure of the input product. If the product has URLs or File contents then the "index" page will refer to these with hotlinks.

 

How it works

Invokes the same internal "renderer" as that used by putProductToDirectory, which is the AsHTMLIndex product visitor. This renderer creates an .html page that summarizes the hierachical content of a root product container showing hot links to files and URLs, as well as any String content and product descriptions.

 

Revised: 19 August 1999