Index: openacs-4/packages/acs-core-docs/www/backup-recovery.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/backup-recovery.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/backup-recovery.adp 3 Sep 2021 09:14:49 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/backup-recovery.adp 7 Sep 2021 09:39:19 -0000 1.4.2.6 @@ -27,7 +27,7 @@ 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 +

Figure 8.1. Backup and Recovery Strategy

Backup and Recovery Strategy


OpenACS docs are written by the named authors, and may be edited by 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.46.2.4 -r1.46.2.5 --- openacs-4/packages/acs-core-docs/www/backup-recovery.html 3 Sep 2021 09:14:50 -0000 1.46.2.4 +++ openacs-4/packages/acs-core-docs/www/backup-recovery.html 7 Sep 2021 09:39:19 -0000 1.46.2.5 @@ -6,7 +6,7 @@ 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


+

Figure 8.1. Backup and Recovery Strategy

Backup and Recovery Strategy


OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff. Index: openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.adp 3 Sep 2021 09:14:51 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.adp 7 Sep 2021 09:39:20 -0000 1.4.2.6 @@ -16,7 +16,7 @@ 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-packages.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.html,v diff -u -r1.13.2.4 -r1.13.2.5 --- openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.html 3 Sep 2021 09:14:51 -0000 1.13.2.4 +++ openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.html 7 Sep 2021 09:39:20 -0000 1.13.2.5 @@ -2,7 +2,7 @@ Configuring an OpenACS package

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.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.adp 3 Sep 2021 09:14:51 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.adp 7 Sep 2021 09:39:20 -0000 1.4.2.6 @@ -16,7 +16,7 @@ OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff.

-Setting Permission on an OpenACS +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 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.13.2.4 -r1.13.2.5 --- openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.html 3 Sep 2021 09:14:51 -0000 1.13.2.4 +++ openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.html 7 Sep 2021 09:39:20 -0000 1.13.2.5 @@ -2,7 +2,7 @@ Setting Permissions on an OpenACS package

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.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-install-packages.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/configuring-install-packages.adp 3 Sep 2021 09:14:51 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/configuring-install-packages.adp 7 Sep 2021 09:39:20 -0000 1.4.2.6 @@ -15,7 +15,7 @@ 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 things it +Installing OpenACS packages

An OpenACS package extends your website and lets it do things it was not 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-install-packages.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-install-packages.html,v diff -u -r1.13.2.4 -r1.13.2.5 --- openacs-4/packages/acs-core-docs/www/configuring-install-packages.html 3 Sep 2021 09:14:52 -0000 1.13.2.4 +++ openacs-4/packages/acs-core-docs/www/configuring-install-packages.html 7 Sep 2021 09:39:20 -0000 1.13.2.5 @@ -2,7 +2,7 @@ Installing OpenACS packages

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 was not 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.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.adp 3 Sep 2021 09:14:52 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.adp 7 Sep 2021 09:39:21 -0000 1.4.2.6 @@ -15,7 +15,7 @@ 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 +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 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.13.2.4 -r1.13.2.5 --- openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.html 3 Sep 2021 09:14:52 -0000 1.13.2.4 +++ openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.html 7 Sep 2021 09:39:21 -0000 1.13.2.5 @@ -2,7 +2,7 @@ Mounting OpenACS packages

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/cvs-guidelines.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/cvs-guidelines.adp,v diff -u -r1.5.2.6 -r1.5.2.7 --- openacs-4/packages/acs-core-docs/www/cvs-guidelines.adp 3 Sep 2021 09:14:53 -0000 1.5.2.6 +++ openacs-4/packages/acs-core-docs/www/cvs-guidelines.adp 7 Sep 2021 09:39:21 -0000 1.5.2.7 @@ -18,7 +18,7 @@

Using CVS with OpenACS

-Getting Started

All OpenACS code is available anonymously. To get code +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.

If you are an OpenACS developer, you should check out code so @@ -77,7 +77,7 @@

-Checkout for Package Development

If you are actively developing a non-core package, you should +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-9. This ensures that you are working on top of a stable OpenACS core, but still allows you to commit feature changes to @@ -94,7 +94,7 @@ packages and their current state.

-Checkout for Core Development

If you are actively developing packages in the OpenACS Core, +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 @@ -103,7 +103,7 @@ 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 +Checkout .LRN

.LRN consists of a given version OpenACS core, plus a set of packages. These are collectively packages together to form a distribution of .LRN. F .LRN 2.0.0 sits on top of OpenACS 5.0.0. .LRN also uses an OpenACS install.xml file during installation; @@ -128,7 +128,7 @@

OpenACS CVS Concepts

-Modules

All OpenACS code resides within a single CVS module, +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 @@ -163,7 +163,7 @@ module of the same name.

- Tags and Branches

Tags and Branches look similar in commands, but behave + Tags and Branches

Tags and Branches look similar in commands, but behave differently. A tag is a fixed point on a branch. Check out a tag to get a specific version of OpenACS. Check out a branch to get the most current code for that major-minor version (e.g., 5.0.x or @@ -403,7 +403,7 @@

- Informal Guidelines

Informal guidelines which may be obsolete in places and should + Informal Guidelines

Informal guidelines which may be obsolete in places and should be reviewed:

Using CVS with OpenACS

Getting Started

+

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. @@ -53,7 +53,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

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-9. This ensures that you are working on top of a stable OpenACS core, but still allows you to commit feature @@ -68,13 +68,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 distribution of .LRN. F .LRN 2.0.0 sits on top of OpenACS 5.0.0. @@ -89,7 +89,7 @@ mv dotlrn/install.xml ..

Working with CVS

Once you have a checkout you can use some commands to track what has changed since you checked out your copy. cvs -n update does not change any files, but reports which changes have been updated or locally modified, or are not present in CVS. -

To update your files, use cvs update. This will merge changes from the repository with your local files. It has no effect on the cvs.openacs.org repository.

OpenACS CVS Concepts

Modules

+

To update your files, use cvs update. This will merge changes from the repository with your local files. It has no effect on the cvs.openacs.org repository.

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, @@ -117,7 +117,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 @@ -317,7 +317,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. -

+

Informal Guidelines

Informal guidelines which may be obsolete in places and should be reviewed: Index: openacs-4/packages/acs-core-docs/www/cvs-tips.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/cvs-tips.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/cvs-tips.adp 3 Sep 2021 09:14:54 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/cvs-tips.adp 7 Sep 2021 09:39:21 -0000 1.4.2.6 @@ -16,7 +16,7 @@ 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 +OPTIONAL. These steps take an existing OpenACS directory and add it to a CVS repository.

  1. 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.37.2.4 -r1.37.2.5 --- openacs-4/packages/acs-core-docs/www/cvs-tips.html 3 Sep 2021 09:14:54 -0000 1.37.2.4 +++ openacs-4/packages/acs-core-docs/www/cvs-tips.html 7 Sep 2021 09:39:22 -0000 1.37.2.5 @@ -2,7 +2,7 @@ Appendix D. Using CVS with an OpenACS Site

    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.adp
      ===================================================================
      RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/docbook-primer.adp,v
      diff -u -r1.6.2.7 -r1.6.2.8
      --- openacs-4/packages/acs-core-docs/www/docbook-primer.adp	3 Sep 2021 09:14:55 -0000	1.6.2.7
      +++ openacs-4/packages/acs-core-docs/www/docbook-primer.adp	7 Sep 2021 09:39:23 -0000	1.6.2.8
      @@ -409,7 +409,7 @@
       tools will be marked up to conform to the DocBook XML
       DTD. The remaining discussion is about publishing using
       Docbook.

      - is a publishing standard based on XML + is a publishing standard based on XML with similar goals to the OpenACS Documentation project. Some specific reasons why we are using DocBook:

      • It is open-source.

      • The DocBook community mailing lists @@ -449,7 +449,7 @@ 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: +you remember to:

        • Always close your tags with corresponding end-tags and to not use other tag @@ -490,7 +490,7 @@

          Document Structure

          The documentation for each package will make up a little "book" that is structured like this - examples are -emphasized: +emphasized:

               book                        : Docs for one package - templating
                |
          @@ -515,19 +515,19 @@
           

        Headlines, Sections

        - Given that your job starts at the + 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 + 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 + The other attribute is xreflabel. The value of this is the text that will appear as the link when referring to this sect1.

        Right after the opening tag you put the title of the document - this is usually the same as xreflabel-attribute. E.g. the top level of the document you're reading right now looks like this:

        @@ -538,7 +538,7 @@
         
         </sect1>
         

        - Inside this container your document will + Inside this container your document will be split up into <sect2>'s, each with the same requirements - id and xreflabel attributes, and a <title>-tag inside. Actually, the xreflabel is never required in @@ -548,7 +548,7 @@

        Code

        - For displaying a snippet of code, a + For displaying a snippet of code, a filename or anything else you just want to appear as a part of a sentence, we use <computeroutput> and <code> tags. These replace the HTML-tag <code> tag, @@ -562,15 +562,15 @@

        Links

        - Linking falls into two different + 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 +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>.
        @@ -594,7 +594,7 @@
         
        2. Linking outside the documentation

        - If you're hyper-linking out of the + If you're hyper-linking out of the documentation, it works almost the same way as HTML - the tag is just a little different (<ulink>):

        <ulink url="http://www.oracle.com/">Oracle Corporation</ulink>

        ....will create a hyper-link to Oracle in the HTML-version of the documentation.

        @@ -611,7 +611,7 @@ Note: The graphics guidelines are not written in stone. Use another valid approach if it works better for you.

        - To insert a graphic we use the elements + To insert a graphic we use the elements <mediaobject>, <imageobject>, <imagedata>, @@ -636,7 +636,7 @@

        Lists

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

        1. How to make an <ul>
        @@ -689,7 +689,7 @@

        Tables

        - DocBook supports several types of tables, + DocBook supports several types of tables, but in most cases, the <informaltable> is enough:

         <informaltable frame="all">
           <tgroup cols="3">
        @@ -735,7 +735,7 @@
         

        Emphasis

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

        The <emphasis> tag defaults to italics when parsed. If you're looking for emphasizing with bold type, use <emphasis 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.56.2.5 -r1.56.2.6 --- openacs-4/packages/acs-core-docs/www/docbook-primer.html 3 Sep 2021 09:14:55 -0000 1.56.2.5 +++ openacs-4/packages/acs-core-docs/www/docbook-primer.html 7 Sep 2021 09:39:23 -0000 1.56.2.6 @@ -578,7 +578,7 @@ DTD. The remaining discussion is about publishing using Docbook.

        - + is a publishing standard based on XML with similar goals to the OpenACS Documentation project. Some specific reasons why we are using DocBook:

        • @@ -640,7 +640,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 @@ -689,7 +689,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
            @@ -713,20 +713,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.

          @@ -741,7 +741,7 @@ </sect1>

      - + Inside this container your document will be split up into <sect2>'s, each with the same requirements - id and xreflabel @@ -750,7 +750,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 use <computeroutput> @@ -768,12 +768,12 @@ tag around text that has been wrapped by combinations of <computeroutput> and <userinput>

    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:

    @@ -797,7 +797,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 @@ -818,7 +818,7 @@ for you.

    - + To insert a graphic we use the elements <mediaobject>, <imageobject>, @@ -844,7 +844,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 @@ -889,7 +889,7 @@ </variablelist>

    Tables

    - + DocBook supports several types of tables, but in most cases, the <informaltable> is enough: @@ -926,7 +926,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.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/ext-auth-requirements.adp,v diff -u -r1.6.2.6 -r1.6.2.7 --- openacs-4/packages/acs-core-docs/www/ext-auth-requirements.adp 3 Sep 2021 09:14:59 -0000 1.6.2.6 +++ openacs-4/packages/acs-core-docs/www/ext-auth-requirements.adp 7 Sep 2021 09:39:24 -0000 1.6.2.7 @@ -12,7 +12,7 @@ External Authentication Requirements

-Vision

People have plenty of usernames and passwords already, we +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 @@ -74,7 +74,7 @@

Requirements

-New API

+New API
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.45.2.4 -r1.45.2.5 --- openacs-4/packages/acs-core-docs/www/ext-auth-requirements.html 3 Sep 2021 09:14:59 -0000 1.45.2.4 +++ openacs-4/packages/acs-core-docs/www/ext-auth-requirements.html 7 Sep 2021 09:39:24 -0000 1.45.2.5 @@ -1,5 +1,5 @@ -External Authentication Requirements
FeatureStatusDescription
New API
Prev Chapter 15. Kernel Documentation Next

External Authentication Requirements

Vision

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

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 @@ -45,7 +45,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
    New API
    EXT-AUTH-01AExtend Authentication/Acct Status API
    EXT-AUTH-03AAccount Creation API
    EXT-AUTH-05APassword Management API
    EXT-AUTH-30AAuthority Management API

    Login

    FeatureStatusDescription
    Login
    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, an authority, and a +

    Account Management (NO PICTURE YET)

    Batch Synchronization (NO PICTURE YET)

    Requirements

    New API

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

    Login

    FeatureStatusDescription
    Login
    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, an 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.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/form-builder.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/form-builder.adp 3 Sep 2021 09:15:00 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/form-builder.adp 7 Sep 2021 09:39:24 -0000 1.4.2.6 @@ -25,7 +25,7 @@ Multi-part Elements

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

    -SELECT elements

    1. +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 "
      @@ -96,7 +96,7 @@
       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 query.

    +Error when selecting values

    This generally happens when there is an error in your query.

    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.33.2.4 -r1.33.2.5 --- openacs-4/packages/acs-core-docs/www/form-builder.html 3 Sep 2021 09:15:00 -0000 1.33.2.4 +++ openacs-4/packages/acs-core-docs/www/form-builder.html 7 Sep 2021 09:39:24 -0000 1.33.2.5 @@ -6,7 +6,7 @@ adaptable UI. Error handling includes inline error reporting, and is customizable. However, ad_form can be tricky to use. In addition to this document, the ad_form api - documentation is helpful.

    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 "
      + documentation is helpful.

    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
      @@ -51,5 +51,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.

    Index: openacs-4/packages/acs-core-docs/www/high-avail.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/high-avail.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/high-avail.adp 3 Sep 2021 09:15:01 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/high-avail.adp 7 Sep 2021 09:39:25 -0000 1.4.2.6 @@ -12,7 +12,7 @@ High Availability/High Performance Configurations

    See also the section called “Running a PostgreSQL database on another server”.

    -

    Figure 6.1. Multiple-server +

    Figure 6.1. Multiple-server configuration

    Multiple-server configuration

    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.27.2.4 -r1.27.2.5 --- openacs-4/packages/acs-core-docs/www/high-avail.html 3 Sep 2021 09:15:01 -0000 1.27.2.4 +++ openacs-4/packages/acs-core-docs/www/high-avail.html 7 Sep 2021 09:39:25 -0000 1.27.2.5 @@ -1,2 +1,2 @@ -High Availability/High Performance Configurations

    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

    +High Availability/High Performance Configurations

    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

    Index: openacs-4/packages/acs-core-docs/www/how-do-I.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/how-do-I.adp,v diff -u -r1.5.2.5 -r1.5.2.6 --- openacs-4/packages/acs-core-docs/www/how-do-I.adp 3 Sep 2021 09:15:01 -0000 1.5.2.5 +++ openacs-4/packages/acs-core-docs/www/how-do-I.adp 7 Sep 2021 09:39:25 -0000 1.5.2.6 @@ -11,20 +11,20 @@

    How Do I?

    -How do I edit the front page of a new site +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 +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 +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 @@ -34,7 +34,7 @@

    -How do I put custom functionality on front +How do I put custom functionality on front page of a new site?

    Every page within an OpenACS site is part of a subsiteMore 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 @@ -49,7 +49,7 @@

    -How do I change the site-wide style?

    Almost all pages on an OpenACS site use ACS Templating, and so +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:

    • @@ -71,12 +71,12 @@ navigation "meta" elements such as Translator widgets and Admin widgets.

    -

    Figure 4.1. Site +

    Figure 4.1. Site Templates

    Site Templates

    -How do I diagnose a permissions +How do I diagnose a permissions problem?

    • @@ -117,12 +117,12 @@

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

    • Click "Grant Permission"

    • Grant the write permission to Registered Users.

      -

      Figure 4.2. Granting +

      Figure 4.2. Granting Permissions

      Granting Permissions

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

    -

    Figure 4.3. Granting Permissions +

    Figure 4.3. Granting Permissions in 5.0

    Granting Permissions in 5.0

    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.31.2.4 -r1.31.2.5 --- openacs-4/packages/acs-core-docs/www/how-do-I.html 3 Sep 2021 09:15:01 -0000 1.31.2.4 +++ openacs-4/packages/acs-core-docs/www/how-do-I.html 7 Sep 2021 09:39:25 -0000 1.31.2.5 @@ -1,7 +1,7 @@ -How Do I?

    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?

      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 processor 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 privilege on the event in order to register. Let's assume that the privileges inherit, so that if a user has the write privilege on the whole package, they will have the write privilege on the event.

      • Setting Permissions. A permission has three parts: the privilege, the object of the privilege, and the subject being granted the privilege. In this case the privilege 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

      +

    • 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 privilege on the event in order to register. Let's assume that the privileges inherit, so that if a user has the write privilege on the whole package, they will have the write privilege on the event.

  • Setting Permissions. A permission has three parts: the privilege, the object of the privilege, and the subject being granted the privilege. In this case the privilege 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

  • Index: openacs-4/packages/acs-core-docs/www/i18n-convert.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/i18n-convert.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/i18n-convert.adp 3 Sep 2021 09:15:02 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/i18n-convert.adp 7 Sep 2021 09:39:25 -0000 1.4.2.6 @@ -144,7 +144,7 @@

    -Avoiding common i18n mistakes

      +Avoiding common i18n mistakes
    • Replace complicated keys with longer, simpler 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.29.2.4 -r1.29.2.5 --- openacs-4/packages/acs-core-docs/www/i18n-convert.html 3 Sep 2021 09:15:02 -0000 1.29.2.4 +++ openacs-4/packages/acs-core-docs/www/i18n-convert.html 7 Sep 2021 09:39:25 -0000 1.29.2.5 @@ -72,7 +72,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

    • 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,
                 when this wizard is completed and casting begins.</p>

      has a bold tag which confuses the converter into thinking there are two message keys for the text beginning "Invitations ..." where there should be one:

      Instead, we cancel those keys, edit the file manually, and put in a single temporary message tag:

        <p class="form-help-text"> <#Invitations_are_sent <b>Invitations</b> are sent, 
       when this wizard is completed and casting begins.#>
         </p>

      Complex if statements may produce convoluted message keys that are very hard to localize. Rewrite these if statements. For example:

      Select which case <if @simulation.casting_type@ eq "open">and
      Index: openacs-4/packages/acs-core-docs/www/index.adp
      ===================================================================
      RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/index.adp,v
      diff -u -r1.29.2.5 -r1.29.2.6
      --- openacs-4/packages/acs-core-docs/www/index.adp	3 Sep 2021 09:15:03 -0000	1.29.2.5
      +++ openacs-4/packages/acs-core-docs/www/index.adp	7 Sep 2021 09:39:25 -0000	1.29.2.6
      @@ -9,7 +9,7 @@
       		    

      -OpenACS Core Documentation


      +OpenACS Core Documentation

    Table of Contents

    I. OpenACS For Index: openacs-4/packages/acs-core-docs/www/index.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/index.html,v diff -u -r1.56.2.4 -r1.56.2.5 --- openacs-4/packages/acs-core-docs/www/index.html 3 Sep 2021 09:15:03 -0000 1.56.2.4 +++ openacs-4/packages/acs-core-docs/www/index.html 7 Sep 2021 09:39:26 -0000 1.56.2.5 @@ -1,4 +1,4 @@ -OpenACS Core Documentation

    OpenACS Core Documentation


    Table of Contents

    I. OpenACS For Everyone
    1. High level information: What is OpenACS?
    Overview
    OpenACS Release Notes
    II. Administrator's Guide
    2. Installation Overview
    Basic Steps
    Prerequisite Software
    3. Complete Installation
    Install a Unix-like system and supporting software
    Install Oracle 8.1.7
    Install PostgreSQL
    Install AOLserver 4
    Install OpenACS 5.9.0
    OpenACS Installation Guide for Windows
    OpenACS Installation Guide for macOS
    4. Configuring a new OpenACS Site
    Installing OpenACS packages
    Mounting OpenACS packages
    Configuring an OpenACS package
    Setting Permissions on an OpenACS package
    How Do I?
    5. Upgrading
    Overview
    Upgrading 4.5 or higher to 4.6.3
    Upgrading OpenACS 4.6.3 to 5.0
    Upgrading an OpenACS 5.0.0 or greater installation
    Upgrading the OpenACS files
    Upgrading Platform components
    6. Production Environments
    Starting and Stopping an OpenACS instance.
    AOLserver keepalive with inittab
    Running multiple services on one machine
    High Availability/High Performance Configurations
    Staged Deployment for Production Networks
    Installing SSL Support for an OpenACS service
    Set up Log Analysis Reports
    External uptime validation
    Diagnosing Performance Problems
    7. Database Management
    Running a PostgreSQL database on another server
    Deleting a tablespace
    Vacuum Postgres nightly
    8. Backup and Recovery
    Backup Strategy
    Manual backup and recovery
    Automated Backup
    Using CVS for backup-recovery
    A. Install Red Hat 8/9
    B. Install additional supporting software
    Unpack the OpenACS tarball
    Initialize CVS (OPTIONAL)
    Add PSGML commands to emacs init file (OPTIONAL)
    Install Daemontools (OPTIONAL)
    Install qmail (OPTIONAL)
    Install Analog web file analyzer
    Install nspam
    Install Full Text Search using Tsearch2
    Install nsopenssl
    Install tclwebtest.
    Install PHP for use in AOLserver
    Install Squirrelmail for use as a webmail system for OpenACS
    Install PAM Radius for use as external authentication
    Install LDAP for use as external authentication
    Install AOLserver 3.3oacs1
    C. Credits
    Where did this document come from?
    Linux Install Guides
    Security Information
    Resources
    III. For OpenACS Package Developers
    9. Development Tutorial
    Creating an Application Package
    Setting Up Database Objects
    Creating Web Pages
    Debugging and Automated Testing
    10. Advanced Topics
    Write the Requirements and Design Specs
    Add the new package to CVS
    OpenACS Edit This Page Templates
    Adding Comments
    Admin Pages
    Categories
    Profile your code
    Prepare the package for distribution.
    Distributing upgrades of your package
    Notifications
    Hierarchical data
    Using .vuh files for pretty URLs
    Laying out a page with CSS instead of tables
    Sending HTML email from your application
    Basic Caching
    Scheduled Procedures
    Enabling WYSIWYG
    Adding in parameters for your package
    Writing upgrade scripts
    Connect to a second database
    Future Topics
    11. Development Reference
    OpenACS Packages
    OpenACS Data Models and the Object System
    The Request Processor
    The OpenACS Database Access API
    Using Templates in OpenACS
    Groups, Context, Permissions
    Writing OpenACS Application Pages
    Parties in OpenACS
    OpenACS Permissions Tediously Explained
    Object Identity
    Programming with AOLserver
    Using Form Builder: building html forms dynamically
    12. Engineering Standards
    OpenACS Style Guide
    +OpenACS Core Documentation

    OpenACS Core Documentation


    Table of Contents

    I. OpenACS For Everyone
    1. High level information: What is OpenACS?
    Overview
    OpenACS Release Notes
    II. Administrator's Guide
    2. Installation Overview
    Basic Steps
    Prerequisite Software
    3. Complete Installation
    Install a Unix-like system and supporting software
    Install Oracle 8.1.7
    Install PostgreSQL
    Install AOLserver 4
    Install OpenACS 5.9.0
    OpenACS Installation Guide for Windows
    OpenACS Installation Guide for macOS
    4. Configuring a new OpenACS Site
    Installing OpenACS packages
    Mounting OpenACS packages
    Configuring an OpenACS package
    Setting Permissions on an OpenACS package
    How Do I?
    5. Upgrading
    Overview
    Upgrading 4.5 or higher to 4.6.3
    Upgrading OpenACS 4.6.3 to 5.0
    Upgrading an OpenACS 5.0.0 or greater installation
    Upgrading the OpenACS files
    Upgrading Platform components
    6. Production Environments
    Starting and Stopping an OpenACS instance.
    AOLserver keepalive with inittab
    Running multiple services on one machine
    High Availability/High Performance Configurations
    Staged Deployment for Production Networks
    Installing SSL Support for an OpenACS service
    Set up Log Analysis Reports
    External uptime validation
    Diagnosing Performance Problems
    7. Database Management
    Running a PostgreSQL database on another server
    Deleting a tablespace
    Vacuum Postgres nightly
    8. Backup and Recovery
    Backup Strategy
    Manual backup and recovery
    Automated Backup
    Using CVS for backup-recovery
    A. Install Red Hat 8/9
    B. Install additional supporting software
    Unpack the OpenACS tarball
    Initialize CVS (OPTIONAL)
    Add PSGML commands to emacs init file (OPTIONAL)
    Install Daemontools (OPTIONAL)
    Install qmail (OPTIONAL)
    Install Analog web file analyzer
    Install nspam
    Install Full Text Search using Tsearch2
    Install nsopenssl
    Install tclwebtest.
    Install PHP for use in AOLserver
    Install Squirrelmail for use as a webmail system for OpenACS
    Install PAM Radius for use as external authentication
    Install LDAP for use as external authentication
    Install AOLserver 3.3oacs1
    C. Credits
    Where did this document come from?
    Linux Install Guides
    Security Information
    Resources
    III. For OpenACS Package Developers
    9. Development Tutorial
    Creating an Application Package
    Setting Up Database Objects
    Creating Web Pages
    Debugging and Automated Testing
    10. Advanced Topics
    Write the Requirements and Design Specs
    Add the new package to CVS
    OpenACS Edit This Page Templates
    Adding Comments
    Admin Pages
    Categories
    Profile your code
    Prepare the package for distribution.
    Distributing upgrades of your package
    Notifications
    Hierarchical data
    Using .vuh files for pretty URLs
    Laying out a page with CSS instead of tables
    Sending HTML email from your application
    Basic Caching
    Scheduled Procedures
    Enabling WYSIWYG
    Adding in parameters for your package
    Writing upgrade scripts
    Connect to a second database
    Future Topics
    11. Development Reference
    OpenACS Packages
    OpenACS Data Models and the Object System
    The Request Processor
    The OpenACS Database Access API
    Using Templates in OpenACS
    Groups, Context, Permissions
    Writing OpenACS Application Pages
    Parties in OpenACS
    OpenACS Permissions Tediously Explained
    Object Identity
    Programming with AOLserver
    Using Form Builder: building html forms dynamically
    12. Engineering Standards
    OpenACS Style Guide
    CVS Guidelines -
    Release Version Numbering
    Constraint naming standard
    ACS File Naming and Formatting Standards
    PL/SQL Standards
    Variables
    Automated Testing
    13. Documentation Standards
    OpenACS Documentation Guide
    Using PSGML mode in Emacs
    Using nXML mode in Emacs
    Detailed Design Documentation Template
    System/Application Requirements Template
    14. Internationalization
    Internationalization and Localization Overview
    How Internationalization/Localization works in OpenACS
    How to Internationalize a Package
    Design Notes
    Translator's Guide
    D. Using CVS with an OpenACS Site
    IV. For OpenACS Platform Developers
    15. Kernel Documentation
    Overview
    Object Model Requirements
    Object Model Design
    Permissions Requirements
    Permissions Design
    Groups Requirements
    Groups Design
    Subsites Requirements
    Subsites Design Document
    Package Manager Requirements
    Package Manager Design
    Database Access API
    OpenACS Internationalization Requirements
    Security Requirements
    Security Design
    Security Notes
    Request Processor Requirements
    Request Processor Design
    Documenting Tcl Files: Page Contracts and Libraries
    Bootstrapping OpenACS
    External Authentication Requirements
    16. Releasing OpenACS
    OpenACS Core and .LRN
    How to Update the OpenACS.org repository
    How to package and release an OpenACS Package
    How to Update the translations
    Index
    +
    Release Version Numbering
    Constraint naming standard
    ACS File Naming and Formatting Standards
    PL/SQL Standards
    Variables
    Automated Testing
    13. Documentation Standards
    OpenACS Documentation Guide
    Using PSGML mode in Emacs
    Using nXML mode in Emacs
    Detailed Design Documentation Template
    System/Application Requirements Template
    14. Internationalization
    Internationalization and Localization Overview
    How Internationalization/Localization works in OpenACS
    How to Internationalize a Package
    Design Notes
    Translator's Guide
    D. Using CVS with an OpenACS Site
    IV. For OpenACS Platform Developers
    15. Kernel Documentation
    Overview
    Object Model Requirements
    Object Model Design
    Permissions Requirements
    Permissions Design
    Groups Requirements
    Groups Design
    Subsites Requirements
    Subsites Design Document
    Package Manager Requirements
    Package Manager Design
    Database Access API
    OpenACS Internationalization Requirements
    Security Requirements
    Security Design
    Security Notes
    Request Processor Requirements
    Request Processor Design
    Documenting Tcl Files: Page Contracts and Libraries
    Bootstrapping OpenACS
    External Authentication Requirements
    16. Releasing OpenACS
    OpenACS Core and .LRN
    How to Update the OpenACS.org repository
    How to package and release an OpenACS Package
    How to Update the translations
    Index
    Index: openacs-4/packages/acs-core-docs/www/install-cvs.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-cvs.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/install-cvs.adp 3 Sep 2021 09:15:04 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/install-cvs.adp 7 Sep 2021 09:39:26 -0000 1.4.2.6 @@ -9,7 +9,7 @@ rightLink="psgml-for-emacs" rightLabel="Next">

    -Initialize CVS (OPTIONAL)

    CVS is a source control system. Create and initialize a +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-cvs.html
    ===================================================================
    RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-cvs.html,v
    diff -u -r1.43.2.4 -r1.43.2.5
    --- openacs-4/packages/acs-core-docs/www/install-cvs.html	3 Sep 2021 09:15:04 -0000	1.43.2.4
    +++ openacs-4/packages/acs-core-docs/www/install-cvs.html	7 Sep 2021 09:39:26 -0000	1.43.2.5
    @@ -1,5 +1,5 @@
     
    -Initialize CVS (OPTIONAL)

    Initialize CVS (OPTIONAL)

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

    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.adp
    ===================================================================
    RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-daemontools.adp,v
    diff -u -r1.4.2.5 -r1.4.2.6
    --- openacs-4/packages/acs-core-docs/www/install-daemontools.adp	3 Sep 2021 09:15:04 -0000	1.4.2.5
    +++ openacs-4/packages/acs-core-docs/www/install-daemontools.adp	7 Sep 2021 09:39:26 -0000	1.4.2.6
    @@ -15,7 +15,7 @@
     svgroup. svgroup is a script for granting permissions, to allow
     users other than root to use daemontools for specific services.

    1. -

      Install Daemontools

      +

      Install Daemontools

      download daemontools and install it.

      • 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.44.2.4 -r1.44.2.5 --- openacs-4/packages/acs-core-docs/www/install-daemontools.html 3 Sep 2021 09:15:05 -0000 1.44.2.4 +++ openacs-4/packages/acs-core-docs/www/install-daemontools.html 7 Sep 2021 09:39:27 -0000 1.44.2.5 @@ -4,7 +4,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-tsearch2.adp
                ===================================================================
                RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.adp,v
                diff -u -r1.5.2.5 -r1.5.2.6
                --- openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.adp	3 Sep 2021 09:15:05 -0000	1.5.2.5
                +++ openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.adp	7 Sep 2021 09:39:27 -0000	1.5.2.6
                @@ -17,7 +17,7 @@
                 OpenACS docs are written by the named authors, and may be edited by
                 OpenACS documentation staff.

              -Install Tsearch2 module

              In earlier versions of PostgreSQL (7.4), tsearch2 was a contrib +Install Tsearch2 module

          In earlier versions of PostgreSQL (7.4), tsearch2 was a contrib module. With PostgreSQL 9.*, it was included in the standard PostgreSQL package with minor naming changes (e.g. the function "rank" became "ts_rank"). PostgreSQL 9 included 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.15.2.4 -r1.15.2.5 --- openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.html 3 Sep 2021 09:15:05 -0000 1.15.2.4 +++ openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.html 7 Sep 2021 09:39:27 -0000 1.15.2.5 @@ -6,7 +6,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

        In earlier versions of PostgreSQL (7.4), tsearch2 was a contrib +

        Install Tsearch2 module

        In earlier versions of PostgreSQL (7.4), tsearch2 was a contrib module. With PostgreSQL 9.*, it was included in the standard PostgreSQL package with minor naming changes (e.g. the function "rank" became "ts_rank"). PostgreSQL 9 included a backward Index: openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.adp 3 Sep 2021 09:15:07 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.adp 7 Sep 2021 09:39:27 -0000 1.4.2.6 @@ -105,7 +105,7 @@ commands.

        More information can be found on the AOLserver Daemontools page.

    -

    Table 6.1. How it +

    Table 6.1. How it Works

    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.27.2.4 -r1.27.2.5 --- openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.html 3 Sep 2021 09:15:07 -0000 1.27.2.4 +++ openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.html 7 Sep 2021 09:39:27 -0000 1.27.2.5 @@ -64,6 +64,6 @@ More information can be found on the AOLserver Daemontools page. -

    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)

    Index: openacs-4/packages/acs-core-docs/www/install-qmail.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-qmail.adp,v diff -u -r1.5.2.6 -r1.5.2.7 --- openacs-4/packages/acs-core-docs/www/install-qmail.adp 3 Sep 2021 09:15:09 -0000 1.5.2.6 +++ openacs-4/packages/acs-core-docs/www/install-qmail.adp 7 Sep 2021 09:39:27 -0000 1.5.2.7 @@ -19,7 +19,7 @@ available from QMail wiki page

  • -

    Replace sendmail with qmail's wrapper.

    [root qmail-1.03]# rm -f /usr/bin/sendmail /usr/sbin/sendmail
    +

    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
    @@ -55,7 +55,7 @@
     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 (instead of +

    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.9.0/packages/acs-core-docs/www/files/qmail.rc.txt /var/qmail/rc
    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.45.2.4 -r1.45.2.5
    --- openacs-4/packages/acs-core-docs/www/install-qmail.html	3 Sep 2021 09:15:10 -0000	1.45.2.4
    +++ openacs-4/packages/acs-core-docs/www/install-qmail.html	7 Sep 2021 09:39:28 -0000	1.45.2.5
    @@ -4,7 +4,7 @@
           send and receive mail, and you don't want to use an alternate
           MTA.

    1. Install qmail. QMail is available as standard Debian/Ubuntu package, rpms for Fedora/Redhat/CenTOS are available from QMail wiki - page

    2. Replace sendmail with qmail's wrapper.

      [root qmail-1.03]# rm -f /usr/bin/sendmail /usr/sbin/sendmail
      +	     page

    3. 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
      @@ -26,7 +26,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.9.0/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.adp
    ===================================================================
    RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-redhat.adp,v
    diff -u -r1.5.2.7 -r1.5.2.8
    --- openacs-4/packages/acs-core-docs/www/install-redhat.adp	3 Sep 2021 09:15:10 -0000	1.5.2.7
    +++ openacs-4/packages/acs-core-docs/www/install-redhat.adp	7 Sep 2021 09:39:28 -0000	1.5.2.8
    @@ -35,7 +35,7 @@
     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
    + (Wherever you see the word secure, you
     should always read it as, "secure enough for our purposes,
     given the amount of work we're willing to exert and the
     estimated risk and consequences.")

  • Insert Red Hat 8.0 or 9.0 Disk 1 into the CD-ROM and reboot the @@ -73,7 +73,7 @@ screen

  • -

    Configure Networking. Again, if you +

    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 @@ -102,7 +102,7 @@ development server we'll be setting up.

  • -Select any additional languages you want +Select any additional languages you want the computer to support and then click Next

  • Choose your timezone and click @@ -118,11 +118,11 @@ web server, because that would conflict with the database and web server we'll install later.

    check Editors -(this installs emacs),
    click Details next +(this installs emacs),
    click Details next to Text-based Internet, check lynx, and click OK;
    check Authoring and -Publishing (this installs +Publishing (this installs docbook),
    uncheck Server Configuration Tools,
    uncheck Web Server,
    uncheck Windows File @@ -147,7 +147,7 @@ will appear.

    uncheck apmd (monitors power, not very useful for servers),
    check ImageMagick -(required for the photo-album packages,
    uncheckisdn4k-utils +(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 @@ -192,7 +192,7 @@

    Lock down SSH

    1. - SSH is the protocol we use to connect + 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 ssh connections. As a security precaution, we are now going to tell ssh not to allow 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.44.2.5 -r1.44.2.6 --- openacs-4/packages/acs-core-docs/www/install-redhat.html 3 Sep 2021 09:15:11 -0000 1.44.2.5 +++ openacs-4/packages/acs-core-docs/www/install-redhat.html 7 Sep 2021 09:39:28 -0000 1.44.2.6 @@ -27,7 +27,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 @@ -55,7 +55,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

    2. Configure Networking. + IF YOU ARE WIPING YOUR HARD DRIVE.

    3. 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 timezone 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.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-steps.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/install-steps.adp 3 Sep 2021 09:15:12 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/install-steps.adp 7 Sep 2021 09:39:28 -0000 1.4.2.6 @@ -99,8 +99,8 @@

    -Paths and Users

    -

    Table 2.1. Default directories +Paths and Users

    +

    Table 2.1. Default directories for a standard install

    @@ -111,7 +111,7 @@ 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.38.2.4 -r1.38.2.5 --- openacs-4/packages/acs-core-docs/www/install-steps.html 3 Sep 2021 09:15:12 -0000 1.38.2.4 +++ openacs-4/packages/acs-core-docs/www/install-steps.html 7 Sep 2021 09:39:29 -0000 1.38.2.5 @@ -44,7 +44,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

    name of administrative access accountremadmin
    OpenACS service -$OPENACS_SERVICE_NAME (set to service0 +$OPENACS_SERVICE_NAME (set to service0 in default install)
    OpenACS service account$OPENACS_SERVICE_NAME
    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.9.0/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.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/ix01.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/ix01.adp 3 Sep 2021 09:15:12 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/ix01.adp 7 Sep 2021 09:39:29 -0000 1.4.2.6 @@ -8,23 +8,23 @@ rightLink="" rightLabel="">

    -Index

    +Index

    C

    -
    computeroutput
    code, Code -
    cvs
    +
    computeroutput
    code, Code +
    cvs
    initializing, Initialize CVS (OPTIONAL)
    setup, Using CVS with an OpenACS Site @@ -33,98 +33,98 @@

    D

    -
    daemontools
    installation, Install Daemontools (OPTIONAL) -
    docbook
    installation, Install Red Hat 8/9 -
    DocBook
    +
    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 +
    Document structure, Document Structure

    E

    -
    emacs
    installation, Install Red Hat 8/9 -
    emphasis
    bold, italics, Emphasis +
    emacs
    installation, Install Red Hat 8/9 +
    emphasis
    bold, italics, Emphasis

    G

    -
    Graphics
    Images, Graphics +
    Graphics
    Images, Graphics

    I

    -
    informaltable
    table, Tables +
    informaltable
    table, Tables

    L

    -
    language
    installation, Install Red Hat 8/9 -
    Linking, Links -
    lists, Lists +
    language
    installation, Install Red Hat 8/9 +
    Linking, Links +
    lists, Lists
    -

    T

    The publish point for new +

    T

    The publish point for new packages should be fixed., Prepare the package for distribution.

    U

    -
    ulink, Links -
    upgrade
    +
    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 +
    XML guidelines, OpenACS Documentation Strategy: Why DocBook? -
    xref
    linkend, Links -
    xreflabel, Headlines, +
    xref
    linkend, Links +
    xreflabel, Headlines, Sections
    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.32.2.4 -r1.32.2.5 --- openacs-4/packages/acs-core-docs/www/ix01.html 3 Sep 2021 09:15:15 -0000 1.32.2.4 +++ openacs-4/packages/acs-core-docs/www/ix01.html 7 Sep 2021 09:39:29 -0000 1.32.2.5 @@ -1,3 +1,3 @@ -Index

    Index

    Symbols

    $OPENACS_SERVICE_NAME, Paths and Users

    C

    computeroutput
    code, Code
    cvs
    initializing, Initialize CVS (OPTIONAL)
    setup, Using CVS with an OpenACS Site

    E

    emacs
    installation, Install Red Hat 8/9
    emphasis
    bold, italics, Emphasis

    F

    full text search
    installation, Install Tsearch2 module

    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

    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
    +Index

    Index

    Symbols

    $OPENACS_SERVICE_NAME, Paths and Users

    C

    computeroutput
    code, Code
    cvs
    initializing, Initialize CVS (OPTIONAL)
    setup, Using CVS with an OpenACS Site

    E

    emacs
    installation, Install Red Hat 8/9
    emphasis
    bold, italics, Emphasis

    F

    full text search
    installation, Install Tsearch2 module

    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

    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
    Index: openacs-4/packages/acs-core-docs/www/maint-performance.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/maint-performance.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/maint-performance.adp 3 Sep 2021 09:15:16 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/maint-performance.adp 7 Sep 2021 09:39:30 -0000 1.4.2.7 @@ -31,7 +31,7 @@

    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 +

    Figure 6.8. Query Analysis example

    Query Analysis example

    @@ -109,7 +109,7 @@ 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 +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 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.32.2.4 -r1.32.2.5 --- openacs-4/packages/acs-core-docs/www/maint-performance.html 3 Sep 2021 09:15:16 -0000 1.32.2.4 +++ openacs-4/packages/acs-core-docs/www/maint-performance.html 7 Sep 2021 09:39:30 -0000 1.32.2.5 @@ -2,7 +2,7 @@ Diagnosing Performance Problems

    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 filesystem 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
       
      @@ -59,7 +59,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.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/maintenance-deploy.adp,v diff -u -r1.5.2.6 -r1.5.2.7 --- openacs-4/packages/acs-core-docs/www/maintenance-deploy.adp 3 Sep 2021 09:15:17 -0000 1.5.2.6 +++ openacs-4/packages/acs-core-docs/www/maintenance-deploy.adp 7 Sep 2021 09:39:30 -0000 1.5.2.7 @@ -24,7 +24,7 @@ working configuration safely and quickly.

    -Method 1: Deployment with CVS

    With this method, we control the files on a site via CVS. This +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 live. The @@ -102,7 +102,7 @@ tags to follow ...

    -Method 2: A/B Deployment

    The approach taken in this section is to always create a new +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 @@ -118,28 +118,28 @@ risk losing data in the shuffle. It also requires extra steps if the database will be affected.

    -Simple A/B Deployment: Database is not +Simple A/B Deployment: Database is not changed

    -

    Figure 6.2. Simple A/B +

    Figure 6.2. Simple A/B Deployment - Step 1

    Simple A/B Deployment - Step 1

    -

    Figure 6.3. Simple A/B +

    Figure 6.3. Simple A/B Deployment - Step 2

    Simple A/B Deployment - Step 2

    -

    Figure 6.4. Simple A/B +

    Figure 6.4. Simple A/B Deployment - Step 3

    Simple A/B Deployment - Step 3

    -Complex A/B Deployment: Database is +Complex A/B Deployment: Database is changed

    -

    Figure 6.5. Complex A/B +

    Figure 6.5. Complex A/B Deployment - Step 1

    Complex A/B Deployment - Step 1

    -

    Figure 6.6. Complex A/B +

    Figure 6.6. Complex A/B Deployment - Step 2

    Complex A/B Deployment - Step 2

    -

    Figure 6.7. Complex A/B +

    Figure 6.7. Complex A/B Deployment - Step 3

    Complex A/B Deployment - Step 3

    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.28.2.4 -r1.28.2.5 --- openacs-4/packages/acs-core-docs/www/maintenance-deploy.html 3 Sep 2021 09:15:17 -0000 1.28.2.4 +++ openacs-4/packages/acs-core-docs/www/maintenance-deploy.html 7 Sep 2021 09:39:30 -0000 1.28.2.5 @@ -2,7 +2,7 @@ Staged Deployment for Production Networks

    Staged Deployment for Production Networks

    ($Id$)

    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 @@ -67,4 +67,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 filesystem 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

    + 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 filesystem 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

    Index: openacs-4/packages/acs-core-docs/www/objects.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/objects.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/objects.adp 3 Sep 2021 09:15:19 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/objects.adp 7 Sep 2021 09:39:30 -0000 1.4.2.6 @@ -86,7 +86,7 @@ for the PG version) file created when we created the package. Then, do the following:

    -Describe the new type to the type +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  
    @@ -142,7 +142,7 @@
     attributes, so there is no need for us to define them.

    -Define a table in which to store your +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 note, but also an acs_object. The new table definition looks @@ -166,7 +166,7 @@ acs_objects.

    -Define a package for type specific +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:

    @@ -213,7 +213,7 @@
     only" by default. We'll talk about this more later.

    -Define a package body for type specific +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 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.55.2.4 -r1.55.2.5 --- openacs-4/packages/acs-core-docs/www/objects.html 3 Sep 2021 09:15:19 -0000 1.55.2.4 +++ openacs-4/packages/acs-core-docs/www/objects.html 7 Sep 2021 09:39:31 -0000 1.55.2.5 @@ -79,7 +79,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  
    @@ -139,7 +139,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 @@ -164,7 +164,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: @@ -212,7 +212,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.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/openacs.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/openacs.adp 3 Sep 2021 09:15:20 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/openacs.adp 7 Sep 2021 09:39:31 -0000 1.4.2.7 @@ -314,7 +314,7 @@ 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
    +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. @@ -346,7 +346,7 @@ specific port, e.g. port 80. In order for OpenACS to work, you 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/openacs.html
    ===================================================================
    RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/openacs.html,v
    diff -u -r1.54.2.4 -r1.54.2.5
    --- openacs-4/packages/acs-core-docs/www/openacs.html	3 Sep 2021 09:15:20 -0000	1.54.2.4
    +++ openacs-4/packages/acs-core-docs/www/openacs.html	7 Sep 2021 09:39:31 -0000	1.54.2.5
    @@ -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.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/packages.adp,v diff -u -r1.7.2.6 -r1.7.2.7 --- openacs-4/packages/acs-core-docs/www/packages.adp 3 Sep 2021 09:15:21 -0000 1.7.2.6 +++ openacs-4/packages/acs-core-docs/www/packages.adp 7 Sep 2021 09:39:32 -0000 1.7.2.7 @@ -25,7 +25,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 +

    Figure 11.1. Server file layout diagram

     ROOT/
         bin/
    @@ -64,7 +64,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 +

    Figure 11.2. Package file layout diagram

     ROOT/
       +-- packages/    APM Root
    @@ -134,7 +134,7 @@
     files are not sourced in these 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 +

    Table 11.1. Package files

    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.57.2.5 -r1.57.2.6 --- openacs-4/packages/acs-core-docs/www/packages.html 3 Sep 2021 09:15:21 -0000 1.57.2.5 +++ openacs-4/packages/acs-core-docs/www/packages.html 7 Sep 2021 09:39:32 -0000 1.57.2.6 @@ -13,7 +13,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 maintenance.
    @@ -51,7 +51,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
             |
    @@ -124,7 +124,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.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.adp 3 Sep 2021 09:15:22 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.adp 7 Sep 2021 09:39:32 -0000 1.4.2.6 @@ -127,7 +127,7 @@ Context Hierarchy

    Suppose objects A, B, ..., and F form the following hierarchy.

    -

    Table 11.2. Context Hierarchy +

    Table 11.2. Context Hierarchy Example

    @@ -153,7 +153,7 @@

    This can be represented in the acs_objects table by the following entries:

    -

    Table 11.3. acs_objects example +

    Table 11.3. acs_objects example data

    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.49.2.4 -r1.49.2.5 --- openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.html 3 Sep 2021 09:15:22 -0000 1.49.2.4 +++ openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.html 7 Sep 2021 09:39:33 -0000 1.49.2.5 @@ -105,7 +105,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 @@ -139,7 +139,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.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/psgml-for-emacs.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/psgml-for-emacs.adp 3 Sep 2021 09:15:24 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/psgml-for-emacs.adp 7 Sep 2021 09:39:33 -0000 1.4.2.6 @@ -11,7 +11,7 @@

    Add PSGML commands to emacs init file (OPTIONAL)

    - If you plan to write or edit any + 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 fixes the backspace -> 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.44.2.4 -r1.44.2.5 --- openacs-4/packages/acs-core-docs/www/psgml-for-emacs.html 3 Sep 2021 09:15:24 -0000 1.44.2.4 +++ openacs-4/packages/acs-core-docs/www/psgml-for-emacs.html 7 Sep 2021 09:39:33 -0000 1.44.2.5 @@ -1,5 +1,5 @@ -Add PSGML commands to emacs init file (OPTIONAL)

    Add PSGML commands to emacs init file (OPTIONAL)

    +Add PSGML commands to emacs init file (OPTIONAL)

    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.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/release-notes.adp,v diff -u -r1.8.2.8 -r1.8.2.9 --- openacs-4/packages/acs-core-docs/www/release-notes.adp 3 Sep 2021 09:15:25 -0000 1.8.2.8 +++ openacs-4/packages/acs-core-docs/www/release-notes.adp 7 Sep 2021 09:39:34 -0000 1.8.2.9 @@ -11,12 +11,390 @@

    OpenACS Release Notes

    -Release 5.10.0

    • ... to be completed ....

    Altogether, OpenACS 5.10.0 differs from OpenACS 5.9.1 by the +Release 5.10.0

      +
    • The release of OpenACS 5.10.0 contains the 93 packages of the +oacs-5-10 branch. These packages include the OpenACS core packages, +the major application packages (e.g. most the ones used on +OpenACS.org), and DotLRN 2.10.0.

    • +

      Functional improvements

        +
      • +

        Features:

          +
        • Added additional page_contract filter: oneof(red|green|blue)

        • +template::add_event_listener +and template::add_confirm_handler now can +target elements by CSS selector

        • Added text/markdown to the accepted text formats or rich-text +widget

        • +

          Support for range types in .xql files:

          PostgreSQL supports range types since 9.5. When using range +types, square braces have to be used in SQL statements. Since +OpenACS uses always Tcl substitution in .xql files, and OpenACS +does NOT allow backslash substitution in these files, square +brackets could not be escaped and therefore not be used in .xql +files so far. This change allows now a developer to deactivate the +substitution by passing e.g. -subst +none to the db_* command using the .xql file. Valid values +for -subst are all, none, vars, and commands, default is all which is exactly the behavior of +previous releases. Therefore, this change is fully backward +compatible.

          +
        • Improved API browser: Visualization for code dependencies (which +procs calls what, from where is a proc being called) and +test-coverage

        • Warn site administrators about expiring certificates

        • +

          Additional input types (and widgets) for ad_form:

            +
          • checkbox_text

          • color

          • email

          • tel

          • url

          • number

          • file (multiple)

          • h5date and h5time: date and time fields using native HTML5 +visualization and input normalization

          • +
          +
        • +

          Registry for .js and .css libraries: allow besides classical +URLs symbolic names for loading external resources (e.g. jquery), +this makes it easier to upgrade libraries in multiple packages +(without running into problems with duplicate versions) and +supports switching between CDN and local pathsURN. The existing +implementation is based on URNs and extends the existing +template-head API to support registration for URNs. A URN provides +an abstraction and a single place for e.g. updating references to +external resources when switching between a CDN and a locally +stored resource, or when a resource should be updated. Instead of +adding e.g. a CDN URL via template::head::add_script, one can add +an URN and control its content from a single place. Use common +namespaces for OpenACS such as urn:ad:css:* and urn:ad:js:*.

            +
          • +

            Register URNs:

            Example provider (e.g. in some theme):

            +   template::register_urn \ 
            +       -urn urn:ad:js:jquery \ 
            +       -resource /resources/xowiki/jquery/jquery.min.js
            +
            +
          • +

            The registered URN can be used like classical URL after +registration.

            Example consumer:

            +   template::head::add_javascript -src urn:ad:js:jquery
            +
          • +

            Declare composite files: Provide an interface to define that a +.js file or a .css file contains multiple other .js/.css files in +order to reduce the number of requests.

            +   template::head::includes -container urn:js::style.js -parts {urn:ad:js:jquery ...}
            +
          • +
          +
        • Improved support for streaming HTML: The new API function +template::collect_body_scripts +can be used to get the content of template::script or CSP calls +(template::add_body_script, +template::add_event_listener, +template::add_body_handler, +template::add_script) when +streaming HTML (incremental HTML) is used. Before, these call could +bot be used for streaming HTML.

        • +
        +
      • +

        Reforms:

          +
        • +

          Dynamic blueprint reloading:

            +
          • When reloading apm packages, watched files, etc. the NaviServer +blueprint is now updated correctly. This solves the long-standing +problem that changes for scheduled procedures required a restart of +the server. Furthermore, the old-style reloading was based on a +ever-growing list of reload operations each time a new reload was +requested, causing slow-downs in long running server instances, +especially, when new threads are started.

          • Now changes are applied to all NaviServer threads, including +threads for schedules procedures, ns_jobs and the like. Note that +the current job has to be finished before the changes can be +applied.

          • For the transition, it is possible to switch between the +classical reloading style and blueprint reloading by changing a +variable in acs-tcl/tcl/apm-procs.tcl

          • +
          +
        • +

          Login:

          • Get rid of bugging "login page expired" messages. The +17 years old construct was replaced by newer means to avoid caching +of form values from the login form. Admins of existing sites should +set the kernel parameter LoginPageExpirationTime to 0

          +
        • +

          Forums:

            +
          • Removed hard-coded dependency with registered_users group when +checking forum permissions

          • Don't rely so heavily on acs_permissions to model forum +configuration, as this can have unexpected consequences in +convoluted multi-group/multi-subsite scenarios. Prefer simpler +table attributes instead

          • New style of attachments to the forums, allowing multiple +attachments to a single message directly from the message post +page, using the multiple file input widget. Retain compatibility +with old style attachments, using the new 'AttachmentStyle' +package instance parameter. Currently, this supports two values: +'simple' (new behavior) and 'complex' previous +behavior.

          • +
          +
        • +

          Chat:

            +
          • Revamping of the GUI

          • Responsiveness

          • Full screen mode

          • Skins support (minimal, classic and bubbles, included): Skins +are located in the new /packages/xowiki/www/resources/chat-skins/ +directory. New skins can be created by just adding the css and js +files in the skins directory, and naming them accordingly +(chat-$SKIN_NAME.{js|css}).

          • Avatars (can be enabled per room)

          • Number of active users in chat

          • Tab notifications of new messages

          • +

            Web Notifications:

              +
            • https://www.w3.org/TR/notifications/

            • +https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API/Using_the_Notifications_API

            • +
            +
          • +
          +
        • +

          acs-lang:

            +
          • +

            admin pages:

              +
            • Added the option to unregister (delete permanently the message +key from all locales) a message key that has been already marked as +deleted. Useful for cleaning up old message keys.

            • Added the option to undelete, using the new ::message::undelete +proc.

            • Made number and category (untranslated/deleted/...) of messages +coherent in all pages.

            • Added the columns 'total' and 'deleted' to the +index page.

            • +
            +
          • object_id reference: it is now possible to associate a message +key to an object_id in a way that e.g. when the object is deleted, +so is the message key. This addresses cases such as the message +keys generated by group creation or by the new XoWiki localized +fields

          • +
          +
        • +

          Notifications:

            +
          • Improved scalability for notifications: One of the most +expensive operations in large site is the cleanup for +notification_requests in situations, where the user has lost +permissions on an object, on which the user wanted to receive +notifications. This check was performed previously in notification::sweep::cleanup_notifications +via a permission check over all notification requests, which can be +very costly on large sites. This change moves this cleanup into the +actual notification sending, where the permissions have to be sent +anyhow.

          • When sending a notification on behalf of a person, if the system +is not configured to process replies to notification, do not set +the reply-to address to anything different than the sender

          • Notifications: proper cleanup of acs_objects resulting from the +deletion of dynamic notification requests

          • +
          +
        • User/Person/Party API: rework and rationalize caching of all +party, person and user API, create separate caches for each of +these types, make the API and return dicts. acs_user::get will not +fail anymore with non-existing user.

        • User Portrait: created API to retrieve and create, store and +delete the user's portrait. Also address leftover child +relationships from the past and delete them properly.

        • +
        +
      • +
      +
    • +

      Non-functional Changes

        +
      • +

        Improved automated regression test infrastructure and test +coverage

          +
        • All packages in the oacs-5-10 branch pass regression test

        • Web testing was separated from non-maintained tcltest and was +built on the standard OpenACS infrastructure

        • Include web testing per default in standard regression +testing

        • Introduced new test authentication authority, allowing to run +many user administration tests outside the context of a "real +authority": in cases where the real authority depends on +external services to proof identity, (e.g. Kerberos), those tests +would just fail.

        • Introduce the display of warnings in the UI

        • Added test coverage information in the automated testing pages, +using the new proc-coverage API and providing test coverage +information for packages and system wide.

        • Increased overall coverage of public API

        • New tests checking various data-model properties and smells

        • +
        +
      • +

        Improved scalability:

          +
        • Provided lock-free implementation of ad_page_contract_filters and ad_page_contract_filter_rules. This change +improves parallel processing of requests and is primarily +interesting for sites with a few mio page views per days. These +locks were among the most frequent nsv locks

        • Reduced locks on util_memoize_cache my more invariants values +into per-thread caching (acs_lookup_magic_object, ad_acs_version, .... ) and by avoiding +specialized calls, which can be realized by already optimized ones +(apm_package_installed_p_not_cached +ref-timezones was most frequently used util_memoize_cache +entry). These changes are necessary to avoid full still-stand on +the unfortunate long-time locks on util_memoize_cache stemming from +permission and user management with wild-card flush operations, +which require to iterate over all cache entries (which might be on +a busy server several hundred thousands)

        • Added new interface for cache partitioning to reduce lock +latencies on high load websites

        • Added new interface for lock-free per-thread and per-request +caching to avoid scattered ad-hoc implementations

        • Better reuse of DB handles (reduced expiring/reopen/etc.), +faster access to handles

        • +
        +
      • +

        Improved startup time:

          +
        • When the package acs-automated-testing is disabled, startup time +is reduced by avoiding loading of support functions and tests; the +size of the blueprint is reduced

        • xowf: loading of at-jobs is significantly improved.

        • +
        +
      • +

        Security improvements:

          +
        • Strengthened page contracts

        • CSP support for application packages

        • CSP fine tuning  

        • +
        +
      • +

        Better exception handling based on Tcl 8.6 exception handlers +(try and throw, also available in Tcl 8.5)

          +
        • Provided a new ad_try +implementation based on Tcl's try replaces now the old ad_try, with_catch and with_finally, which are marked as +deprecated

        • The new ad_try is in essence +Tcl's try but with +predefined handling of ad_script_abort and should be also used +instead of catch, when the +OpenACS API is used (which might use script aborts)

        • All core packages use the new ad_try instead of the deprecated +versions.

        • +
        +
      • +

        Connection close reform:

          +
        • NaviServer/AOLserver continue after connection closing commands +to execute a script. This is in many situations not desired, +especially, when for the page as well a .adp file exists, which +will try to deliver this on the already closed connection. This can +lead to errors in the error.log file, which are sometimes hard to +analyze

        • Due to this cleanup, developers should use in most such cases +cases ad_script_abort +

        • Connection closing commands are e.g. ad_returnredirect, ad_redirect_for_registration, cr_write_content, ad_page_contract_handle_datasource_error, +ad_return_string_as_file, +ad_return_complaint, +ad_return_error, ad_return_forbidden, ad_return_warning, ad_return_exception_page, ns_returnredirect, ns_return, ns_returnerror +

        • The new version has made on most occasions explicit, when the +script should abort.

        • +
        +
      • +

        API changes (new and extended API calls):

          +
        • New API call category::get +to obtain category description for a category_id and locale

        • New utility ad_pad emulating +both lpad and rpad typically available in DBMSs

        • New proc lc_content_size_pretty, prettify data size given in +bytes. It supports three different standards (SI base-10, IEC +base-2 and the old JEDEC base-2), default is SI base-10.

        • New flag -export for +ad_form: this flag uses +export_vars under the hood and +supports all of this API's features (e.g. :multiple, :sign, +:array). This addresses a long standing TODO

        • +util::pdfinfo: simple +poppler-utils wrapper to extract pdf information

        • util::http: leverage new ns_http features such as request file +spooling. Native implementation will now be used only on NaviServer +>= 4.99.15.

        • +

          Database API:

            +
          • +db_foreach: queries executed +inside of a db_foreach will not be issued using a different handle +and will therefore be safe to use in a transaction

          • +db_list_of_lists: new +-with_headers flag, which will +make the first element of the returned list to be the column names +as defined in the query

          • +
          +
        • +

          Groups API:

            +
          • Logics to delete a group type have now been included in the +API

          • Allow to filter group members by member_state in the API

          • +
          +
        • +
        +
      • +

        Deprecated commands:

          +
        • Many deprecated API calls were included in the code (and +sometimes still in use) sometimes more than 10 years after these +calls have been deprecated. In case a site modification still uses +deprecated code, the user is warned about this. The OpenACS 5.10 +code base does not depend on deprecated code.

        • Move deprecated code into separate files

        • Made loading of deprecated code optional (can be controlled via +parameter "WithDeprecatedCode" in section +"ns_section ns/server/${server}/acs" of the config file. +By default, deprecated procs are still loaded

        • +

          When deprecated code is not loaded, the blueprint of the +interpreter is smaller. The following number of lines of code can +be omitted when loading without the deprecated procs:

            +
          • acs-tcl: 3178

          • acs-templating: 450

          • xotcl-core http-client-procs: 830

          • acs-content-repository: 1717 (including .xql files)

          • +
          +
        • +
        +
      • +

        Bugfix and Code Maintenance:

          +
        • Made sure all party emails are stored as lowercase through the +API

        • Fixed long standing regression in template::list: we were +looping through the list "elements", rather than the +"display_elements". This prevents specifying different +sets of columns to be returned depending on the -formats and -selected_format options in +template::list::create.

        • acs-content-repository: New HEIC and HEIF mimetypes

        • acs-mail-lite: handle to_addr specified as "DisplayName +<email>" without errors

        • Fixed invalidating of all existing user logins, (aka) +"Logout from everywhere" feature, useful e.g. to make +sure no device still holds a valid login when we change our +password on a device

        • Don't lose the return URL when one tries to join a subsite +before being logged in

        • Added doc(base_href) and +doc(base_target) for setting +<base> element via blank-baster (see issue #3435)

        • +

          Groups:

            +
          • When a new group is created, flush all the group::get_id caches +with the same name so that the new group can be fetched correctly +in case it replaces a previously deleted one

          • Cleanup message keys coming from groups in acs-translations when +a group is deleted

          • +
          +
        • +

          acs-lang:

            +
          • +lang::util::convert_to_i18n: +do not always register a en_US translation, which would be always +overridden. Instead, let lang::message::register make sure that a +en_US message exists and create one only as a fallback.

          • +lc_time_fmt: leverage Tcl +clock to address shortcomings such as handling of dates in +Julian/Gregorian calendar and impossible dates such as 1999-02-29, +implement missing formats, support previously undocumented formats +explicitly

          • +
          +
        • search: make sure objects in the search indexer queue still +exist by the time they are swept by the indexer (e.g. items deleted +before the indexer could sweep them)

        • +attribute::delete: fix proc +so it leverages stored procedure capability of dropping the +database table as well

        • +util::http: fix UTF-8 +encoding issues for some cornercases

        • Localization: Complete Italian and Spanish localization for the +whole .LRN set of packages (including themes). Message keys for new +and previously localized packages have also been updated

        • +
        +
      • +

        General cleanup/maintenance

          +
        • Improved handling of server implementation-specific code: +server-specific code can be optionally loaded via specifying the +server family in the filename. Provided *-procs-aolserver.tcl and *-procs-naviserver.tcl similar to +*.postgresql.xql and *.oracle.xql where appropriate

        • Modernization of Tcl idioms.

        • Compliance of files, proc names, ... to the naming +conventions.

        • White space cleanup, indentation changes.

        • Improvement of public API documentation

        • Adjustment of proc protection levels (public, private)

        • Adjustment of log severity

        • Cleanup of obsolete files

        • Replacement of handcrafted forms by ad_form

        • Typo fixing

        • Editor hints

        • Replacement of deprecated calls

        • Addition of missing contracts

        • ...

        • +
        +
      • +

        SQL cleanup:

          +
        • +

          Cleanup of obsolete nonportable SQL constructs in a way Oracle +and PostgreSQL code base divergency is reduced:

            +
          • "nvl" -> "coalesce"

          • "sysdate" / "now()" -> standard +"current_date" or "current_timestamp"

          • Use standard-compliant "dual" table where appropriate +(required by Oracle, supported by PostgreSQL)

          • Use non-dialectal cast idioms when appropriate

          • Adopt CTE idioms in Oracle codebase as well (e.g. connect -> +with recursive)

          • ... (reference Oracle version will be 11gr2 as is oldest version +officially supported by Oracle (See here and here)

          • +
          +
        • +

          Reduced superfluous .xql queries

            +
          • acs-subsite: delete 21 files with un-referenced .xql queries

          • acs-tcl: delete 4 files

          • news: 3 files

          • file-storage: 1 file

          • dotlrn: 9 files

          • +
          +
        • +
        +
      • +

        New Packages:

          +
        • cookie-consent: alerting users about the use of cookies on a +website

        • boomerang: performance of your website from your end user’s +point of view

        • xooauth: OAuth implementation, including LTI (Learning Tools +Interoperability)

        • dotlrn-bootstrap3-theme: Bootstrap 3 theme for DotLRN

        • xowf-monaco-plugin: Integration of Monaco editor with for code +exercise types in xowf

        • proctoring-support: utilities and user interfaces to implement +proctoring of the user session, mainly intended in the context of +distance education and online exams. The main proctoring feature +relies only on web technologies and does not require any plugin or +additional software. Optional support for the Safe Exam Browser has +also been introduced. The package is currently at the core of WU +Online Exam infrastructure and is integrated in the inclass exam +implementation for xowf

        • +
        +
      • +
      +
    • Require Tcl 8.6, XOTcl 2.1, PostgreSQL 9.6 (PostgreSQL 9.5 EOL: +February 2021), tdom 0.9

    • +

    Altogether, OpenACS 5.10.0 differs from OpenACS 5.9.1 by the following statistics

    -      xxx files changed, xxx insertions(+), xxx deletions(-)
    -    

    contributed by xxxx committers (...) and xxxx patch/bugfix -providers (...). All packages of the release were tested with -PostgreSQL 10.* and Tcl 8.6.*.

    For more details, consult the raw ChangeLog.

    + 3442 files changed, 120847 insertions(+), 92002 deletions(-) +

    contributed by 7 committers (Antonio Pisano, Gustaf Neumann, +Günter Ernst, Hector Romojaro, Michael Aram, Stefan Sobernig, +Thomas Renner) and additional 13 patch/bugfix providers (Felix +Mödritscher, Florian Mosböck, Frank Bergmann, Franz Penz, Hanifa +Hasan, Keith Paskett, Markus Moser, Maurizio Martignano, Monika +Andergassen, Nathan Coulter, Rainer Bachleitner, Stephan +Adelsberger, Tony Kirkham). All packages of the release were tested +with PostgreSQL 13.* and Tcl 8.6.*.

    For more details, consult the raw +ChangeLog.

    Release 5.9.1

      @@ -531,7 +909,7 @@ 3658 files changed, 120800 insertions(+), 97617 deletions(-)

      contributed by 4 committers (Michael Aram, Victor Guerra, Gustaf Neumann, Antonio Pisano) and patch/bugfix providers (Frank -Bergmann, Andrew Helsley, Felix Mödritscher, Marcos Moser, Franz +Bergmann, Andrew Helsley, Felix Mödritscher, Markus Moser, Franz Penz, Thomas Renner). These are significantly more changes as the differences in the last releases. All packages of the release were tested with PostgreSQL 9.4.* and Tcl 8.5.*.

      For more details, consult the raw ChangeLog.

      @@ -823,20 +1201,20 @@ 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-notes.xml,v 1.39.2.4 2021/09/02 -18:42:46 gustafn Exp $)
    +
    ($‌Id: release-notes.xml,v 1.39.2.5 2021/09/06 +17:42:35 gustafn Exp $)

    -Release 4.6.3

    Release Notes for 4.6.3

    +Release 4.6.3

    Release Notes for 4.6.3

    -Release 4.6.2

    Release Notes for 4.6.2

    +Release 4.6.2

    Release Notes for 4.6.2

    -Release 4.6

    Release Notes for 4.6

    +Release 4.6

    Release Notes for 4.6

    -Release 4.5

    Release Notes for 4.5

    +Release 4.5

    Release Notes for 4.5

    OpenACS Release Notes

    OpenACS Release Notes

    Release 5.10.0

    • - ... to be completed .... -

    Altogether, OpenACS 5.10.0 differs from OpenACS 5.9.1 by the - following statistics -

    -      xxx files changed, xxx insertions(+), xxx deletions(-)
    -    

    - contributed by xxxx committers (...) and xxxx patch/bugfix providers - (...). All packages of - the release were tested with PostgreSQL 10.* and Tcl 8.6.*. -

    - For more details, consult the - raw ChangeLog. -

    Release 5.9.1

    • + The release of OpenACS 5.10.0 contains the 93 packages of the oacs-5-10 + branch. These packages include the OpenACS core packages, the major + application packages (e.g. most the ones used on OpenACS.org), and + DotLRN 2.10.0. +

    • Functional improvements +

      • Features: +

        • Added additional page_contract filter: oneof(red|green|blue)

        • template::add_event_listener and template::add_confirm_handler now can target elements by CSS selector

        • Added text/markdown to the accepted text formats or rich-text widget

        • Support for range types in .xql files: +

          PostgreSQL supports range types since 9.5. When using range types, square braces have to be used in SQL statements. Since OpenACS uses always Tcl substitution in .xql files, and OpenACS does NOT allow backslash substitution in these files, square brackets could not be escaped and therefore not be used in .xql files so far. This change allows now a developer to deactivate the substitution by passing e.g. -subst none to the db_* command using the .xql file. Valid values for -subst are all, none, vars, and commands, default is all which is exactly the behavior of previous releases. Therefore, this change is fully backward compatible.

          +

        • Improved API browser: Visualization for code dependencies (which procs calls what, from where is a proc being called) and test-coverage

        • Warn site administrators about expiring certificates

        • Additional input types (and widgets) for ad_form: +

          • checkbox_text

          • color

          • email

          • tel

          • url

          • number

          • file (multiple)

          • h5date and h5time: date and time fields using native HTML5 visualization and input normalization

          +

        • Registry for .js and .css libraries: allow besides classical URLs symbolic names for loading external resources (e.g. jquery), this makes it easier to upgrade libraries in multiple packages (without running into problems with duplicate versions) and supports switching between CDN and local pathsURN. The existing implementation is based on URNs and extends the existing template-head API to support registration for URNs. A URN provides an abstraction and a single place for e.g. updating references to external resources when switching between a CDN and a locally stored resource, or when a resource should be updated. Instead of adding e.g. a CDN URL via template::head::add_script, one can add an URN and control its content from a single place. Use common namespaces for OpenACS such as urn:ad:css:* and urn:ad:js:*. +

          • +

            Register URNs:

            + Example provider (e.g. in some theme): + +

            +   template::register_urn \ 
            +       -urn urn:ad:js:jquery \ 
            +       -resource /resources/xowiki/jquery/jquery.min.js
            +

            +

          • +

            The registered URN can be used like classical URL after registration.

            + +

            Example consumer:

            + +

            +   template::head::add_javascript -src urn:ad:js:jquery

            +

          • Declare composite files: Provide an interface to define that a .js file or a .css file contains multiple other .js/.css files in order to reduce the number of requests. +

            +   template::head::includes -container urn:js::style.js -parts {urn:ad:js:jquery ...}

            +

          +

        • +

          Improved support for streaming HTML: The new API function template::collect_body_scripts can be used to get the content of template::script or CSP calls (template::add_body_script, template::add_event_listener, template::add_body_handler, template::add_script) when streaming HTML (incremental HTML) is used. Before, these call could bot be used for streaming HTML.

          +

        +

      • Reforms: +

        • Dynamic blueprint reloading: +

          • When reloading apm packages, watched files, etc. the NaviServer blueprint is now updated correctly. This solves the long-standing problem that changes for scheduled procedures required a restart of the server. Furthermore, the old-style reloading was based on a ever-growing list of reload operations each time a new reload was requested, causing slow-downs in long running server instances, especially, when new threads are started.

          • Now changes are applied to all NaviServer threads, including threads for schedules procedures, ns_jobs and the like. Note that the current job has to be finished before the changes can be applied.

          • For the transition, it is possible to switch between the classical reloading style and blueprint reloading by changing a variable in acs-tcl/tcl/apm-procs.tcl

          +

        • Login: +

          • Get rid of bugging "login page expired" messages. The 17 years old construct was replaced by newer means to avoid caching of form values from the login form. Admins of existing sites should set the kernel parameter LoginPageExpirationTime to 0

          +

        • Forums: +

          • Removed hard-coded dependency with registered_users group when checking forum permissions

          • Don't rely so heavily on acs_permissions to model forum configuration, as this can have unexpected consequences in convoluted multi-group/multi-subsite scenarios. Prefer simpler table attributes instead

          • New style of attachments to the forums, allowing multiple attachments to a single message directly from the message post page, using the multiple file input widget. Retain compatibility with old style attachments, using the new 'AttachmentStyle' package instance parameter. Currently, this supports two values: 'simple' (new behavior) and 'complex' previous behavior.

          +

        • Chat: +

          • Revamping of the GUI

          • Responsiveness

          • Full screen mode

          • Skins support (minimal, classic and bubbles, included): Skins are located in the new /packages/xowiki/www/resources/chat-skins/ directory. New skins can be created by just adding the css and js files in the skins directory, and naming them accordingly (chat-$SKIN_NAME.{js|css}).

          • Avatars (can be enabled per room)

          • Number of active users in chat

          • Tab notifications of new messages

          • Web Notifications: +

            • https://www.w3.org/TR/notifications/

            • https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API/Using_the_Notifications_API

            +

          +

        • acs-lang: +

          • admin pages: +

            • Added the option to unregister (delete permanently the message key from all locales) a message key that has been already marked as deleted. Useful for cleaning up old message keys.

            • Added the option to undelete, using the new ::message::undelete proc.

            • Made number and category (untranslated/deleted/...) of messages coherent in all pages.

            • Added the columns 'total' and 'deleted' to the index page.

            +

          • object_id reference: it is now possible to associate a message key to an object_id in a way that e.g. when the object is deleted, so is the message key. This addresses cases such as the message keys generated by group creation or by the new XoWiki localized fields

          +

        • Notifications: +

          • Improved scalability for notifications: One of the most expensive operations in large site is the cleanup for notification_requests in situations, where the user has lost permissions on an object, on which the user wanted to receive notifications. This check was performed previously in notification::sweep::cleanup_notifications via a permission check over all notification requests, which can be very costly on large sites. This change moves this cleanup into the actual notification sending, where the permissions have to be sent anyhow.

          • When sending a notification on behalf of a person, if the system is not configured to process replies to notification, do not set the reply-to address to anything different than the sender

          • Notifications: proper cleanup of acs_objects resulting from the deletion of dynamic notification requests

          +

        • User/Person/Party API: rework and rationalize caching of all party, person and user API, create separate caches for each of these types, make the API and return dicts. acs_user::get will not fail anymore with non-existing user.

        • User Portrait: created API to retrieve and create, store and delete the user's portrait. Also address leftover child relationships from the past and delete them properly.

        +

      +

    • Non-functional Changes +

      • Improved automated regression test infrastructure and test coverage +

        • All packages in the oacs-5-10 branch pass regression test

        • Web testing was separated from non-maintained tcltest and was built on the standard OpenACS infrastructure

        • Include web testing per default in standard regression testing

        • Introduced new test authentication authority, allowing to run many user administration tests outside the context of a "real authority": in cases where the real authority depends on external services to proof identity, (e.g. Kerberos), those tests would just fail.

        • Introduce the display of warnings in the UI

        • Added test coverage information in the automated testing pages, using the new proc-coverage API and providing test coverage information for packages and system wide.

        • Increased overall coverage of public API

        • New tests checking various data-model properties and smells +

        +

      • Improved scalability: +

        • +

          Provided lock-free implementation of ad_page_contract_filters and ad_page_contract_filter_rules. This change improves parallel processing of requests and is primarily interesting for sites with a few mio page views per days. These locks were among the most frequent nsv locks

          +

        • +

          Reduced locks on util_memoize_cache my more invariants values into per-thread caching (acs_lookup_magic_object, ad_acs_version, .... ) and by avoiding specialized calls, which can be realized by already optimized ones (apm_package_installed_p_not_cached ref-timezones was most frequently used util_memoize_cache entry). These changes are necessary to avoid full still-stand on the unfortunate long-time locks on util_memoize_cache stemming from permission and user management with wild-card flush operations, which require to iterate over all cache entries (which might be on a busy server several hundred thousands)

          +

        • +

          Added new interface for cache partitioning to reduce lock latencies on high load websites

          +

        • +

          Added new interface for lock-free per-thread and per-request caching to avoid scattered ad-hoc implementations

          +

        • +

          Better reuse of DB handles (reduced expiring/reopen/etc.), faster access to handles

          +

        +

      • Improved startup time: +

        • When the package acs-automated-testing is disabled, startup time is reduced by avoiding loading of support functions and tests; the size of the blueprint is reduced

        • xowf: loading of at-jobs is significantly improved.

        +

      • Security improvements: +

        • Strengthened page contracts

        • CSP support for application packages

        • CSP fine tuning +  

        +

      • Better exception handling based on Tcl 8.6 exception handlers (try and throw, also available in Tcl 8.5) +

        • Provided a new ad_try implementation based on Tcl's try replaces now the old ad_try, with_catch and with_finally, which are marked as deprecated

        • The new ad_try is in essence Tcl's try but with predefined handling of ad_script_abort and should be also used instead of catch, when the OpenACS API is used (which might use script aborts)

        • All core packages use the new ad_try instead of the deprecated versions.

        +

      • Connection close reform: +

        • NaviServer/AOLserver continue after connection closing commands to execute a script. This is in many situations not desired, especially, when for the page as well a .adp file exists, which will try to deliver this on the already closed connection. This can lead to errors in the error.log file, which are sometimes hard to analyze

        • Due to this cleanup, developers should use in most such cases cases ad_script_abort

        • Connection closing commands are e.g. ad_returnredirect, ad_redirect_for_registration, cr_write_content, ad_page_contract_handle_datasource_error, ad_return_string_as_file, ad_return_complaint, ad_return_error, ad_return_forbidden, ad_return_warning, ad_return_exception_page, ns_returnredirect, ns_return, ns_returnerror

        • The new version has made on most occasions explicit, when the script should abort.

        +

      • API changes (new and extended API calls): +

        • New API call category::get to obtain category description for a category_id and locale

        • New utility ad_pad emulating both lpad and rpad typically available in DBMSs

        • New proc lc_content_size_pretty, prettify data size given in bytes. It supports three different standards (SI base-10, IEC base-2 and the old JEDEC base-2), default is SI base-10.

        • New flag -export for ad_form: this flag uses export_vars under the hood and supports all of this API's features (e.g. :multiple, :sign, :array). This addresses a long standing TODO

        • util::pdfinfo: simple poppler-utils wrapper to extract pdf information

        • util::http: leverage new ns_http features such as request file spooling. Native implementation will now be used only on NaviServer >= 4.99.15.

        • Database API: +

          • db_foreach: queries executed inside of a db_foreach will not be issued using a different handle and will therefore be safe to use in a transaction

          • db_list_of_lists: new -with_headers flag, which will make the first element of the returned list to be the column names as defined in the query

          +

        • Groups API: +

          • Logics to delete a group type have now been included in the API

          • Allow to filter group members by member_state in the API

          +

        +

      • Deprecated commands: +

        • Many deprecated API calls were included in the code (and sometimes still in use) sometimes more than 10 years after these calls have been deprecated. In case a site modification still uses deprecated code, the user is warned about this. The OpenACS 5.10 code base does not depend on deprecated code.

        • Move deprecated code into separate files

        • Made loading of deprecated code optional (can be controlled via parameter "WithDeprecatedCode" in section "ns_section ns/server/${server}/acs" of the config file. By default, deprecated procs are still loaded

        • When deprecated code is not loaded, the blueprint of the interpreter is smaller. The following number of lines of code can be omitted when loading without the deprecated procs: +

          • acs-tcl: 3178

          • acs-templating: 450

          • xotcl-core http-client-procs: 830

          • acs-content-repository: 1717 (including .xql files)

          +

        +

      • Bugfix and Code Maintenance: +

        • Made sure all party emails are stored as lowercase through the API

        • Fixed long standing regression in template::list: we were looping through the list "elements", rather than the "display_elements". This prevents specifying different sets of columns to be returned depending on the -formats and -selected_format options in template::list::create.

        • acs-content-repository: New HEIC and HEIF mimetypes

        • acs-mail-lite: handle to_addr specified as "DisplayName <email>" without errors

        • Fixed invalidating of all existing user logins, (aka) "Logout from everywhere" feature, useful e.g. to make sure no device still holds a valid login when we change our password on a device

        • Don't lose the return URL when one tries to join a subsite before being logged in

        • Added doc(base_href) and doc(base_target) for setting <base> element via blank-baster (see issue #3435)

        • Groups: +

          • When a new group is created, flush all the group::get_id caches with the same name so that the new group can be fetched correctly in case it replaces a previously deleted one

          • Cleanup message keys coming from groups in acs-translations when a group is deleted

          +

        • acs-lang: +

          • lang::util::convert_to_i18n: do not always register a en_US translation, which would be always overridden. Instead, let lang::message::register make sure that a en_US message exists and create one only as a fallback.

          • lc_time_fmt: leverage Tcl clock to address shortcomings such as handling of dates in Julian/Gregorian calendar and impossible dates such as 1999-02-29, implement missing formats, support previously undocumented formats explicitly

          +

        • search: make sure objects in the search indexer queue still exist by the time they are swept by the indexer (e.g. items deleted before the indexer could sweep them)

        • attribute::delete: fix proc so it leverages stored procedure capability of dropping the database table as well

        • util::http: fix UTF-8 encoding issues for some cornercases

        • Localization: Complete Italian and Spanish localization for the whole .LRN set of packages (including themes). Message keys for new and previously localized packages have also been updated

        +

      • General cleanup/maintenance +

        • Improved handling of server implementation-specific code: server-specific code can be optionally loaded via specifying the server family in the filename. Provided *-procs-aolserver.tcl and *-procs-naviserver.tcl similar to *.postgresql.xql and *.oracle.xql where appropriate

        • Modernization of Tcl idioms.

        • Compliance of files, proc names, ... to the naming conventions.

        • White space cleanup, indentation changes.

        • Improvement of public API documentation

        • Adjustment of proc protection levels (public, private)

        • Adjustment of log severity

        • Cleanup of obsolete files

        • Replacement of handcrafted forms by ad_form

        • Typo fixing

        • Editor hints

        • Replacement of deprecated calls

        • Addition of missing contracts

        • ...

        +

      • SQL cleanup: +

        • Cleanup of obsolete nonportable SQL constructs in a way Oracle and PostgreSQL code base divergency is reduced: +

          • "nvl" -> "coalesce"

          • "sysdate" / "now()" -> standard "current_date" or "current_timestamp"

          • Use standard-compliant "dual" table where appropriate (required by Oracle, supported by PostgreSQL)

          • Use non-dialectal cast idioms when appropriate

          • Adopt CTE idioms in Oracle codebase as well (e.g. connect -> with recursive)

          • ... (reference Oracle version will be 11gr2 as is oldest version officially supported by Oracle (See here and here)

          +

        • Reduced superfluous .xql queries +

          • acs-subsite: delete 21 files with un-referenced .xql queries

          • acs-tcl: delete 4 files

          • news: 3 files

          • file-storage: 1 file

          • dotlrn: 9 files

          +

        +

      • New Packages: +

        • cookie-consent: alerting users about the use of cookies on a website

        • boomerang: performance of your website from your end user’s point of view

        • xooauth: OAuth implementation, including LTI (Learning Tools Interoperability)

        • dotlrn-bootstrap3-theme: Bootstrap 3 theme for DotLRN

        • xowf-monaco-plugin: Integration of Monaco editor with for code exercise types in xowf

        • proctoring-support: utilities and user interfaces to implement proctoring of the user session, mainly intended in the context of distance education and online exams. The main proctoring feature relies only on web technologies and does not require any plugin or additional software. Optional support for the Safe Exam Browser has also been introduced. The package is currently at the core of WU Online Exam infrastructure and is integrated in the inclass exam implementation for xowf

        +

      +

    • Require Tcl 8.6, XOTcl 2.1, PostgreSQL 9.6 (PostgreSQL 9.5 EOL: February 2021), tdom 0.9

    Altogether, OpenACS 5.10.0 differs from OpenACS 5.9.1 by the +following statistics +

    + 3442 files changed, 120847 insertions(+), 92002 deletions(-) 
    +

    +contributed by 7 committers (Antonio Pisano, Gustaf Neumann, Günter Ernst, Hector Romojaro, Michael Aram, Stefan Sobernig, Thomas Renner) and additional 13 patch/bugfix providers (Felix Mödritscher, Florian Mosböck, Frank Bergmann, Franz Penz, Hanifa Hasan, Keith Paskett, Markus Moser, Maurizio Martignano, Monika Andergassen, Nathan Coulter, Rainer Bachleitner, Stephan Adelsberger, Tony Kirkham). + +All packages of +the release were tested with PostgreSQL 13.* and Tcl 8.6.*. +

    + For more details, consult the + raw ChangeLog. +

    Release 5.9.1

    • The release of OpenACS 5.9.1 contains the 88 packages of the oacs-5-9 branch. These packages include the OpenACS core packages, the major application packages (e.g. most the ones used on OpenACS.org), and @@ -875,7 +980,7 @@

      contributed by 4 committers (Michael Aram, Victor Guerra, Gustaf Neumann, Antonio Pisano) and patch/bugfix providers (Frank Bergmann, Andrew Helsley, Felix - Mödritscher, Marcos Moser, Franz Penz, Thomas Renner). + Mödritscher, Markus Moser, Franz Penz, Thomas Renner). These are significantly more changes as the differences in the last releases. All packages of the release were tested with PostgreSQL 9.4.* and Tcl 8.5.*. @@ -1181,4 +1286,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$)
    +

    ($Id$)
    Index: openacs-4/packages/acs-core-docs/www/tutorial-css-layout.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-css-layout.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/tutorial-css-layout.adp 3 Sep 2021 09:15:31 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/tutorial-css-layout.adp 7 Sep 2021 09:39:39 -0000 1.4.2.6 @@ -12,7 +12,7 @@ Laying out a page with CSS instead of tables

    -.LRN home page with table-based +.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%">
    @@ -38,7 +38,7 @@
                             MBA 101

    -.LRN Home with CSS-based layout

    A sample of the HTML code (full source)

    <div class="left">
    +.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-css-layout.html
    ===================================================================
    RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-css-layout.html,v
    diff -u -r1.15.2.4 -r1.15.2.5
    --- openacs-4/packages/acs-core-docs/www/tutorial-css-layout.html	3 Sep 2021 09:15:31 -0000	1.15.2.4
    +++ openacs-4/packages/acs-core-docs/www/tutorial-css-layout.html	7 Sep 2021 09:39:39 -0000	1.15.2.5
    @@ -1,5 +1,5 @@
     
    -Laying out a page with CSS instead of tables

    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

    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%">
    @@ -21,7 +21,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.adp
    ===================================================================
    RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-cvs.adp,v
    diff -u -r1.4.2.5 -r1.4.2.6
    --- openacs-4/packages/acs-core-docs/www/tutorial-cvs.adp	3 Sep 2021 09:15:31 -0000	1.4.2.5
    +++ openacs-4/packages/acs-core-docs/www/tutorial-cvs.adp	7 Sep 2021 09:39:39 -0000	1.4.2.6
    @@ -69,7 +69,7 @@
     done
     (many lines omitted)
     [$OPENACS_SERVICE_NAME myfirstpackage]$
    -

    Figure 10.1. Upgrading a local +

    Figure 10.1. Upgrading a local CVS repository

    Upgrading a local CVS repository

    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.29.2.4 -r1.29.2.5 --- openacs-4/packages/acs-core-docs/www/tutorial-cvs.html 3 Sep 2021 09:15:31 -0000 1.29.2.4 +++ openacs-4/packages/acs-core-docs/www/tutorial-cvs.html 7 Sep 2021 09:39:39 -0000 1.29.2.5 @@ -59,4 +59,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

    +[$OPENACS_SERVICE_NAME myfirstpackage]$

    Figure 10.1. Upgrading a local CVS repository

    Upgrading a local CVS repository

    Index: openacs-4/packages/acs-core-docs/www/tutorial-database.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-database.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/tutorial-database.adp 3 Sep 2021 09:15:31 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/tutorial-database.adp 7 Sep 2021 09:39:39 -0000 1.4.2.7 @@ -15,7 +15,7 @@ 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 myfirstpackage/sql/ directory. All database +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 myfirstpackage/sql/postgresql @@ -42,15 +42,15 @@ simplify our database creation. (More information about ACS Objects. More information about the Content Repository.)

    -

    Figure 9.2. Tutorial Data +

    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 +

    Figure 9.3. The Database Creation Script

    -- creation script
     --
     -- \@author joel\@aufrecht.org
    @@ -79,7 +79,7 @@
     uninstalled.

     [$OPENACS_SERVICE_NAME postgresql]$ emacs myfirstpackage-drop.sql
     
    -

    Figure 9.4. Database Deletion +

    Figure 9.4. Database Deletion Script

    -- drop script
     --
     -- \@author joel\@aufrecht.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.47.2.4 -r1.47.2.5
    --- openacs-4/packages/acs-core-docs/www/tutorial-database.html	3 Sep 2021 09:15:32 -0000	1.47.2.4
    +++ openacs-4/packages/acs-core-docs/www/tutorial-database.html	7 Sep 2021 09:39:39 -0000	1.47.2.5
    @@ -2,7 +2,7 @@
     Setting Up Database Objects

    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 @@ -32,13 +32,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:$
    @@ -62,7 +62,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.adp
    ===================================================================
    RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-debug.adp,v
    diff -u -r1.4.2.6 -r1.4.2.7
    --- openacs-4/packages/acs-core-docs/www/tutorial-debug.adp	3 Sep 2021 09:15:32 -0000	1.4.2.6
    +++ openacs-4/packages/acs-core-docs/www/tutorial-debug.adp	7 Sep 2021 09:39:40 -0000	1.4.2.7
    @@ -15,7 +15,7 @@
     OpenACS docs are written by the named authors, and may be edited by
     OpenACS documentation staff.

    -Debugging

    +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 @@ -41,7 +41,7 @@           

    -Manual testing

    Make a list of basic tests to make sure it works

    +Manual testing

    Make a list of basic tests to make sure it works

    @@ -69,11 +69,11 @@ to delete your own note. Edit your own note. Search for a note.

    -Write automated tests

    +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 + 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 @@ -139,7 +139,7 @@ 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 +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 @@ -149,7 +149,7 @@ integrating them.

    -Example

    Now we can add the rest of the API tests, including a test with +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-debug.html
    ===================================================================
    RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-debug.html,v
    diff -u -r1.46.2.4 -r1.46.2.5
    --- openacs-4/packages/acs-core-docs/www/tutorial-debug.html	3 Sep 2021 09:15:32 -0000	1.46.2.4
    +++ openacs-4/packages/acs-core-docs/www/tutorial-debug.html	7 Sep 2021 09:39:40 -0000	1.46.2.5
    @@ -2,7 +2,7 @@
     Debugging and Automated Testing
    Test NumActionExpected Result
    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 @@ -23,16 +23,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 filename 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
    @@ -68,7 +68,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" {$new_id ne ""}

    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" {$new_id ne ""}

    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.adp
    ===================================================================
    RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-distribute.adp,v
    diff -u -r1.4.2.5 -r1.4.2.6
    --- openacs-4/packages/acs-core-docs/www/tutorial-distribute.adp	3 Sep 2021 09:15:32 -0000	1.4.2.5
    +++ openacs-4/packages/acs-core-docs/www/tutorial-distribute.adp	7 Sep 2021 09:39:40 -0000	1.4.2.6
    @@ -13,7 +13,7 @@
     distribution.

    Browse to the package manager. Click on tutorialapp.

    Click on Generate a distribution file for this package from the filesystem.

    Click on the file size (37.1KB) after the label Distribution File: and save the -file to /var/tmp.

    Package development guidelines

    +file to /var/tmp.

    Package development guidelines

    37.1KB) after the label Distribution File: and save the file to - /var/tmp.

    + /var/tmp.

    Package development guidelines

    Index: openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.adp 3 Sep 2021 09:15:32 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.adp 7 Sep 2021 09:39:41 -0000 1.4.2.6 @@ -80,7 +80,7 @@
  • The template should provide us with the following ETP layout:

    -

    Table 10.1. table showing ETP +

    Table 10.1. table showing ETP layout

    Index: openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.html,v diff -u -r1.12.2.4 -r1.12.2.5 --- openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.html 3 Sep 2021 09:15:33 -0000 1.12.2.4 +++ openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.html 7 Sep 2021 09:39:41 -0000 1.12.2.5 @@ -13,5 +13,5 @@ cvs -d:pserver:anonymous@openacs.org:/cvsroot co edit-this-page
  • Go to the package manager at http://yoursite/acs-admin/apm. And install the new package: edit-this-page.

  • Or use the "Add Application" form available on the Main site.

  • Change ETP Application

    • Work out how to change the ETP application.

    • Investigate each of the available ETP templates:

      • Default

      • News

      • FAQ

    Exercise 4: Create a New ETP Template

    • Browse the files for each of the above ETP templates at:

      cd ~/openacs/packages/edit-this-page/templates
    • Use the article template as the basis of our new col2 template.

      cp article-content.adp col2-content.adp
                   cp article-content.tcl col2-content.tcl
                   cp article-index.adp col2-index.adp
      -            cp article-index.tcl col2-index.tcl
    • The template should provide us with the following ETP layout:

      Table 10.1. table showing ETP layout

    Header
    SidebarMain Content Pane

  • The "Main Content" pane should contain the editable content that ETP provides.

  • The "Header" should display the title of the page that you set in ETP.

  • The "Sidebar" should display the extlinks that you add as a content item in ETP.

  • Exercise 5: Register the col2 Template with ETP

    • Need to register your template with ETP so that it appears in the drop-down menu that you would have seen in Exercise 3.

      cd ~/openacs/packages/edit-this-page/tcl
      +            cp article-index.tcl col2-index.tcl
    • The template should provide us with the following ETP layout:

      Table 10.1. table showing ETP layout

      Header
      SidebarMain Content Pane

    • The "Main Content" pane should contain the editable content that ETP provides.

    • The "Header" should display the title of the page that you set in ETP.

    • The "Sidebar" should display the extlinks that you add as a content item in ETP.

    Exercise 5: Register the col2 Template with ETP

    • Need to register your template with ETP so that it appears in the drop-down menu that you would have seen in Exercise 3.

      cd ~/openacs/packages/edit-this-page/tcl
                   emacs etp-custom-init.tcl
    • Use the function etp::define_application to register your template with ETP

      • Uncomment the "asc" definition

      • Set allow_extlinks to true, the rest should be false.

    • Restart your server for the changes to take effect.

    Exercise 6: Configure ETP to use the col2 Template

    • Configure your ETP instance at /lab4/index to use the col2 template.

    • Create external links to link to other mounted ETP instances.

    • Check that your external links show up in the sidebar when you view your ETP application using the col2 template.

    Who Wrote This and When

    This problem set was originally written by Nick Carroll in August 2004 for the University of Sydney Course EBUS5002.

    This material is copyright 2004 by Nick Carroll. It may be copied, reused, and modified, provided credit is given to the original author.

    ($Id$)
    Index: openacs-4/packages/acs-core-docs/www/tutorial-newpackage.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-newpackage.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/tutorial-newpackage.adp 3 Sep 2021 09:15:33 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/tutorial-newpackage.adp 7 Sep 2021 09:39:41 -0000 1.4.2.6 @@ -18,7 +18,7 @@ The intended page map

    -Overview

    To start developing new code in OpenACS, we build a new package. +Overview

    To start developing new code in OpenACS, we build a new package. A package is a discrete collection of web pages, Tcl code, and database tables and procedures. A package with user interface is called an application; @@ -36,14 +36,14 @@ displaying a list of text notes.

    -Before you begin

    You will need:

      +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.9.0 distribution.

    -

    Figure 9.1. Assumptions in this +

    Figure 9.1. Assumptions in this section

    @@ -62,7 +62,7 @@

    -Use the APM to initialize a new +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 @@ -102,7 +102,7 @@ packages).

    -Add an Application Instance to the +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 @@ -121,7 +121,7 @@ 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 +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
    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.46.2.4 -r1.46.2.5
    --- openacs-4/packages/acs-core-docs/www/tutorial-newpackage.html	3 Sep 2021 09:15:33 -0000	1.46.2.4
    +++ openacs-4/packages/acs-core-docs/www/tutorial-newpackage.html	7 Sep 2021 09:39:41 -0000	1.46.2.5
    @@ -2,7 +2,7 @@
     Creating an Application Package
    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 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 @@ -18,11 +18,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.9.0 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 @@ -55,7 +55,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 @@ -66,7 +66,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/myfirstpackage - 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.adp
    ===================================================================
    RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-pages.adp,v
    diff -u -r1.6.2.5 -r1.6.2.6
    --- openacs-4/packages/acs-core-docs/www/tutorial-pages.adp	3 Sep 2021 09:15:34 -0000	1.6.2.5
    +++ openacs-4/packages/acs-core-docs/www/tutorial-pages.adp	7 Sep 2021 09:39:41 -0000	1.6.2.6
    @@ -15,23 +15,23 @@
     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, +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/tutorial/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 +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 separate file and include it on the index page.

    -

    Figure 9.5. Page +

    Figure 9.5. Page Map

    Page Map

    -Build the "Index" page

    Each user-visible page in your package has, typically, three +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 check 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.49.2.4 -r1.49.2.5 --- openacs-4/packages/acs-core-docs/www/tutorial-pages.html 3 Sep 2021 09:15:34 -0000 1.49.2.4 +++ openacs-4/packages/acs-core-docs/www/tutorial-pages.html 7 Sep 2021 09:39:42 -0000 1.49.2.5 @@ -2,8 +2,8 @@ Creating Web Pages

    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/tutorial/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 separate 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/tutorial/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 separate 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.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.adp 3 Sep 2021 09:15:36 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.adp 7 Sep 2021 09:39:42 -0000 1.4.2.7 @@ -8,7 +8,7 @@ rightLink="upgrade-4.6.3-to-5" rightLabel="Next">

    -Upgrading 4.5 or higher to 4.6.3

    The required platform for OpenACS 4.6 is the same as 4.5, with +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.4, you need to manually run 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.30.2.4 -r1.30.2.5 --- openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.html 3 Sep 2021 09:15:36 -0000 1.30.2.4 +++ openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.html 7 Sep 2021 09:39:42 -0000 1.30.2.5 @@ -1,5 +1,5 @@ -Upgrading 4.5 or higher to 4.6.3

    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

    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.4, you need to manually run acs-kernel/sql/postgres/upgrade-4.4-4.5.sql. See Bug #632

    1. Make a Backup. Back up the database and filesystem (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 filesystem. the section called “Upgrading the OpenACS files”

    5. Index: openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.adp,v diff -u -r1.5.2.6 -r1.5.2.7 --- openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.adp 3 Sep 2021 09:15:37 -0000 1.5.2.6 +++ openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.adp 7 Sep 2021 09:39:42 -0000 1.5.2.7 @@ -11,7 +11,7 @@ Upgrading the OpenACS files

    -Choosing a Method to Upgrade your +Choosing 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 filesystem (via any of the @@ -25,7 +25,7 @@

    -Methods of upgrading OpenACS files

      +Methods of upgrading OpenACS files
    • Upgrading files for a site which is not in a CVS @@ -53,7 +53,7 @@ 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 +

      Figure 5.2. Upgrading a local CVS repository

      Upgrading a local CVS repository

      • @@ -180,7 +180,7 @@ [$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$

    -Upgrading a Production Site Safely

    If you are upgrading a production OpenACS site which is on a +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 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.31.2.4 -r1.31.2.5 --- openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.html 3 Sep 2021 09:15:37 -0000 1.31.2.4 +++ openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.html 7 Sep 2021 09:39:42 -0000 1.31.2.5 @@ -1,5 +1,5 @@ -Upgrading the OpenACS files

      Upgrading the OpenACS files

      Choosing a Method to Upgrade your Files

      OpenACS is distributed in many different ways: +Upgrading the OpenACS files

      Upgrading the OpenACS files

      Choosing 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 filesystem (via any @@ -11,7 +11,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
        @@ -32,7 +32,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 @@ -97,7 +97,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.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/upgrade-overview.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/upgrade-overview.adp 3 Sep 2021 09:15:37 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/upgrade-overview.adp 7 Sep 2021 09:39:43 -0000 1.4.2.6 @@ -25,11 +25,11 @@ upgrade scripts, and prompt you to restart the server. After restarting the server again, the upgrade is complete.

    -

    Figure 5.1. Upgrading with the +

    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 +

    Table 5.1. Assumptions in this section

    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.30.2.4 -r1.30.2.5 --- openacs-4/packages/acs-core-docs/www/upgrade-overview.html 3 Sep 2021 09:15:38 -0000 1.30.2.4 +++ openacs-4/packages/acs-core-docs/www/upgrade-overview.html 7 Sep 2021 09:39:43 -0000 1.30.2.5 @@ -4,4 +4,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

    + 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

    Index: openacs-4/packages/acs-core-docs/www/variables.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/variables.adp,v diff -u -r1.4.2.5 -r1.4.2.6 --- openacs-4/packages/acs-core-docs/www/variables.adp 3 Sep 2021 09:15:38 -0000 1.4.2.5 +++ openacs-4/packages/acs-core-docs/www/variables.adp 7 Sep 2021 09:39:43 -0000 1.4.2.6 @@ -19,7 +19,7 @@ OpenACS documentation staff.

    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 +

    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/variables.html
    ===================================================================
    RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/variables.html,v
    diff -u -r1.33.2.4 -r1.33.2.5
    --- openacs-4/packages/acs-core-docs/www/variables.html	3 Sep 2021 09:15:38 -0000	1.33.2.4
    +++ openacs-4/packages/acs-core-docs/www/variables.html	7 Sep 2021 09:39:43 -0000	1.33.2.5
    @@ -4,7 +4,7 @@
               by OpenACS documentation staff.
             

    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-5-10.xml
    ===================================================================
    RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/for-everyone/release-notes-5-10.xml,v
    diff -u -r1.1.2.1 -r1.1.2.2
    --- openacs-4/packages/acs-core-docs/www/xml/for-everyone/release-notes-5-10.xml	6 Sep 2021 17:42:35 -0000	1.1.2.1
    +++ openacs-4/packages/acs-core-docs/www/xml/for-everyone/release-notes-5-10.xml	7 Sep 2021 09:39:43 -0000	1.1.2.2
    @@ -322,7 +322,7 @@
      Altogether, OpenACS 5.10.0 differs from OpenACS 5.9.1 by the
     following statistics
     
    -  xxx files changed, xxx insertions(+), xxx deletions(-)
    + 3442 files changed, 120847 insertions(+), 92002 deletions(-) 
     
     contributed by 7 committers (Antonio Pisano, Gustaf Neumann, Günter Ernst, Hector Romojaro, Michael Aram, Stefan Sobernig, Thomas Renner) and additional 13 patch/bugfix providers (Felix Mödritscher, Florian Mosböck, Frank Bergmann, Franz Penz, Hanifa Hasan, Keith Paskett, Markus Moser, Maurizio Martignano, Monika Andergassen, Nathan Coulter, Rainer Bachleitner, Stephan Adelsberger, Tony Kirkham).
     
    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.39.2.5 -r1.39.2.6
    --- openacs-4/packages/acs-core-docs/www/xml/for-everyone/release-notes.xml	6 Sep 2021 17:42:35 -0000	1.39.2.5
    +++ openacs-4/packages/acs-core-docs/www/xml/for-everyone/release-notes.xml	7 Sep 2021 09:39:44 -0000	1.39.2.6
    @@ -1366,7 +1366,7 @@
         
         contributed by 4 committers (Michael Aram, Victor Guerra, Gustaf Neumann, Antonio Pisano) and
         patch/bugfix providers (Frank Bergmann, Andrew Helsley, Felix
    -    Mödritscher, Marcos Moser, Franz Penz, Thomas Renner).
    +    Mödritscher, Markus Moser, Franz Penz, Thomas Renner).
         These are significantly more  changes as the differences
         in the last releases. All packages of the release were tested with
         PostgreSQL 9.4.* and Tcl 8.5.*.