<?xml version='1.0'?>

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
               "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!-- Global variables are defined in variables.ent -->
<!ENTITY % myvars SYSTEM "variables.ent">
%myvars;

]>

<book>
  <title>OpenACS Core Documentation</title>

  <part id="for-everyone">
    <title>OpenACS For Everyone</title>

    <chapter id="general-documents">
      <title>High level information: What is OpenACS?</title>

      <sect1 id="openacs-overview" xreflabel="OpenACS Overview">
        <title>Overview</title>
        <para>
          OpenACS (Open Architecture Community System) is an
          advanced toolkit for building scalable, community-oriented
          web applications.  If you're thinking of building an
          enterprise-level web application, OpenACS is a solid,
          scalable framework for building dynamic content driven
          sites.
        </para>

        <para>
          OpenACS is a collection of pre-built applications and
          services that you can use to build your web
          site/application. Through a modular architecture, OpenACS
          has packages for user/groups management, content
          management, e-commerce, news, FAQs, calendar, forums, bug
          tracking, full-text searching, and <ulink
            url="http://openacs.org/packages/">much
            more</ulink>.
        </para>


        <para>
          OpenACS relies on <ulink
            url="http://www.aolserver.com/">AOLserver</ulink>, the
          free, multithreaded, scalable, Tcl-enabled,
          web/application server used by America Online for most of
          its web sites, and a true ACID-compliant Relational
          Database Management System (RDBMS). Currently OpenACS
          supports PostgreSQL, an open source RDBMS, and Oracle and
          is easily extensible to other databases which support a
          comparable feature set.
        </para>

        <para>
          The OpenACS toolkit is derived from the ArsDigita
          Community System (ACS). ArsDigita (now part of Red Hat,
          Inc.) kindly made their work available under the <ulink
            url="http://www.gnu.org/licenses/gpl.txt">GPL</ulink>,
          making all of this possible.
        </para>

        <para>
          The OpenACS project was born when Don Baccus, Ben Adida, and
          others decided to port ACS from Oracle to PostgreSQL, thus
          making it a fully open-source solution.  With OpenACS 4,
          Oracle and PostgreSQL support were combined in one code base
          and with OpenACS 5, support for internationalization and
          localization has been added.
        </para>

        <para>
          A vibrant and productive community has sprung up around the
          OpenACS software and there are many volunteer contributors
          as well as a commercial companies able to provide support,
          hosting, and custom development.  Many of the production
          users are actively funding and contributing work back to the
          project.  Formal, consensus driven governance has been
          established (with semi-annual elections) which ensures the
          project serves the needs of it's constituents.
        </para>

        <para>
          The OpenACS community would like to hear your comments and
          can help you in your endeavors with the system. Visit our
          <ulink url="http://openacs.org/">web site</ulink> and feel
          free to <ulink url="http://openacs.org/forums/">ask questions or provide feedback</ulink>.
        </para>
      </sect1>
      <xi:include href="for-everyone/release-notes.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Release Notes Section Missing</xi:fallback>
      </xi:include>
    </chapter>
  </part>

  <part id="acs-admin">
    <title>Administrator's Guide</title>

  <chapter id="install-overview">
    <title>Installation Overview</title>

    <authorblurb>
      <para>by <ulink url="mailto:vinod@kurup.com">Vinod Kurup</ulink></para>
    </authorblurb>

    <xi:include href="install-guide/overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
      <xi:fallback>Overview Section Missing</xi:fallback>
    </xi:include>
<!--
    <xi:include href="install-guide/quick.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
      <xi:fallback><para>Quick Guide Missing</para></xi:fallback>
    </xi:include>
-->
    <xi:include href="install-guide/software.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
      <xi:fallback>Section Missing</xi:fallback>
    </xi:include>
    </chapter>

    <chapter id="complete-install">
      <title>Complete Installation</title>
      <xi:include href="install-guide/os.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section Missing</xi:fallback>
      </xi:include>

      <xi:include href="install-guide/oracle.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback><para>Section Missing</para></xi:fallback>
      </xi:include>
      <xi:include  href="install-guide/postgres.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section Missing</xi:fallback>
      </xi:include>

      <xi:include href="install-guide/aolserver4.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section Missing</xi:fallback>
      </xi:include>

      <xi:include href="install-guide/openacs.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section Missing</xi:fallback>
      </xi:include>

      <xi:include href="install-guide/win2kinstall.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>

      <xi:include href="install-guide/macinstall.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
    </chapter>

    <xi:include href="install-guide/configuring.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
      <xi:fallback>Section missing</xi:fallback>
    </xi:include>

    <xi:include href="install-guide/upgrade.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
      <xi:fallback>Section missing</xi:fallback>
    </xi:include>
    
    <xi:include href="install-guide/maintenance.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
      <xi:fallback>Section missing</xi:fallback>
    </xi:include>

    <xi:include href="install-guide/database-maintenance.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
      <xi:fallback>Section missing</xi:fallback>
    </xi:include>

    <xi:include href="install-guide/recovery.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
      <xi:fallback>Section missing</xi:fallback>
    </xi:include>


    <xi:include href="install-guide/red-hat.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
      <xi:fallback>Section missing</xi:fallback>
    </xi:include>

    <xi:include href="install-guide/other-software.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
      <xi:fallback>Section missing</xi:fallback>
    </xi:include>

    <xi:include href="install-guide/credits.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
      <xi:fallback>Credits Section Missing</xi:fallback>
    </xi:include>
  </part>

  <part id="acs-package-dev">
    <title>For OpenACS Package Developers</title>
    <partintro>
      <para>Tutorials and reference material for creating new OpenACS packages.
      </para>
    </partintro>

    <chapter id="tutorial"> 
      <title>Development Tutorial</title>
      <xi:include href="developers-guide/tutorial.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="developers-guide/tutorial-db.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="developers-guide/tutorial-pages.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="developers-guide/tutorial-debug.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
    </chapter>
    <xi:include href="developers-guide/tutorial-advanced.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
      <xi:fallback>Section missing</xi:fallback>
    </xi:include>

    <chapter id="dev-guide">
      <title>Development Reference</title>

      <xi:include href="developers-guide/packages.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="developers-guide/objects.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="developers-guide/rp.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="developers-guide/db-api.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="developers-guide/templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="developers-guide/permissions.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="developers-guide/subsites.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="developers-guide/parties.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="developers-guide/permissions-tediously-explained.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="developers-guide/object-identity.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="developers-guide/programming-with-aolserver.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="developers-guide/form-builder.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
    </chapter>

    <chapter id="eng-standards">
      <title>Engineering Standards</title>

       <xi:include href="engineering-standards/style-guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
 
      <xi:include href="engineering-standards/cvs.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="engineering-standards/eng-standards-versioning.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="engineering-standards/constraint-naming.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="engineering-standards/filenaming.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="engineering-standards/plsql.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="engineering-standards/variables.xml"  xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="engineering-standards/auto-testing.xml"  xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>

    </chapter>

    <chapter id="doc-standards">
      <title>Documentation Standards</title>
      <xi:include href="engineering-standards/docbook-primer.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="engineering-standards/psgml-mode.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="engineering-standards/nxml-mode.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="engineering-standards/design-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="engineering-standards/requirements-template.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
    </chapter>

      <xi:include href="developers-guide/i18n.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>

    <xi:include href="developers-guide/cvs.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
      <xi:fallback>CVS Section missing</xi:fallback>
    </xi:include>

  </part>

  <part id="acs-plat-dev">
    <title>For OpenACS Platform Developers</title>
    <chapter id="kernel-doc">
      <title>Kernel Documentation</title>

      <sect1 id="kernel-overview">
        <title>Overview</title>

        <itemizedlist>
          <listitem>
            <para>
              The <emphasis>OpenACS Kernel</emphasis>, which
              handles system-wide necessities such as metadata,
              security, users and groups, subsites, and package
              management and deployment.
            </para>
          </listitem>
          <listitem>
            <para>
              The <emphasis>OpenACS Core</emphasis>, which
              comprises all the other packages that ship with the
              kernel and are most frequently needed by users, such as
              templating, forums, and user
              registration/management. The packages tend to be
              developed and distributed with the kernel.
            </para>
          </listitem>
          <listitem>
            <para>

              <emphasis>OpenACS Application packages</emphasis>,
              which typically provide user-level
              web services built on top of the Kernel and Core.
              Application packages are
              developed separately from the Kernel, and are typically
              released independently of it.

            </para>
          </listitem>
        </itemizedlist>
        <para>
          This document provides a high level overview of the kernel
          package. <ulink url="index.html">Documentation for other packages on this server</ulink>
        </para>
      </sect1>

      <xi:include href="kernel/object-system-req.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/object-system-design.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/permissions-requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/permissions-design.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/groups-requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/groups-design.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/subsites-requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/subsites-design.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/apm-requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/apm-design.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/db-api.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/i18n-requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/security-requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/security-design.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/security-notes.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/rp-requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/rp-design.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/tcl-doc.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/bootstrap-acs.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
      <xi:include href="kernel/ext-auth.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
        <xi:fallback>Section missing</xi:fallback>
      </xi:include>
    </chapter>
    <xi:include href="releasing-openacs.xml" xmlns:xi="http://www.w3.org/2001/XInclude">
      <xi:fallback>'Releasing OpenACS' missing</xi:fallback>
    </xi:include>

  </part>
<index></index>
</book>
