NAME

WebApp::Documentation::Index - Master Index of WebApp PODs

VERSION

  Time-stamp: <2006-06-18 00:22:20 mailto:attila@stalphonsos.com>
  $Id: Index.pm,v 1.6 2006/07/13 19:13:40 attila Exp $

SYNOPSIS

  $ perldoc WebApp::Documentation::Index

DESCRIPTION

This POD points at all of the other PODs in WebApp, and briefly describes what they are and who should read them.

Documentation PODs

This is the set of modules that exist only to hold PODs, for your reading pleasure:

WebApp::Documentation - Reference Manual

The reference manual. Large. Full of nutritious fibre. Definitive source of answers to most questions.

Audience: hackers

Link: WebApp::Documentation

WebApp::Documentation::Index - This Thing Right Here

Boo!

Audience: anyone

Link: Not needed.

WebApp::Documentation::Rationale - White Paper on Rationale

A short white paper that discusses the rationale behind WebApp, with examples.

Audience: anyone technical

Link: WebApp::Documentation::Rationale

WebApp::Documentation::TemplateApp - Tour of the Template Application

A tour guide for the template application, which almost all WebApp users will play with at least once. Contains a basic overview, plus a file-by-file breakdown of everything in the template app.

Audience: hackers

Link: WebApp::Documentation::TemplateApp

WebApp::Documentation::QuickStart - Quick-Start Doc for the Congenitally Impatient

Quick-start guide for the impatient. A short, simple document that will get you started if you're in a hurry.

Audience: anyone technical

Link: WebApp::Documentation::QuickStart

Module PODs

These are PODs for the modules that comprise WebApp, and are generally method-by-method (or sub by sub) descriptions of the API presented by the module.

WebApp - CLI Tools, VERSION

Module used mainly by the webapp command-line program. Also contains the version of WebApp in $WebApp::VERSION.

Audience: sysadmins

Link: WebApp

WebApp::Config - Config File API

OO interface to the app configuration file.

Audience: hackers, sysadmins

Link: WebApp::Config

WebApp::Component - HTML Suss Engine

The core of the s/// engine and the driver logic lives here. Normally not used or seen by mortal hackers.

Audience: WebApp developers

Link: WebApp::Component

WebApp::Session - A User Session

A session object. Each session can have an arbitrary set of key=val pairs of unlimited size. WebApp takes care of maintaining this state for you.

Audience: WebApp developers

Link: WebApp::Session

WebApp::Stored - Base Class for Stored Objects

An abstract superclass that implements a generic, database-backed object concept, including many-to-one relationships and other advanced features. The default template used to generate the automatically-generated portions of database-backed objects inherits from this class by default. See the mkstored POD for more details.

Audience: hackers

Link: WebApp::Stored

WebApp::Thing - Base Class for non-Stored Objects

Abstract superclass for a generic thing with arbitrary attributes. Used as a base class by WebApp::Xaction, and is generally useful for any non-database-backed object. Eventually, this will replace WebApp::Stored as the base class for database-backed objects, too.

Audience: hackers

Link: WebApp::Thing

WebApp::User - A User Identity

A user identity. Can be tied to sessions. Can be used to store the state of a user's session upon logout and restore it automatically on the next login.

Audience: WebApp developers

Link: WebApp::User

WebApp::Utils - Miscellany

A collection of random utility subs that don't go anywhere else

Audience: hackers

Link: WebApp::Utils

WebApp::Xaction - An HTTP Transaction and its State

An abstract superclass that implements the idea of a web transaction. Used and extended by the template application. You don't have to use it, but it's probably a good idea to check it out.

Audience: hackers

Link: WebApp::Xaction

Command-Line Program PODs

mkstored - DDL => Class.pm file

A tool that parses the DDL for your application and generates database-backed object classes based on it.

Audience: hackers

Link: mkstored

webapp - General Admin Command-Line Tool

Command-line interface to basic WebApp administrative functions, including user management, new application creation, application installation, etc.

Audience: sysadmins

Link: webapp

AUTHOR

Sean Levy <mailto:snl@cluefactory.com>

COPYRIGHT AND LICENSE

(C) 2002-2006 by Sean Levy <mailto:snl@cluefactory>. all rights reserved.

This code is released under a BSD license. Please see the LICENSE file that came with the source distribution, or visit http://cluefactory.com/oss/WebApp/license.html