NAME

OpenInteract2::Manual - User Guide and Reference Manual for OpenInteract

DESCRIPTION

This is the manual for OpenInteract2. It includes information about how to setup OpenInteract2 (including databases, web servers, etc.), how to develop modules in OpenInteract and how to extend it for your own purposes. It is also a reference for the features OpenInteract2 has with pointers to the relevant module documentation for details.

This manual provides an overview of the framework along with examples, directions, etc. If you need implementation-specific information, please see the documentation for the appropriate module. (All modules are listed below.)

The manual is broken down into:

• OpenInteract2::Manual::Intro

  Provides an introduction to the capabilities of OpenInteract 2 and a quick start guide for setting up a website.

• OpenInteract2::Manual::Tutorial

  Create a new package and modify an existing one. Developers should read this first.

• OpenInteract2::Manual::Conversion

  Read this if you're upgrading an existing OpenInteract 1.x site to OpenInteract 2, particularly if you're going to be migrating custom packages you've developed.

• OpenInteract2::Manual::Changes

  Listing of the changes between OI versions. The major architectural changes between 1.x and 2.x are also listed here.

• OpenInteract2::Manual::Templates

  Using templates.

• OpenInteract2::Manual::Widgets

  Using template widgets.

• OpenInteract2::Manual::Packages

  Learn about a package: how we create distributable OpenInteract2 applications.

• OpenInteract2::Manual::Caching

  How to setup and use content caching.

• OpenInteract2::Manual::Tutorial

  Walk through creating a new package, including templates, actions, data and documentation.

• OpenInteract2::Manual::Authentication

  How to setup authentication and related actions.

• OpenInteract2::Manual::Security

  How task and object security works and how you can change it.

• OpenInteract2::Manual::Management

  Managing OpenInteract2 using oi2_manage and the OpenInteract2::Manage framework.

• OpenInteract2::Manual::AdminDatabase

  Setup databases.

• OpenInteract2::Manual::AdminApache

  Setup Apache/mod_perl.

• OpenInteract2::Manual::Datasource

  How to setup and use datasources.

• OpenInteract2::Manual::DataImport

  Importing data into OpenInteract datasources.

• OpenInteract2::Manual::SPOPS

  How OpenInteract2 enhances SPOPS objects and makes them easier for you to configure.

• OpenInteract2::Manual::SearchResults

  Serializing and retrieving search results.

• OpenInteract2::Manual::LDAP

  How to setup and use LDAP support.

MODULES

• Apache::OpenInteract2: OpenInteract2 Content handler for Apache 1.x

• Apache::OpenInteract2::HttpAuth: Use HTTP authentication to check logins against OpenInteract2 users

• HTTP::Daemon::OpenInteract2: Subclass of HTTP::Daemon for OpenInteract 2

• OpenInteract2::Action: Represent and dispatch actions

• OpenInteract2::Action::Common: Base class for common functionality

• OpenInteract2::Action::CommonAdd: Tasks to display empty form and create an object

• OpenInteract2::Action::CommonDisplay: Task to display an object

• OpenInteract2::Action::CommonRemove: Task to remove an object

• OpenInteract2::Action::CommonSearch: Implement searching functionality for SPOPS::DBI-based objects

• OpenInteract2::Action::CommonUpdate: Task to update an object

• OpenInteract2::Action::TemplateOnly: Base class for template-only actions

• OpenInteract2::Auth: Base class for logging in OpenInteract users

• OpenInteract2::Auth::AdminCheck: See whether user is admin

• OpenInteract2::Auth::Group: Retreive groups into OpenInteract

• OpenInteract2::Auth::User: Base class for creating OpenInteract users

• OpenInteract2::Cache: - Caches objects to avoid database hits and content to avoid template processing

• OpenInteract2::Cache::File: - Implement caching in the filesystem

• OpenInteract2::Config: - Centralized configuration information

• OpenInteract2::Config::Base: Represents a server base configuration

• OpenInteract2::Config::GlobalOverride: - Process global override settings for a set of configuration directives

• OpenInteract2::Config::Ini: Read/write INI-style (++) configuration files

• OpenInteract2::Config::IniFile: OI configuration using INI files

• OpenInteract2::Config::Package: Read, write and check package config files

• OpenInteract2::Config::PackageChanges: Represent entries from a package Changes file

• OpenInteract2::Config::PerlFile: Subclass OpenInteract2::Config to read/write information from/to a perl file

• OpenInteract2::Config::Readonly: Simple read/write for readonly files

• OpenInteract2::Config::TransferSample: On website install or package creation, transfer and modify sample files

• OpenInteract2::Constants: Define codes used throughout OpenInteract

• OpenInteract2::ContentGenerator: Coordinator for classes generating content

• OpenInteract2::ContentGenerator::TT2Context: Provide a custom context for templates in OpenInteract

• OpenInteract2::ContentGenerator::TT2Plugin: Custom OpenInteract functionality in templates

• OpenInteract2::ContentGenerator::TT2Process: Process Template Toolkit templates in OpenInteract

• OpenInteract2::ContentGenerator::TT2Provider: Retrieve templates for the Template Toolkit

• OpenInteract2::ContentGenerator::TemplateSource: Common routines for loading content from OI2 templates

• OpenInteract2::ContentGenerator::TextTemplate: Content generator using Text::Template

• OpenInteract2::Context: Provides the environment for a server

• OpenInteract2::Controller: Top-level controller to generate and place content

• OpenInteract2::Controller::HTML: Controller for HTML content

• OpenInteract2::Controller::ManageBoxes: Mixin methods for managing boxes

• OpenInteract2::Controller::ManageTemplates: Mixin methods for managing templates

• OpenInteract2::Controller::Raw: Basic controller just outputting action content

• OpenInteract2::Conversion::ActionConfig: Convert old action.perl files into INI configurations

• OpenInteract2::Conversion::IniConfig: Parent class for converting perl configurations to INI format

• OpenInteract2::Conversion::SPOPSConfig: Convert old spops.perl files into INI configurations

• OpenInteract2::Cookie: Generic cookie methods

• OpenInteract2::Datasource::DBI: Create DBI database handles

• OpenInteract2::Datasource::LDAP: Centralized connection location to LDAP directories

• OpenInteract2::DatasourceManager: Base class for datasource connection managers

• OpenInteract2::Exception: Base class for exceptions in OpenInteract

• OpenInteract2::Exception::Application: Unknown

• OpenInteract2::Exception::Datasource: Unknown

• OpenInteract2::Exception::Parameter: Unknown

• OpenInteract2::Exception::Security: Unknown

• OpenInteract2::File: Safe filesystem operations for OpenInteract

• OpenInteract2::Manage: Provide common functions and factory for management tasks

• OpenInteract2::Manage::Package: Parent for all package management tasks

• OpenInteract2::Manage::Package::Check: Check validity of a package

• OpenInteract2::Manage::Package::CreatePackage: Create a sample package

• OpenInteract2::Manage::Package::Export: Export a package into a portable format

• OpenInteract2::Manage::Website: Parent for website management tasks

• OpenInteract2::Manage::Website::Create: Create a new website

• OpenInteract2::Manage::Website::CreateSuperuserPassword: Change password for superuser

• OpenInteract2::Manage::Website::InstallPackage: Install a package distribution to a website

• OpenInteract2::Manage::Website::InstallPackageData: Install object/table data from packages

• OpenInteract2::Manage::Website::InstallPackageSecurity: Managment task

• OpenInteract2::Manage::Website::InstallPackageSql: Install SQL structures, object/SQL data and security objects

• OpenInteract2::Manage::Website::InstallPackageStructure: Managment task

• OpenInteract2::Manage::Website::ListActions: List all actions in a website

• OpenInteract2::Manage::Website::ListObjects: Task to list all SPOPS objects in a website

• OpenInteract2::Manage::Website::ListPackages: List packages installed to a website

• OpenInteract2::Manage::Website::RemovePackage: Managment task

• OpenInteract2::Manage::Website::TestDB: Managment task

• OpenInteract2::Manage::Website::TestLDAP: Task to test configured LDAP connections

• OpenInteract2::Manage::Website::ThemeDump: Dump a theme to a themeball

• OpenInteract2::Manage::Website::ThemeInstall: Install a theme from a themeball

• OpenInteract2::Manage::Website::Upgrade: Upgrade website from a new OpenInteract distribution

• OpenInteract2::Manage::Website::ViewSession: View contents of a session

• OpenInteract2::Package: Perform actions on individual packages

• OpenInteract2::Repository: Operations to manipulate package repositories.

• OpenInteract2::Request: Represent a single request

• OpenInteract2::Request::Apache: Read parameters, uploaded files and headers

• OpenInteract2::Request::CGI: Read parameters, uploaded files and headers

• OpenInteract2::Request::LWP: Read parameters, uploaded files and headers

• OpenInteract2::Request::Standalone: Manually create a request object

• OpenInteract2::Response: Information about and actions on an HTTP response

• OpenInteract2::Response::Apache: OpenInteract2::Response::Apache

• OpenInteract2::Response::CGI: OpenInteract2::Response::CGI

• OpenInteract2::Response::LWP: OpenInteract2::Response::CGI

• OpenInteract2::Response::Standalone: OpenInteract2::Response::Standalone

• OpenInteract2::ResultsIterator: Iterator to scroll through search results that are objects of different classes.

• OpenInteract2::ResultsManage: Save and retrieve generic search results

• OpenInteract2::SPOPS: Define common behaviors for all SPOPS objects in the OpenInteract Framework

• OpenInteract2::SPOPS::DBI: Common SPOPS::DBI-specific methods for objects

• OpenInteract2::SPOPS::LDAP: Common SPOPS::LDAP-specific methods for objects

• OpenInteract2::SQLInstall: - Dispatcher for installing various SQL data from packages to database

• OpenInteract2::Session: Implement session handling in the framework

• OpenInteract2::Session::DBI: Create sessions within a DBI data source

• OpenInteract2::Session::File: Create sessions within a filesystem

• OpenInteract2::Session::SQLite: Create sessions within a SQLite data source

• OpenInteract2::Setup: Setup an OpenInteract2::Context object

• OpenInteract2::URL: Create URLs, parse URLs and generate action mappings

• OpenInteract2::Upload: Represent a file upload

• OpenInteract2::Util: Package of routines that do not really fit anywhere else

COPYRIGHT

Copyright (c) 2001-2003 Chris Winters. All rights reserved.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the file titled "COPYING-DOCS".

AUTHORS

Chris Winters <chris@cwinters.com>

The following people have offered patches, advice, development funds, etc. to OpenInteract and OpenInteract2:

• intes.net (http://www.intes.net/) has funded and supported OpenInteract development from its inception.

• Andreas Nolte <andreas.nolte@bertelsmann.de> and his team have contributed lots of great ideas and have been super for bouncing ideas around.

• Christian Lemburg <lemburg@aixonix.de>