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


File Names

Specifying Icon File Names

Variable:
%opt_icons=( 'id', 'filename', .... ;

This is a hash table of all the images used directly by WebMagick and located in the $opt_iconpath (see section Specifying WebMagick Icon Location) directory. The elments are pairs of icon `id's and the filename of the image. The `id's currently used internally by `WebMagick' are :- `background', `dirbackground', `prev', `next', `next_grey', `up', `help', and `ball'. These IDs are used as follows:

background
thumbnail frame background image
dirbackground
directory frame background image
prev
link to previous page
next
link to next page
next_gray
link to next page (when there isn't one)
up
link to parent directory up
help
link to help Readme File (if it exists)
ball
a decorative ball

By default the background and dirbackground options are undefined which results in no background images being defined.

Other images can also be defined in the hash table and WebMagick will automatically process those images along with the images it uses, to generate the icon URL and size infomation. This information can then be used in the various special formating options to add extra, or special purpose links.

An alternative way to define entries (particularly useful in directory .webmagickrc files) is to define (or undefine) individual hash table entries.

Use syntax similar to

$opt_icons{'background'} = 'background.gif';

to add a background image to the thumbnail page or override an existing definition.

Use syntax similar to

undef $opt_icons{'background'};

to undefine an existing definition for the image corresponding to `background'. This can be useful if the default is to display a background image but you want to turn off the background image for a particular sub-directory tree.

Index File Base Name

Variable:
$opt_indexname=filename
Argument:
--indexname filename

Base name of the master index files (default server index), usually set to `index.html'. This is also the filename WebMagick will look for in sub-directories and parent directory `.webmagickrc' files as the document to make links to.

EG: If a directory is not processed by WebMagick, by either never running WebMagick on that directory, or the option $opt_ignore has been set, then setting $opt_indexname will specify the document WebMagick created index files of OTHER directories should link to.

If you do not want WebMagick to ever link to this directory then setting the option, $opt_indexname, to "NOLINK" will will prevent WebMagick index files in other directories from linking to this directory.

If you want WebMagick to entirely ignore a particular directory tree, even during recursion of the surrounding directories, then you can use the following options in its "`.webmagickrc'" file:

#
# .webmagickrc -- WebMagick is not to process or even link
# to this directory tree
#
$opt_indexname = 'NOLINK'; # Do not link to this directory
$opt_ignore    = 1;        # Do not generate WebMagick image indexes
$opt_prune     = 1;        # Don't recurse into sub-directories

Specifying README File Name

Variable:
$opt_readme=filename
Argument:
--readme filename

Name of directory information file (default `README.html'). If this file exists in the directory, then it will be displayed in preference to the first page of images and a link will appear in the directory frame which links to the image index. Typically the contents of this file describe the images to be viewed.

Page Index File Name

Variable:
$opt_pageindexname=string
Argument:
--pageindexname string

Base name of page-related index files (default `.index'). This name is used as the prefix for all generated files except for the main index file. The default naming creates these as hidden files (UNIX convention).

Specifying Sub-Directory Titles

Variable:
$opt_dirindexname=filename
Argument:
--dirindexname filename

Specify the file name to contain the directory-name to title cross-reference for naming sub-directories (default file name `.dirindex'). If this file exists, then dirtext will replace `dirname' if `dirname' is found in the file. This provides the ability to use user-specified text rather than actual sub-directory names.

The format of the file is:

dirname  dirtext

With dirname representing the directory name and dirtext representing the replacement link text.

It is wise to limit the length of dirtext to fit within the limitations of the directory frame.


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