Go to the first, previous, next, last section, table of contents.

HTML Options

HTML Content

Allow Configuration

Variable:

$opt_allowconfig=1

Argument:

--allowconfig

Available only when also using $opt_javascript and $opt_tables, Allow Configuration gives the user the option to select their own frame style and number of rows and columns for the table. There will be an icon in the directory frame that will pop-up a new window which includes pictures of the available frame styles.

This configuration is accomplished with cookies. If the user has cookies disabled in their browser, their configuration will not be saved.

When a configuration is saved, it will be applied to all directories at or below $opt_prefixpath. For example, if $opt_prefixpath is empty (the default), the configuration will apply to all directories on the site.

JavaScript Mode

Variable:

$opt_javascript=1

Argument:

--javascript

When JavaScript mode is enabled, JavaScript code is added to the main index file (default index.html) to re-set the location to the JavaScript index file (currently hard-coded as "indexjs.html"). This results in JavaScript being loaded into the browser automatically if JavaScript is supported by the browser and the browser is one that WebMagick supports (currently Netscape 3.0X, Netscape 4.0X, and Internet Explorer 4.0X). Browsers that do not support JavaScript, have JavaScript disabled, or are not recognized by WebMagick safely ignore the JavaScript and operate directly from WebMagick's usual HTML files.

The advantage of JavaScript mode is that other than retrieving a few intial files and the images to be viewed, all HTML is generated directly within the user's browser, minimizing server accesses. In addition, navigation and presentation are dramatically improved since there is no need to pre-compute every possible viewing option and JavaScript has better control and knowledge of the browser than HTML does.

In order for JavaScript mode to operate correctly, the file 'webmagick.js' must be installed in the location specified by $opt_iconpath (see section Specifying WebMagick Icon Location) and the server must be updated to associate MIME type "application/x-javascript" with the extension ".js". Read your web server's documentation to see what is required in order to add new MIME types (if the type is not already supported).

Apache server: Update conf/mime.types and add the line

CERN or W3 server: Update config/httpd.conf and add the line

Phttpd: Update modules/file.conf and add the following to the content-types list

Table Mode

Variable:

$opt_tables=1

Argument:

--tables

Use HTML tables instead of imagemaps for displaying thumbnails. This results in quicker navigation because smaller images are downloaded, and quicker directory processing, since no montages are created.

This option is available with or without JavaScript mode enabled.

README File Treatment

Variable:

$opt_readmevisible=1

Argument:

--readmevisible

Specify the handling of a README file. If the file designated by $opt_readme exists (default `README.html') then make it the first page seen when the user enters a directory. Regardless of this option, the help icon will appear if the README file exists which is a link to the file.

Address Information

Variable:

$opt_address=string

Argument:

--address string

Specify additional information to place in <ADDRESS></ADDRESS> tags in page frame. WebMagick copyright and support information is placed on all generated pages.

Anonymize

Variable:

$opt_anonymous

Argument:

--anonymous

Turn off the WebMagick copyright info and author's address on all generated pages. If you are operating a site that my mother wouldn't approve of, please use this option.

Page Header

Variable:

$opt_header=string

Argument:

--header string

Specify text to add to the page header in the thumbnail frame (a short term hack). This option is subject to change and will be eliminated if the thumbnail frame is templatized.

Page Title

Variable:

$opt_title=string

Argument:

--title string

Specify the page title. If this option is not specified, then WebMagick will generate its own title in the form 'Index of directory "subdirectory name"'.

Stylesheet

Variable:

$opt_stylesheet=URL

Argument:

--stylesheet URL

Specify a style sheet to use for all generated pages. This will override the following options:

Directory Page Template (No Frames)

Variable:

$opt_dirfmt=string

Specify a template (written in PERL) that represents the format used to generate the frame-less directory navigation page. This format will be seen by browsers that do not support frames. This is a guru-level option that may require reading WebMagick code.

Directory Page Template (Framed)

Variable:

$opt_frameddirfmt=string

Specify a template (written in PERL) that represents the format used to generate the framed (left frame) directory navigation page. This format will be seen by browsers that support frames. This is a guru-level option that may require reading WebMagick code.

Per-Image HTML

When per-image HTML mode is enabled, an HTML file is generated corresponding to each image. The HTML file is named based on the image file name with an HTML extension.

Enable Per-image HTML

Variable:

$opt_pichtml=1

Argument:

--pichtml

Enable per-image HTML file generation.

Per-image HTML extension

Variable:

$opt_pichtmlext='.ext'.

Argument:

--pichtmlext extention

Set the file extension to use for per-image HTML files. The final name is the image file name appended with this file extension. The default extension is '.html'.

Per-image HTML Nav Buttons

Variable:

$opt_pichtmlnav

Argument:

--pichtmlnav

Enable image navigation buttons (up, previous, next) on per-image HTML files.

Per-image Picture Title

Variable:

$opt_pichtmlputtitle

Argument:

--pichtmlputtitle

Enable per-image HTML picture titles. Default is on.

Per-image Picture Title Start HTML

Variable:

$opt_pichtmltitlestart

Argument:

--pichtmltitlestart

HTML to add before picture title (default is <P>)

Per-image Picture Title End HTML

Variable:

$opt_pichtmltitleend

Argument:

--pichtmltitleend

HTML to add after picture title (default is </P>)

Default Frame Target

Variable:

$opt_pichtmltarget='targetname';

Argument:

--pichtmltarget target_name

Set the default URL target name for links in per-image HTML files. There is normally no need to set this target because HTML is normally displayed in the current frame and there are no links by default, however, sometimes it is desirable for links to display in a different (or new) window.

Extra Top HTML

Variable:

$opt_pichtmltop='html_source';

Argument:

--pichtmltop 'html_source'

Extra HTML to insert above the image.

Extra Bottom HTML

Variable:

$opt_pichtmlbottom='html_source';

Argument:

--pichtmlbottom 'html_source'

Extra HTML to insert below the image.

Text Colors

Thumbnail Frame Background Color

Variable:

$opt_colorback=colorspec

Argument:

--colorback colorspec

Specify the background color for thumbnail frame.

Thumbnail Frame Text Foreground Color

Variable:

$opt_colorfore=colorspec

Argument:

--colorfore colorspec

Specify the toreground color for text in thumbnail frame.

Directory Frame Text Color

Variable:

$opt_dircolorfore=colorspec

Argument:

--dircolorfore colorspec

Specify the foreground text color of the directory frame. Defaults to the value of $opt_colorfore (see section Thumbnail Frame Text Foreground Color) if not explicitly set.

Directory Frame Background Color

Variable:

$opt_dircolorback=colorspec

Argument:

--dircolorback colorspec

Specify the background color of the directory frame. Defaults to the value of $opt_colorback (see section Thumbnail Frame Background Color) if not explicitly set.

HTML Link Colors

Thumbnail Frame Active Link Color

Variable:

$opt_coloralink=colorspec

Argument:

--coloralink colorspec

Specify the link (active) color for the thumbnail frame.

Thumbnail Frame Un-visited Link Color

Variable:

$opt_colorlink=colorspec

Argument:

--colorlink colorspec

Specify link (unvisited) color for the thumbnail frame.

Thumbnail Frame Visited Link Color

Variable:

$opt_colorvlink=colorspec

Argument:

--colorvlink colorspec

Specify link (visited) color for the thumbnail frame.

Directory Frame Active Link Color

Variable:

$opt_dircoloralink=colorspec

Argument:

--dircoloralink colorspec

Specify link (active) color for the directory frame. Defaults to value of $opt_coloralink (see section Thumbnail Frame Active Link Color)if not explicitly set.

Directory Frame Un-Visited Color

Variable:

$opt_dircolorlink=colorspec

Argument:

--dircolorlink colorspec

Specify link (unvisited) color for the directory frame. Defaults to the value of $opt_colorlink (see section Thumbnail Frame Un-visited Link Color) if not explicitly set.

Directory Frame Visited Color

Variable:

$opt_dircolorvlink=colorspec

Argument:

--dircolorvlink colorspec

Specify link (visited) color for the directory frame. Defaults to value of $opt_colorvlink (see section Thumbnail Frame Visited Link Color) if not explicitly set.

Frame Options

Enable Frames

Variable:

$opt_frames=1

Argument:

--[no]frames

Enable frames. This defaults to on, but is useful to turn off if you have a single directory collection.

Enable Frame Borders

Variable:

$opt_frameborder=borderenable

Argument:

--frameborder borderenable

Enable decorative frame borders with the value 'YES' or disable decorative frame borders by specifying the value 'NO'. These options are passed directly to the HTML's FRAMESET 'FRAMEBORDER' option in the generated pages.

Frame Border Thickness

Variable:

$opt_framebordersize=bordersize

Argument:

--framebordersize bordersize

Specifies the number of pixels allocated to the frame border.

Frame Margin Height

Variable:

$opt_framemarginheight=marginheight

Argument:

--framemarginheight marginheight

Specifies the number of pixels allocated to the frame margin in the vertical direction.

Frame Margin Width

Variable:

$opt_framemarginwidth=marginwidth

Argument:

--framemarginwidth marginwidth

Specifies the number of pixels allocated to the frame margin in the horizontal direction.

Frame Style

Variable:

$opt_framestyle=framestyle

Argument:

--framestyle framestyle

Specifies the frame template to use. Templates are currently specified for the range of 1-4 with the following effect:

1. Simple two frame screen with directories listed in the left frame and imagemap or README displayed in the right frame.
   
   

2. Three frame screen with directories listed in top-left frame, imagemap displayed in bottom-left frame, and README/Images displayed in full-height right-hand frame.
   
   

3. Three frame screen with directories listed in left frame, imagemap displayed in top-right frame, and README/Images displayed in lower-right frame.
   
   

4. Three frame screen with directories listed in lower-left frame, imagemap displayed in top frame, and README/Images displayed in lower-right frame.
   
   

HTML Meta Tags

Meta-Tag Author

Variable:

$opt_metaauthor=string

Specify author name to add to the HTML meta tags in generated HTML files.

Meta-Tag Charset

Variable:

$opt_metacharset=string

Specify HTML documents character set in case HTTPD can't provide it.

Meta-Tag Classification

Variable:

$opt_metaclassification=string

Specify any classification information to add to the HTML meta tags in generated HTML files. This may be used by indexing robots.

Meta-Tag Description

Variable:

$opt_metadescription=string

Specify page description text to add to the HTML meta tags in generated HTML files. This information may used by indexing robots.

Meta-Tag Expires

Variable:

$opt_metaexpires=string

Page expiration date to add to the HTML meta tags in generated HTML files. Should be specified in the form:

Since the specified expiration time is absolute, use of this option implies a commitment to execute WebMagick with option --forcehtml as least as often as the specified expiration period.

This information is used by browsers and caching servers to determine when cached data becomes stale.

Meta-Tag Key-Words

Variable:

$opt_metakeywords=string

Specify keywords to add to the HTML meta tags in generated HTML files. Should be specified as a string with keywords delimited by a comma (e.g. "key1,key2,key3"). This information may used by indexing robots.