Index: openacs-4/readme.txt =================================================================== RCS file: /usr/local/cvsroot/openacs-4/readme.txt,v diff -u -r1.13.2.2 -r1.13.2.3 --- openacs-4/readme.txt 20 Oct 2005 18:05:17 -0000 1.13.2.2 +++ openacs-4/readme.txt 1 Dec 2005 17:45:49 -0000 1.13.2.3 @@ -1,6 +1,6 @@ This is the OpenACS - the Open Architecture Community System. -Version 5.2.0 release candidate 1 +Version 5.2.0 release candidate 3 -------------- Index: openacs-4/packages/acs-core-docs/www/backup-recovery.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/backup-recovery.html,v diff -u -r1.36.2.3 -r1.36.2.4 --- openacs-4/packages/acs-core-docs/www/backup-recovery.html 30 Nov 2005 05:21:56 -0000 1.36.2.3 +++ openacs-4/packages/acs-core-docs/www/backup-recovery.html 1 Dec 2005 17:45:49 -0000 1.36.2.4 @@ -7,4 +7,4 @@ probably need to create your own backup strategies (in particular full dumps from oracle, while easy to set up, are far from the best solution).

There are three basic things which need to be backed up, the database data, the server - source tree, and the acs-content-repository (which is in the server source tree).

Figure�8.1.�Backup and Recovery Strategy

Backup and Recovery Strategy
($Id$)
Prev Home Next
Vacuum Postgres nightly Up Backup Strategy
docs@openacs.org
View comments on this page at openacs.org
+ source tree, and the acs-content-repository (which is in the server source tree).

Figure�8.1.�Backup and Recovery Strategy

Backup and Recovery Strategy
($Id$)
Prev Home Next
Vacuum Postgres nightly Up Backup Strategy
docs@openacs.org
View comments on this page at openacs.org
Index: openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.html,v diff -u -r1.1.2.3 -r1.1.2.4 --- openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.html 30 Nov 2005 05:21:56 -0000 1.1.2.3 +++ openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.html 1 Dec 2005 17:45:49 -0000 1.1.2.4 @@ -1,7 +1,7 @@ Configuring an OpenACS package
Alex logo
Prev Chapter�4.�Configuring a new OpenACS Site Next

Configuring an OpenACS package

by Jade Rubick

OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff. -

Configuring an OpenACS package

After you've installed and mounted your package, you can +

Configuring an OpenACS package

After you've installed and mounted your package, you can configure each instance to act as you would like.

This is done from the Applications page. Log in, go to the Admin or Control Panel, click on the subsite the application is in, and click on Applications. If you click on the 'Parameters' Index: openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.html,v diff -u -r1.1.2.3 -r1.1.2.4 --- openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.html 30 Nov 2005 05:21:56 -0000 1.1.2.3 +++ openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.html 1 Dec 2005 17:45:49 -0000 1.1.2.4 @@ -1,7 +1,7 @@ Setting Permissions on an OpenACS package

Alex logo
Prev Chapter�4.�Configuring a new OpenACS Site Next

Setting Permissions on an OpenACS package

by Jade Rubick

OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff. -

Setting Permission on an OpenACS package

After you've installed and mounted your package, you can +

Setting Permission on an OpenACS package

After you've installed and mounted your package, you can configure each instance to act as you would like.

This is done from the Applications page. Log in, go to the Admin or Control Panel, click on the subsite the application is in, and click on Applications. If you click on the 'Permissions' Index: openacs-4/packages/acs-core-docs/www/configuring-install-packages.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-install-packages.html,v diff -u -r1.1.2.3 -r1.1.2.4 --- openacs-4/packages/acs-core-docs/www/configuring-install-packages.html 30 Nov 2005 05:21:56 -0000 1.1.2.3 +++ openacs-4/packages/acs-core-docs/www/configuring-install-packages.html 1 Dec 2005 17:45:49 -0000 1.1.2.4 @@ -1,7 +1,7 @@ Installing OpenACS packages

Alex logo
Prev Chapter�4.�Configuring a new OpenACS Site Next

Installing OpenACS packages

by Jade Rubick

OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff. -

Installing OpenACS packages

An OpenACS package extends your website and lets it do +

Installing OpenACS packages

An OpenACS package extends your website and lets it do things it wasn't able to do before. You can have a weblog, a forums, a calendar, or even do sophisticated project-management via your website.

After you've installed OpenACS, you can congratulate Index: openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.html,v diff -u -r1.1.2.3 -r1.1.2.4 --- openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.html 30 Nov 2005 05:21:56 -0000 1.1.2.3 +++ openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.html 1 Dec 2005 17:45:49 -0000 1.1.2.4 @@ -1,7 +1,7 @@ Mounting OpenACS packages

Alex logo
Prev Chapter�4.�Configuring a new OpenACS Site Next

Mounting OpenACS packages

by Jade Rubick

OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff. -

Mounting OpenACS packages

After you've installed your packages, you have to 'mount' +

Mounting OpenACS packages

After you've installed your packages, you have to 'mount' them in order to make them appear on your website.

Make sure you are logged in, and then click on the 'Admin' or 'Control Panel' link to get to the Site-Wide Administration page (at /acs-admin). Click on the subsite you'd Index: openacs-4/packages/acs-core-docs/www/contributing-code.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/Attic/contributing-code.html,v diff -u -r1.2.2.3 -r1.2.2.4 --- openacs-4/packages/acs-core-docs/www/contributing-code.html 30 Nov 2005 05:21:56 -0000 1.2.2.3 +++ openacs-4/packages/acs-core-docs/www/contributing-code.html 1 Dec 2005 17:45:49 -0000 1.2.2.4 @@ -135,7 +135,7 @@ flag which defaults to no-effect wouldn't require a TIP. Added a new mandatory flag to an existing function would require a TIP. -

+

Reasons

We don't currently have clear standards for committing @@ -171,7 +171,7 @@ applies to all packages. This tag can be used to fork packages as needed, and provides a common ancestor between the fork and the OpenACS code so that patches can be generated. -

+

Informal Guidelines

Informal guidelines which may be obsolete in places and should be reviewed: Index: openacs-4/packages/acs-core-docs/www/cvs-tips.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/cvs-tips.html,v diff -u -r1.26.2.3 -r1.26.2.4 --- openacs-4/packages/acs-core-docs/www/cvs-tips.html 30 Nov 2005 05:21:56 -0000 1.26.2.3 +++ openacs-4/packages/acs-core-docs/www/cvs-tips.html 1 Dec 2005 17:45:49 -0000 1.26.2.4 @@ -1,7 +1,7 @@ Appendix�D.�Using CVS with an OpenACS Site

Alex logo
Prev Part�III.�For OpenACS Package Developers Next

Appendix�D.�Using CVS with an OpenACS Site

By Joel Aufrecht

OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff. -

Add the Service to CVS - OPTIONAL.�These steps take an existing OpenACS directory and add +

Add the Service to CVS - OPTIONAL.�These steps take an existing OpenACS directory and add it to a CVS repository.

  1. Create and set permissions on a subdirectory in the local cvs repository.

    [root root]# mkdir /cvsroot/$OPENACS_SERVICE_NAME
 [root root]# chown $OPENACS_SERVICE_NAME.$OPENACS_SERVICE_NAME /cvsroot/$OPENACS_SERVICE_NAME
Index: openacs-4/packages/acs-core-docs/www/docbook-primer.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/docbook-primer.html,v
diff -u -r1.43.2.3 -r1.43.2.4
--- openacs-4/packages/acs-core-docs/www/docbook-primer.html	30 Nov 2005 05:21:56 -0000	1.43.2.3
+++ openacs-4/packages/acs-core-docs/www/docbook-primer.html	1 Dec 2005 17:45:49 -0000	1.43.2.4
@@ -574,7 +574,7 @@
       sufficient. We could even write our own, or just use the
       OpenACS templating system via the Edit-This-Page package.
       However,
-       
+       
       is a publishing standard based on XML with
       similar goals to the OpenACS Documentation project.  Some specific reasons why we are using DocBook:
     
    •       
@@ -638,7 +638,7 @@
     list of elements and use more exotic features in your
       documents. The list is made up of SGML-elements but basically
       the same elements are valid in the XML DTD as long as you remember to:
-      
+      
     
      • 
       Always close your tags with corresponding end-tags and to
       not use other tag minimization
@@ -687,7 +687,7 @@
       The documentation for each package will make up a little "book" that is structured like this 
       - examples are emphasized:
 
-      
+      
 
     
             book                        : Docs for one package - templating
@@ -711,20 +711,20 @@
       sources of these DocBook documents
       to get an idea of how they are tied together.
     
      Headlines, Sections
      
-      
+      
       Given that your job starts at the sect1-level, all your documents should open with a
       <sect1>-tag and end 
       with the corresponding </sect1>.
     
      
-      
+      
       You need to feed every <sect1> two attributes. The first attribute,
       id, is standard and can be used with all elements. It comes in  very 
       handy when interlinking between documents (more about this when talking about links in the section called “Links”). 
       The value of id has to be unique 
       throughout the book you're making since the id's in your 
       sect1's will turn into filenames when the book is parsed into HTML.
     
      
-      
+      
       The other attribute is xreflabel. The value of this is the text that will appear
       as the link when referring to this sect1.
     
      
@@ -739,7 +739,7 @@
 
 </sect1>

    - + Inside this container your document will be split up into <sect2>'s, each with the same requirements - id and xreflabel @@ -748,7 +748,7 @@ When it comes to naming your sect2's and below, prefix them with some abbreviation of the id in the sect1 such as requirements-overview.

Code

- + For displaying a snippet of code, a filename or anything else you just want to appear as a part of a sentence, we will use the tag <computeroutput>. @@ -758,12 +758,12 @@ <programlisting> is used. Just wrap your code block in it; mono-spacing, indents and all that stuff is taken care of automatically.

Links

- + Linking falls into two different categories: inside the book you're making and outside:

1. Inside linking, cross-referencing other parts of your book

By having unique id's you can cross-reference any part of your book with a simple tag, regardless of where that part is. -

Check out how I link to a subsection of the Developer's Guide:

Put this in your XML:

+      
Check out how I link to a subsection of the Developer's Guide:
Put this in your XML:
 - Find information about creating a package in
 <xref linkend="packages-making-a-package"></xref>.
 
And the output is:
@@ -787,7 +787,7 @@
         packages-looks, the
         parser will try its best to explain where the link takes you.
2. Linking outside the documentation

- + If you're hyper-linking out of the documentation, it works almost the same way as HTML - the tag is just a little different @@ -808,7 +808,7 @@ do it, so if you want to start converting your documents right away, start out with the ones without graphics ;)

- + To insert a graphic we use the elements <mediaobject>, <imageobject>, @@ -834,7 +834,7 @@ Put your graphics in a separate directory ("images") and link to them only with relative paths.

Lists

- + Here's how you make the DocBook equivalent of the three usual HTML-lists:

1. How to make an <ul>

Making an unordered list is pretty much like doing the same thing in HTML - if you close your <li>, that is. The only differences are that each list item has to be wrapped in something more, such as @@ -879,7 +879,7 @@ </variablelist>

Tables

- + DocBook supports several types of tables, but in most cases, the <informaltable> is enough: @@ -916,7 +916,7 @@ <table> for an example.

Emphasis

- + Our documentation uses two flavors of emphasis - italics and bold type. DocBook uses one - <emphasis>.

Index: openacs-4/packages/acs-core-docs/www/ext-auth-requirements.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/ext-auth-requirements.html,v diff -u -r1.31.2.3 -r1.31.2.4 --- openacs-4/packages/acs-core-docs/www/ext-auth-requirements.html 30 Nov 2005 05:21:56 -0000 1.31.2.3 +++ openacs-4/packages/acs-core-docs/www/ext-auth-requirements.html 1 Dec 2005 17:45:49 -0000 1.31.2.4 @@ -1,4 +1,4 @@ -External Authentication Requirements

Alex logo
Prev Chapter�17.�Kernel Documentation Next

External Authentication Requirements

Vision

People have plenty of usernames and passwords already, we +External Authentication Requirements

Alex logo
Prev Chapter�17.�Kernel Documentation Next

External Authentication Requirements

Vision

People have plenty of usernames and passwords already, we don't want them to have yet another. We want people to be able to log in to OpenACS with the same password they use to log in to any other system.

Besides, administrators have better things to do than create @@ -44,7 +44,7 @@ only one implementation of the authentication API, namly the one included in OpenACS Core.

  • Authentication Driver API: The service contract which authentication drivers implement.

    • Conceptual Pictures

    Authentication:

    -

    Account Management (NO PICTURE YET)

    Batch Synchronization (NO PICTURE YET)

    Requirements

    New API

    FeatureStatusDescription
    EXT-AUTH-01AExtend Authentication/Acct Status API
    EXT-AUTH-03AAccount Creation API
    EXT-AUTH-05APassword Management API
    EXT-AUTH-30AAuthority Management API

    Login

    FeatureStatusDescription
    EXT-AUTH-04ARewrite login, register, and admin pages to use APIs
    EXT-AUTH-38Aad_form complain feature
    EXT-AUTH-19ARewrite password recovery to use API
    EXT-AUTH-21ARewrite email verification with API
    EXT-AUTH-28AUsername is email switch

    Users will log in using a username, a authority, and a +

    Account Management (NO PICTURE YET)

    Batch Synchronization (NO PICTURE YET)

    Requirements

    New API

    FeatureStatusDescription
    EXT-AUTH-01AExtend Authentication/Acct Status API
    EXT-AUTH-03AAccount Creation API
    EXT-AUTH-05APassword Management API
    EXT-AUTH-30AAuthority Management API

    Login

    FeatureStatusDescription
    EXT-AUTH-04ARewrite login, register, and admin pages to use APIs
    EXT-AUTH-38Aad_form complain feature
    EXT-AUTH-19ARewrite password recovery to use API
    EXT-AUTH-21ARewrite email verification with API
    EXT-AUTH-28AUsername is email switch

    Users will log in using a username, a authority, and a password. The authority is the source for user/password verification. OpenACS can be an authority itself.

    Each user in OpenACS will belong to exactly one authority, which can either be the "local" OpenACS users table, in which case the Index: openacs-4/packages/acs-core-docs/www/form-builder.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/form-builder.html,v diff -u -r1.21.2.3 -r1.21.2.4 --- openacs-4/packages/acs-core-docs/www/form-builder.html 30 Nov 2005 05:21:56 -0000 1.21.2.3 +++ openacs-4/packages/acs-core-docs/www/form-builder.html 1 Dec 2005 17:45:49 -0000 1.21.2.4 @@ -1,4 +1,4 @@ -Using HTML Forms

    Alex logo
    Prev Chapter�11.�Development Reference Next

    Using HTML Forms

    Overview

    Multi-part Elements

    Some elements have more than one choice, or can submit more than one value.

    SELECT elements

    1. Creating the form element.�Populate a list of lists with values for the option list.

      set foo_options [db_list_of_lists foo_option_list "
+Using HTML Forms
      Alex logo
      Prev Chapter�11.�Development Reference Next
      Using HTML Forms
      Overview
      Multi-part Elements
      Some elements have more than one choice, or can submit more than one value.
      SELECT elements
      1. Creating the form element.�Populate a list of lists with values for the option list.
        set foo_options [db_list_of_lists foo_option_list "
     select foo,
            foo_id
       from foos
@@ -43,5 +43,5 @@
     ns_set print $mypage
 }
     
      Tips for form widgets
      Here are some tips for dealing with some of the form widgets:
      Current widget
      Common Errors
      Here are some common errors and what to do when you
-    encounter them:
      Error when selecting values
      This generally happens when there is an error in your
+    encounter them:
      Error when selecting values
      This generally happens when there is an error in your
           query.
      ($Id$)
      Prev Home Next
      Programming with AOLserver Up Chapter�12.�Engineering Standards
      docs@openacs.org
      View comments on this page at openacs.org
      
Index: openacs-4/packages/acs-core-docs/www/high-avail.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/high-avail.html,v
diff -u -r1.15.2.3 -r1.15.2.4
--- openacs-4/packages/acs-core-docs/www/high-avail.html	30 Nov 2005 05:21:56 -0000	1.15.2.3
+++ openacs-4/packages/acs-core-docs/www/high-avail.html	1 Dec 2005 17:45:49 -0000	1.15.2.4
@@ -1 +1 @@
-High Availability/High Performance Configurations
      Alex logo
      Prev Chapter�6.�Production Environments Next
      High Availability/High Performance Configurations
      See also the section called “Running a PostgreSQL database on another server”.
      Figure�6.1.�Multiple-server configuration
      Multiple-server configuration
      Prev Home Next
      Running multiple services on one machine Up Staged Deployment for Production Networks
      docs@openacs.org
      View comments on this page at openacs.org
      
+High Availability/High Performance Configurations
      Alex logo
      Prev Chapter�6.�Production Environments Next
      High Availability/High Performance Configurations
      See also the section called “Running a PostgreSQL database on another server”.
      Figure�6.1.�Multiple-server configuration
      Multiple-server configuration
      Prev Home Next
      Running multiple services on one machine Up Staged Deployment for Production Networks
      docs@openacs.org
      View comments on this page at openacs.org
      
Index: openacs-4/packages/acs-core-docs/www/how-do-I.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/how-do-I.html,v
diff -u -r1.18.2.3 -r1.18.2.4
--- openacs-4/packages/acs-core-docs/www/how-do-I.html	30 Nov 2005 05:21:56 -0000	1.18.2.3
+++ openacs-4/packages/acs-core-docs/www/how-do-I.html	1 Dec 2005 17:45:49 -0000	1.18.2.4
@@ -1,6 +1,6 @@
-How Do I?
      Alex logo
      Prev Chapter�4.�Configuring a new OpenACS Site Next
      How Do I?
      How do I edit the front page of a new site through a web interface?
      The easiest way is to install the Edit-This-Page package.
      1. Log in to the web site as an administrator.
      2. Click on Admin > Install Software > Install from OpenACS Repository / Install new application
      3. Choose Edit This Page and install
      4. Follow the instructions within Edit This Page (the link will only work after Edit This Page is installed).
      How do I let anybody who registers post to a weblog?
      Go to /admin/permissions and grant Create to Registered Users
      How do I replace the front page of a new site with the front page of an application on that site
      Suppose you install a new site and install Weblogger, and you want all visitors to see weblogger automatically.
      1. On the front page, click the Admin button.
      2. On the administration page, click Parameters link.
      3. Change the parameter IndexRedirectUrl to be the URI of the desired application.  For a default weblogger installation, this would be weblogger/.  Note the trailing slash.
      How do I put custom functionality on front page of a new site?
      Every page within an OpenACS site is part of a subsite More information).  The home page of the entire site is the front page is a special, default instance of a subsite, served from /var/lib/aolserver/$OPENACS_SERVICE_NAME/www.  If an index page is not found there, the default index page for all subsites is used.  To customize the code on the front page, copy the default index page from the Subsite package to the Main site and edit it:
      1. cp /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-subsite/www/index* /var/lib/aolserver/$OPENACS_SERVICE_NAME/www
      2. Edit the new index.adp to change the text; you shouldn't need to edit index.tcl unless you are adding new functionality.
      How do I change the site-wide style?
      Almost all pages on an OpenACS site use ACS Templating, and so their appearance is driven by a layer of different files.  Let's examine how this works:
      • 
+How Do I?
        Alex logo
        Prev Chapter�4.�Configuring a new OpenACS Site Next
        How Do I?
        How do I edit the front page of a new site through a web interface?
        The easiest way is to install the Edit-This-Page package.
        1. Log in to the web site as an administrator.
        2. Click on Admin > Install Software > Install from OpenACS Repository / Install new application
        3. Choose Edit This Page and install
        4. Follow the instructions within Edit This Page (the link will only work after Edit This Page is installed).
        How do I let anybody who registers post to a weblog?
        Go to /admin/permissions and grant Create to Registered Users
        How do I replace the front page of a new site with the front page of an application on that site
        Suppose you install a new site and install Weblogger, and you want all visitors to see weblogger automatically.
        1. On the front page, click the Admin button.
        2. On the administration page, click Parameters link.
        3. Change the parameter IndexRedirectUrl to be the URI of the desired application.  For a default weblogger installation, this would be weblogger/.  Note the trailing slash.
        How do I put custom functionality on front page of a new site?
        Every page within an OpenACS site is part of a subsite More information).  The home page of the entire site is the front page is a special, default instance of a subsite, served from /var/lib/aolserver/$OPENACS_SERVICE_NAME/www.  If an index page is not found there, the default index page for all subsites is used.  To customize the code on the front page, copy the default index page from the Subsite package to the Main site and edit it:
        1. cp /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-subsite/www/index* /var/lib/aolserver/$OPENACS_SERVICE_NAME/www
        2. Edit the new index.adp to change the text; you shouldn't need to edit index.tcl unless you are adding new functionality.
        How do I change the site-wide style?
        Almost all pages on an OpenACS site use ACS Templating, and so their appearance is driven by a layer of different files.  Let's examine how this works:
        • 
           A templated page uses an ADP/TCL pair.  The first line in the ADP file is usually:
           
          <master>
          If it appears exactly like this, without any arguments, the template processer uses default-master for that subsite.  For pages in /var/lib/aolserver/$OPENACS_SERVICE_NAME/www, this is /var/lib/aolserver/$OPENACS_SERVICE_NAME/www/default-master.adp and the associated .tcl file.
-          
        • The default-master is itself a normal ADP page.  It draws the subsite navigation elements and invokes site-master (/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/site-master.adp and .tcl)
        • The site-master draws site-wide navigation elements and invokes blank-master (/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/blank-master.adp and .tcl).  
        • Blank-master does HTML housekeeping and provides a framework for special sitewide navigation "meta" elements such as Translator widgets and Admin widgets.
        Figure�4.1.�Site Templates
        Site Templates
        How do I diagnose a permissions problem?
        • Steps to Reproduce.�The events package does not allow users to register for new events.
          1. Go to the http://yourserver.net/events as a visitor (ie, log out and, if necessary, clear cookies).  This in on a 4.6.3 site with events version 0.1d3.
          2. Select an available event
          3. A link such as Registration: Deadline is 03/15/2004 10:00am. 
+          
          4. The default-master is itself a normal ADP page.  It draws the subsite navigation elements and invokes site-master (/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/site-master.adp and .tcl)
          5. The site-master draws site-wide navigation elements and invokes blank-master (/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/blank-master.adp and .tcl).  
          6. Blank-master does HTML housekeeping and provides a framework for special sitewide navigation "meta" elements such as Translator widgets and Admin widgets.
        Figure�4.1.�Site Templates
        Site Templates
        How do I diagnose a permissions problem?
        • Steps to Reproduce.�The events package does not allow users to register for new events.
          1. Go to the http://yourserver.net/events as a visitor (ie, log out and, if necessary, clear cookies).  This in on a 4.6.3 site with events version 0.1d3.
          2. Select an available event
          3. A link such as Registration: Deadline is 03/15/2004 10:00am. 
 � Login or sign up to register for this event. is visible.  Click on "Login or sign up"
-          
          4. Complete a new registration.  Afterwards, you should be redirected back to the same page.
          Actual Results: The page says "You do not have permission to register for this event."
          Expected results: A link or form to sign up for the event is shown.
        • Finding the problem.�We start with the page that has the error.  In the URL it's http://myserver.net/events/event-info.tcl, so open the file /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/events/www/event-info.tcl.  It contains this line:
          set can_register_p [events::security::can_register_for_event_p -event_id $event_id]
          We need to know what that procedure does, so go to /api-doc, paste events::security::can_register_for_event_p into the ACS Tcl API Search box, and click Feeling Lucky.  The next pages shows the proc, and we click "show source" to see more information.  The body of the proc is simply
          return [permission::permission_p -party_id $user_id -object_id $event_id -privilege write]
          This means that a given user must have the write privilige on the event in order to register.  Let's assume that the priviliges inherit, so that if a user has the write privilige on the whole package, they will have the write privilege on the event.
        • Setting Permissions.�A permission has three parts: the privilige, the object of the privilige, and the subject being granted the privilige.  In this case the privilige is "write," the object is the Events package, and the subject is all Registered Users.
          1. To grant permissions on a package, start at the site map.  Find the event package and click "Set permissions".  
          2. Click "Grant Permission"
          3. Grant the write permission to Registered Users.
            Figure�4.2.�Granting Permissions
            Granting Permissions
          OpenACS 5.0 offers a prettier version at /admin/applications.
          Figure�4.3.�Granting Permissions in 5.0
          Granting Permissions in 5.0
        Prev Home Next
        Setting Permissions on an OpenACS package Up Chapter�5.�Upgrading
        docs@openacs.org
        View comments on this page at openacs.org
        
+          
      • Complete a new registration.  Afterwards, you should be redirected back to the same page.

    Actual Results: The page says "You do not have permission to register for this event."

    Expected results: A link or form to sign up for the event is shown.

  • Finding the problem.�We start with the page that has the error. In the URL it's http://myserver.net/events/event-info.tcl, so open the file /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/events/www/event-info.tcl. It contains this line:

    set can_register_p [events::security::can_register_for_event_p -event_id $event_id]

    We need to know what that procedure does, so go to /api-doc, paste events::security::can_register_for_event_p into the ACS Tcl API Search box, and click Feeling Lucky. The next pages shows the proc, and we click "show source" to see more information. The body of the proc is simply

    return [permission::permission_p -party_id $user_id -object_id $event_id -privilege write]

    This means that a given user must have the write privilige on the event in order to register. Let's assume that the priviliges inherit, so that if a user has the write privilige on the whole package, they will have the write privilege on the event.

  • Setting Permissions.�A permission has three parts: the privilige, the object of the privilige, and the subject being granted the privilige. In this case the privilige is "write," the object is the Events package, and the subject is all Registered Users.

    1. To grant permissions on a package, start at the site map. Find the event package and click "Set permissions".

    2. Click "Grant Permission"

    3. Grant the write permission to Registered Users.

      Figure�4.2.�Granting Permissions

      Granting Permissions

    OpenACS 5.0 offers a prettier version at /admin/applications.

    Figure�4.3.�Granting Permissions in 5.0

    Granting Permissions in 5.0
    • Prev Home Next
    Setting Permissions on an OpenACS package Up Chapter�5.�Upgrading
    docs@openacs.org
    View comments on this page at openacs.org
    Index: openacs-4/packages/acs-core-docs/www/i18n-convert.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/i18n-convert.html,v diff -u -r1.17.2.3 -r1.17.2.4 --- openacs-4/packages/acs-core-docs/www/i18n-convert.html 30 Nov 2005 05:21:56 -0000 1.17.2.3 +++ openacs-4/packages/acs-core-docs/www/i18n-convert.html 1 Dec 2005 17:45:50 -0000 1.17.2.4 @@ -71,7 +71,7 @@ test. If you don't provide the package_key argument then all packages with catalog files will be checked. The script will run its checks primarily on en_US xml catalog files. -

    Avoiding common i18n mistakes

    • Replace complicated keys with longer, simpler keys.�When writing in one language, it is possible to create clever code to make correct text. In English, for example, you can put an if command at the end of a word which adds "s" if a count is anything but 1. This pluralizes nouns correctly based on the data. However, it is confusing to read and, when internationalized, may result in message keys that are both confusing and impossible to set correctly in some languages. While internationalizing, watch out that the automate converter does not create such keys. Also, refactor compound text as you encounter it.

      The automated system can easily get confused by tags within message texts, so that it tries to create two or three message keys for one long string with a tag in the middle. In these cases, uncheck those keys during the conversion and then edit the files directly. For example, this code:

        <p class="form-help-text"><b>Invitations</b> are sent,
+

    Avoiding common i18n mistakes

    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
    9.1. Assumptions in this section
    9.2. Tutorial Data Model
    9.3. The Database Creation Script
    9.4. Database Deletion Script
    9.5. Page Map
    10.1. Upgrading a local CVS repository
    11.1. Server file layout diagram
    11.2. Package file layout diagram

    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
    11.1. Package files
    11.2. Context Hierarchy Example
    11.3. acs_objects example data
    16.1. Internationalization and Localization Overview

    List of Examples

    12.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
    Index: openacs-4/packages/acs-core-docs/www/install-cvs.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-cvs.html,v diff -u -r1.31.2.3 -r1.31.2.4 --- openacs-4/packages/acs-core-docs/www/install-cvs.html 30 Nov 2005 05:21:56 -0000 1.31.2.3 +++ openacs-4/packages/acs-core-docs/www/install-cvs.html 1 Dec 2005 17:45:50 -0000 1.31.2.4 @@ -1,4 +1,4 @@ -Initialize CVS (OPTIONAL)
    Alex logo
    Prev Appendix�B.�Install additional supporting software Next

    Initialize CVS (OPTIONAL)

    CVS is a source control system. Create and initialize a +Initialize CVS (OPTIONAL)

    Alex logo
    Prev Appendix�B.�Install additional supporting software Next

    Initialize CVS (OPTIONAL)

    CVS is a source control system. Create and initialize a directory for a local cvs repository.

    [root tmp]# mkdir /cvsroot
 [root tmp]# cvs -d /cvsroot init
 [root tmp]#
Index: openacs-4/packages/acs-core-docs/www/install-daemontools.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-daemontools.html,v
diff -u -r1.32.2.3 -r1.32.2.4
--- openacs-4/packages/acs-core-docs/www/install-daemontools.html	30 Nov 2005 05:21:56 -0000	1.32.2.3
+++ openacs-4/packages/acs-core-docs/www/install-daemontools.html	1 Dec 2005 17:45:50 -0000	1.32.2.4
@@ -3,7 +3,7 @@
       installed in /package.  These commands install daemontools and
       svgroup.  svgroup is a script for granting permissions, to allow
       users other than root to use daemontools for specific
-      services.
    1. Install Daemontools
      download daemontools and install it.
      • Red Hat 8
        [root root]# mkdir -p /package
+      services.
        1. Install Daemontools
          download daemontools and install it.
          • Red Hat 8
            [root root]# mkdir -p /package
 [root root]# chmod 1755 /package/
 [root root]# cd /package/
 [root package]# tar xzf /tmp/daemontools-0.76.tar.gz
Index: openacs-4/packages/acs-core-docs/www/install-full-text-search-openfts.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-full-text-search-openfts.html,v
diff -u -r1.2.2.3 -r1.2.2.4
--- openacs-4/packages/acs-core-docs/www/install-full-text-search-openfts.html	30 Nov 2005 05:21:56 -0000	1.2.2.3
+++ openacs-4/packages/acs-core-docs/www/install-full-text-search-openfts.html	1 Dec 2005 17:45:50 -0000	1.2.2.4
@@ -5,7 +5,7 @@
       Tsearch2. See 
       Install       Full Text Search using Tsearch2. Tsearch2 is much easier to install, requiring only
       compilation of one module from PostgreSQL contrib, with an
-      automated install process using the tsearch2-driver package.
            Install OpenFTS module
            If you want full text search, and you are running PostgreSQL, install this module to support FTS.  Do this step after you have installed both PostgreSQL and
+      automated install process using the tsearch2-driver package.
            Install OpenFTS module
            If you want full text search, and you are running PostgreSQL, install this module to support FTS.  Do this step after you have installed both PostgreSQL and
       AOLserver.  You will need the openfts
       tarball in /tmp.
            1. Install Tsearch.  This is a PostgreSQL module that
 	  OpenFTS requires.
              [root root]# su - postgres
@@ -80,7 +80,7 @@
 make
 su postgres
 make install
-exit
            Install OpenFTS prerequisites in PostgreSQL instance
            If you are installing Full Text Search, add required
+exit
      Install OpenFTS prerequisites in PostgreSQL instance
      If you are installing Full Text Search, add required
         packages to the new database.  (In order for full text search
         to work, you must also install the PostgreSQL
         OpenFTS module and prerequisites.)
      [$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ /usr/local/pgsql/bin/psql $OPENACS_SERVICE_NAME -f /usr/local/src/postgresql-7.3.4/contrib/tsearch/tsearch.sql
Index: openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.html,v
diff -u -r1.2.2.3 -r1.2.2.4
--- openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.html	30 Nov 2005 05:21:56 -0000	1.2.2.3
+++ openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.html	1 Dec 2005 17:45:50 -0000	1.2.2.4
@@ -5,7 +5,7 @@
       V2 Introduction by Andrew J. Kopciuch
      
           OpenACS docs are written by the named authors, and may be edited
           by OpenACS documentation staff.
-        
      Install Tsearch2 module
      If you want full text search, and you are running PostgreSQL, install this module to support FTS.  Do this step after you have installed both PostgreSQL and
+        
      Install Tsearch2 module
      If you want full text search, and you are running PostgreSQL, install this module to support FTS.  Do this step after you have installed both PostgreSQL and
       AOLserver.  You will need the tseach2 module form PostgreSQL
       contrib. This is included with the PostgreSQL full source
       distribution. It is also available with the PostgreSQL contrib
Index: openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.html,v
diff -u -r1.15.2.3 -r1.15.2.4
--- openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.html	30 Nov 2005 05:21:56 -0000	1.15.2.3
+++ openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.html	1 Dec 2005 17:45:50 -0000	1.15.2.4
@@ -63,6 +63,6 @@
 
         Most of this information comes from Tom Jackson's AOLserver+Daemontools
           Mini-HOWTO.
-
    Table�6.1.�How it Works
    ProgramInvoked by this program ...... using this fileWhere to find errorsLog goes toUse these commands to control it
    svscanboot
+
    Table�6.1.�How it Works
    ProgramInvoked by this program ...... using this fileWhere to find errorsLog goes toUse these commands to control it
    svscanboot
       init/etc/inittabps -auxw | grep readproctitlen/a�
    aolserversupervise
 (a child of svscanboot)/service/$OPENACS_SERVICE_NAME/run/var/lib/aolserver/$OPENACS_SERVICE_NAME/log/error.log/var/lib/aolserver/$OPENACS_SERVICE_NAME/log/$OPENACS_SERVICE_NAME.logsvc -k /service/$OPENACS_SERVICE_NAME
    postgresqlRedhat init scripts during boot/etc/init.d/postgresql/usr/local/pgsql/data/server.log�service postgresql start (Red Hat), /etc/init.d/postgresql start (Debian)
    Prev Home Next
    Chapter�6.�Production Environments Up AOLserver keepalive with inittab
    docs@openacs.org
    View comments on this page at openacs.org
    
Index: openacs-4/packages/acs-core-docs/www/install-qmail.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-qmail.html,v
diff -u -r1.32.2.3 -r1.32.2.4
--- openacs-4/packages/acs-core-docs/www/install-qmail.html	30 Nov 2005 05:21:56 -0000	1.32.2.3
+++ openacs-4/packages/acs-core-docs/www/install-qmail.html	1 Dec 2005 17:45:50 -0000	1.32.2.4
@@ -29,7 +29,7 @@
 tcpserver: usage: tcpserver [ -1UXpPhHrRoOdDqQv ] [ -c limit ] [ -x rules.cdb ] [ -B banner ] [ -g gid ] [ -u uid
 ] [ -b backlog ] [ -l localname ] [ -t timeout ] host port program
 [root ucspi-tcp-0.88]#
-
    
+
    
 (I'm not sure if this next step is 100% necessary, but when I skip it
 I get problems.  If you get the error 553 sorry, that domain isn't in my list of allowed rcpthosts (#5.7.1) then you need to do this.)  AOLserver sends outgoing mail via the ns_sendmail
 command, which pipes a command to the sendmail executable.  Or, in our
@@ -43,7 +43,7 @@
 send outgoing mail.
    [root ucspi-tcp-0.88]# cp /tmp/openacs-5.2.0b8/packages/acs-core-docs/www/files/tcp.smtp.txt /etc/tcp.smtp
 [root ucspi-tcp-0.88]# tcprules /etc/tcp.smtp.cdb /etc/tcp.smtp.tmp < /etc/tcp.smtp
 cp /tmp/openacs-5.2.0b8/packages/acs-core-docs/www/files/tcp.smtp.txt /etc/tcp.smtp 
-tcprules /etc/tcp.smtp.cdb /etc/tcp.smtp.tmp < /etc/tcp.smtp 
  • Install Qmail.�
    Download qmail,
+tcprules /etc/tcp.smtp.cdb /etc/tcp.smtp.tmp < /etc/tcp.smtp 
  • Install Qmail.�
    Download qmail,
             set up the standard supporting users and build the binaries:
    [root root]# cd /usr/local/src
 [root src]# wget http://www.qmail.org/netqmail-1.04.tar.gz
 [root src]# tar xzf netqmail-1.04.tar.gz
@@ -102,7 +102,7 @@
 cd netqmail-1.04
 ./collate.sh
 cd netqmail-1.04
-make setup check
    Replace sendmail with qmail's wrapper.
    [root qmail-1.03]# rm -f /usr/bin/sendmail /usr/sbin/sendmail
+make setup check
    Replace sendmail with qmail's wrapper.
    [root qmail-1.03]# rm -f /usr/bin/sendmail /usr/sbin/sendmail
 [root qmail-1.03]# ln -s /var/qmail/bin/sendmail /usr/sbin/sendmail
 [root qmail-1.03]#
 rm -f /usr/bin/sendmail /usr/sbin/sendmail
@@ -124,7 +124,7 @@
 cd ~alias; touch .qmail-postmaster .qmail-mailer-daemon .qmail-root 
 chmod 644 ~alias/.qmail* 
 /var/qmail/bin/maildirmake ~alias/Maildir/ 
-chown -R alias.nofiles /var/qmail/alias/Maildir
    Configure qmail to use the Maildir delivery format
+chown -R alias.nofiles /var/qmail/alias/Maildir
    Configure qmail to use the Maildir delivery format
           (instead of mbox), and install a version of the qmail startup script modified to use Maildir.
    [root alias]# echo "./Maildir" > /var/qmail/bin/.qmail
 [root alias]# cp /tmp/openacs-5.2.0b8/packages/acs-core-docs/www/files/qmail.rc.txt /var/qmail/rc
 [root alias]# chmod 755 /var/qmail/rc
Index: openacs-4/packages/acs-core-docs/www/install-redhat.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-redhat.html,v
diff -u -r1.32.2.3 -r1.32.2.4
--- openacs-4/packages/acs-core-docs/www/install-redhat.html	30 Nov 2005 05:21:56 -0000	1.32.2.3
+++ openacs-4/packages/acs-core-docs/www/install-redhat.html	1 Dec 2005 17:45:50 -0000	1.32.2.4
@@ -26,7 +26,7 @@
 	
    1. Unplug the network cable from your
           computer.  We don't want to connect to the network
           until we're sure the computer is secure.  
-           
+           
   (Wherever you see
           the word secure, you should always read it as, "secure
           enough for our purposes, given the amount of work we're
@@ -54,7 +54,7 @@
 Review (and modify if needed) the partitions created and click Next
    2. On the pop-up window asking "Are you sure
 	  you want to do this?" click
 	  Yes
-	  IF YOU ARE WIPING YOUR HARD DRIVE.
    3. Click Next on the boot loader screen
  • Configure Networking.  
+	  IF YOU ARE WIPING YOUR HARD DRIVE.
  • Click Next on the boot loader screen
  • Configure Networking.  
 Again, if you know what you're doing, do this step
           yourself, being sure to note the firewall holes. Otherwise,
           follow the instructions in this step to set up a computer directly connected to the internet with a dedicated IP address.
    1. DHCP is a system by which a computer that
@@ -75,7 +75,7 @@
 Mail (SMTP).  In the Other ports
 box, enter 443, 8000, 8443.  Click
 Next.
-Port 443 is for https (http over ssl), and 8000 and 8443 are http and https access to the development server we'll be setting up.
  • Select any additional languages you want the
+Port 443 is for https (http over ssl), and 8000 and 8443 are http and https access to the development server we'll be setting up.
  • Select any additional languages you want the
 	  computer to support and then click
 	  Next
  • Choose your time zone and click Next.
  • Type in a root
 password, twice.
  • On the Package selection page, we're going to
@@ -87,13 +87,13 @@
 risk that's still screened by the firewall, or a resource hog.  Just
 don't install a database or web server, because that would conflict
 with the database and web server we'll install later.
-
    check Editors (this installs emacs),
    click Details next to Text-based Internet, check lynx, and click OK;
    check Authoring and Publishing (this installs docbook),
    uncheck Server Configuration Tools,
    uncheck Web Server,
    uncheck Windows File Server,
    check SQL Database Server (this installs PostgreSQL),
    check Development Tools (this installs gmake and other build tools),
    uncheck Administration Tools, and
    uncheck Printing Support.
    At the bottom, check Select Individual Packages and click Next
  • We need to fine-tune the exact list of packages.
+
    check Editors (this installs emacs),
    click Details next to Text-based Internet, check lynx, and click OK;
    check Authoring and Publishing (this installs docbook),
    uncheck Server Configuration Tools,
    uncheck Web Server,
    uncheck Windows File Server,
    check SQL Database Server (this installs PostgreSQL),
    check Development Tools (this installs gmake and other build tools),
    uncheck Administration Tools, and
    uncheck Printing Support.
    At the bottom, check Select Individual Packages and click Next
  • We need to fine-tune the exact list of packages.
 The same rules apply as in the last step - you can add more stuff, but
 you shouldn't remove anything the guide adds.  We're going to go
 through all the packages in one big list, so select
 Flat
 View and wait. In a minute, a
-list of packages will appear.
    uncheck apmd (monitors power, not very useful for servers), 
    check ImageMagick (required for the photo-album packages, 
    uncheckisdn4k-utils (unless you are using isdn, this installs a useless daemon), 
    check mutt (a mail program that reads Maildir),
    uncheck nfs-utils (nfs is a major security risk), 
    uncheck pam-devel (I don't remember why, but we don't want this), 
    uncheck portmap, 
    uncheck postfix (this is an MTA, but we're going to install qmail later), 
    check  postgresql-devel,
    uncheck rsh (rsh is a security hole), 
    uncheck sendmail (sendmail is an insecure MTA; we're going to install qmail instead later),
    check tcl (we need tcl), and 
    uncheck xinetd (xinetd handles incoming tcp connections.  We'll install a different, more secure program, ucspi-tcp).
    Click Next
  • Red Hat isn't completely happy with the combination
+list of packages will appear.
    uncheck apmd (monitors power, not very useful for servers), 
    check ImageMagick (required for the photo-album packages, 
    uncheckisdn4k-utils (unless you are using isdn, this installs a useless daemon), 
    check mutt (a mail program that reads Maildir),
    uncheck nfs-utils (nfs is a major security risk), 
    uncheck pam-devel (I don't remember why, but we don't want this), 
    uncheck portmap, 
    uncheck postfix (this is an MTA, but we're going to install qmail later), 
    check  postgresql-devel,
    uncheck rsh (rsh is a security hole), 
    uncheck sendmail (sendmail is an insecure MTA; we're going to install qmail instead later),
    check tcl (we need tcl), and 
    uncheck xinetd (xinetd handles incoming tcp connections.  We'll install a different, more secure program, ucspi-tcp).
    Click Next
  • Red Hat isn't completely happy with the combination
 of packages we've selected, and wants to satisfy some dependencies.
 Don't let it.  On the next screen, choose
 Ignore Package
@@ -119,7 +119,7 @@
         upgrading all of that.  Since you are upgrading the kernel,
         reboot after this step.
 
  • Lock down SSH
    1. 
-              
+              
               SSH is the protocol we use to connect
               securely to the computer (replacing telnet, which is
               insecure).  sshd is the daemon that listens for incoming
Index: openacs-4/packages/acs-core-docs/www/install-steps.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-steps.html,v
diff -u -r1.26.2.3 -r1.26.2.4
--- openacs-4/packages/acs-core-docs/www/install-steps.html	30 Nov 2005 05:21:56 -0000	1.26.2.3
+++ openacs-4/packages/acs-core-docs/www/install-steps.html	1 Dec 2005 17:45:50 -0000	1.26.2.4
@@ -40,7 +40,7 @@
 su - $OPENACS_SERVICE_NAME
 svc -d /service/$OPENACS_SERVICE_NAME
 dropdb $OPENACS_SERVICE_NAME
-createdb $OPENACS_SERVICE_NAME
      Setting a global shell variable for cut and paste.�In order to cut and paste the instructions into your shell, you must set the environment variable $OPENACS_SERVICE_NAME.  In order to set it globally so that it works for any new users or special service users you may create, edit the file /etc/profile ( /etc/share/skel/dot.profile for FreeBSD) and add this line:
      export OPENACS_SERVICE_NAME=service0
    Paths and Users
    Table�2.1.�Default directories for a standard install
    Fully qualified domain name of your serveryourserver.test
    name of administrative access accountremadmin
    OpenACS service
+createdb $OPENACS_SERVICE_NAME
    Setting a global shell variable for cut and paste.�In order to cut and paste the instructions into your shell, you must set the environment variable $OPENACS_SERVICE_NAME.  In order to set it globally so that it works for any new users or special service users you may create, edit the file /etc/profile ( /etc/share/skel/dot.profile for FreeBSD) and add this line:
    export OPENACS_SERVICE_NAME=service0
    Paths and Users
    Table�2.1.�Default directories for a standard install
    Fully qualified domain name of your serveryourserver.test
    name of administrative access accountremadmin
    OpenACS service
                 $OPENACS_SERVICE_NAME (set to service0 in default install)
    OpenACS service account$OPENACS_SERVICE_NAME
    OpenACS database name$OPENACS_SERVICE_NAME
    Root of OpenACS service file tree (SERVERROOT)/var/lib/aolserver/$OPENACS_SERVICE_NAME
    Location of source code tarballs for new software/var/tmp
    The OpenACS tarball contains some files which
                 are useful while setting up other software.  Those
                 files are located at:/var/tmp/openacs-5.2.0b8/packages/acs-core-docs/www/files
    Database backup directory/var/lib/aolserver/$OPENACS_SERVICE_NAME/database-backup
    Service config files/var/lib/aolserver/$OPENACS_SERVICE_NAME/etc
    Service log files/var/lib/aolserver/$OPENACS_SERVICE_NAME/log
    Compile directory/usr/local/src
    PostgreSQL directory/usr/local/pgsql
    AOLserver directory/usr/local/aolserver
    
Index: openacs-4/packages/acs-core-docs/www/ix01.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/ix01.html,v
diff -u -r1.20.2.3 -r1.20.2.4
--- openacs-4/packages/acs-core-docs/www/ix01.html	30 Nov 2005 05:21:56 -0000	1.20.2.3
+++ openacs-4/packages/acs-core-docs/www/ix01.html	1 Dec 2005 17:45:50 -0000	1.20.2.4
@@ -1,2 +1,2 @@
-Index
    Alex logo
    Prev  
    Index
    Symbols
    $OPENACS_SERVICE_NAME, Paths and Users
    A
    AOLserver
    configuration, Installation Option 2: Install from tarball
    Automated tests, Write automated tests
    C
    computeroutput
    code, Code
    cvs
    initializing, Initialize CVS (OPTIONAL)
    setup, Using CVS with an OpenACS Site
    D
    daemontools
    installation, Install Daemontools (OPTIONAL)
    docbook
    installation, Install Red Hat 8/9
    DocBook
    DTD, OpenACS Documentation Strategy: Why DocBook?
    emacs configuration for, Add PSGML commands to emacs init file (OPTIONAL)
    Document structure, Document Structure
    E
    emacs
    installation, Install Red Hat 8/9
    emphasis
    bold, italics, Emphasis
    F
    full text search
    installation, Install Tsearch2 module, Install OpenFTS module, Install OpenFTS prerequisites in PostgreSQL instance
    G
    Graphics
    Images, Graphics
    I
    informaltable
    table, Tables
    L
    language
    installation, Install Red Hat 8/9
    Linking, Links
    lists, Lists
    O
    OpenACS Package, What a Package Looks Like
    P
    photo-album
    installation (see ImageMagick)
    Postgres
    Vacuuming, Installation Option 2: Install from tarball
    Q
    qmail
    installation, Install qmail (OPTIONAL)
    Maildir, Install qmail (OPTIONAL)
    rcpthosts error message, Install qmail (OPTIONAL)
    S
    sect1, Headlines, Sections
    sect2, Headlines, Sections
    Sections
    Headlines, Headlines, Sections
    security
    definition, Install Red Hat 8/9
    firewall, Install Red Hat 8/9
    sendmail
    removing, Install qmail (OPTIONAL)
    ssh, Install Red Hat 8/9
    T
    The publish point for new packages should be
+Index
    Alex logo
    Prev  
    Index
    Symbols
    $OPENACS_SERVICE_NAME, Paths and Users
    A
    AOLserver
    configuration, Installation Option 2: Install from tarball
    Automated tests, Write automated tests
    C
    computeroutput
    code, Code
    cvs
    initializing, Initialize CVS (OPTIONAL)
    setup, Using CVS with an OpenACS Site
    D
    daemontools
    installation, Install Daemontools (OPTIONAL)
    docbook
    installation, Install Red Hat 8/9
    DocBook
    DTD, OpenACS Documentation Strategy: Why DocBook?
    emacs configuration for, Add PSGML commands to emacs init file (OPTIONAL)
    Document structure, Document Structure
    E
    emacs
    installation, Install Red Hat 8/9
    emphasis
    bold, italics, Emphasis
    F
    full text search
    installation, Install Tsearch2 module, Install OpenFTS module, Install OpenFTS prerequisites in PostgreSQL instance
    G
    Graphics
    Images, Graphics
    I
    informaltable
    table, Tables
    L
    language
    installation, Install Red Hat 8/9
    Linking, Links
    lists, Lists
    O
    OpenACS Package, What a Package Looks Like
    P
    photo-album
    installation (see ImageMagick)
    Postgres
    Vacuuming, Installation Option 2: Install from tarball
    Q
    qmail
    installation, Install qmail (OPTIONAL)
    Maildir, Install qmail (OPTIONAL)
    rcpthosts error message, Install qmail (OPTIONAL)
    S
    sect1, Headlines, Sections
    sect2, Headlines, Sections
    Sections
    Headlines, Headlines, Sections
    security
    definition, Install Red Hat 8/9
    firewall, Install Red Hat 8/9
    sendmail
    removing, Install qmail (OPTIONAL)
    ssh, Install Red Hat 8/9
    T
    The publish point for new packages should be
         fixed., Prepare the package for distribution.
    U
    ulink, Links
    upgrade
    OpenACS 4.5 to 4.6.x
    Linux/Unix, Upgrading 4.5 or higher to 4.6.3
    X
    XML guidelines, OpenACS Documentation Strategy: Why DocBook?
    xref
    linkend, Links
    xreflabel, Headlines, Sections
    Prev Home 
    How to Update the translations Up 
    docs@openacs.org
    View comments on this page at openacs.org
    
Index: openacs-4/packages/acs-core-docs/www/maint-performance.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/maint-performance.html,v
diff -u -r1.20.2.3 -r1.20.2.4
--- openacs-4/packages/acs-core-docs/www/maint-performance.html	30 Nov 2005 05:21:56 -0000	1.20.2.3
+++ openacs-4/packages/acs-core-docs/www/maint-performance.html	1 Dec 2005 17:45:50 -0000	1.20.2.4
@@ -1,7 +1,7 @@
 Diagnosing Performance Problems
    Alex logo
    Prev Chapter�6.�Production Environments Next
    Diagnosing Performance Problems
    • Did performance problems happen overnight, or did they sneak up on
     you? Any clue what caused the performance problems (e.g. loading 20K
     users into .LRN)
    • Is the file system out of space?  Is the machine swapping to disk constantly?
    • Isolating and solving database problems.
      • Without daily internal maintenance, most databases slowly degrade in performance.  For PostGreSQL, see the section called “Vacuum Postgres nightly”.  For Oracle, use exec dbms_stats.gather_schema_stats('SCHEMA_NAME') (Andrew Piskorski's Oracle notes).
      • You can track the exact amount of time each database query on a page takes:
        1. Go to Main Site : Site-Wide Administration : Install Software
        2. Click on "Install New Application" in "Install from OpenACS Repository"
        3. Choose "ACS Developer Support">
        4. After install is complete, restart the server.
        5. Browse to Developer Support, which is automatically mounted at /ds.
-              
        6. Turn on Database statistics
        7. Browse directly to a slow page and click "Request Information" at the bottom of the page.
        8. This should return a list of database queries on the page, including the exact query (so it can be cut-paste into psql or oracle) and the time each query took.
          Figure�6.8.�Query Analysis example
          Query Analysis example
      • Identify a runaway Oracle query: first, use ps aux or top to get the UNIX process ID of a runaway Oracle process.
        Log in to SQL*Plus as the admin:
        [$OPENACS_SERVICE_NAME ~]$ svrmgrl
+              
      • Turn on Database statistics
      • Browse directly to a slow page and click "Request Information" at the bottom of the page.
      • This should return a list of database queries on the page, including the exact query (so it can be cut-paste into psql or oracle) and the time each query took.
        Figure�6.8.�Query Analysis example
        Query Analysis example
    • Identify a runaway Oracle query: first, use ps aux or top to get the UNIX process ID of a runaway Oracle process.
      Log in to SQL*Plus as the admin:
      [$OPENACS_SERVICE_NAME ~]$ svrmgrl
 
 Oracle Server Manager Release 3.1.7.0.0 - Production
 
@@ -58,7 +58,7 @@
     
      
       To be able to get a overview of how Oracle executes a particular query,
       install "autotrace". I usually follow the instructions here http://asktom.oracle.com/~tkyte/article1/autotrace.html.
-    
      Make sure, that the Oracle CBO works with adequate statistics
      
+    
      Make sure, that the Oracle CBO works with adequate statistics
      
     The Oracle Cost Based optimizer is a piece of software that tries to find
     the "optimal" execution plan for a given SQL statement. For that it
     estimates the costs of running a SQL query in a particular way (by default
Index: openacs-4/packages/acs-core-docs/www/maintenance-deploy.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/maintenance-deploy.html,v
diff -u -r1.15.2.3 -r1.15.2.4
--- openacs-4/packages/acs-core-docs/www/maintenance-deploy.html	30 Nov 2005 05:21:56 -0000	1.15.2.3
+++ openacs-4/packages/acs-core-docs/www/maintenance-deploy.html	1 Dec 2005 17:45:50 -0000	1.15.2.4
@@ -1,7 +1,7 @@
 Staged Deployment for Production Networks
      Alex logo
      Prev Chapter�6.�Production Environments Next
      Staged Deployment for Production Networks
      By Joel Aufrecht
      
           OpenACS docs are written by the named authors, and may be edited
           by OpenACS documentation staff.
-        
      This section describes two minimal-risk methods for deploying changes on a production network.  The important characteristics of a safe change deployment include:  (THIS SECTION IN DEVELOPMENT)
      • Control: You know for sure that the change you are making is the change that you intend to make and is the change that you tested.
      • Rollback: If anything goes wrong, you can return to the previous working configuration safely and quickly.
      Method 1: Deployment with CVS
      With this method, we control the files on a site via
+        
      This section describes two minimal-risk methods for deploying changes on a production network.  The important characteristics of a safe change deployment include:  (THIS SECTION IN DEVELOPMENT)
      • Control: You know for sure that the change you are making is the change that you intend to make and is the change that you tested.
      • Rollback: If anything goes wrong, you can return to the previous working configuration safely and quickly.
      Method 1: Deployment with CVS
      With this method, we control the files on a site via
       CVS. This example uses one developmental server (service0-dev) and one
       production server (service0). Depending on your needs, you can also
       have a staging server for extensive testing before you go
@@ -66,4 +66,4 @@
 cvs up -Pd index.adp
      If you make changes that require changes to the database,
       test them out first on service0-dev, using either -create.sql or
       upgrade scripts. Once you've tested them, you then update and
-      run the upgrade scripts from the package manager. 
      The production site can run "HEAD" from cvs.
      The drawback to using HEAD as the live code is that you cannot commit new work on the development server without erasing the definition of 'working production code.'  So a better method is to use a tag.  This guarantees that, at any time in the future, you can retrieve exactly the same set of code.  This is useful for both of the characteristics of safe change deployment.  For control, you can use tags to define a body of code, test that code, and then know that what you are deploying is exactly that code.  For rollback, you can use return to the last working tag if the new tag (or new, untagged changes) cause problems.  .... example of using tags to follow ...
    Method 2: A/B Deployment
    The approach taken in this section is to always create a new service with the desired changes, running in parallel with the existing site.  This guarantees control, at least at the final step of the process: you know what changes you are about to make because you can see them directly.  It does not, by itself, guarantee the entire control chain.  You need additional measures to make sure that the change you are making is exactly and completely the change you intended to make and tested previously, and nothing more.  Those additional measures typically take the form of source control tags and system version numbers.  The parallel-server approach also guarantees rollback because the original working service is not touched; it is merely set aside.
    This approach can has limitations.  If the database or file system regularly receiving new data, you must interrupt this function or risk losing data in the shuffle.  It also requires extra steps if the database will be affected.
    Simple A/B Deployment: Database is not changed
    Figure�6.2.�Simple A/B Deployment - Step 1
    Simple A/B Deployment - Step 1
    Figure�6.3.�Simple A/B Deployment - Step 2
    Simple A/B Deployment - Step 2
    Figure�6.4.�Simple A/B Deployment - Step 3
    Simple A/B Deployment - Step 3
    Complex A/B Deployment: Database is changed
    Figure�6.5.�Complex A/B Deployment - Step 1
    Complex A/B Deployment - Step 1
    Figure�6.6.�Complex A/B Deployment - Step 2
    Complex A/B Deployment - Step 2
    Figure�6.7.�Complex A/B Deployment - Step 3
    Complex A/B Deployment - Step 3
    Prev Home Next
    High Availability/High Performance Configurations Up Installing SSL Support for an OpenACS service
    docs@openacs.org
    View comments on this page at openacs.org
    
+      run the upgrade scripts from the package manager. 
    The production site can run "HEAD" from cvs.
    The drawback to using HEAD as the live code is that you cannot commit new work on the development server without erasing the definition of 'working production code.'  So a better method is to use a tag.  This guarantees that, at any time in the future, you can retrieve exactly the same set of code.  This is useful for both of the characteristics of safe change deployment.  For control, you can use tags to define a body of code, test that code, and then know that what you are deploying is exactly that code.  For rollback, you can use return to the last working tag if the new tag (or new, untagged changes) cause problems.  .... example of using tags to follow ...
    Method 2: A/B Deployment
    The approach taken in this section is to always create a new service with the desired changes, running in parallel with the existing site.  This guarantees control, at least at the final step of the process: you know what changes you are about to make because you can see them directly.  It does not, by itself, guarantee the entire control chain.  You need additional measures to make sure that the change you are making is exactly and completely the change you intended to make and tested previously, and nothing more.  Those additional measures typically take the form of source control tags and system version numbers.  The parallel-server approach also guarantees rollback because the original working service is not touched; it is merely set aside.
    This approach can has limitations.  If the database or file system regularly receiving new data, you must interrupt this function or risk losing data in the shuffle.  It also requires extra steps if the database will be affected.
    Simple A/B Deployment: Database is not changed
    Figure�6.2.�Simple A/B Deployment - Step 1
    Simple A/B Deployment - Step 1
    Figure�6.3.�Simple A/B Deployment - Step 2
    Simple A/B Deployment - Step 2
    Figure�6.4.�Simple A/B Deployment - Step 3
    Simple A/B Deployment - Step 3
    Complex A/B Deployment: Database is changed
    Figure�6.5.�Complex A/B Deployment - Step 1
    Complex A/B Deployment - Step 1
    Figure�6.6.�Complex A/B Deployment - Step 2
    Complex A/B Deployment - Step 2
    Figure�6.7.�Complex A/B Deployment - Step 3
    Complex A/B Deployment - Step 3
    Prev Home Next
    High Availability/High Performance Configurations Up Installing SSL Support for an OpenACS service
    docs@openacs.org
    View comments on this page at openacs.org
    
Index: openacs-4/packages/acs-core-docs/www/objects.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/objects.html,v
diff -u -r1.43.2.3 -r1.43.2.4
--- openacs-4/packages/acs-core-docs/www/objects.html	30 Nov 2005 05:21:56 -0000	1.43.2.3
+++ openacs-4/packages/acs-core-docs/www/objects.html	1 Dec 2005 17:45:50 -0000	1.43.2.4
@@ -78,7 +78,7 @@
 Fire up your text editor and open the
 ROOT/packages/notes/sql/oracle/notes-create.sql (ROOT/packages/notes/sql/postgresql/notes-create.sql for the PG version) file created
 when we created the package.  Then, do the following:
-
    Describe the new type to the type system
    
+
    Describe the new type to the type system
    
 First, add an entry to the acs_object_types table with the following PL/SQL call:
 
     begin  
@@ -138,7 +138,7 @@
 because the new type note is a subtype of
 acs_object, it will inherit these attributes, so there is
 no need for us to define them.
-
    Define a table in which to store your objects
    
+
    Define a table in which to store your objects
    
 The next thing we do is make a small modification to the data model to
 reflect the fact that each row in the notes table
 represents something that is not only an object of type
@@ -163,7 +163,7 @@
 use the acs_objects table to find objects will
 transparently find any objects that are instances of any subtype of
 acs_objects.
-
    Define a package for type specific procedures
    
+
    Define a package for type specific procedures
    
 The next step is to define a PL/SQL package for your new type, and
 write some basic procedures to create and delete objects. Here is a
 package definition for our new type:
@@ -211,7 +211,7 @@
 object OBJ was "read only", then any other object that used OBJ as its
 context would also be "read only" by default. We'll talk about this more
 later.
-
    Define a package body for type specific procedures
    
+
    Define a package body for type specific procedures
    
 The PL/SQL package body contains the implementations of the procedures
 defined above. The only subtle thing going on here is that we must use
 acs_object.new to insert a row into
Index: openacs-4/packages/acs-core-docs/www/openacs-cvs-concepts.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/Attic/openacs-cvs-concepts.html,v
diff -u -r1.2.2.3 -r1.2.2.4
--- openacs-4/packages/acs-core-docs/www/openacs-cvs-concepts.html	30 Nov 2005 05:21:56 -0000	1.2.2.3
+++ openacs-4/packages/acs-core-docs/www/openacs-cvs-concepts.html	1 Dec 2005 17:45:50 -0000	1.2.2.4
@@ -2,7 +2,7 @@
     CVS Guidelines
   ">
    Alex logo
    Prev Chapter�14.�
     CVS Guidelines
-   Next
    OpenACS CVS Concepts
    Modules
    
+  
    		 Next
    OpenACS CVS Concepts
    Modules
    
         All OpenACS code resides within a single CVS module, openacs-4.  (The openacs-4 directory contains code for all versions of OpenACS 4 and later, and .LRN 1 and later.)   Checking out this module retrieves all openacs code of any type.  For convenience, subsets of openacs-4 are repackaged as smaller modules.
    
           acs-core contains only critical common
           packages. It does not have any user applications, such as forums,
@@ -30,7 +30,7 @@
           project-manager-all contains the packages required, in combination with acs-core, to run the project-manager package.
         
    
           Each OpenACS package (i.e., directory in openacs-4/packages/) is also aliased as a module of the same name.
-        
    
+        
    
         Tags and Branches
       
    
         Tags and Branches look similar in commands, but behave differently. A tag is a fixed point on a branch.  Check out
Index: openacs-4/packages/acs-core-docs/www/openacs.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/openacs.html,v
diff -u -r1.42.2.3 -r1.42.2.4
--- openacs-4/packages/acs-core-docs/www/openacs.html	30 Nov 2005 05:21:56 -0000	1.42.2.3
+++ openacs-4/packages/acs-core-docs/www/openacs.html	1 Dec 2005 17:45:50 -0000	1.42.2.4
@@ -237,7 +237,7 @@
 CREATE DATABASE
 [$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$
 su - $OPENACS_SERVICE_NAME
-/usr/local/pgsql/bin/createdb -E UNICODE $OPENACS_SERVICE_NAME
  • Automate daily database Vacuuming.  This is a process which cleans out discarded data from the database.  A quick way to automate vacuuming is to edit the cron file for the database user.  Recommended: VACUUM ANALYZE every hour and VACUUM FULL ANALYZE every day.
    [$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ export EDITOR=emacs;crontab -e
    Add these lines to the file.  The vacuum command cleans up temporary structures within a PostGreSQL database, and can improve performance.  We vacuum gently every hour and completely every day.  The numbers and stars at the beginning are cron columns that specify when the program should be run - in this case, whenever the minute is 0 and the hour is 1, i.e., 1:00 am every day, and every (*) day of month, month, and day of week.  Type man 5 crontab for more information.
    0 1-23 * * * /usr/local/pgsql/bin/vacuumdb --analyze $OPENACS_SERVICE_NAME
+/usr/local/pgsql/bin/createdb -E UNICODE $OPENACS_SERVICE_NAME
  • Automate daily database Vacuuming.  This is a process which cleans out discarded data from the database.  A quick way to automate vacuuming is to edit the cron file for the database user.  Recommended: VACUUM ANALYZE every hour and VACUUM FULL ANALYZE every day.
    [$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ export EDITOR=emacs;crontab -e
    Add these lines to the file.  The vacuum command cleans up temporary structures within a PostGreSQL database, and can improve performance.  We vacuum gently every hour and completely every day.  The numbers and stars at the beginning are cron columns that specify when the program should be run - in this case, whenever the minute is 0 and the hour is 1, i.e., 1:00 am every day, and every (*) day of month, month, and day of week.  Type man 5 crontab for more information.
    0 1-23 * * * /usr/local/pgsql/bin/vacuumdb --analyze $OPENACS_SERVICE_NAME
 0 0 * * * /usr/local/pgsql/bin/vacuumdb --full --analyze $OPENACS_SERVICE_NAME
    Depending on your distribution, you may receive
                 email when the crontab items are executed. If you
                 don't want to receive email for those crontab items,
@@ -250,7 +250,7 @@
 	  need to configure a virtual server.  The Reference Platform
 	  uses a configuration file included in the OpenACS tarball,
 	  /var/lib/aolserver/$OPENACS_SERVICE_NAME/etc/config.tcl.
-	   Open it in an editor to adjust the parameters.
    [root root]# su - $OPENACS_SERVICE_NAME
+	   Open it in an editor to adjust the parameters.
    [root root]# su - $OPENACS_SERVICE_NAME
 [$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/etc
 [$OPENACS_SERVICE_NAME etc]$ emacs config.tcl
 
    
Index: openacs-4/packages/acs-core-docs/www/packages.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/packages.html,v
diff -u -r1.42.2.3 -r1.42.2.4
--- openacs-4/packages/acs-core-docs/www/packages.html	30 Nov 2005 05:21:57 -0000	1.42.2.3
+++ openacs-4/packages/acs-core-docs/www/packages.html	1 Dec 2005 17:45:50 -0000	1.42.2.4
@@ -12,7 +12,7 @@
     
    Server file layout
    
       Here is how an OpenACS 5 server is laid out
       starting from the Server root (ROOT):
-    
    Figure�11.1.�Server file layout diagram
    +    
    Figure�11.1.�Server file layout diagram
     ROOT/
     bin/
         Various executables and scripts for server maintanence.
@@ -50,7 +50,7 @@
       
       To illustrate the general structure of a package, let's see what the
       package for the "notes" application should look like.
-    
    Figure�11.2.�Package file layout diagram
    +    
    Figure�11.2.�Package file layout diagram
     ROOT/
   +-- packages/    APM Root
         |
@@ -123,7 +123,7 @@
       directories.  This makes it suitable for storing icons, css
       files, javascript, and other static content which can be treated
       this way.
-    
    Table�11.1.�Package files
    File TypeIts UseNaming Convention
    Package Specification FileThe package specification file is an XML file generated and
+    
    Table�11.1.�Package files
    File TypeIts UseNaming Convention
    Package Specification FileThe package specification file is an XML file generated and
           maintained by the OpenACS Package Manager (APM).  It specifies
           information about the package including its parameters and its
           files.notes.info
    Data Model Creation Script
Index: openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.html,v
diff -u -r1.36.2.3 -r1.36.2.4
--- openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.html	30 Nov 2005 05:21:57 -0000	1.36.2.3
+++ openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.html	1 Dec 2005 17:45:50 -0000	1.36.2.4
@@ -100,7 +100,7 @@
     
    Context Hierarchy
    
       Suppose objects A, B, ..., 
       and F form the following hierarchy. 
-    
    Table�11.2.�Context Hierarchy Example
    
+    
    Table�11.2.�Context Hierarchy Example
    
 	      A
 	      
    
   	        object_id=10
@@ -134,7 +134,7 @@
       This can be represented in the 
       acs_objects table
       by the following entries: 
-    
    Table�11.3.�acs_objects example data
    object_idcontext_id
    2010
    3010
    4020
    5020
    6030
    
+    
    Table�11.3.�acs_objects example data
    object_idcontext_id
    2010
    3010
    4020
    5020
    6030
    
       The first entry tells us that object 20 is the descendant of object 10, and
       the third entry shows that object 40 is the descendant of object 20. By
       running a CONNECT BY query,
Index: openacs-4/packages/acs-core-docs/www/psgml-for-emacs.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/psgml-for-emacs.html,v
diff -u -r1.32.2.3 -r1.32.2.4
--- openacs-4/packages/acs-core-docs/www/psgml-for-emacs.html	30 Nov 2005 05:21:57 -0000	1.32.2.3
+++ openacs-4/packages/acs-core-docs/www/psgml-for-emacs.html	1 Dec 2005 17:45:51 -0000	1.32.2.4
@@ -1,4 +1,4 @@
-Add PSGML commands to emacs init file (OPTIONAL)
    Alex logo
    Prev Appendix�B.�Install additional supporting software Next
    Add PSGML commands to emacs init file (OPTIONAL)
    
+Add PSGML commands to emacs init file (OPTIONAL)
    Alex logo
    Prev Appendix�B.�Install additional supporting software Next
    Add PSGML commands to emacs init file (OPTIONAL)
    
 If you plan to write or edit any documentation with emacs, install a
       customized emacs configuration file with DocBook commands in the skeleton
       directory, so it will be used for all new users.  The file also
Index: openacs-4/packages/acs-core-docs/www/release-notes.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/release-notes.html,v
diff -u -r1.46.2.3 -r1.46.2.4
--- openacs-4/packages/acs-core-docs/www/release-notes.html	30 Nov 2005 05:21:57 -0000	1.46.2.3
+++ openacs-4/packages/acs-core-docs/www/release-notes.html	1 Dec 2005 17:45:51 -0000	1.46.2.4
@@ -1,4 +1,4 @@
-OpenACS Release Notes
    Alex logo
    Prev Chapter�1.�High level information: What is OpenACS? Next
    OpenACS Release Notes
    The ChangeLogs include an annotated list of changes since the last release and in the entire 5.2 release sequence.
    Release 5.2.0 release candidate 2
    • Bug fixes.
      New TIPs implemented.
      This release does not include new translations.
    Release 5.1.4
    • Bug fixes.
      The missing CR TCL API has been filled in, thanks to Rocael and
+OpenACS Release Notes
      Alex logo
      Prev Chapter�1.�High level information: What is OpenACS? Next
      OpenACS Release Notes
      The ChangeLogs include an annotated list of changes since the last release and in the entire 5.2 release sequence.
      Release 5.2.0 release candidate 3
      • Bug fixes.
        New TIPs implemented.
        This release does not include new translations.
      Release 5.1.4
      • Bug fixes.
        The missing CR TCL API has been filled in, thanks to Rocael and
         his team and Dave Bauer.
        This release does not include new translations.
      Release 5.1.3
      • Bug fixes, primarily for .LRN compatibility in support of upcoming .LRN 2.1.0 releases. This release does not include new translations since 5.1.2.
         
      Release 5.1.2
      • Translations syncronized with the translation server.
         Basque and Catalan added.
@@ -111,4 +111,4 @@
         
      • 
 	   Serving backup files and files from the CVS directories is turned off by default via the acs-kernel parameter
      	   ExcludedFiles in section request-processor (The variable provides a string match glob list of files and is defaulted to "*/CVS/* *~")
-	
      ($Id$)
      Release 4.6.3
      Release Notes for 4.6.3
      Release 4.6.2
      Release Notes for 4.6.2
      Release 4.6
      Release Notes for 4.6
      Release 4.5
      Release Notes for 4.5
      Prev Home Next
      Overview Up Part�II.�Administrator's Guide
      docs@openacs.org
      View comments on this page at openacs.org
      
+	
    ($Id$)
    Release 4.6.3
    Release Notes for 4.6.3
    Release 4.6.2
    Release Notes for 4.6.2
    Release 4.6
    Release Notes for 4.6
    Release 4.5
    Release Notes for 4.5
    Prev Home Next
    Overview Up Part�II.�Administrator's Guide
    docs@openacs.org
    View comments on this page at openacs.org
    
Index: openacs-4/packages/acs-core-docs/www/tutorial-css-layout.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-css-layout.html,v
diff -u -r1.4.2.3 -r1.4.2.4
--- openacs-4/packages/acs-core-docs/www/tutorial-css-layout.html	30 Nov 2005 05:21:57 -0000	1.4.2.3
+++ openacs-4/packages/acs-core-docs/www/tutorial-css-layout.html	1 Dec 2005 17:45:51 -0000	1.4.2.4
@@ -1,4 +1,4 @@
-Laying out a page with CSS instead of tables
    Alex logo
    Prev Chapter�10.�Advanced Topics Next
    Laying out a page with CSS instead of tables
    .LRN home page with table-based layout
    A sample of the HTML code (full source)
    <table border="0" width="100%">
+Laying out a page with CSS instead of tables
    Alex logo
    Prev Chapter�10.�Advanced Topics Next
    Laying out a page with CSS instead of tables
    .LRN home page with table-based layout
    A sample of the HTML code (full source)
    <table border="0" width="100%">
   <tr>
     <td valign="top" width="50%">
       <table class="element" border=0 cellpadding="0" cellspacing="0" width="100%">
@@ -20,7 +20,7 @@
                   <table border="0" bgcolor="white" cellpadding="0" cellspacing="0" width="100%">
                     <tr>
                       <td class=element-text>
-                        MBA 101
    .LRN Home with CSS-based layout
    A sample of the HTML code (full source)
    <div class="left">
+                        MBA 101
    .LRN Home with CSS-based layout
    A sample of the HTML code (full source)
    <div class="left">
   <div class="portlet-wrap-shadow">
     <div class="portlet-wrap-bl">
       <div class="portlet-wrap-tr">
Index: openacs-4/packages/acs-core-docs/www/tutorial-cvs.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-cvs.html,v
diff -u -r1.18.2.3 -r1.18.2.4
--- openacs-4/packages/acs-core-docs/www/tutorial-cvs.html	30 Nov 2005 05:21:57 -0000	1.18.2.3
+++ openacs-4/packages/acs-core-docs/www/tutorial-cvs.html	1 Dec 2005 17:45:51 -0000	1.18.2.4
@@ -58,4 +58,4 @@
 initial revision: 1.1
 done
 (many lines omitted)
-[$OPENACS_SERVICE_NAME myfirstpackage]$
    Figure�10.1.�Upgrading a local CVS repository
    Upgrading a local CVS repository
    Prev Home Next
    Write the Requirements and Design Specs Up OpenACS Edit This Page Templates
    docs@openacs.org
    View comments on this page at openacs.org
    
+[$OPENACS_SERVICE_NAME myfirstpackage]$
    Figure�10.1.�Upgrading a local CVS repository
    Upgrading a local CVS repository
    Prev Home Next
    Write the Requirements and Design Specs Up OpenACS Edit This Page Templates
    docs@openacs.org
    View comments on this page at openacs.org
    
Index: openacs-4/packages/acs-core-docs/www/tutorial-database.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-database.html,v
diff -u -r1.35.2.3 -r1.35.2.4
--- openacs-4/packages/acs-core-docs/www/tutorial-database.html	30 Nov 2005 05:21:57 -0000	1.35.2.3
+++ openacs-4/packages/acs-core-docs/www/tutorial-database.html	1 Dec 2005 17:45:51 -0000	1.35.2.4
@@ -1,7 +1,7 @@
 Setting Up Database Objects
    Alex logo
    Prev Chapter�9.�Development Tutorial Next
    Setting Up Database Objects
    by Joel Aufrecht
    
           OpenACS docs are written by the named authors, and may be edited
           by OpenACS documentation staff.
-        
    Code the data model
    We create all database objects with scripts in the
+        
    Code the data model
    We create all database objects with scripts in the
       myfirstpackage/sql/ directory.  All
       database scripts are database-specific and are thus in either
       the myfirstpackage/sql/oracle or
@@ -31,13 +31,13 @@
       repository functions to simplify our database creation.  (More
       information about ACS Objects.  More information about the
       Content Repository.)
-
    Figure�9.2.�Tutorial Data Model
    Tutorial Data Model
    The top of each sql file has some
+
    Figure�9.2.�Tutorial Data Model
    Tutorial Data Model
    The top of each sql file has some
       standard comments, including doc tags such as
       @author which will be picked up
       by the API browser.  The string
       $Id$ will automatically be
       expanded when the file is checked in to cvs.
    [$OPENACS_SERVICE_NAME ~]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/sql/postgresql
-[$OPENACS_SERVICE_NAME postgresql]$ emacs myfirstpackage-create.sql
    Paste the text below into the file, save, and close.
    Figure�9.3.�The Database Creation Script
    -- creation script
+[$OPENACS_SERVICE_NAME postgresql]$ emacs myfirstpackage-create.sql
    Paste the text below into the file, save, and close.
    Figure�9.3.�The Database Creation Script
    -- creation script
 --
 -- @author joel@aufrecht.org
 -- @cvs-id &Id:$
@@ -61,7 +61,7 @@
     object.  Notice the use of "mfp."  This is derived from "My
     First Package" and ensures that our object is unlikely to conflict
     with objects from other packages.
    Create a database file to drop everything if the package is uninstalled.
    -[$OPENACS_SERVICE_NAME postgresql]$ emacs myfirstpackage-drop.sql
    Figure�9.4.�Database Deletion Script
    -- drop script
+[$OPENACS_SERVICE_NAME postgresql]$ emacs myfirstpackage-drop.sql
    Figure�9.4.�Database Deletion Script
    -- drop script
 --
 -- @author joel@aufrecht.org
 -- @cvs-id &Id:$
Index: openacs-4/packages/acs-core-docs/www/tutorial-debug.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-debug.html,v
diff -u -r1.34.2.3 -r1.34.2.4
--- openacs-4/packages/acs-core-docs/www/tutorial-debug.html	30 Nov 2005 05:21:57 -0000	1.34.2.3
+++ openacs-4/packages/acs-core-docs/www/tutorial-debug.html	1 Dec 2005 17:45:51 -0000	1.34.2.4
@@ -1,7 +1,7 @@
 Debugging and Automated Testing
    Alex logo
    Prev Chapter�9.�Development Tutorial Next
    Debugging and Automated Testing
    by Joel Aufrecht
    
           OpenACS docs are written by the named authors, and may be edited
           by OpenACS documentation staff.
-        
    Debugging
    Developer Support.�The Developer Support package adds several goodies: debug
+        
    Debugging
    Developer Support.�The Developer Support package adds several goodies: debug
       information for every page; the ability to log comments to the
       page instead of the error log, and fast user switching so that you
       can test pages as anonymous and as dummy users without logging
@@ -22,16 +22,16 @@
 ?�searches�backward�
    
 /�searches�forward.�
    
 ����������
    
-    
    Manual testing
    Make a list of basic tests to make sure it works
    Test NumActionExpected Result
    001Browse to the index page while not logged in and
+    
    Manual testing
    Make a list of basic tests to make sure it works
    Test NumActionExpected Result
    001Browse to the index page while not logged in and
             while one or more notes exist.No edit or delete or add links should appear.
    002Browse to the index page while logged in.  An Edit
             link should appear.  Click on it.  Fill out the form and
             click Submit.The text added in the form should be visible on the
             index page.
    API-001Invoke mfp::note::create with a specific word as the title.Proc should return an object id.
    API-002Given an object id from API-001, invoke mfp::note::get.Proc should return the specific word in the title.
    API-003Given the object id from API-001, invoke mfp::note::delete.Proc should return 0 for success.
    Other things to test: try to delete someone else's
         note.  Try to delete your own note.  Edit your own note.
-        Search for a note.
    Write automated tests
    by Simon Carstensen and Joel Aufrecht
    
+        Search for a note.
    Write automated tests
    by Simon Carstensen and Joel Aufrecht
    
           OpenACS docs are written by the named authors, and may be edited
           by OpenACS documentation staff.
-        
    
+        
    
     It seems to me that a lot of people have been asking for some guidelines on how to write automated tests. I've done several tests by now and have found the process to be extremely easy and useful. It's a joy to work with automated testing once you get the hang of it.
    Create the directory that will contain the test
     script and edit the script file.  The directory location and file name are standards which are recognized by the automated testing package:
    [$OPENACS_SERVICE_NAME www]$ mkdir /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/tcl/test
 [$OPENACS_SERVICE_NAME www]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/tcl/test
@@ -67,7 +67,7 @@
 goes inside -test_code {}.  We want to implement test case API-001, "Given an object id from API-001, invoke mfp::note::get.  Proc should return the specific word in the title."
           set name [ad_generate_random_string]
       set new_id [mfp::note::add -title $name]
-      aa_true "Note add succeeded" [exists_and_not_null new_id]
    To test our simple case, we must load the test file into the system (just as with the /tcl file in the basic tutorial, since the file didn't exist when the system started, the system doesn't know about it.)  To make this file take effect, go to the APM and choose "Reload changed" for "MyFirstPackage".  Since we'll be changing it frequently, select "watch this file" on the next page.  This will cause the system to check this file every time any page is requested, which is bad for production systems but convenient for developing.  We can also add some aa_register_case flags to make it easier to run the test.  The -procs flag, which indicates which procs are tested by this test case, makes it easier to find procs in your package that aren't tested at all.  The -cats flag, setting categories, makes it easier to control which tests to run.  The smoke test setting means that this is a basic test case that can and should be run any time you are doing any test. (a definition of "smoke test")
    Once the file is loaded, go to ACS Automated Testing and click on myfirstpackage.  You should see your test case.  Run it and examine the results.
    TCLWebtest tests
    API testing can only test part of our package - it doesn't test the code in our adp/tcl pairs.  For this, we can use TCLwebtest.  TCLwebtest must be installed for this test to work.  This provides a library of functions that make it easy to call a page through HTTP, examine the results, and drive forms.  TCLwebtest's functions overlap slightly with acs-automated-testing; see the example provided for one approach on integrating them.
    Example
    Now we can add the rest of the API tests, including a test with deliberately bad data.  The complete test looks like:
    ad_library {
+      aa_true "Note add succeeded" [exists_and_not_null new_id]
    To test our simple case, we must load the test file into the system (just as with the /tcl file in the basic tutorial, since the file didn't exist when the system started, the system doesn't know about it.)  To make this file take effect, go to the APM and choose "Reload changed" for "MyFirstPackage".  Since we'll be changing it frequently, select "watch this file" on the next page.  This will cause the system to check this file every time any page is requested, which is bad for production systems but convenient for developing.  We can also add some aa_register_case flags to make it easier to run the test.  The -procs flag, which indicates which procs are tested by this test case, makes it easier to find procs in your package that aren't tested at all.  The -cats flag, setting categories, makes it easier to control which tests to run.  The smoke test setting means that this is a basic test case that can and should be run any time you are doing any test. (a definition of "smoke test")
    Once the file is loaded, go to ACS Automated Testing and click on myfirstpackage.  You should see your test case.  Run it and examine the results.
    TCLWebtest tests
    API testing can only test part of our package - it doesn't test the code in our adp/tcl pairs.  For this, we can use TCLwebtest.  TCLwebtest must be installed for this test to work.  This provides a library of functions that make it easy to call a page through HTTP, examine the results, and drive forms.  TCLwebtest's functions overlap slightly with acs-automated-testing; see the example provided for one approach on integrating them.
    Example
    Now we can add the rest of the API tests, including a test with deliberately bad data.  The complete test looks like:
    ad_library {
     Test cases for my first package.
 }
 
Index: openacs-4/packages/acs-core-docs/www/tutorial-distribute.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-distribute.html,v
diff -u -r1.18.2.3 -r1.18.2.4
--- openacs-4/packages/acs-core-docs/www/tutorial-distribute.html	30 Nov 2005 05:21:57 -0000	1.18.2.3
+++ openacs-4/packages/acs-core-docs/www/tutorial-distribute.html	1 Dec 2005 17:45:51 -0000	1.18.2.4
@@ -6,5 +6,5 @@
         (37.1KB)
         after the label Distribution
         File: and save the file to
-        /var/tmp.
    
+        /var/tmp.
    
 
    Package development guidelines
    Prev Home Next
    Profile your code Up Distributing upgrades of your package
    docs@openacs.org
    View comments on this page at openacs.org
    
Index: openacs-4/packages/acs-core-docs/www/tutorial-newpackage.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-newpackage.html,v
diff -u -r1.35.2.3 -r1.35.2.4
--- openacs-4/packages/acs-core-docs/www/tutorial-newpackage.html	30 Nov 2005 05:21:57 -0000	1.35.2.3
+++ openacs-4/packages/acs-core-docs/www/tutorial-newpackage.html	1 Dec 2005 17:45:51 -0000	1.35.2.4
@@ -1,7 +1,7 @@
 Creating an Application Package
    Alex logo
    Prev Chapter�9.�Development Tutorial Next
    Creating an Application Package
    by Joel Aufrecht
    
           OpenACS docs are written by the named authors, and may be edited
           by OpenACS documentation staff.
-        
    The intended page map
    Overview
    To start developing new code in OpenACS, we build a new package. A package 
+        
    The intended page map
    Overview
    To start developing new code in OpenACS, we build a new package. A package 
       is a a discrete collection of web pages, tcl code, and database tables and procedures.
       A package with user interface is called an application; 
       a package which provides functions to other packages and has no direct interface, a
@@ -17,11 +17,11 @@
         right now.  Code that is temporary hackage is clearly marked.
       
    In this tutorial, we will make an application package for
     displaying a list of text notes.
-
    Before you begin
    You will need:
    • A computer with a working installation of
+
    Before you begin
    You will need:
    • A computer with a working installation of
 	  OpenACS.  If you don't have this, see Chapter�2, Installation Overview.
 	  
    • Example files, which are included in the
 standard OpenACS 5.2.0b8 distribution.
-	  
    Figure�9.1.�Assumptions in this section
    Fully qualified domain name of your serveryourserver.test
    URL of your serverhttp://yourserver.test:8000
    Name of development account$OPENACS_SERVICE_NAME
    New Package keymyfirstpackage
    Use the APM to initialize a new package
    We use the ACS Package Manager (APM) to add, remove, and
+	  
    Figure�9.1.�Assumptions in this section
    Fully qualified domain name of your serveryourserver.test
    URL of your serverhttp://yourserver.test:8000
    Name of development account$OPENACS_SERVICE_NAME
    New Package keymyfirstpackage
    Use the APM to initialize a new package
    We use the ACS Package Manager (APM) to add, remove, and
     upgrade packages.  It handles package meta-data, such as lists of
     files that belong in the package.  Each package is uniquely
     identified by a package key.  To start developing a new
@@ -54,7 +54,7 @@
           /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage.
           This is the "home directory" of our new package, and all
           files in the package will be within this directory. More on the structure of
-          packages). 
    Add an Application Instance to the Server
    In order to see your work in progress, you must create a
+          packages). 
    Add an Application Instance to the Server
    In order to see your work in progress, you must create a
       map between the URL space of incoming requests and the package application instance.
       You do this by adding the application in the main site administration).  This
       creates a link between the incoming URL requests and an
@@ -65,7 +65,7 @@
       in this tutorial.
    1. Browse to
 http://yourserver.test:8000/admin/applications/application-add/.
    2. Choose "My First Package" from the list and click OK (the other fields are optional).
    By mounting the package, we've caused all requests to
       http://yourserver.test:8000/my-first-package
-      to be satisfied from the files at /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/www.
    Quick start
    The remainder of the tutorial walks you through each file one at a time as you create the package.  You can skip all this, and get a working package, by doing the following:
    cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-core-docs/www/files/tutorial
+      to be satisfied from the files at /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/www.
    Quick start
    The remainder of the tutorial walks you through each file one at a time as you create the package.  You can skip all this, and get a working package, by doing the following:
    cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-core-docs/www/files/tutorial
 psql $OPENACS_SERVICE_NAME -f myfirstpackage-create.sql
 cp note-edit.* note-delete.tcl index.* ../../../../myfirstpackage/www/
 mkdir ../../../../myfirstpackage/lib
Index: openacs-4/packages/acs-core-docs/www/tutorial-pages.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-pages.html,v
diff -u -r1.35.2.3 -r1.35.2.4
--- openacs-4/packages/acs-core-docs/www/tutorial-pages.html	30 Nov 2005 05:21:57 -0000	1.35.2.3
+++ openacs-4/packages/acs-core-docs/www/tutorial-pages.html	1 Dec 2005 17:45:51 -0000	1.35.2.4
@@ -1,8 +1,8 @@
 Creating Web Pages
    Alex logo
    Prev Chapter�9.�Development Tutorial Next
    Creating Web Pages
    by Joel Aufrecht
    
           OpenACS docs are written by the named authors, and may be edited
           by OpenACS documentation staff.
-        
    Install some API
    As a workaround for missing content-repository functionality, copy a provided file into the directory for tcl files:
    -    cp /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-core-docs/www/files/note-procs.tcl /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/tcl/
    To make this file take effect, go to the APM and choose "Reload changed" for "MyFirstPackage".
    Page Map
    Our package will have two visible pages.  The first shows a list of all objects; the second shows a single object in view or edit mode, and can also be used to add an object.  The index page will display the list, but since we might reuse the list later, we'll put it in a seperate file and include it on the index page.
    Figure�9.5.�Page Map
    Page Map
    Build the "Index" page
    Each user-visible page in your package has, typically,
+        
    Install some API
    As a workaround for missing content-repository functionality, copy a provided file into the directory for tcl files:
    +    cp /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-core-docs/www/files/note-procs.tcl /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/tcl/
    To make this file take effect, go to the APM and choose "Reload changed" for "MyFirstPackage".
    Page Map
    Our package will have two visible pages.  The first shows a list of all objects; the second shows a single object in view or edit mode, and can also be used to add an object.  The index page will display the list, but since we might reuse the list later, we'll put it in a seperate file and include it on the index page.
    Figure�9.5.�Page Map
    Page Map
    Build the "Index" page
    Each user-visible page in your package has, typically,
       three parts.  The  tcl file
       holds the procedural logic for the page, including TCL and
       database-independent SQL code, and does things like
Index: openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.html,v
diff -u -r1.18.2.3 -r1.18.2.4
--- openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.html	30 Nov 2005 05:21:57 -0000	1.18.2.3
+++ openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.html	1 Dec 2005 17:45:51 -0000	1.18.2.4
@@ -1,4 +1,4 @@
-Upgrading 4.5 or higher to 4.6.3
    Alex logo
    Prev Chapter�5.�Upgrading Next
    Upgrading 4.5 or higher to 4.6.3
    The required platform for OpenACS 4.6 is the same as
+Upgrading 4.5 or higher to 4.6.3
    Alex logo
    Prev Chapter�5.�Upgrading Next
    Upgrading 4.5 or higher to 4.6.3
    The required platform for OpenACS 4.6 is the same as
       4.5, with the exception of OpenFTS.  OpenACS 4.6 and later require OpenFTS 0.3.2 for full text search on PostGreSQL.  If you have OpenFTS 0.2, you'll need to upgrade.  
    If upgrading from 4.2, you need to manually run acs-kernel/sql/postgres/upgrade-4.2-4.5.sql.  See Bug #632
    1. Make a Backup.�Back up the database and file system (see the section called “Manual backup and recovery”).
    2. OPTIONAL: Upgrade OpenFTS.�the section called “Upgrading OpenFTS from 0.2 to 0.3.2”
    3. 
             Stop the server
           
      [root root]# svc -d /service/$OPENACS_SERVICE_NAME
    4. Upgrade the file system.�the section called “Upgrading the OpenACS files”
    5. 
Index: openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.html,v
diff -u -r1.18.2.3 -r1.18.2.4
--- openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.html	30 Nov 2005 05:21:57 -0000	1.18.2.3
+++ openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.html	1 Dec 2005 17:45:51 -0000	1.18.2.4
@@ -1,4 +1,4 @@
-Upgrading the OpenACS files
      Alex logo
      Prev Chapter�5.�Upgrading Next
      Upgrading the OpenACS files
      Chosing a Method to Upgrade your Files
      OpenACS is distributed in many different ways:
+Upgrading the OpenACS files
      Alex logo
      Prev Chapter�5.�Upgrading Next
      Upgrading the OpenACS files
      Chosing a Method to Upgrade your Files
      OpenACS is distributed in many different ways:
         
      •  as a collection of files
      •  as one big tarball
      •  via CVS
      •  via automatic download from within the APM
             (package manager)
      
       
      Upgrades work by first changing the file system (via any
@@ -10,7 +10,7 @@
         describes whether or not you need to be upgrading using this
         page or not:
         the section called “Upgrading an OpenACS 5.0.0 or greater installation”
-      
      Methods of upgrading OpenACS files
      • Upgrading files for a site which is not in a CVS repository.�Unpack the tarball into a new directory and copy its
+      
      Methods of upgrading OpenACS files
      • Upgrading files for a site which is not in a CVS repository.�Unpack the tarball into a new directory and copy its
           contents on top of your working directory. Or just 'install
           software', select remote repository, and upgrade your files
           from there.
        [root root]# su - $OPENACS_SERVICE_NAME
@@ -31,7 +31,7 @@
         with the latest OpenACS version, without overriding your own
         local customizations. 
        This diagram explains the basic idea. However, the
         labels are incorrect. Step 1(a) has been removed, and Step
-        1(b) should be labelled Step 1.
        Figure�5.2.�Upgrading a local CVS repository
        Upgrading a local CVS repository
        • Step 0: Set up a working CVS checkout.�
          To get your OpenACS code into your local CVS
+        1(b) should be labelled Step 1.
          Figure�5.2.�Upgrading a local CVS repository
          Upgrading a local CVS repository
          • Step 0: Set up a working CVS checkout.�
            To get your OpenACS code into your local CVS
                 repository, you will set up a working CVS checkout of
                 OpenACS. When you want to update your site, you'll
                 update the working CVS checkout, import those changes
@@ -95,7 +95,7 @@
       
            1. [$OPENACS_SERVICE_NAME ~]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME
 [$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ cvs up -Pd
 (CVS feedback)
-[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$
          Upgrading a Production Site Safely
          If you are upgrading a production OpenACS site which is on a private CVS tree, this process lets you do the upgrade without risking extended downtime or an unusable site:
          1. Declare a freeze on new cvs updates - ie, you cannot run cvs update
+[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$
    Upgrading a Production Site Safely
    If you are upgrading a production OpenACS site which is on a private CVS tree, this process lets you do the upgrade without risking extended downtime or an unusable site:
    1. Declare a freeze on new cvs updates - ie, you cannot run cvs update
    on the production site
    2. 
             Make a manual backup of the production site in addition to the
    automated backups
    3. Import the new code (for example, OpenACS 5.0.4, openacs-5-0-compat versions of
Index: openacs-4/packages/acs-core-docs/www/upgrade-overview.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/upgrade-overview.html,v
diff -u -r1.18.2.3 -r1.18.2.4
--- openacs-4/packages/acs-core-docs/www/upgrade-overview.html	30 Nov 2005 05:21:57 -0000	1.18.2.3
+++ openacs-4/packages/acs-core-docs/www/upgrade-overview.html	1 Dec 2005 17:45:51 -0000	1.18.2.4
@@ -3,4 +3,4 @@
     or better, you should always be able to upgrade all of your core
     packages automatically.  If you haven't changed anything, no
     manual intervention should be required.  If you are running
-    OpenACS prior to 4.5, upgrading will require manual effort.
      If all of these conditions are true:
      • Your OpenACS Core is 5.0.0 or later
      • You do not keep your OpenACS site in a local CVS repository
      • You do not have any custom code
      then you can upgrade automatically using the automated installer in the OpenACS Package Manager (APM), and you can probably skip the rest of this chapter.  To upgrade directly from the OpenACS repository using the APM:
      1. Browse to the Installer.
      2. Click install or upgrade under "Install from OpenACS Repository" and select the packages to install or upgrade.
      3. The APM will download the requested packages from OpenACS.org, install the files on your hard drive, run any appropriate database upgrade scripts, and prompt you to restart the server.  After restarting the server again, the upgrade is complete.
      Figure�5.1.�Upgrading with the APM
      Upgrading with the APM
      It's always a good idea to precede an upgrade attempt with a snapshot backup.
      Table�5.1.�Assumptions in this section
      name of OpenACS user$OPENACS_SERVICE_NAME
      OpenACS server name$OPENACS_SERVICE_NAME
      Root of OpenACS file tree/var/lib/aolserver/$OPENACS_SERVICE_NAME
      Database backup directory/var/lib/aolserver/$OPENACS_SERVICE_NAME/database-backup
    Prev Home Next
    Chapter�5.�Upgrading Up Upgrading 4.5 or higher to 4.6.3
    docs@openacs.org
    View comments on this page at openacs.org
    
+    OpenACS prior to 4.5, upgrading will require manual effort.
    If all of these conditions are true:
    • Your OpenACS Core is 5.0.0 or later
    • You do not keep your OpenACS site in a local CVS repository
    • You do not have any custom code
    then you can upgrade automatically using the automated installer in the OpenACS Package Manager (APM), and you can probably skip the rest of this chapter.  To upgrade directly from the OpenACS repository using the APM:
    1. Browse to the Installer.
    2. Click install or upgrade under "Install from OpenACS Repository" and select the packages to install or upgrade.
    3. The APM will download the requested packages from OpenACS.org, install the files on your hard drive, run any appropriate database upgrade scripts, and prompt you to restart the server.  After restarting the server again, the upgrade is complete.
    Figure�5.1.�Upgrading with the APM
    Upgrading with the APM
    It's always a good idea to precede an upgrade attempt with a snapshot backup.
    Table�5.1.�Assumptions in this section
    name of OpenACS user$OPENACS_SERVICE_NAME
    OpenACS server name$OPENACS_SERVICE_NAME
    Root of OpenACS file tree/var/lib/aolserver/$OPENACS_SERVICE_NAME
    Database backup directory/var/lib/aolserver/$OPENACS_SERVICE_NAME/database-backup
    Prev Home Next
    Chapter�5.�Upgrading Up Upgrading 4.5 or higher to 4.6.3
    docs@openacs.org
    View comments on this page at openacs.org
    
Index: openacs-4/packages/acs-core-docs/www/using-cvs-with-openacs.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/Attic/using-cvs-with-openacs.html,v
diff -u -r1.2.2.3 -r1.2.2.4
--- openacs-4/packages/acs-core-docs/www/using-cvs-with-openacs.html	30 Nov 2005 05:21:57 -0000	1.2.2.3
+++ openacs-4/packages/acs-core-docs/www/using-cvs-with-openacs.html	1 Dec 2005 17:45:51 -0000	1.2.2.4
@@ -4,7 +4,7 @@
     CVS Guidelines
   ">
    Alex logo
    Prev Chapter�14.�
     CVS Guidelines
-   Next
    Using CVS with OpenACS
    Getting Started
    
+  
    		 Next
    Using CVS with OpenACS
    Getting Started
    
         All OpenACS code is available anonymously.  To get code
       anonymously, use the parameter
       -d:pserver:anonymous@cvs.openacs.org:/cvsroot immediately after cvs in a cvs command to check out or export code.
@@ -47,7 +47,7 @@
 cd CVSROOT
 emacs avail
    Add an avail line of the form:
    avail|username|openacs-4
    cvs commit -m "added commit on X for username" avail
    Branimir suggests an additional level of abstraction.  If you put
    Host cvs-server
       HostName cvs.openacs.org
-      User yournamehere
    into your ~/.ssh/config file, then you can use -d :ext:cvs-server:/cvsroot instead of -d :ext:cvs.openacs.org:/cvsroot.  You can then change the definition of cvs-server by changing one file instead of editing hundreds of CVSROOT/Repository files.
    Checkout for Package Development
    If you are actively developing a non-core package, you
+      User yournamehere
    into your ~/.ssh/config file, then you can use -d :ext:cvs-server:/cvsroot instead of -d :ext:cvs.openacs.org:/cvsroot.  You can then change the definition of cvs-server by changing one file instead of editing hundreds of CVSROOT/Repository files.
    Checkout for Package Development
    If you are actively developing a non-core package, you
       should work from the latest core release branch.  Currently this
       is oacs-5-2.  This ensures that you are working on top
       of a stable OpenACS core, but still allows you to commit feature
@@ -62,13 +62,13 @@
             Inventory and Package
             maintainers and status for a list of available
             packages and their current state.
-      
    Checkout for Core Development
    If you are actively developing packages in the OpenACS
+      
    Checkout for Core Development
    If you are actively developing packages in the OpenACS
       Core, work from the HEAD branch.  HEAD is used for active
               development of the next version of core OpenACS. It may be very
               buggy; it may not even install correctly. Do not use this branch for
               development of non-core features unless your work depends on some
               of the HEAD core work. To check out HEAD, omit the
-              -r tag.
    To check out HEAD for development, which requires an OpenACS developer account:
    cvs -d:ext:cvs.openacs.org:/cvsroot checkout acs-core
    To check out HEAD anonymously:
    cvs -d:pserver:anonymous@cvs.openacs.org:/cvsroot checkout acs-core
    Checkout .LRN
    
+              -r tag.
    To check out HEAD for development, which requires an OpenACS developer account:
    cvs -d:ext:cvs.openacs.org:/cvsroot checkout acs-core
    To check out HEAD anonymously:
    cvs -d:pserver:anonymous@cvs.openacs.org:/cvsroot checkout acs-core
    Checkout .LRN
    
         .LRN consists of a given version openacs core, plus a set of
         packages. These are collectively packages together to form a
         distrubution of .LRN. F .LRN 2.0.0 sits on top of OpenACS 5.0.0.
Index: openacs-4/packages/acs-core-docs/www/variables.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/variables.html,v
diff -u -r1.21.2.3 -r1.21.2.4
--- openacs-4/packages/acs-core-docs/www/variables.html	30 Nov 2005 05:21:57 -0000	1.21.2.3
+++ openacs-4/packages/acs-core-docs/www/variables.html	1 Dec 2005 17:45:51 -0000	1.21.2.4
@@ -3,7 +3,7 @@
           by OpenACS documentation staff.
         
    Date and Time Variables
    Starting with OpenACS 5.0 and the introduction of acs-lang,
     we recommend retrieving date/time information from the database in
-    ANSI format and then using lc_time_fmt to format it for display.
    Example�12.1.�Getting datetime from the database ANSI-style
    db_multirow -extend { mydate_pretty } {
+    ANSI format and then using lc_time_fmt to format it for display.
    Example�12.1.�Getting datetime from the database ANSI-style
    db_multirow -extend { mydate_pretty } {
     select to_char(mydate, 'YYYY-MM-DD HH24:MI:SS') as mydate_ansi,
           ...
     ...
Index: openacs-4/packages/acs-core-docs/www/xml/for-everyone/release-notes.xml
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/for-everyone/release-notes.xml,v
diff -u -r1.19.2.3 -r1.19.2.4
--- openacs-4/packages/acs-core-docs/www/xml/for-everyone/release-notes.xml	30 Nov 2005 05:21:58 -0000	1.19.2.3
+++ openacs-4/packages/acs-core-docs/www/xml/for-everyone/release-notes.xml	1 Dec 2005 17:45:52 -0000	1.19.2.4
@@ -36,7 +36,7 @@
 The ChangeLogs include an annotated list of changes since the last release and in the entire &majorversion;.&minorversion; release sequence.
 
   
-    Release 5.2.0 release candidate 2
+    Release 5.2.0 release candidate 3
     
       
         Bug fixes.