# Symlinks Files

Normally, an index file will contain only links to files and subdirectories in its own directory. Symlinks files provide a way to add links to other files or subdirectories that are not located in the same directory as the index.

A file named "`symlinks.txt`" is placed in the directory which contains the index. The symlinks file contains a list of paths to other files and/or subdirectories which should appear in the index in addition to those in the current directory.

The format of the symlinks file is as follows:

- One path per line
- Each path must be a legal Windows path to an existing file or directory (i.e. it must use backslash path separators).
- Each path must be a relative path -- no absolute paths are allowed (e.g. "`..\..\items\one.htm`" is legal, but "`c:\items\one.htm`" is not).
- Paths may be one of the following:
  - A path to a directory. These must end with a backslash ("`\`") character. Directory paths will automatically be resolved to reference the appropriate index file for the specified directory when the index for the current directory is generated.
  - A path to a slide image. These must end with "`.gif`", "`.jpg`", "`.jpeg`", or an embedded image file extension (e.g. "`.avi`"). Slide image paths will automatically be resolved to reference the corresponding HTML slide file when the index is generated.
  - A path to an HTML file. These must end with "`.htm`" or "`.html`".
  All other extensions will be ignored.
- Blank lines and comment lines beginning with a colon (`:`) are ignored.

Table of Contents