Configuring an OpenACS package

+
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 -N -r1.4.2.1 -r1.4.2.2 --- openacs-4/packages/acs-core-docs/www/cvs-tips.adp 2 Mar 2019 19:30:04 -0000 1.4.2.1 +++ openacs-4/packages/acs-core-docs/www/cvs-tips.adp 10 Mar 2019 21:47:13 -0000 1.4.2.2 @@ -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.

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 -N -r1.37.2.1 -r1.37.2.2 --- openacs-4/packages/acs-core-docs/www/cvs-tips.html 2 Mar 2019 19:30:04 -0000 1.37.2.1 +++ openacs-4/packages/acs-core-docs/www/cvs-tips.html 10 Mar 2019 21:47:13 -0000 1.37.2.2 @@ -2,7 +2,7 @@ Appendix D. Using CVS with an OpenACS Site

Prev	Part III. For OpenACS Package Developers	Next

Appendix D. Using CVS with an OpenACS Site

By Joel Aufrecht

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

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

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

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/db-api-detailed.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/db-api-detailed.adp,v
diff -u -N -r1.5.2.2 -r1.5.2.3
--- openacs-4/packages/acs-core-docs/www/db-api-detailed.adp	2 Mar 2019 19:30:04 -0000	1.5.2.2
+++ openacs-4/packages/acs-core-docs/www/db-api-detailed.adp	10 Mar 2019 21:47:13 -0000	1.5.2.3
@@ -195,7 +195,7 @@
 environment). Note that bind variables are not limited to one per
 statement; you can use an arbitrary number, and each will pull from
 the correspondingly named Tcl variable. (Alternatively, you can
-also specify an list or ns_set
+also specify a list or ns_set
 providing bind variables' values; see Usage.)
The value of a bind variable is taken literally by the database
 driver, so there is never any need to put single-quotes around the
 value for a bind variable, or to use db_quote to escape single-quotes contained
@@ -683,7 +683,7 @@
 script and should never be referenced directly by user code.
 Returns the current rdbms type and version.
 
-

($‌Id: db-api.xml,v 1.12.2.1 2019/02/14 16:15:00 +

($‌Id: db-api.xml,v 1.12.2.2 2019/03/10 21:44:57 gustafn Exp $)

Index: openacs-4/packages/acs-core-docs/www/db-api-detailed.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/db-api-detailed.html,v diff -u -N -r1.52.2.2 -r1.52.2.3 --- openacs-4/packages/acs-core-docs/www/db-api-detailed.html 2 Mar 2019 19:30:04 -0000 1.52.2.2 +++ openacs-4/packages/acs-core-docs/www/db-api-detailed.html 10 Mar 2019 21:47:13 -0000 1.52.2.3 @@ -180,7 +180,7 @@ $some_presentation_id (in the caller's environment). Note that bind variables are not limited to one per statement; you can use an arbitrary number, and each will pull from the correspondingly named Tcl -variable. (Alternatively, you can also specify an list or ns_set +variable. (Alternatively, you can also specify a list or ns_set providing bind variables' values; see Usage.)

The value of a bind variable is taken literally by the database driver, so there is never any need to put single-quotes around the value for a bind 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 -N -r1.6.2.1 -r1.6.2.2 --- openacs-4/packages/acs-core-docs/www/docbook-primer.adp 2 Mar 2019 19:30:04 -0000 1.6.2.1 +++ openacs-4/packages/acs-core-docs/www/docbook-primer.adp 10 Mar 2019 21:47:13 -0000 1.6.2.2 @@ -347,7 +347,7 @@ Tcl environment, OpenACS protocols, AOLserver template and ns_* commands, OpenACS templating, sql queries, db triggers, scheduling protocols, how to use the page contract, how to get the accessing -user_id etc

Show how to construct basic SQL queries using the db API,

The life of an http request to a dynamic, templated page

General rules to follow for stability, scalability

Show the step by step customizing of an existing package that +user_id etc

Show how to construct basic SQL queries using the db API,

The life of an HTTP request to a dynamic, templated page

General rules to follow for stability, scalability

Show the step by step customizing of an existing package that meets current recommended coding styles of OpenACS package development, by referring to developer resources.

Use the ArsDigita problem sets and "what Lars produced for ACS Java" as inspiration for a PostgreSQL equivalent tutorial @@ -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 @@ -612,7 +612,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>, @@ -637,7 +637,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>
@@ -690,7 +690,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"> @@ -736,7 +736,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 @@ -753,7 +753,7 @@
Note
This section is quoted almost verbatim from the LDP Author Guide.
Once you have the Docbook -Tools installed, you can convert your xml documents to HTML or +Tools installed, you can convert your XML documents to HTML or other formats.
With the DocBook XSL stylesheets, generation of multiple files is controlled by the stylesheet. If you want to generate a single file, you call one stylesheet. If you want to generate multiple 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 -N -r1.56.2.1 -r1.56.2.2 --- openacs-4/packages/acs-core-docs/www/docbook-primer.html 2 Mar 2019 19:30:04 -0000 1.56.2.1 +++ openacs-4/packages/acs-core-docs/www/docbook-primer.html 10 Mar 2019 21:47:13 -0000 1.56.2.2 @@ -465,7 +465,7 @@
Show how to construct basic SQL queries using the db API,
- The life of an http request to a dynamic, templated page + The life of an HTTP request to a dynamic, templated page
General rules to follow for stability, scalability
@@ -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>.
  @@ -943,7 +943,7 @@ for this. See these links for an explanation.
  Converting to HTML
  Note
  This section is quoted almost verbatim from the LDP Author Guide.
  Once you have the Docbook Tools - installed, you can convert your xml documents to HTML or other + installed, you can convert your XML documents to HTML or other formats.
  With the DocBook XSL stylesheets, generation of multiple files 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 -N -r1.6.2.1 -r1.6.2.2 --- openacs-4/packages/acs-core-docs/www/ext-auth-requirements.adp 2 Mar 2019 19:30:04 -0000 1.6.2.1 +++ openacs-4/packages/acs-core-docs/www/ext-auth-requirements.adp 10 Mar 2019 21:47:13 -0000 1.6.2.2 @@ -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 @@ -153,7 +153,7 @@ and is primarily meant for backwards compatibility with the old OpenACS login process. The local authority driver is an encapsulation of current -functionality within an driver matching a service contract. The +functionality within a driver matching a service contract. The other drivers call external functions. The possible functions for each authority are split into several drivers for convenience. One driver handles authentication, one account creation, and one 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 -N -r1.45.2.1 -r1.45.2.2 --- openacs-4/packages/acs-core-docs/www/ext-auth-requirements.html 2 Mar 2019 19:30:04 -0000 1.45.2.1 +++ openacs-4/packages/acs-core-docs/www/ext-auth-requirements.html 10 Mar 2019 21:47:13 -0000 1.45.2.2 @@ -1,5 +1,5 @@ -External Authentication Requirements Feature Status Description New API Prev Chapter 15. Kernel Documentation Next External Authentication Requirements Vision People have plenty of usernames and passwords already, we +External Authentication Requirements Prev Chapter 15. Kernel Documentation Next External Authentication Requirements Vision People have plenty of usernames and passwords already, we don't want them to have yet another. We want people to be able to log in to OpenACS with the same password they use to log in to any other system. Besides, administrators have better things to do than create @@ -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 Feature Status Description New API EXT-AUTH-01 A Extend Authentication/Acct Status API EXT-AUTH-03 A Account Creation API EXT-AUTH-05 A Password Management API EXT-AUTH-30 A Authority Management API Login Feature Status Description Login EXT-AUTH-04 A Rewrite login, register, and admin pages to use APIs EXT-AUTH-38 A ad_form complain feature EXT-AUTH-19 A Rewrite password recovery to use API EXT-AUTH-21 A Rewrite email verification with API EXT-AUTH-28 A Username is email switch Users will log in using a username, a authority, and a + Account Management (NO PICTURE YET) Batch Synchronization (NO PICTURE YET) Requirements New API Feature Status Description New API EXT-AUTH-01 A Extend Authentication/Acct Status API EXT-AUTH-03 A Account Creation API EXT-AUTH-05 A Password Management API EXT-AUTH-30 A Authority Management API Login Feature Status Description Login EXT-AUTH-04 A Rewrite login, register, and admin pages to use APIs EXT-AUTH-38 A ad_form complain feature EXT-AUTH-19 A Rewrite password recovery to use API EXT-AUTH-21 A Rewrite email verification with API EXT-AUTH-28 A Username is email switch Users will log in using a username, a authority, and a password. The authority is the source for user/password verification. OpenACS can be an authority itself. Each user in OpenACS will belong to exactly one authority, which can either be the "local" OpenACS users table, in which case the @@ -80,7 +80,7 @@ username and email. This is a setting that spans all authorities, and is primarily meant for backwards compatibility with the old OpenACS login process. The local authority driver is an encapsulation of current - functionality within an driver matching a service contract. The + functionality within a driver matching a service contract. The other drivers call external functions. The possible functions for each authority are split into several drivers for convenience. One driver handles authentication, one account creation, and one 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 -N -r1.4.2.1 -r1.4.2.2 --- openacs-4/packages/acs-core-docs/www/form-builder.adp 2 Mar 2019 19:30:04 -0000 1.4.2.1 +++ openacs-4/packages/acs-core-docs/www/form-builder.adp 10 Mar 2019 21:47:14 -0000 1.4.2.2 @@ -13,8 +13,8 @@ dynamically Overview -($‌Id: form-builder.xml,v 1.10 2017/08/07 -23:47:54 gustafn Exp $) +($‌Id: form-builder.xml,v 1.10.2.1 2019/03/10 +21:44:57 gustafn Exp $) OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff. OpenACS has a form manager called ad_form. Ad_form has an adaptable UI. Error handling includes inline error reporting, and @@ -25,7 +25,7 @@ Multi-part Elements

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

-SELECT elements +SELECT elements

Creating the form element. Populate a list of lists with values for the option list. @@ -54,7 +54,7 @@ refreshes to pull additional information from the database

Prev	Chapter 4. Configuring a new OpenACS Site	Next

Prev	Chapter 4. Configuring a new OpenACS Site	Next

Prev	Chapter 4. Configuring a new OpenACS Site	Next

Prev	Chapter 4. Configuring a new OpenACS Site	Next

Prev	Chapter 6. Production Environments	Next

Prev	Chapter 6. Production Environments	Next

Prev	Chapter 4. Configuring a new OpenACS Site	Next

Prev	Chapter 4. Configuring a new OpenACS Site	Next

		Next

		Next

Initialize CVS (OPTIONAL)

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

Prev	Appendix B. Install additional supporting software	Next

Initialize CVS (OPTIONAL)

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

[root tmp]# mkdir /cvsroot
 [root tmp]# cvs -d /cvsroot init
 [root tmp]#
Index: openacs-4/packages/acs-core-docs/www/install-daemontools.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-daemontools.adp,v
diff -u -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/install-daemontools.adp	2 Mar 2019 19:30:05 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/install-daemontools.adp	10 Mar 2019 21:47:14 -0000	1.4.2.2
@@ -15,7 +15,7 @@
 svgroup. svgroup is a script for granting permissions, to allow
 users other than root to use daemontools for specific services.

 
-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 -N -r1.44.2.1 -r1.44.2.2
--- openacs-4/packages/acs-core-docs/www/install-daemontools.html	2 Mar 2019 19:30:05 -0000	1.44.2.1
+++ openacs-4/packages/acs-core-docs/www/install-daemontools.html	10 Mar 2019 21:47:14 -0000	1.44.2.2
@@ -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.
Install Daemontools
download daemontools and install it.
Red Hat 8
[root root]# mkdir -p /package
+      services.
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 -N -r1.5.2.1 -r1.5.2.2
--- openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.adp	2 Mar 2019 19:30:05 -0000	1.5.2.1
+++ openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.adp	10 Mar 2019 21:47:14 -0000	1.5.2.2
@@ -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 -N -r1.15.2.1 -r1.15.2.2
--- openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.html	2 Mar 2019 19:30:05 -0000	1.15.2.1
+++ openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.html	10 Mar 2019 21:47:14 -0000	1.15.2.2
@@ -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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.adp	2 Mar 2019 19:30:05 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.adp	10 Mar 2019 21:47:14 -0000	1.4.2.2
@@ -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 -N -r1.27.2.1 -r1.27.2.2
--- openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.html	2 Mar 2019 19:30:05 -0000	1.27.2.1
+++ openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.html	10 Mar 2019 21:47:14 -0000	1.27.2.2
@@ -64,6 +64,6 @@
 
         More information can be found on the AOLserver
 	Daemontools page.
-
Table 6.1. How it Works

 
 
Program Invoked by this program ... ... using this file Where to find errors Log goes to Use these commands to control it
svscanboot
+
Table 6.1. How it Works
Program Invoked by this program ... ... using this file Where to find errors Log goes to Use these commands to control it
svscanboot
       init /etc/inittab ps -auxw | grep readproctitle n/a  
aolserver supervise
 (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.log svc -k /service/$OPENACS_SERVICE_NAME
postgresql Redhat init scripts during boot /etc/init.d/postgresql /usr/local/pgsql/data/server.log   service postgresql start (Red Hat), /etc/init.d/postgresql start (Debian)

Prev Home  Next
Chapter 6. Production Environments Up  AOLserver keepalive with inittab
docs@openacs.org

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 -N -r1.5.2.1 -r1.5.2.2
--- openacs-4/packages/acs-core-docs/www/install-qmail.adp	2 Mar 2019 19:30:05 -0000	1.5.2.1
+++ openacs-4/packages/acs-core-docs/www/install-qmail.adp	10 Mar 2019 21:47:14 -0000	1.5.2.2
@@ -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 -N -r1.45.2.1 -r1.45.2.2
--- openacs-4/packages/acs-core-docs/www/install-qmail.html	2 Mar 2019 19:30:05 -0000	1.45.2.1
+++ openacs-4/packages/acs-core-docs/www/install-qmail.html	10 Mar 2019 21:47:14 -0000	1.45.2.2
@@ -4,7 +4,7 @@
       send and receive mail, and you don't want to use an alternate
       MTA.
Install qmail. QMail is available as standard Debian/Ubuntu package,
       rpms for Fedora/Redhat/CenTOS are available from QMail wiki
-	     page
Replace sendmail with qmail's wrapper.
[root qmail-1.03]# rm -f /usr/bin/sendmail /usr/sbin/sendmail
+	     page
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 -N -r1.5.2.1 -r1.5.2.2
--- openacs-4/packages/acs-core-docs/www/install-redhat.adp	2 Mar 2019 19:30:05 -0000	1.5.2.1
+++ openacs-4/packages/acs-core-docs/www/install-redhat.adp	10 Mar 2019 21:47:14 -0000	1.5.2.2
@@ -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 time zone 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

 
 
- 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 -N -r1.44.2.1 -r1.44.2.2
--- openacs-4/packages/acs-core-docs/www/install-redhat.html	2 Mar 2019 19:30:05 -0000	1.44.2.1
+++ openacs-4/packages/acs-core-docs/www/install-redhat.html	10 Mar 2019 21:47:14 -0000	1.44.2.2
@@ -27,7 +27,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 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
On the pop-up window asking "Are you sure
 	  you want to do this?" click
 	  Yes
-	  IF YOU ARE WIPING YOUR HARD DRIVE.
Click Next on the boot loader screen
Configure Networking.  
+	  IF YOU ARE WIPING YOUR HARD DRIVE.
Click Next on the boot loader screen
Configure Networking.  
 Again, if you know what you're doing, do this step
           yourself, being sure to note the firewall holes. Otherwise,
           follow the instructions in this step to set up a computer directly connected to the internet with a dedicated IP address.
DHCP is a system by which a computer that
@@ -76,7 +76,7 @@
 Mail (SMTP).  In the Other ports
 box, enter 443, 8000, 8443.  Click
 Next.
-Port 443 is for https (http over ssl), and 8000 and 8443 are http and https access to the development server we'll be setting up.
Select any additional languages you want the
+Port 443 is for https (http over ssl), and 8000 and 8443 are http and https access to the development server we'll be setting up.
Select any additional languages you want the
 	  computer to support and then click
 	  Next
Choose your time zone and click Next.
Type in a root
 password, twice.
On the Package selection page, we're going to
@@ -88,13 +88,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
@@ -120,7 +120,7 @@
         upgrading all of that.  Since you are upgrading the kernel,
         reboot after this step.
 
Lock down SSH

-              
+              
               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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/install-steps.adp	2 Mar 2019 19:30:05 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/install-steps.adp	10 Mar 2019 21:47:14 -0000	1.4.2.2
@@ -100,8 +100,8 @@
 

 
 
-Paths and Users

-Table 2.1. Default directories
+Paths and Users

+Table 2.1. Default directories
 for a standard install
@@ -112,7 +112,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 -N -r1.38.2.1 -r1.38.2.2
--- openacs-4/packages/acs-core-docs/www/install-steps.html	2 Mar 2019 19:30:05 -0000	1.38.2.1
+++ openacs-4/packages/acs-core-docs/www/install-steps.html	10 Mar 2019 21:47:14 -0000	1.38.2.2
@@ -44,7 +44,7 @@
 su - $OPENACS_SERVICE_NAME
 svc -d /service/$OPENACS_SERVICE_NAME
 dropdb $OPENACS_SERVICE_NAME
-createdb $OPENACS_SERVICE_NAMESetting 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 account remadmin
 

 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 server yourserver.test
name of administrative access account remadmin
OpenACS service 
+createdb $OPENACS_SERVICE_NAMESetting 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 server yourserver.test
name of administrative access account remadmin
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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/ix01.adp	2 Mar 2019 19:30:05 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/ix01.adp	10 Mar 2019 21:47:14 -0000	1.4.2.2
@@ -8,23 +8,23 @@
 			rightLink="" rightLabel="">
 		    

 
-Index

+Index

 
-Symbols
$OPENACS_SERVICE_NAME, Paths and
+Symbols$OPENACS_SERVICE_NAME, Paths and
 Users
 
 

 A

-AOLserver
configuration, Installation Option 2: Install
+
AOLserver
configuration, Installation Option 2: Install
 from tarball
-
Automated tests, Write
+
Automated tests, Write
 automated tests
 
 
 

 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
 
 
 

 F

-full text search
installation, Install
+
full text search
installation, Install
 Tsearch2 module
 
 
 

 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
 
 
 

-O
OpenACS Package, What a Package
+OOpenACS Package, What a Package
 Looks Like
 
 

 P

-photo-album
installation (see ImageMagick)
Postgres
Vacuuming, Installation Option 2: Install
+
photo-album
installation (see ImageMagick)
Postgres
Vacuuming, Installation Option 2: Install
 from tarball
 
 
 

 Q

-qmail
Maildir, Install
+
qmail
Maildir, Install
 qmail (OPTIONAL)
 
 
 

 S

-sect1, Headlines,
+
sect1, Headlines,
 Sections
-
sect2, Headlines,
+
sect2, Headlines,
 Sections
-
Sections
Headlines, Headlines,
+
Sections
Headlines, Headlines,
 Sections
-
security

+
security

 definition, Install Red Hat 8/9
 
firewall, Install Red Hat 8/9
 
-
sendmail
removing, Install qmail (OPTIONAL)
-
ssh, Install Red Hat 8/9
+
sendmail
removing, Install qmail (OPTIONAL)
+
ssh, Install Red Hat 8/9
 
 
 

-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 -N -r1.32.2.1 -r1.32.2.2
--- openacs-4/packages/acs-core-docs/www/ix01.html	2 Mar 2019 19:30:05 -0000	1.32.2.1
+++ openacs-4/packages/acs-core-docs/www/ix01.html	10 Mar 2019 21:47:14 -0000	1.32.2.2
@@ -1,3 +1,3 @@
 
-IndexPrev  
Index
Symbols
$OPENACS_SERVICE_NAME, Paths and Users
A
AOLserver
configuration, Installation Option 2: Install from tarball
Automated tests, Write automated tests
C
computeroutput
code, Code
cvs
initializing, Initialize CVS (OPTIONAL)
setup, Using CVS with an OpenACS Site
D
daemontools
installation, Install Daemontools (OPTIONAL)
docbook
installation, Install Red Hat 8/9
DocBook
DTD, OpenACS Documentation Strategy: Why DocBook?
emacs configuration for, Add PSGML commands to emacs init file (OPTIONAL)
Document structure, Document Structure
E
emacs
installation, Install Red Hat 8/9
emphasis
bold, italics, Emphasis
F
full text search
installation, Install Tsearch2 module
G
Graphics
Images, Graphics
I
informaltable
table, Tables
L
language
installation, Install Red Hat 8/9
Linking, Links
lists, Lists
O
OpenACS Package, What a Package Looks Like
P
photo-album
installation (see ImageMagick)
Postgres
Vacuuming, Installation Option 2: Install from tarball
Q
qmail
Maildir, Install qmail (OPTIONAL)
S
sect1, Headlines, Sections
sect2, Headlines, Sections
Sections
Headlines, Headlines, Sections
security
definition, Install Red Hat 8/9
firewall, Install Red Hat 8/9
sendmail
removing, Install qmail (OPTIONAL)
ssh, Install Red Hat 8/9
T
The publish point for new packages should be
-        fixed., Prepare the package for distribution.
U
ulink, Links
upgrade
OpenACS 4.5 to 4.6.x
Linux/Unix, Upgrading 4.5 or higher to 4.6.3
X
XML guidelines, OpenACS Documentation Strategy: Why DocBook?
xref
linkend, Links
xreflabel, Headlines, Sections
Prev Home  
How to Update the translations Up  
docs@openacs.org

+IndexPrev  
Index
Symbols
$OPENACS_SERVICE_NAME, Paths and Users
A
AOLserver
configuration, Installation Option 2: Install from tarball
Automated tests, Write automated tests
C
computeroutput
code, Code
cvs
initializing, Initialize CVS (OPTIONAL)
setup, Using CVS with an OpenACS Site
D
daemontools
installation, Install Daemontools (OPTIONAL)
docbook
installation, Install Red Hat 8/9
DocBook
DTD, OpenACS Documentation Strategy: Why DocBook?
emacs configuration for, Add PSGML commands to emacs init file (OPTIONAL)
Document structure, Document Structure
E
emacs
installation, Install Red Hat 8/9
emphasis
bold, italics, Emphasis
F
full text search
installation, Install Tsearch2 module
G
Graphics
Images, Graphics
I
informaltable
table, Tables
L
language
installation, Install Red Hat 8/9
Linking, Links
lists, Lists
O
OpenACS Package, What a Package Looks Like
P
photo-album
installation (see ImageMagick)
Postgres
Vacuuming, Installation Option 2: Install from tarball
Q
qmail
Maildir, Install qmail (OPTIONAL)
S
sect1, Headlines, Sections
sect2, Headlines, Sections
Sections
Headlines, Headlines, Sections
security
definition, Install Red Hat 8/9
firewall, Install Red Hat 8/9
sendmail
removing, Install qmail (OPTIONAL)
ssh, Install Red Hat 8/9
T
The publish point for new packages should be
+        fixed., Prepare the package for distribution.
U
ulink, Links
upgrade
OpenACS 4.5 to 4.6.x
Linux/Unix, Upgrading 4.5 or higher to 4.6.3
X
XML guidelines, OpenACS Documentation Strategy: Why DocBook?
xref
linkend, Links
xreflabel, Headlines, Sections
Prev Home  
How to Update the translations Up  
docs@openacs.org

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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/maint-performance.adp	2 Mar 2019 19:30:05 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/maint-performance.adp	10 Mar 2019 21:47:14 -0000	1.4.2.2
@@ -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

 


 
@@ -110,7 +110,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 -N -r1.32.2.1 -r1.32.2.2
--- openacs-4/packages/acs-core-docs/www/maint-performance.html	2 Mar 2019 19:30:05 -0000	1.32.2.1
+++ openacs-4/packages/acs-core-docs/www/maint-performance.html	10 Mar 2019 21:47:14 -0000	1.32.2.2
@@ -2,7 +2,7 @@
 Diagnosing Performance Problems
Prev Chapter 6. Production Environments  Next
Diagnosing Performance Problems
Did performance problems happen overnight, or did they sneak up on
     you? Any clue what caused the performance problems (e.g. loading 20K
     users into .LRN)
Is the file system out of space?  Is the machine swapping to disk constantly?
Isolating and solving database problems.
Without daily internal maintenance, most databases slowly degrade in performance.  For PostGreSQL, see the section called “Vacuum Postgres nightly”.  For Oracle, use exec dbms_stats.gather_schema_stats('SCHEMA_NAME') (Andrew Piskorski's Oracle notes).
You can track the exact amount of time each database query on a page takes:
Go to Main Site : Site-Wide Administration : Install Software
Click on "Install New Application" in "Install from OpenACS Repository"
Choose "ACS Developer Support">
After install is complete, restart the server.
Browse to Developer Support, which is automatically mounted at /ds.
-              
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

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

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 -N -r1.5.2.1 -r1.5.2.2
--- openacs-4/packages/acs-core-docs/www/maintenance-deploy.adp	2 Mar 2019 19:30:05 -0000	1.5.2.1
+++ openacs-4/packages/acs-core-docs/www/maintenance-deploy.adp	10 Mar 2019 21:47:14 -0000	1.5.2.2
@@ -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 @@
 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
+Simple A/B Deployment: Database is not
 changed

-Figure 6.2. Simple A/B
+
Figure 6.2. Simple A/B
 Deployment - Step 1

 


-Figure 6.3. Simple A/B
+
Figure 6.3. Simple A/B
 Deployment - Step 2

 


-Figure 6.4. Simple A/B
+
Figure 6.4. 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

 


-Figure 6.6. Complex A/B
+
Figure 6.6. Complex A/B
 Deployment - Step 2

 


-Figure 6.7. Complex A/B
+
Figure 6.7. 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 -N -r1.28.2.1 -r1.28.2.2
--- openacs-4/packages/acs-core-docs/www/maintenance-deploy.html	2 Mar 2019 19:30:05 -0000	1.28.2.1
+++ openacs-4/packages/acs-core-docs/www/maintenance-deploy.html	10 Mar 2019 21:47:14 -0000	1.28.2.2
@@ -2,7 +2,7 @@
 Staged Deployment for Production NetworksPrev Chapter 6. Production Environments  Next
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 file system regularly receiving new data, you must interrupt this function or risk losing data in the shuffle.  It also requires extra steps if the database will be affected.
Simple A/B Deployment: Database is not changed
Figure 6.2. Simple A/B Deployment - Step 1

Figure 6.3. Simple A/B Deployment - Step 2

Figure 6.4. Simple A/B Deployment - Step 3

Complex A/B Deployment: Database is changed
Figure 6.5. Complex A/B Deployment - Step 1

Figure 6.6. Complex A/B Deployment - Step 2

Figure 6.7. Complex A/B Deployment - Step 3

Prev Home  Next
High Availability/High Performance Configurations Up  Installing SSL Support for an OpenACS service
docs@openacs.org

+      run the upgrade scripts from the package manager. 
The production site can run "HEAD" from cvs.
The drawback to using HEAD as the live code is that you cannot commit new work on the development server without erasing the definition of 'working production code.'  So a better method is to use a tag.  This guarantees that, at any time in the future, you can retrieve exactly the same set of code.  This is useful for both of the characteristics of safe change deployment.  For control, you can use tags to define a body of code, test that code, and then know that what you are deploying is exactly that code.  For rollback, you can use return to the last working tag if the new tag (or new, untagged changes) cause problems.  .... example of using tags to follow ...
Method 2: A/B Deployment
The approach taken in this section is to always create a new service with the desired changes, running in parallel with the existing site.  This guarantees control, at least at the final step of the process: you know what changes you are about to make because you can see them directly.  It does not, by itself, guarantee the entire control chain.  You need additional measures to make sure that the change you are making is exactly and completely the change you intended to make and tested previously, and nothing more.  Those additional measures typically take the form of source control tags and system version numbers.  The parallel-server approach also guarantees rollback because the original working service is not touched; it is merely set aside.
This approach can has limitations.  If the database or file system regularly receiving new data, you must interrupt this function or risk losing data in the shuffle.  It also requires extra steps if the database will be affected.
Simple A/B Deployment: Database is not changed
Figure 6.2. Simple A/B Deployment - Step 1

Figure 6.3. Simple A/B Deployment - Step 2

Figure 6.4. Simple A/B Deployment - Step 3

Complex A/B Deployment: Database is changed
Figure 6.5. Complex A/B Deployment - Step 1

Figure 6.6. Complex A/B Deployment - Step 2

Figure 6.7. Complex A/B Deployment - Step 3

Prev Home  Next
High Availability/High Performance Configurations Up  Installing SSL Support for an OpenACS service
docs@openacs.org

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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/objects.adp	2 Mar 2019 19:30:05 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/objects.adp	10 Mar 2019 21:47:14 -0000	1.4.2.2
@@ -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 -N -r1.55.2.1 -r1.55.2.2
--- openacs-4/packages/acs-core-docs/www/objects.html	2 Mar 2019 19:30:05 -0000	1.55.2.1
+++ openacs-4/packages/acs-core-docs/www/objects.html	10 Mar 2019 21:47:14 -0000	1.55.2.2
@@ -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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/openacs.adp	2 Mar 2019 19:30:05 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/openacs.adp	10 Mar 2019 21:47:14 -0000	1.4.2.2
@@ -320,7 +320,7 @@
 automate vacuuming is to edit the cron file for the database user.
 Recommended: VACUUM ANALYZE
 every hour and VACUUM FULL
-ANALYZE every day.
+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
@@ -354,7 +354,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 -N -r1.54.2.1 -r1.54.2.2
--- openacs-4/packages/acs-core-docs/www/openacs.html	2 Mar 2019 19:30:05 -0000	1.54.2.1
+++ openacs-4/packages/acs-core-docs/www/openacs.html	10 Mar 2019 21:47:14 -0000	1.54.2.2
@@ -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 -N -r1.7.2.1 -r1.7.2.2
--- openacs-4/packages/acs-core-docs/www/packages.adp	2 Mar 2019 19:30:05 -0000	1.7.2.1
+++ openacs-4/packages/acs-core-docs/www/packages.adp	10 Mar 2019 21:47:14 -0000	1.7.2.2
@@ -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 -N -r1.57.2.1 -r1.57.2.2
--- openacs-4/packages/acs-core-docs/www/packages.html	2 Mar 2019 19:30:05 -0000	1.57.2.1
+++ openacs-4/packages/acs-core-docs/www/packages.html	10 Mar 2019 21:47:14 -0000	1.57.2.2
@@ -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 Type Its Use Naming Convention
Package Specification File The package specification file is an XML file generated and
+    
Table 11.1. Package files
File Type Its Use Naming Convention
Package Specification File The 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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.adp	2 Mar 2019 19:30:05 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.adp	10 Mar 2019 21:47:15 -0000	1.4.2.2
@@ -127,7 +127,7 @@
 Context
 HierarchySuppose 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 -N -r1.49.2.1 -r1.49.2.2
--- openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.html	2 Mar 2019 19:30:05 -0000	1.49.2.1
+++ openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.html	10 Mar 2019 21:47:15 -0000	1.49.2.2
@@ -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_id context_id
20 10
30 10
40 20
50 20
60 30


+    
Table 11.3. acs_objects example data
object_id context_id
20 10
30 10
40 20
50 20
60 30


       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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/psgml-for-emacs.adp	2 Mar 2019 19:30:05 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/psgml-for-emacs.adp	10 Mar 2019 21:47:15 -0000	1.4.2.2
@@ -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 -N -r1.44.2.1 -r1.44.2.2
--- openacs-4/packages/acs-core-docs/www/psgml-for-emacs.html	2 Mar 2019 19:30:05 -0000	1.44.2.1
+++ openacs-4/packages/acs-core-docs/www/psgml-for-emacs.html	10 Mar 2019 21:47:15 -0000	1.44.2.2
@@ -1,5 +1,5 @@
 
-Add PSGML commands to emacs init file (OPTIONAL)
Prev Appendix B. Install additional supporting software  Next
Add PSGML commands to emacs init file (OPTIONAL)

+Add PSGML commands to emacs init file (OPTIONAL)
Prev Appendix B. Install additional supporting software  Next
Add PSGML commands to emacs init file (OPTIONAL)

 If you plan to write or edit any documentation with emacs, install a
       customized emacs configuration file with DocBook commands in the skeleton
       directory, so it will be used for all new users.  The file also
Index: openacs-4/packages/acs-core-docs/www/release-notes.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/release-notes.adp,v
diff -u -N -r1.8.2.1 -r1.8.2.2
--- openacs-4/packages/acs-core-docs/www/release-notes.adp	2 Mar 2019 19:30:05 -0000	1.8.2.1
+++ openacs-4/packages/acs-core-docs/www/release-notes.adp	10 Mar 2019 21:47:15 -0000	1.8.2.2
@@ -503,7 +503,7 @@
 ns_log, but which logs the calling information (like URL and
 call-stack) to ease tracking of errors.
Use per-thread caching to reduce number of mutex lock operations
 and lock contention on various caches (util-memoize, xo_site_nodes,
-xotcl_object_types) and nsvs (e.g ds_properties)
Improved templating of OpenACS core documentation
Improved Russian Internationalization
Make pretty-names of acs-core packages more consistent
Mark unused functions of acs-tcl/tcl/table-display-procs.tcl as
+xotcl_object_types) and nsvs (e.g. ds_properties)
Improved templating of OpenACS core documentation
Improved Russian Internationalization
Make pretty-names of acs-core packages more consistent
Mark unused functions of acs-tcl/tcl/table-display-procs.tcl as
 deprecated
Many more bug fixes (from bug tracker and extra) and performance
 improvements.

 Version numbers:

@@ -815,20 +815,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 2018/08/05
-21:26:03 gustafn Exp $)
+
($‌Id: release-notes.xml,v 1.39.2.1 2019/03/10
+21:36:25 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
 
 
  Use per-thread caching to reduce number of
 	    mutex lock operations and lock contention on various caches
 	    (util-memoize, xo_site_nodes, xotcl_object_types) and nsvs
-	    (e.g ds_properties) 

+	    (e.g. ds_properties) 

 	      Improved templating of OpenACS core documentation
 	    

 	      Improved Russian Internationalization
@@ -1169,4 +1169,4 @@
         

           Serving backup files and files from the CVS directories is turned off by default via the acs-kernel parameter
           ExcludedFiles in section request-processor (The variable provides a string match glob list of files and is defaulted to "*/CVS/* *~")
-        
($Id$)
Release 4.6.3
Release Notes for 4.6.3
Release 4.6.2
Release Notes for 4.6.2
Release 4.6
Release Notes for 4.6
Release 4.5
Release Notes for 4.5
Prev Home  Next
Overview Up  Part II. Administrator's Guide
docs@openacs.org

+        
($Id$)
Release 4.6.3
Release Notes for 4.6.3
Release 4.6.2
Release Notes for 4.6.2
Release 4.6
Release Notes for 4.6
Release 4.5
Release Notes for 4.5
Prev Home  Next
Overview Up  Part II. Administrator's Guide
docs@openacs.org

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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/tutorial-css-layout.adp	2 Mar 2019 19:30:06 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/tutorial-css-layout.adp	10 Mar 2019 21:47:15 -0000	1.4.2.2
@@ -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>
@@ -39,7 +39,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 -N -r1.15.2.1 -r1.15.2.2
--- openacs-4/packages/acs-core-docs/www/tutorial-css-layout.html	2 Mar 2019 19:30:06 -0000	1.15.2.1
+++ openacs-4/packages/acs-core-docs/www/tutorial-css-layout.html	10 Mar 2019 21:47:15 -0000	1.15.2.2
@@ -1,5 +1,5 @@
 
-Laying out a page with CSS instead of tablesPrev Chapter 10. Advanced Topics  Next
Laying out a page with CSS instead of tables
.LRN home page with table-based layout
A sample of the HTML code (full source)
<table border="0" width="100%">
+Laying out a page with CSS instead of tablesPrev Chapter 10. Advanced Topics  Next
Laying out a page with CSS instead of tables
.LRN home page with table-based layout
A sample of the HTML code (full source)
<table border="0" width="100%">
   <tr>
     <td valign="top" width="50%">
       <table class="element" border="0" cellpadding="0" cellspacing="0" width="100%">
@@ -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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/tutorial-cvs.adp	2 Mar 2019 19:30:06 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/tutorial-cvs.adp	10 Mar 2019 21:47:15 -0000	1.4.2.2
@@ -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

 


 

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 -N -r1.29.2.1 -r1.29.2.2
--- openacs-4/packages/acs-core-docs/www/tutorial-cvs.html	2 Mar 2019 19:30:06 -0000	1.29.2.1
+++ openacs-4/packages/acs-core-docs/www/tutorial-cvs.html	10 Mar 2019 21:47:15 -0000	1.29.2.2
@@ -59,4 +59,4 @@
 initial revision: 1.1
 done
 (many lines omitted)
-[$OPENACS_SERVICE_NAME myfirstpackage]$
Figure 10.1. Upgrading a local CVS repository

Prev Home  Next
Write the Requirements and Design Specs Up  OpenACS Edit This Page Templates
docs@openacs.org

+[$OPENACS_SERVICE_NAME myfirstpackage]$
Figure 10.1. Upgrading a local CVS repository

Prev Home  Next
Write the Requirements and Design Specs Up  OpenACS Edit This Page Templates
docs@openacs.org

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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/tutorial-database.adp	2 Mar 2019 19:30:06 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/tutorial-database.adp	10 Mar 2019 21:47:15 -0000	1.4.2.2
@@ -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

 

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 -N -r1.47.2.1 -r1.47.2.2
--- openacs-4/packages/acs-core-docs/www/tutorial-database.html	2 Mar 2019 19:30:06 -0000	1.47.2.1
+++ openacs-4/packages/acs-core-docs/www/tutorial-database.html	10 Mar 2019 21:47:15 -0000	1.47.2.2
@@ -2,7 +2,7 @@
 Setting Up Database ObjectsPrev Chapter 9. Development Tutorial  Next
Setting Up Database Objects
by Joel Aufrecht
           OpenACS docs are written by the named authors, and may be edited
           by OpenACS documentation staff.
-        
Code the data model
We create all database objects with scripts in the
+        
Code the data model
We create all database objects with scripts in the
       myfirstpackage/sql/ directory.  All
       database scripts are database-specific and are thus in either
       the myfirstpackage/sql/oracle or
@@ -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

The top of each sql file has some
+
Figure 9.2. 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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/tutorial-debug.adp	2 Mar 2019 19:30:06 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/tutorial-debug.adp	10 Mar 2019 21:47:15 -0000	1.4.2.2
@@ -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 testingMake 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 -N -r1.46.2.1 -r1.46.2.2
--- openacs-4/packages/acs-core-docs/www/tutorial-debug.html	2 Mar 2019 19:30:06 -0000	1.46.2.1
+++ openacs-4/packages/acs-core-docs/www/tutorial-debug.html	10 Mar 2019 21:47:15 -0000	1.46.2.2
@@ -2,7 +2,7 @@
 Debugging and Automated Testing

 
 Test Num Action Expected 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 Num Action Expected Result
001 Browse to the index page while not logged in and
+    
Manual testing
Make a list of basic tests to make sure it works
Test Num Action Expected Result
001 Browse to the index page while not logged in and
             while one or more notes exist. No edit or delete or add links should appear.
002 Browse 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-001 Invoke mfp::note::create with a specific word as the title. Proc should return an object id.
API-002 Given an object id from API-001, invoke mfp::note::get. Proc should return the specific word in the title.
API-003 Given the object id from API-001, invoke mfp::note::delete. Proc should return 0 for success.
Other things to test: try to delete someone else's
         note.  Try to delete your own note.  Edit your own note.
-        Search for a note.
Write automated tests
by Simon Carstensen and Joel Aufrecht
+        Search for a note.
Write automated tests
by Simon Carstensen and Joel Aufrecht
           OpenACS docs are written by the named authors, and may be edited
           by OpenACS documentation staff.
-        

+        

     It seems to me that a lot of people have been asking for some guidelines on how to write automated tests. I've done several tests by now and have found the process to be extremely easy and useful. It's a joy to work with automated testing once you get the hang of it.
Create the directory that will contain the test
     script and edit the script file.  The directory location and file name are standards which are recognized by the automated testing package:
[$OPENACS_SERVICE_NAME www]$ mkdir /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/tcl/test
 [$OPENACS_SERVICE_NAME www]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/tcl/test
@@ -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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/tutorial-distribute.adp	2 Mar 2019 19:30:06 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/tutorial-distribute.adp	10 Mar 2019 21:47:15 -0000	1.4.2.2
@@ -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
Prev Home  Next
Profile your code Up  Distributing upgrades of your package
docs@openacs.org

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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.adp	2 Mar 2019 19:30:06 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.adp	10 Mar 2019 21:47:15 -0000	1.4.2.2
@@ -81,7 +81,7 @@
 
 The template should provide us with the following ETP
 layout:

-Table 10.1. table showing ETP
+
Table 10.1. table showing ETP
 layout
@@ -126,8 +126,8 @@
 Who Wrote This and WhenThis 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: tutorial-advanced.xml,v 1.60 2018/08/05
-21:26:03 gustafn Exp $)
+original author.
($‌Id: tutorial-advanced.xml,v 1.60.2.1
+2019/03/10 21:44:57 gustafn Exp $)
 
 
 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
Sidebar Main 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
Sidebar Main 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$)
Prev Home  Next
Add the new package to CVS Up  Adding Comments
docs@openacs.org

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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/tutorial-newpackage.adp	2 Mar 2019 19:30:06 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/tutorial-newpackage.adp	10 Mar 2019 21:47:15 -0000	1.4.2.2
@@ -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 -N -r1.46.2.1 -r1.46.2.2
--- openacs-4/packages/acs-core-docs/www/tutorial-newpackage.html	2 Mar 2019 19:30:06 -0000	1.46.2.1
+++ openacs-4/packages/acs-core-docs/www/tutorial-newpackage.html	10 Mar 2019 21:47:15 -0000	1.46.2.2
@@ -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 server yourserver.test
URL of your server http://yourserver.test:8000
Name of development account $OPENACS_SERVICE_NAME
New Package key myfirstpackage

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 server yourserver.test
URL of your server http://yourserver.test:8000
Name of development account $OPENACS_SERVICE_NAME
New Package key myfirstpackage

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.
Browse to
 http://yourserver.test:8000/admin/applications/application-add/.
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 -N -r1.6.2.1 -r1.6.2.2
--- openacs-4/packages/acs-core-docs/www/tutorial-pages.adp	2 Mar 2019 19:30:06 -0000	1.6.2.1
+++ openacs-4/packages/acs-core-docs/www/tutorial-pages.adp	10 Mar 2019 21:47:15 -0000	1.6.2.2
@@ -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

 


 
 
-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 -N -r1.49.2.1 -r1.49.2.2
--- openacs-4/packages/acs-core-docs/www/tutorial-pages.html	2 Mar 2019 19:30:06 -0000	1.49.2.1
+++ openacs-4/packages/acs-core-docs/www/tutorial-pages.html	10 Mar 2019 21:47:15 -0000	1.49.2.2
@@ -2,8 +2,8 @@
 Creating Web Pages
Prev Chapter 9. Development Tutorial  Next
Creating Web Pages
by Joel Aufrecht
           OpenACS docs are written by the named authors, and may be edited
           by OpenACS documentation staff.
-        
Install some API
As a workaround for missing content-repository functionality, copy a provided file into the directory for Tcl files:
-    cp /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-core-docs/www/files/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

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

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/tutorial-specs.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-specs.adp,v
diff -u -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/tutorial-specs.adp	2 Mar 2019 19:30:06 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/tutorial-specs.adp	10 Mar 2019 21:47:15 -0000	1.4.2.2
@@ -29,12 +29,12 @@
 [$OPENACS_SERVICE_NAME xml]$
OpenACS uses DocBook for documentation. DocBook is an XML
 standard for semantic markup of documentation. That means that the
 tags you use indicate meaning, not intended appearance. The style
-sheet will determine appearance. You will edit the text in an xml
+sheet will determine appearance. You will edit the text in an XML
 file, and then process the file into html for reading.
Open the file index.xml in
 emacs. Examine the file. Find the version history (look for the tag
 <revhistory>). Add a new
 record to the document version history. Look for the <authorgroup> tag and add yourself as
-a second author. Save and exit.
Process the xml file to create html documentation. The html
+a second author. Save and exit.
Process the XML file to create html documentation. The html
 documentation, including supporting files such as pictures, is
 stored in the www/docs/
 directory. A Makefile is provided to generate html from the xml,
Index: openacs-4/packages/acs-core-docs/www/tutorial-specs.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-specs.html,v
diff -u -N -r1.16.2.1 -r1.16.2.2
--- openacs-4/packages/acs-core-docs/www/tutorial-specs.html	2 Mar 2019 19:30:06 -0000	1.16.2.1
+++ openacs-4/packages/acs-core-docs/www/tutorial-specs.html	10 Mar 2019 21:47:15 -0000	1.16.2.2
@@ -22,13 +22,13 @@
 	an XML standard for semantic markup of documentation.  That
 	means that the tags you use indicate meaning, not intended
 	appearance.  The style sheet will determine appearance.  You
-      will edit the text in an xml file, and then process the file
+      will edit the text in an XML file, and then process the file
       into html for reading.
Open the file index.xml
       in emacs.  Examine the file.  Find the version history (look for the tag
         <revhistory>).  Add a
         new record to the document version history.  Look for the
         <authorgroup> tag and
-        add yourself as a second author.  Save and exit.
Process the xml file to create html documentation.  The
+        add yourself as a second author.  Save and exit.
Process the XML file to create html documentation.  The
       html documentation, including supporting files such as pictures,
       is stored in the www/docs/
       directory.  A Makefile is provided to generate html from the xml, and copy all of the
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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.adp	2 Mar 2019 19:30:06 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.adp	10 Mar 2019 21:47:15 -0000	1.4.2.2
@@ -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 -N -r1.30.2.1 -r1.30.2.2
--- openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.html	2 Mar 2019 19:30:06 -0000	1.30.2.1
+++ openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.html	10 Mar 2019 21:47:15 -0000	1.30.2.2
@@ -1,5 +1,5 @@
 
-Upgrading 4.5 or higher to 4.6.3
Prev Chapter 5. Upgrading  Next
Upgrading 4.5 or higher to 4.6.3
The required platform for OpenACS 4.6 is the same as
+Upgrading 4.5 or higher to 4.6.3
Prev Chapter 5. Upgrading  Next
Upgrading 4.5 or higher to 4.6.3
The required platform for OpenACS 4.6 is the same as
       4.5, with the exception of OpenFTS.  OpenACS 4.6 and later require OpenFTS 0.3.2 for full text search on PostGreSQL.  If you have OpenFTS 0.2, you'll need to upgrade.  
If upgrading from 4.4, you need to manually run acs-kernel/sql/postgres/upgrade-4.4-4.5.sql.  See Bug #632
A computer with OpenACS 4.5.
OpenACS 4.6 tarball or CVS checkout/export.
Required for Full Text Search on PostgreSQL: OpenFTS 0.3.2
Make a Backup. Back up the database and file system (see the section called “Manual backup and recovery”).
OPTIONAL: Upgrade OpenFTS. the section called “Upgrading OpenFTS from 0.2 to 0.3.2”

             Stop the server
           
[root root]# svc -d /service/$OPENACS_SERVICE_NAME
Upgrade the file system. the section called “Upgrading the OpenACS files”

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 -N -r1.5.2.1 -r1.5.2.2
--- openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.adp	2 Mar 2019 19:30:06 -0000	1.5.2.1
+++ openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.adp	10 Mar 2019 21:47:15 -0000	1.5.2.2
@@ -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 file system (via any of the
@@ -26,7 +26,7 @@
 
 

 
-Methods of upgrading OpenACS files

+Methods of upgrading OpenACS files

 
 
 Upgrading files for a site which is not in a CVS
@@ -54,7 +54,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

 


 
@@ -183,7 +183,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:

 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 -N -r1.31.2.1 -r1.31.2.2
--- openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.html	2 Mar 2019 19:30:06 -0000	1.31.2.1
+++ openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.html	10 Mar 2019 21:47:15 -0000	1.31.2.2
@@ -1,5 +1,5 @@
 
-Upgrading the OpenACS files
Prev Chapter 5. Upgrading  Next
Upgrading the OpenACS files
Choosing a Method to Upgrade your Files
OpenACS is distributed in many different ways:
+Upgrading the OpenACS files
Prev Chapter 5. Upgrading  Next
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 file system (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

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

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 @@
       
[$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:
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:
Declare a freeze on new cvs updates - ie, you cannot run cvs update
    on the production site

             Make a manual backup of the production site in addition to the
    automated backups
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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/upgrade-overview.adp	2 Mar 2019 19:30:06 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/upgrade-overview.adp	10 Mar 2019 21:47:15 -0000	1.4.2.2
@@ -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

 

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 -N -r1.30.2.1 -r1.30.2.2
--- openacs-4/packages/acs-core-docs/www/upgrade-overview.html	2 Mar 2019 19:30:06 -0000	1.30.2.1
+++ openacs-4/packages/acs-core-docs/www/upgrade-overview.html	10 Mar 2019 21:47:15 -0000	1.30.2.2
@@ -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:
Browse to the Installer.
Click install or upgrade under "Install from OpenACS Repository" and select the packages to install or upgrade.
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

It's always a good idea to precede an upgrade attempt with a snapshot backup.
Table 5.1. Assumptions in this section

 
 
name of OpenACS user $OPENACS_SERVICE_NAME
OpenACS server name $OPENACS_SERVICE_NAME
Root of OpenACS file tree /var/lib/aolserver/$OPENACS_SERVICE_NAME
Database backup directory /var/lib/aolserver/$OPENACS_SERVICE_NAME/database-backup

Prev Home  Next
Chapter 5. Upgrading Up  Upgrading 4.5 or higher to 4.6.3
docs@openacs.org

+    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:
Browse to the Installer.
Click install or upgrade under "Install from OpenACS Repository" and select the packages to install or upgrade.
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

It's always a good idea to precede an upgrade attempt with a snapshot backup.
Table 5.1. Assumptions in this section
name of OpenACS user $OPENACS_SERVICE_NAME
OpenACS server name $OPENACS_SERVICE_NAME
Root of OpenACS file tree /var/lib/aolserver/$OPENACS_SERVICE_NAME
Database backup directory /var/lib/aolserver/$OPENACS_SERVICE_NAME/database-backup

Prev Home  Next
Chapter 5. Upgrading Up  Upgrading 4.5 or higher to 4.6.3
docs@openacs.org

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 -N -r1.4.2.1 -r1.4.2.2
--- openacs-4/packages/acs-core-docs/www/variables.adp	2 Mar 2019 19:30:06 -0000	1.4.2.1
+++ openacs-4/packages/acs-core-docs/www/variables.adp	10 Mar 2019 21:47:15 -0000	1.4.2.2
@@ -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 -N -r1.33.2.1 -r1.33.2.2
--- openacs-4/packages/acs-core-docs/www/variables.html	2 Mar 2019 19:30:06 -0000	1.33.2.1
+++ openacs-4/packages/acs-core-docs/www/variables.html	10 Mar 2019 21:47:15 -0000	1.33.2.2
@@ -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,
           ...
     ...

Feature	Status	Description
New API
EXT-AUTH-01	A	Extend Authentication/Acct Status API
EXT-AUTH-03	A	Account Creation API
EXT-AUTH-05	A	Password Management API
EXT-AUTH-30	A	Authority Management API

Feature	Status	Description
Login
EXT-AUTH-04	A	Rewrite login, register, and admin pages to use APIs
EXT-AUTH-38	A	ad_form complain feature
EXT-AUTH-19	A	Rewrite password recovery to use API
EXT-AUTH-21	A	Rewrite email verification with API
EXT-AUTH-28	A	Username is email switch

Prev	Home	Next
Programming with AOLserver	Up	Chapter 12. Engineering Standards