locomotive.org


Locomotive Documentation Index

The Locomotive Documentation is divided up into a number of different sections. Each of the links below will open up a different window, which should allow you to click links between the different documents without losing your place.

The Installation Guide leads you through the steps necessary to get your Locomotive up and running as quickly as possible.

Locomotive Java Docs are the Javadoc-generated documentation for all of the Locomotive APIs and sample code.

The Developer's Manual is for developers who wish to implement dynamic Web site features by writing new modules for the Locomotive. It assumes familiarity with SQL relational databases and the SQL language, Java, the JDBC Java-to-database API, and HTML.

The STEAM Manual explains the rules, command syntax, and pre-defined variables of the STEAM template language. Embedded directly into HTML documents, STEAM is a powerful component of the Locomotive which allows you to generate Web pages with dynamic, context-dependent content.

The Administrator's Manual is for System or Database Administrators in charge of making sure everything runs smoothly on the Web site or database server. It tells you how to use the various utility applications for starting and stopping the Locomotive, what the various Locomotive error pages mean, and provides detailed explanations of the different Locomotive configuration files. This manual assumes that you have already installed the Locomotive on your system, and that you are familiar with your operating system (UNIX, Windows, etc.), with the database you're using, with your web server, and with running Java programs on your system.

Locolink tunnel provides information on how to set up the tunnel between a popular third-party web server and the Locomotive. Contains information on both the CGI tunnel and the NSAPI tunnel. You do not need to read this document if you are going to exclusively use the Locomotive Embedded Web Server.

The Sample Modules contains details about the sample modules included in the distribution.

The Locomotive Embedded Web Server contains details about the all Java Web Server which is distributed as part of the Locomotive.

Locomotive Internals is for those who would like to know more about how the Locomotive works, or who would like to start collaborating on the development of the Locomotive internals. It provides brief descriptions about the major classes that make up the core of the Locomotive, as well as descriptions of the Locomotive processes during startup, shutdown, and during a normal request.