Table of Contents (toc) v2.1

Table of Contents creates framed HTML lists of local files and reports on broken links.

What is 'Table of Contents'?

A quick guide to using 'Table of Contents'

Using 'Table of Contents':

   File Selection tab

   Frameset tab

   Preferences tab

   Analyse tab

   File menu

   Broken Links Reporting

   Misc.

Registering 'Table of Contents'

About 'Table of Contents'


What is 'Table of Contents'

'Table of Contents' creates framed HTML lists of local files and reports on broken links.

Table of Contents (TOC) reads the files in your web directory and

creates framed HTML files. These present the hierachy of files

in the left frame so you can view their contents in the right

frame. This Table of Contents makes it easy for you and/or

your users to see an overview of the web site and browse the

HTML pages and the graphics. You can specify which types of

file are indexed, the properties of your frames and index, and

alphabetically sort the entries. Table of Contents will also

read your HTML pages and show you the relative links and

images in the page which are broken. This information can

easily be saved, displayed and printed. Just what you need to

manage your web site.


A quick guide to using Table of Contents

When you load toc you see the item list on the left, initially there is only the "TOC" root item. On the right are the tab sheets; File Selection, Frameset, Preferences, Analyse and About/Register. The directories and files to add to the items list are selected on the first tab, while the second controls the look of the resulting HTML frames and index.  The Analyse tab shows you the links and pictures in your HTML files and whether the links are broken.

To try out the capabilities of TOC and to learn it's functionality follow these steps:

1. Select a directory, on the File Selection tab, which contains web pages.

2. Press the 'AutoIndex' button. WARNING: all sub-directories will also be Indexed.

3. When the Indexing has finished change to the Frameset tab and enter a title for your Index.

4. From the "File" menu choose "Save to Indexed Directory...", and press OK.

5. From the "File" menu choose "Browse last saved TOC." and select your favourite WWW browser.

6. If you wish you can transfer the "toc.html" and "toc-index.html" files to your on-line web directory with no additional modification. You and/or your visitors can then peruse all your files at once to get an overall picture of your web site.

7. Select the Analyse tab and click on one of your web pages in the list on the left.

8. The listboxes show the anchors in your web page and the media displayed, any references to missing files will be shown with a red line and circle through the icon.

  9. Press the "Report..." button if you have any broken links. Select "Current Page", "HTML formatting" and "Load into web browser" and press "OK". The broken links will be displayed in your web browser for you to use to correct them.


File Selection tab

All three buttons on this page add files to the items list.

AutoIndex: Starting from the directory currently selected this button will Index all selected file types, in both the current directory, as well as all sub-directories. File types to Index can be found on the Preferences page.

Index All: All files of the types selected in the current directory are Indexed.

Index Selected: Files selected from the file list will be added as sub-items to the currently selected item.


Analyse tab

The analyse tab shows you properties for items you select.  The tab page must be active for this to occur.

File Properties: The filename, file size and HTML title (for web pages) are displayed in this box.

Anchors: Anchors within your document are displayed. Relative/local and WWW links are distinguished by icons.

    Relative/local links

    Relative/local link to a missing file (broken link)

    WWW links

Media: Pictures, movies, sounds, applets and other media are displayed. Applets, other media and WWW links are distinguished by icons.

    Pictures, movies, sounds and other media

    Missing picture/media (broken link)

    Java applets

    WWW links to media

HTML: For HTML documents and images this edit box will display the HTML required to link to that object.  Press Copy to copy the text to the clipboard.  The WIDTH and HEIGHT attributes are automatically filled in, this can save you much time when creating a web page.

Problems with broken link detection: TOC does not currently check for named anchors (e.g. <A HREF="#top">), these are marked as valid links.  If the anchor is specified in another file the file is checked for but not the named anchor position (e.g. <A HREF="page.html#top">).  If you are using a complex set of frames some links may be marked as broken but will still work, this is caused by framesets that work across directories.


Frameset tab

Title: The HTML title to be used.

Percentage size of TOC frame: Relative size of left frame.

Frameset Properties:

Resizable frames: Allows the frame divider to be moved by the user.

Border Size: Defines a border thickness for the frameset, the default is two. Setting a value of zero turns the borders off.

Border Colour: Sets a colour for the page background.

TOC Background:

Colour: Sets a colour for the left frame background.

Image: Name of background image. Select a file using the "Browse..." button

TOC Text:

Text Colour: Colour of text in the left frame.

Link Colour: Colour of links in the left frame.

Font Size: Size of font in left frame

Font Face: Font name in left frame. It is strongly recommended that you add (by hand) alternative names for non-windows platforms. eg. <FONT FACE="Arial,Helvetica">


Preferences tab

Types to Index: When 'AutoIndex'ing or 'Indexing All' buttons are used only the file types selected will be Indexed, others are ignored. Types can be selected by dragging down the list with the mouse, holding CTRL and clicking, or holding SHIFT and clicking to select a range.

Options:

Prompt Before AutoIndexing: AutoIndexing clears all current items from the list and may be a time consuming process. This option provides a confirmation dialog so you have the chance of cancelling.

Use HTML TITLEs: Most web pages (which are written in HTML) have a title which is enclosed by the <TITLE> tag. TOC can use these titles in place of filenames, this allows for easier identification and description of the file's contents. Uncheck this option to use filenames only.

Sort Alphabetically: Items can be added alphabetically when doing an AutoIndex operation. Check this option to use alphabetical sorting. Alphabetical sorting increases the Indexing time.

Use Absolute File Names: When you save your TOC as HTML the left frame contains links to your files. These links can be either absolute (e.g. "file:///c|/docs/web/page1.html") or relative (e.g. "docs/web/page1.html"). If your TOC is saved onto another drive it will automatically use absolute filenames. Absolute filenames are also used automatically if you save into a directory not in the 'path' of the file. With this option checked TOC will save with relative filenames into the 'path', using the above examples that means "c:/", "c:/docs" and "c:/docs/web". This allows your Table of Contents to be used online with no modifications as long as the directory structure is preserved.

Frameset Properties:

Save Settings: Pressing this button saves the current Frameset properties so that they appear whenever the application is loaded.

Reset: This button resets all the Frameset Properties to their default values and deletes any previously saved settings.

HTML List Type: Your files are listed in the HTML using standard HTML list tags - UL, OL, DL. These provide bulleted, numbered and indented lists respectively.


File menu

New: Clears the items list. All your indexing will be lost.

Save As...: Saves your items list to a framed HTML index. Select the directory where you wish to save your toc, then change the file name if you are not happy with the default "toc.html". The associated index file will have the same prefix as the file name you enter but with "-index" added. So by default you save get two files: "toc.html" and "toc-index.html". If you wish toc to save using relative file names you must save into certain directories only. For example if you Indexed "c:/docs/web" then you should only save into "c:/", "c:/docs" or "c:/docs/web". Any other choice will result in the use of absolute filenames.

Save to indexed directory...:  Saves your Table of Contents.  Acts the same as the Save As command except it starts in the directory you last indexed.  This makes it much quicker if you want to save to that directory.

Browse last saved TOC:  Loads the last TOC you saved into your WWW browser.  If no browser is specified, then the Choose Browser function is activated.  This uses DDE to communicate with the browser, Netscape defined their DDE and MS have copied it so it should work on all versions of their browsers.  Other browsers should also work as long as they have implemented Netscape's DDE messages.

Choose Browser...:  Allows you to select a browser's executable file for use with the option above.

Report on broken Links...:  This option brings up the Reporting dialog.  After you have made your selections and pressed OK all the web pages indexed are searched for broken links and the resulting information presented according to the Reporting options you chose.


Registering 'Table of Contents'

Table of Contents is NOT free, it is a SHAREWARE program.  Shareware means that you may download and freely distribute the unregistered version, which may be used and evaluated for a period of 30 days.  After such time the program must be registered or deleted from your computer.  Shareware is a distribution method, not a type of software.  Shareware has the ultimate money-back guarantee -- if you don't use the product, you don't pay for it.  The shareware system and the continued availability of quality shareware products depend on your willingness to register and pay for the shareware you use. It's the registration fees you pay which allow authors to support and continue to develop quality products. Please show your support for shareware by registering those programs you actually use.

Registration of 'Table of Contents' costs $20 US Dollars or £10 (UK pounds sterling, cheque only).

Ways to Pay: Secure web page-(credit-card), fax-(credit-card), email-(credit-card), post-(cheque).

What you get when you register:

1. A serial number to register 'Table of Contents' will be sent by e-mail.

2. No more nag screens.

3. Peace of mind that the author is not starving to death while you use his program for nothing.

4. Updated versions will be sent by e-mail as soon as they are released, and at no further cost to you.

5. Technical support by e-mail (please quote your serial number)

Upon registering you will receive your registration number.  Enter your name, as it appears in the registration e-mail (case sensitive), and number into the edit boxes on the About/Register tab and press the Register button.  If the code is correct the program will then be registered.

Multiuser licenses:

                  Single user license: $20

                  3-user license: $45

                  5-user license: $60

                  10-user license: $100

  If you don't see the license package you want Mail me with your requirements.


About 'Table of Contents'

'Table of Contents' was written by Andrew Duke in Borland Delphi 2.

The latest information and upgrades can be obtained from the 'Table of Contents' web page at:

http://www.ajdcomp.demon.co.uk/toc/

or by e-mailing me:

ajduke@ajdcomp.demon.co.uk

'Table of Contents' is NOT free, it is a SHAREWARE program. Shareware

     means that you may download and freely distribute the unregistered

     version, which may be used and evaluated for a period of 30 days. After

     such time the program must be registered or deleted from your computer.

Other shareware available:

EasyHTML - The HTML Authoring Tool for those who want complete control over the design of their web documents.

http://www.ajdcomp.demon.co.uk/easyhtml/


Misc Controls

Right Click list items: Right clicking a list item bring up a list showing the file name directory and size in bytes.

Deleting Items: Select an item to be deleted from the list and use the Delete key to remove it and it's child items. This does not delete the file just it's entry in the TOC.


Broken Link Reporting
Broken Links Reporting

The Broken Links Reporting dialog lets you decide what happens to the listings of broken links TOC generates. More than one action may be carried-out with the information.

Report on:

All HTML Pages: All the HTML pages currently indexed in TOC are checked for broken links. The results are collated into a single file.

Current Page: Only the HTML file currently being "Analysed" on the Analyse tab is checked for broken links.

Formatting:

HTML: The output will be in HTML format and is best viewed by your WWW browser.

Text: The output is plain text and is best viewed in your text editor.

Actions:

Save: If this box is checked the output will be saved to the directory specified with a filename of "brokenlinks.html" or "brokenlinks.txt" depending upon the Formatting setting.  The default directory is the one you last index from, a history list of previously used directories is also available.

Load into ...: With this option checked the output will be loaded into your specified WWW browser or your default text editor.  This option uses the WWW browser stored by TOC, or your text editor associated with .txt files.

Print from ...: With this option checked the output will be loaded into your WWW browser or text editor and printed from there.  This option uses the browser you have associated with .html files with a /print("filename") parameter, or your associated text editor with a /p parameter.


Ways to pay

Secure Web Page - Credit Card:

Probably the easiest way to register is to type your details into the forms provided by the Kagi payment collection service here:

https://order.kagi.com/?GX9&S

This page uses SSL security to provide strong encryption for your information as it passes from your computer to Kagi. Ensure that your browser indicates that the page is secure, this is shown by a key, a padlock or other symbol. Read about secure credit-card transactions: http://www.ajdcomp.demon.co.uk/security

Payment page also available in: Japanese, Francais, Deutsch, Italiana, Nederlands and Svensk.

Fax - Credit Card:

To register by Fax you must use a program called Register to correctly format the information before it is sent to Kagi for payment collection. Register.exe is distributed with Table of Contents and can be found in the same directory. Simply enter your name, postal and e-mail addresses, the product to buy and the payment details into the first screen of the program. Click "Next..>>" and select the Print or

Copy options. Send a Fax containing the information, with your fax or fax modem, to the US: +1 510 652 6589. Credit card information is scrambled for security reasons.

E-Mail - Credit Card:

To register by e-mail you must use a program called Register to correctly format the information before it is sent to Kagi for payment collection. Register.exe is distributed with Table of Contents and can be found in the same directory. Simply enter your name, postal and e-mail addresses, the product to buy and the payment details into the first screen of the program. Click "Next..>>" and select the Copy option. Send an email containing the information in the clipboard and send it to: sales@kagi.com. Credit card information is scrambled for security reasons.

Post - Cheque:

To register Table of Contents by post send a cheque for 10 pounds sterling, 20 US Dollars or the equivalent in your local currency. Make the cheque payable to 'Andrew Duke'. Please also include your name, address and e-mail address, then send it to the address below.

Andrew Duke

136 Wricklemarsh Road

London

SE3 8DR

United Kingdom

Please register my copy of 'Table of Contents'

Name.................................................................................................

Address..............................................................................................

............................................................................................................

............................................................................................................

e-mail address.....................................................................................