Introduction

.
__


Teapot-7 Documentor acts as both a documentation
and debugging tool for your Lingo programs.

This program takes the pain out of complex Lingo
projects by producing a set of comprehensively 
linked WWW pages, suitable for local viewing on
recent versions of either Netscape or Explorer.
These pages contain the full text of the scripts 
with comments highlighted, and every use 
or declaration of a handler, a global variable, 
or a symbol made into a hypertext link leading 
to further information. 

While reading scripts you can click on any handler 
name and instantly be taken to the source code, 
or on any global variable or symbol name and 
instantly be taken to a list of all occurrences 
of that variable or symbol.

Scripts and handlers are also indexed both 
alphabetically and in order of occurrence, and 
global variables and symbols are listed in 
tables containing hypertext links to each of 
their occurrences in the scripts.

Perhaps most useful of all is the object browser 
which shows the ancestry of every object, its 
handlers and properties, and the handlers and 
properties it inherits from its ancestors. In a 
neatly laid out table all occurrences of handlers 
and properties in this ancestor chain are arranged 
as hypertext links, making the structure of the 
object clear and the code instantly accesable.

Specially marked comments in the scripts ("--^"
instead of "--") are incorporated into script,
handler and object summaries, allowing selective
extraction of higher level comments.

The problem page lists cases where a local variable
has the same name as a global variable declared 
elsewhere. This often means that the author has 
forgotten to declare a global, thus causing the 
auto-creation of a local variable, and of a hard 
to find bug.

Evaluation versions of the program will only document 
the first seven scripts, and the first seven objects
they find, though they will still list all scripts,
handlers, globals, and symbols.

For a full description of the features of 
Teapot-7 Documentor, see the file "README.DOC" 
which comes with the downloaded Xtra.

If you have any questions, bug reports, feature
requests or comments, please write to 
teapot7@ozemail.com.au