Index: openacs-4/packages/acs-core-docs/www/index.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/index.html,v diff -u -r1.33 -r1.33.2.1 --- openacs-4/packages/acs-core-docs/www/index.html 4 Mar 2004 14:09:22 -0000 1.33 +++ openacs-4/packages/acs-core-docs/www/index.html 18 Apr 2004 11:55:50 -0000 1.33.2.1 @@ -1 +1 @@ -OpenACS Core Documentation

		Next

OpenACS Core Documentation

Table of Contents

I. OpenACS For Everyone

1. High level information: What is OpenACS?

Overview
OpenACS Release Notes

II. Administrator's Guide

2. Installation Overview

Basic Steps
Prerequisite Software

3. Complete Installation

Install a Unix-like system and supporting software
Install Oracle 8.1.7
Install PostgreSQL
Install AOLserver 4
Install OpenACS 5.1.0d2
OpenACS Installation Guide for Windows2000
OpenACS Installation Guide for Mac OS X

4. Configuring a new OpenACS Site

How Do I?

5. Upgrading

Overview
Upgrading 4.5 or higher to 4.6.3
Upgrading OpenACS 4.6.3 to 5.0
Upgrading 5.0.0 to 5.0.x
Upgrading the OpenACS files
Upgrading Platform components

6. Production Environments

Starting and Stopping an OpenACS instance.
AOLserver keepalive with inittab
Running multiple services on one machine
High Availability/High Performance Configurations
Staged Deployment for Production Networks
Installing SSL Support
Set up Log Analysis Reports
External uptime validation
Diagnosing Performance Problems

7. Database Management

Running a PostgreSQL database on another server
Deleting a tablespace
Vacuum Postgres nightly

8. Backup and Recovery

Backup Strategy
Manual backup and recovery
Automated Backup
Using CVS for backup-recovery

A. Install Red Hat 8/9

B. Install additional supporting software

Unpack the OpenACS tarball
Initialize CVS (OPTIONAL)
Add PSGML commands to emacs init file (OPTIONAL)
Install Daemontools (OPTIONAL)
Install qmail (OPTIONAL)
Install Analog web file analyzer
Install nspam
Install Full Text Search
Install nsopenssl
Install tclwebtest.
Install PHP for use in AOLserver
Install Squirrelmail for use as a webmail system for OpenACS
Install AOLserver 3.3oacs1

Where did this document come from?
Linux Install Guides
Security Information
Resources

III. For OpenACS Package Developers

1. Development Tutorial

Creating a Package
Setting Up Database Objects
Creating Web Pages
Debugging and Automated Testing

2. Advanced Topics

Write the Requirements and Design Specs
Add the new package to CVS
Adding Comments
Admin Pages
Categories
Categories
Prepare the package for distribution.
Notifications
Using .vuh files for pretty urls

3. Development Reference

OpenACS Packages
OpenACS Data Models and the Object System
The Request Processor
The OpenACS Database Access API
Using Templates in OpenACS
Groups, Context, Permissions
Writing OpenACS Application Pages
Parties in OpenACS
OpenACS Permissions Tediously Explained
Object Identity
Programming with AOLserver
Using HTML Forms

4. Engineering Standards

OpenACS Style Guide
Release Version Numbering
Constraint naming standard
ACS File Naming and Formatting Standards
PL/SQL Standards
Variables
Automated Testing

5. Documentation Standards

OpenACS Documentation Guide
Using PSGML mode in Emacs
Using nXML mode in Emacs
Detailed Design Documentation Template
System/Application Requirements Template

6. Internationalization


Translator's Guide
Introduction to Developing Internationalized Packages
Internationalizing Existing Packages
Design Notes

B. Using CVS with an OpenACS Site

IV. For OpenACS Platform Developers

7. Kernel Documentation

Overview
Object Model Requirements
Object Model Design
Permissions Requirements
Permissions Design
Groups Requirements
Groups Design
Subsites Requirements
Subsites Design Document
Package Manager Requirements
Package Manager Design
Database Access API
OpenACS Internationalization Requirements
Security Requirements
Security Design
Security Notes
Request Processor Requirements
Request Processor Design
Documenting Tcl Files: Page Contracts and Libraries
Bootstrapping OpenACS
External Authentication Requirements

8. Releasing OpenACS

OpenACS Core and .LRN
How to Update the OpenACS.org repository
How to package and release an OpenACS Package
How to Update the translations

List of Figures

4.1. Site Templates
5.1. Upgrading with the APM
5.2. Upgrading a local CVS repository
6.1. Multiple-server configuration
6.2. Simple A/B Deployment - Step 1
6.3. Simple A/B Deployment - Step 2
6.4. Simple A/B Deployment - Step 3
6.5. Complex A/B Deployment - Step 1
6.6. Complex A/B Deployment - Step 2
6.7. Complex A/B Deployment - Step 3
6.8. Query Analysis example
8.1. Backup and Recovery Strategy
1.1. Assumptions in this section
1.2. Tutorial Data Model
1.3. Database Creation Script - master create file
1.4. Database deletion script
1.5. Page Map
2.1. Upgrading a local CVS repository

List of Tables

2.1. Default directories for a standard install
2.2. Version Compatibility Matrix
5.1. Assumptions in this section
6.1. How it Works
3.1. Context Hierarchy Example
3.2. acs_objects example data
6.1. Internationalization and Localization

List of Examples

4.1. Getting datetime from the database ANSI-style

		Next
		Part�I.�OpenACS For Everyone

docs@openacs.org

View comments on this page at openacs.org +OpenACS Core Documentation

		Next

OpenACS Core Documentation

Table of Contents

I. OpenACS For Everyone

1. High level information: What is OpenACS?

Overview
OpenACS Release Notes

II. Administrator's Guide

2. Installation Overview

Basic Steps
Prerequisite Software

3. Complete Installation

Install a Unix-like system and supporting software
Install Oracle 8.1.7
Install PostgreSQL
Install AOLserver 4
Install OpenACS 5.1.0b1
OpenACS Installation Guide for Windows2000
OpenACS Installation Guide for Mac OS X

4. Configuring a new OpenACS Site

How Do I?

5. Upgrading

Overview
Upgrading 4.5 or higher to 4.6.3
Upgrading OpenACS 4.6.3 to 5.0
Upgrading 5.0.0 to 5.0.x
Upgrading the OpenACS files
Upgrading Platform components

6. Production Environments

Starting and Stopping an OpenACS instance.
AOLserver keepalive with inittab
Running multiple services on one machine
High Availability/High Performance Configurations
Staged Deployment for Production Networks
Installing SSL Support for an OpenACS service
Set up Log Analysis Reports
External uptime validation
Diagnosing Performance Problems

7. Database Management

Running a PostgreSQL database on another server
Deleting a tablespace
Vacuum Postgres nightly

8. Backup and Recovery

Backup Strategy
Manual backup and recovery
Automated Backup
Using CVS for backup-recovery

A. Install Red Hat 8/9

B. Install additional supporting software

Unpack the OpenACS tarball
Initialize CVS (OPTIONAL)
Add PSGML commands to emacs init file (OPTIONAL)
Install Daemontools (OPTIONAL)
Install qmail (OPTIONAL)
Install Analog web file analyzer
Install nspam
Install Full Text Search
Install nsopenssl
Install tclwebtest.
Install PHP for use in AOLserver
Install Squirrelmail for use as a webmail system for OpenACS
Install AOLserver 3.3oacs1

Where did this document come from?
Linux Install Guides
Security Information
Resources

III. For OpenACS Package Developers

1. Development Tutorial

Creating a Package
Setting Up Database Objects
Creating Web Pages
Debugging and Automated Testing

2. Advanced Topics

Write the Requirements and Design Specs
Add the new package to CVS
Adding Comments
Admin Pages
Categories
Categories
Profile your code
Prepare the package for distribution.
Notifications
Hierarchical data
Using .vuh files for pretty urls
Future Topics

3. Development Reference

OpenACS Packages
OpenACS Data Models and the Object System
The Request Processor
The OpenACS Database Access API
Using Templates in OpenACS
Groups, Context, Permissions
Writing OpenACS Application Pages
Parties in OpenACS
OpenACS Permissions Tediously Explained
Object Identity
Programming with AOLserver
Using HTML Forms

4. Engineering Standards

OpenACS Style Guide
Release Version Numbering
Constraint naming standard
ACS File Naming and Formatting Standards
PL/SQL Standards
Variables
Automated Testing

5. Documentation Standards

OpenACS Documentation Guide
Using PSGML mode in Emacs
Using nXML mode in Emacs
Detailed Design Documentation Template
System/Application Requirements Template

6. Internationalization


How Internationalization/Localization works in OpenACS
How to Internationalize a Package
Design Notes
Translator's Guide

B. Using CVS with an OpenACS Site

IV. For OpenACS Platform Developers

7. Kernel Documentation

Overview
Object Model Requirements
Object Model Design
Permissions Requirements
Permissions Design
Groups Requirements
Groups Design
Subsites Requirements
Subsites Design Document
Package Manager Requirements
Package Manager Design
Database Access API
OpenACS Internationalization Requirements
Security Requirements
Security Design
Security Notes
Request Processor Requirements
Request Processor Design
Documenting Tcl Files: Page Contracts and Libraries
Bootstrapping OpenACS
External Authentication Requirements

8. Releasing OpenACS

OpenACS Core and .LRN
How to Update the OpenACS.org repository
How to package and release an OpenACS Package
How to Update the translations

List of Figures

4.1. Site Templates
4.2. Granting Permissions
4.3. Granting Permissions in 5.0
5.1. Upgrading with the APM
5.2. Upgrading a local CVS repository
6.1. Multiple-server configuration
6.2. Simple A/B Deployment - Step 1
6.3. Simple A/B Deployment - Step 2
6.4. Simple A/B Deployment - Step 3
6.5. Complex A/B Deployment - Step 1
6.6. Complex A/B Deployment - Step 2
6.7. Complex A/B Deployment - Step 3
6.8. Query Analysis example
8.1. Backup and Recovery Strategy
1.1. Assumptions in this section
1.2. Tutorial Data Model
1.3. Database Creation Script - master create file
1.4. Database deletion script
1.5. Page Map
2.1. Upgrading a local CVS repository

List of Tables

2.1. Default directories for a standard install
2.2. Version Compatibility Matrix
5.1. Assumptions in this section
6.1. How it Works
3.1. Context Hierarchy Example
3.2. acs_objects example data
6.1. Internationalization and Localization

List of Examples

4.1. Getting datetime from the database ANSI-style

		Next
		Part�I.�OpenACS For Everyone

docs@openacs.org

View comments on this page at openacs.org