The API Doc allows searches on all the active running code on the system, and general browsing of active running code, listed by package. The two primary coding languages present in the API are TCL and PostgreSQL. Basically this a graphical interface that presents and hyperlinks, and indexes the contents of the "sql/, tcl/, and www/" directories found in each package. The API Home Page consists of two important components:
The entry for each package consists of:
A listing of all ".tcl" files contained within this package. These files contain all the procedures used in code execution, therefore the majority of the file names are terminated in "procs.tcl". This is an alphabetically sorted list view of the files contained within the "tcl" directory of the files found in each package.
Clicking on an individual file name links to a page displaying a listing of all the procedures within the file and their names. If you are interested in the source code of a particular procedure, click on the specific procedure name. Procedures used internally by this procedure are hyper-linked to their own source. The source of accompanying Generic/PostgreSQL/Oracle XQL files is also shown, if available.
This is a listing of all the procedures contained in the .tcl files of this package, presented alphabetically. Each procedure name links to a screen showing what specific .tcl file this procedure can be in and belongs to. Also , the source of the each procedure can be seen, as well as the source of related XQL files, if available. Note that procedures called within the body of this procedure are hyper-linked, so that you can quickly jump and see their source as well.
A listing of all ".sql" files contained within this package. These files contain all the create/delete/update routines run on the database. This is an alphabetically sorted list view of the files contained within the "sql" directory of files found in each package. Clicking on a particular file name will link to the source of the file.
A listing of all files responsible for generating HTML webpages that are the interactive screens that end users view and use to interact with ]project-open[. The majority of files responsible for dynamically generating content are ".tcl" or ".adp" for AOL dynamic pages. This is an alphabetically sorted list view of the files contained within the "www" directory of files found in each package. Clicking on a particular file name will link to the source of the file.