###########################################################################
# Table of Contents Configuration file.
#
# Description:
# ExplorerIndex generates either an index of all the files in the specified
# directories, or a Table of Contents (ToC) for all HTML-esqe files
# specified.
#
# Read documentation for more information on all options.
#
# Version:
# 1.1.1
# Copyright (C) 2000-2001 Nigel Swinson, nigel@swinson.com
###########################################################################
## This config file is split into the following sections
## 1) Pathnames
## Essential pathnames that you must set if you want this script to work
## 2) Logical operation
## What you want to index
## 3) Entry Description
## How the indexed entries will appear in the toc
## 4) Javascript
## Configuration of things in the generated javascript.
## 5) Error page configuration
## How the script will cope with errors.
## 6) Server side config
## Things that apply only to the running of the script server side.
##
###########################################################################
# 1) Pathnames.
# This is the prefix for all files used by the script. Set it to the
# directory where the script lives in.
# If the script lives in
# /home/username/htdocs/scripts/explorerindex/
# then point this to
# /home/username/htdocs/scripts/explorerindex/
ScriptRoot /home/ccc/htdocs/scripts/explorerindex
# Point this to the internal path to the document root of the webserver.
# If the script lives in
# /home/username/htdocs/scripts/explorerindex/
# then point this to
# /home/username/htdocs/
# This value will be used to do a chdir command so that the script runs
# from the document root. The paths to all the files to be indexed are with
# respect to document root so this will mean that the links in the TOC will
# actually work.
DocumentRoot /home/ccc/htdocs/scripts/explorerindex/
# Site prefix. This is the url to DocumentRoot. Include the trailing
# / please.
#DocumentRootURL http://www.carrubbers.org/scripts/explorerindex/
# Output file to use for the table of contents. Internal with respect to
# ScriptRoot.
#IndexFile ../../docs/other/siteindex/javascript_index.html
IndexFile Readme.html
# Toc Template file to use for generating the output file. Internal so with
# respect to ScriptRoot. The toc template file accept the following special
# tags:
# - Replaced by the entire index.
# - Marks the start of the index. Used
# - with IndexEnd to create an updateable
# - index where the outputfile is the
# - same as the template file.
# - Marks the end of the index. Used
# - with IndexStart.
IndexTemplateFile Readme.html
###########################################################################
# 2) Logical operation
################################
# Directory and file indexing
# List of directories and files to index. Paths are internal and with respect
# to DocumentRoot.
# If the entry is preceeded by:
# exclude: - then it will not be included in the index.
# index content: - then it's content will be indexed
# exclude content: - don't content index these files/directories.
#
# Do not include a trailing / for directories.
#
# If the directory map contains only 1 file that is to be content indexed,
# and that 1 file is the same file as the IndexTemplateFile, then the script
# will create a table of contents as opposed to an index. A table of contents
# will not contain a home root node, and will not have the name of the
# file as the first node.
index content: Readme.html
# "." separated list of extensions to include. If not defined, all
# extensions will be included. Example: html.htm.gif.jpeg
# This value takes precedence over those entries in the DirectoryIndex
IncludeExtensions html.htm.shtml.shtm
# "." separated list of extensions to exclude. Example: css.class.txt
# This value takes the highest precedence. If an extension appears here
# then it will not be indexed.
ExcludeExtensions class.txt.css.jar.rm.gif.jpg
# If your webserver allows you to browse directories, ie allows
# "http://www.carrubbers.org/Other/", then include this flag. If you don't
# include this flag then the links in the toc to the directories will be
# blank.
#DirectoryBrowsingOK
################################
# Content indexing
# The ContentIndexMap. The ContentIndexMap is used to determine for those
# directories with index content set, which tags to index and at which
# level.
#
# Syntax: SignificantHtmlElement:Level:SigElementEnd:BeforeText,AfterText
#
# See documentation for more information on these parameters.
H1:1 # H1 are level 1 ToC entries
H2:2 # H2 are level 2 ToC entries
H3:3 #
H4:4
H5:5
# "." separated list of extensions that can be content indexed.
ContentIndexExtensions html.htm.shtml.shtm
###########################################################################
# 3) Entry Description
# The FileTitleStart/EndTag describes the patterns that will be searched for
# to determine what to put in the index. If it fails to find FileTitleStartTag,
# FileTitleEndTag then the filename itself will be used. Typicall these
# Will be and , but you may use some other strings such as
# and if you like.
FileTitleStartTag
FileTitleEndTag
# The format for the url of each index entry. If you want each to trigger
# a script with the file path as a parameter for example then you would use
# this feature. Each entry occurrence of (case insensitive) will be
# replaced with the url for this entry. ie if this is:
#
# MyScript?MyParam1=&MyParam2=Value1
#
# ...then each entry will execute the MyScript script with the url as
# parameter 1, and Value2 as Parameter2. The default is:
#
#
#
# ...which provides a link to the file associated with the url by clicking on
# the description.
#FileTitleUrlFormat
# Allowable html tags to use in the index entries. ie script, br, hr are
# examples of tags that you would not want to appear as the label of one
# of the indexes, but b,i,font are far more likely to be. Not all tags
# listed here will be within an a tag. Tags are comma separated and
# case-insensitive. All tags that are not in this list, whether opening or
# closing tags will be discarded. The content between the tags will not
# be discarded.
AllowableIndexTags b,i,font,strong,em
###########################################################################
# 4) Javascript
# The location of the javascript file that contains the code to drive the
# explorer index. Internal path with respect to ScriptRoot.
JavascriptFile ExplorerIndex.js
# The path to the images for the navigation. This is used in the ![]()
tags
# that are written by the javascript. Make this an absolute external
# path. Defaults to "images/"
ImagesPath images/
###########################################################################
# 5) Error page configuration
# Template file for using if an error occurs. This is an internal path
# with respect to Document Root.
# The error template accept the following special tags
# <%--Error#ErrorMessage--%> - Replace with the error message
# <%--Error#ReturnTo--%> - Replaced with ErrorReturnTo as
# - defined below
# <%--Error#ReturnURL--%> - Placed with ErrorReturnURL as defined
# - below.
ErrorTemplate Error.html
# On the error page we will have a ReturnTo link.
# define these two if you wish to use these tags on the error page.
ErrorReturnTo Main page.
ErrorReturnURL http://www.carrubbers.org/
###########################################################################
# 6) Server side config
# Keep the backup files when you are finished running the script.
# How much do you trust this script?
#KeepBackups 1