Index Generator Settings.
=========================

This will hopefully end up being a full listing of all the variables in the settings files, including all the special fields which can be added to them to be replaced by the Index Generator program. The fields are not case-sensitive. Please send corrections, omissions and queries to me by email.

Mark Howard
mh@tildemh.com


TODO: add little bits like project details (name, etc.) and statistics details. 

Sitemap Settings
================

Name: CONFIG_SM_STARTTXT
Description: This is the html code which will be placed at the beginning of the output html file. It should include the html headers and any titles, opening text, etc. which you want to be placed at the start of the file.
Fields:
<!--#GenDate-->
	A formatted version of the date when the index was generated
<!--#TimeGen-->
	Likewise, but using the time when the generation process began
<!--#IndexGenLink-->
	The url of the Index Generator website. (This is just the URL, not a link. Anchor tags will have to be added around it.)
<!--#OutputName-->
	The name of the output file (Not including the path)
<!--#OutputPath-->
	The path of the output file.
Example: <html><head><title>Sitemap</title></head><p align=right>Page Generated on <!--#GenDate--> at <!--#TimeGen--><h1>Sitemap</h1><p>The following is a full listing of all the files available on this website. It is organised in order of the directories in which the files are stored. You can return to this page at any time by pressing the 'sitemap' button in the header bar.<br><br><hr>



Name: CONFIG_SM_ENTERFOLDER
Description: This code will be placed in the output whenever a new folder is entered in the hierarchy. It is used to create the indentations in the output to illustrate the hierarchy of the file system.
Fields:
<!--#FullRelFolder-->
	The name of the new folder, relative to the output file location.
<!--#TopFolder-->
	The name of the folder just entered (without any higher-level folders)
<!--#idgenLink-->
<!--#GenDate-->
<!--#TimeGen-->
Example: <ul><p><a href="<!--#FullRelFolder-->"><!--#TopFolder--></a></p>

Name: CONFIG_SM_LEAVEFOLDER
Description: This code will be placed whenever a folder is left.
Fields: As for CONFIG_SM_ENTERFOLDER
Example: </ul>

Name: CONFIG_SM_LINKSTXT
Description: This is the code which will be placed around each of the links in the sitemap.
Fields:
<!--#FullRelFolder-->
<!--#TopFolder-->
<!--#Filename-->
	The filename of the current file being indexed (not including path).
<!--#RelLocation-->
	The file location relative to the output location
<!--#Title--> 
	The title of the file currently being indexed (This is extracted automatically)
<!--#Description-->
	The description of the file (extracted automatically. May not be as expected if a description was not supplied in the html code)
<!--#Keywords--> 
	A comma separated list of the keywords supplied in the file (not available for all files or file types).
<!--#FileSize-->
	The size of the file (in bytes)
<!--#FileSizeHR-->
	The size of the file in an appropriate human-readable format.
Example:<p><a href="<%%File Location%%>"><%%File Title%%></a><p style="margin-left:40px;"><%%File Description%%></p>


Name: CONFIG_SM_ENDTXT
Description: this is the code which will be placed at the end of the output file. It should include The closing html code.
Fields:
<!--#GenDate-->
<!--#TimeGen-->
<!--#idgenLink-->
<!--#OutputName-->
<!--#OutputPath-->
Example: <p align=right>This sitemap was generated with the open source tool <a href="<!--#idgenLink-->">Index Generator</a></body></html>



Ordered List Settings
=====================
Name: CONFIG_OL_STARTTXT
Description: This is for the html code to go at the start of the file.
Fields:  Same as for sitemap + somewhere for output of CONFIG_OL_NAV to be placed.
Example:

* The following are for a table of links to the various sections of the index, i.e. linking to the first link on the page beggining with each letter.
Name: CONFIG_OL_NAV_START
Description: This goes at the start of it all.
Fields:   ***TODO***
Example: <p>Click on the following links to go the the appropriate section in this index<hr><br><table><tr>

Name: CONFIG_OL_NAV_LINK
Description: This is to go around each link in the navigation table.
Fields: ***TODO***
Example: <td><a href-"<!--#TheLetter-->"><!--#TheLetter--></a></td>

Name: CONFIG_OL_NAV_END
Description: The code to go at the end of the navigation section.
Fields: ***TODO***
Example: </tr></table><br><hr><br><br>

Name: CONFIG_OL_NAV_HIDEMISSING
Description: This boolean value defines whether links should be added to sections which don't exist (because there aren't any pages with titles which begin with those letters).



Name: CONFIG_OL_SECSTART
Description: This goes at the start of each section. A section is defined as a block of links which all start with the same character. This will depend on what fields have been chosen for sorting the list. Predefined sections are used in the case of indices sorted by numeric values.
Fields: ***TODO**
Example: <h2 id="<!--#TheLetter-->"><!--#TheLetter--></h2>

Name: CONFIG_OL_LINK
Description: This is the code to go around the actual links in the ordered lists.
Fields: ***TODO***
Example: <p><a href="<!--#FullRelFilename-->"><!--#FileTitle--></a></p>

Name: CONFIG_OL_ENDTXT
Description: The code to go at the end of an ordered list.
Fields: ***TODO***
Example: <p align=right>Made with ... </body></html>

Name: CONFIG_OL_COLCOUNT
Description: An integer value determining the number of columns to display the links in. 
Example: 1 (default, no coulumns)

Name: CONFIG_OL_COLSTART
Description: Code to go at the start of a column
Fields: ***TODO***
Example: <td valign=top><!--#ColNumber???-->
* the start and end of the actual table should be placed in the actual start and end boxes.

Name: CONFIG_OL_COLEND
Description: Code to go ath the end of a column
Fields: ***TODO***
Example: </td>




Generic Settings (neither sitemap or ordered list type)
========================================================
Name: CONFIG_THEME
Description: This boolean value affects how the gui works. If it is true, none of the settings are visible. The gui will look for a theme information file and show a dfescription of the theme and a few screenshots.


Name: CONFIG_FCOPY
Description: A Comma separarated list of files to be copied. This field is present so that themes can be created which rely on other files, such as image files or javascript files. The image or javascript files should be listed here, with the location presented relative to the theme file (project settings file).

Name: CONFIG_FCTARGET
Description: This is the directory where the above files will be copied, relative to the output file name. Unfortunately, all the files must be placed in the same directory (at the moment..).



File Settings
=============
* NOTE: Most of this is for the gui ONLY. The backend will work only with the list of files supplied. If any of them are not found, then the backend will fail adn suggest you run the gui again. Eventually, we may write a script to create the file list from a folder list, so that it can all be done as a cron job, but not just yet.

Name: CONFIG_FILES_USEFOLDERS
Description: This is a boolean value. If true, folders will be scanned for files to index. If false, individual files will be chosen by the user. This is used only by the gui. All the files are already present in the project settings file by the time it reaches the backend.
Example: true

Name: CONFIG_FILES_FOLDERLIST
Description: A comma separated list of all the folders in the project. These should be absolute references (as the project file may not have been saved when they are defined, and it will allow the project file to be moved around).
Example: /home/www/~mh,/home/www/cgi-bin

Name: CONFIG_FILES_INCFILTER
Description: This is a comma separated list of the file extensions which will be included int the index. Only useful if you use the folder scanning method
Example: html,htm,shtml,asp,pdf,mp3,lwp,ps

Name: CONFIG_FILES_EXCFILTER
Description: A comma separated list of strings to search for in the names/paths of files. If they are found, then tose files will not be indexed
Example: .workinprogress,/provate/,~,temp







Name:
Description:
Example:

Name:
Description:
Example:




