elucidator
general-lib
html
html-v1
cgi
time
file-read
URL-coding
color
1
Overall organization.
1.1
An example of an elucidator setup file.
1.2
Organization of the setup file
1.3
Overall documentation processing forms.
1.4
The documentation-entry and documentation-section clauses
1.5
File structure overview
2
Making the program pages
2.1
Getting started: the top level functions
2.2
The overall program traversal and scanning.
2.3
Traversing and scanning lists
2.4
More lexical troubles
2.5
Making links from the program to the documentation
2.6
Marking detailed places in a program
2.7
Preparing the linking to program source markers.
2.8
Linking from source markers in the program.
3
Extracting defined names
3.1
The function defined-names
3.2
The function bounded-names
4
Parsing the textual documentation
4.1
Introduction to the textual documentation format
4.2
The overall ideas
4.3
The top level functions.
4.4
Organizing the parsing process
4.5
The accept functions
4.6
The collection functions
4.7
The skipping functions
4.8
Summary of parsing process
5
Making the documentation page
5.1
The function documentation-contents
5.2
The function do-program-link-documentation
5.3
The state machines which transform the documentation bodies
5.4
The functions which returns a link to a program unit or a documentation unit
5.5
Refined linking possibilities
5.6
Linking between documentation sections and entries.
5.7
Linking from source markers in the documentation.
5.8
Preparing the linking to the documentation source markers.
6
Extracting applied names.
6.1
Overview
6.2
The function applied-names-multiple-sources.
6.3
Extracting applied names from a single form.
7
Making the indexes
7.1
The cross reference index
7.2
Alphabetically organized cross reference indexes
7.3
The duplicated name index
7.4
The defined name index
7.5
Making the table of contents
7.6
Local table of contents
8
Constructing the HTML files.
8.1
Some HTML details.
8.2
The icons
8.3
The program file menu and coloring schemes
8.4
The Help page
9
Handling of bounded names
9.1
Introduction to the problem
9.2
A solution
10
Dealing with comments.
10.1
Problems and existing descriptions
10.2
Ideas to improved handling of comments
10.3
Solution
10.4
Extracting sectional names from comments.
10.5
Look-ahead through comments for a define form
10.6
Presenting syntactical comments.
10.7
Printing the anchor name
10.8
Pretty printing syntactical comments
11
Addressing definitions in specific source files.
11.1
Background
11.2
The solution to the problem
12
Ideas to future work on the Elucdiator tool.
12.1
The ideas
13
Problems and errors in the Elucidator
13.1
The problems and errors
Generated: 26. Marts 2002, 13:25:23