Standard File and Directory Names

Standard File Names

File Name Location Description
backgnd.gif
backgnd.jpg
     
directory This file, if it exists, will be used as the background for the index in the current directory.
frameset.htm      directory This is the frame set file for the directory in which it appears. This file is generated automatically for each subdirectory when frames support is enabled.
hidden.dir      directory This file should be included in any subdirectory that should not appear in the index of the parent directory. The contents of this file is not significant, and it is usually a zero-length file.
index.db      start dir This is the index database file for the entire directory tree.
index.htm
index.html
     
directory This is the index file for the directory in which it appears. This file will be displayed upon entry to a new subdirectory.
keyicons.txt      icons When this KeyIcons file appears in the "icons" subdirectory, it is used to display icons next to each entry in an index based on the keyword list for that entry.
keywords.kdb      start dir This is the keyword database file for the entire directory tree. Keyword databases have been replaced by index databases.
nothumb.gif
nothumb.jpg
     
icons This is the default thumbnail image file for all directories.
symlinks.txt      directory This file is used to include symbolic links to other directories or files in the directory in which it appears.
thumb.gif
thumb.jpg
     
directory This is the thumbnail image file for the directory in which it appears. This image will appear as a link in the index of the parent directory, and under the index title in the index of the directory in which it appears. It should be small (recommended size: 100x66), and should contain a good representation of the directory contents.
welcome.htm
Welcome.html
     
directory Alternative names for "index.htm". These file names are recognized as index files when indexing subdirectories, but are not used to generate new index files.

See the Icons section below for standard icon file names.


Icons Directory

There are several general-purpose icons that can appear in the HTML pages generated by this software. When an icon is needed, the software that is generating the HTML page searches for a subdirectory named "icons". If the "icons" subdirectory is not found off the current directory, the software searches for the subdirectory off each of the parent directories, starting at the immediate parent and working toward the root directory. Once the "icons" directory is found, the icon is obtained from that directory.

The following standard icon file names are used by this software:

prev.gif Button which appears at the top of all slides, and is used to select the previous slide.
next.gif Button which appears at the top of all slides, and is used to select the next slide.
noprev.gif Button which appears at the top of the first slide in place of the "prev.gif" icon. It should represent an inactive "previous" button. It should have the same dimensions as the "prev.gif" icon.
nonext.gif Button which appears at the top of the last slide in place of the "next.gif" icon. It should represent an inactive "next" button. It should have the same dimensions as the "next.gif" icon.
home.gif Button which appears at the top of all slides, and is used to return to the index or the first slide.
back.gif Button which appears at the top of all indexes, and is used to return to the parent or referring index. If this file does not exist in the "icons" directory, the "home.gif" file will be used instead.
close.gif Button which appears at the top of all indexes, and is used to close the current window. If this file does not exist in the "icons" directory, the "home.gif" file will be used instead.

For example, if the software needed the icon "next.gif", it would search for it along the following paths (in order):

  1. ./icons/next.gif
  2. ../icons/next.gif
  3. ../../icons/next.gif
  4. ...


Copyright © 1996-1999 Christopher P. LaRosa. All Rights Reserverd.