Eli   Documents Get Eli: Translator Construction Made Easy at SourceForge.net.
    Fast, secure and Free Open Source software downloads

General Information

 o Eli: Translator Construction Made Easy
 o Global Index
 o Frequently Asked Questions
 o Typical Eli Usage Errors

Tutorials

 o Quick Reference Card
 o Guide For new Eli Users
 o Release Notes of Eli
 o Tutorial on Name Analysis
 o Tutorial on Type Analysis
 o Typical Eli Usage Errors

Reference Manuals

 o User Interface
 o Eli products and parameters
 o LIDO Reference Manual
 o Typical Eli Usage Errors

Libraries

 o Eli library routines
 o Specification Module Library

Translation Tasks

 o Lexical analysis specification
 o Syntactic Analysis Manual
 o Computation in Trees

Tools

 o LIGA Control Language
 o Debugging Information for LIDO
 o Graphical ORder TOol

 o FunnelWeb User's Manual

 o Pattern-based Text Generator
 o Property Definition Language
 o Operator Identification Language
 o Tree Grammar Specification Language
 o Command Line Processing
 o COLA Options Reference Manual

 o Generating Unparsing Code

 o Monitoring a Processor's Execution

Administration

 o System Administration Guide

Mail Home

Guide for New Eli Users

Previous Chapter Next Chapter Table of Contents


System Documentation

The Eli system documentation is divided into three basic groups:

Tutorial
Strategies and examples for using Eli. The purpose of this material is to present simple techniques that work. Only points that we have found important for most users are covered.

Reference
Detailed definitions of notation and behavior. The purpose of this material is to answer any question that might arise. There is a reference manual for each of the notations understood by Eli, including the language in which requests for processor construction are made. All of the products that can be requested, and all of the parameters that can be used to modify those requests, are the subject of a separate reference manual. Finally, there is a reference manual for the on-line documentation browser.

Administration
Strategies for installing, configuring and maintaining Eli. The purpose of this material is to guide the person responsible for Eli at a particular installation.

All of the documentation is available both on-line and in printed form. Documents are stored on line as hypertext, and can be used to support the debugging phase of a project.

How On-line Documentation Supports Debugging

Two levels of debugging are necessary when using Eli:

  1. The specifications you present to Eli may be inconsistent or ill-formed. In that case, Eli will provide error reports in the same way as any compiler. You must correct the specifications so that they are well-formed and consistent.

  2. You have presented a correct specification to Eli, but this specification describes the wrong problem instance. Now you must determine how the problem instance you have described differs from the one you are really interested in, and change the specification accordingly.

On-line documentation for Eli can only provide support for level (1), because level (2) does not involve symptoms that can be diagnosed by Eli.

Eli presents error reports to a user only on request. The available requests are described in Diagnosing Specification Inconsistencies of Products and Parameters Reference Manual. One of these requests is :help. This request builds a new hypertext subtree containing the error reports, embedded in the text to which they refer. The files containing the errors are made accessible to the nodes describing those errors, so that the user can correct them directly.

To correct a file, move the browser to the node describing the errors in that file. Execute the browser's edit command and make whatever changes are necessary. Then exit the editor.

Error reports are also linked to the nodes of the on-line documentation describing the constructs in which the errors were detected. Thus the user is placed in an environment in which all of the information needed to diagnose the errors, and the tools needed to correct them, are immediately at hand.


Previous Chapter Next Chapter Table of Contents