Index: openacs-4/packages/acs-admin/acs-admin.info
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-admin/acs-admin.info,v
diff -u -r1.58.2.5 -r1.58.2.6
--- openacs-4/packages/acs-admin/acs-admin.info 2 Sep 2021 17:22:27 -0000 1.58.2.5
+++ openacs-4/packages/acs-admin/acs-admin.info 15 Sep 2021 16:11:12 -0000 1.58.2.6
@@ -9,7 +9,7 @@
There are three basic things which need to be backed up, the database data, the server source tree, and the acs-content-repository (which is in the server source tree).
There are three basic things which need to be backed up, the database data, the server source tree, and the acs-content-repository (which is in the server source tree).
-
+
After you've installed and mounted your package, you can configure each instance to act as you would like.
This is done from the Applications page. Log in, go to the Admin or Control Panel, click on the subsite the application is in, and click on Applications. If you click on the 'Parameters' Index: openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.html,v diff -u -r1.13.2.5 -r1.13.2.6 --- openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.html 7 Sep 2021 09:39:20 -0000 1.13.2.5 +++ openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.html 15 Sep 2021 16:11:16 -0000 1.13.2.6 @@ -2,7 +2,7 @@
After you've installed and mounted your package, you can configure each instance to act as you would like.
This is done from the Applications page. Log in, go to the Admin or Control Panel, click on the subsite the application is in, and click on Applications. If you click on the 'Parameters' Index: openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.adp 7 Sep 2021 09:39:20 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.adp 15 Sep 2021 16:11:16 -0000 1.4.2.7 @@ -16,7 +16,7 @@ OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff.
After you've installed and mounted your package, you can configure each instance to act as you would like.
This is done from the Applications page. Log in, go to the Admin or Control Panel, click on the subsite the application is in, and Index: openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.html,v diff -u -r1.13.2.5 -r1.13.2.6 --- openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.html 7 Sep 2021 09:39:20 -0000 1.13.2.5 +++ openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.html 15 Sep 2021 16:11:16 -0000 1.13.2.6 @@ -2,7 +2,7 @@
After you've installed and mounted your package, you can configure each instance to act as you would like.
This is done from the Applications page. Log in, go to the Admin or Control Panel, click on the subsite the application is in, and click on Applications. If you click on the 'Permissions' Index: openacs-4/packages/acs-core-docs/www/configuring-install-packages.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-install-packages.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/configuring-install-packages.adp 7 Sep 2021 09:39:20 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/configuring-install-packages.adp 15 Sep 2021 16:11:16 -0000 1.4.2.7 @@ -15,7 +15,7 @@ OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff.
An OpenACS package extends your website and lets it do things it was not able to do before. You can have a weblog, a forums, a calendar, or even do sophisticated project-management via your website.
After you've installed OpenACS, you can congratulate Index: openacs-4/packages/acs-core-docs/www/configuring-install-packages.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-install-packages.html,v diff -u -r1.13.2.5 -r1.13.2.6 --- openacs-4/packages/acs-core-docs/www/configuring-install-packages.html 7 Sep 2021 09:39:20 -0000 1.13.2.5 +++ openacs-4/packages/acs-core-docs/www/configuring-install-packages.html 15 Sep 2021 16:11:16 -0000 1.13.2.6 @@ -2,7 +2,7 @@
An OpenACS package extends your website and lets it do things it was not able to do before. You can have a weblog, a forums, a calendar, or even do sophisticated project-management via your website.
After you've installed OpenACS, you can congratulate Index: openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.adp 7 Sep 2021 09:39:21 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.adp 15 Sep 2021 16:11:16 -0000 1.4.2.7 @@ -15,7 +15,7 @@ OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff.
After you've installed your packages, you have to 'mount' them in order to make them appear on your website.
Make sure you are logged in, and then click on the 'Admin' or 'Control Panel' link to get to the Index: openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.html,v diff -u -r1.13.2.5 -r1.13.2.6 --- openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.html 7 Sep 2021 09:39:21 -0000 1.13.2.5 +++ openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.html 15 Sep 2021 16:11:16 -0000 1.13.2.6 @@ -2,7 +2,7 @@
After you've installed your packages, you have to 'mount' them in order to make them appear on your website.
Make sure you are logged in, and then click on the 'Admin' or 'Control Panel' link to get to the Site-Wide Administration page (at /acs-admin). Click on the subsite you'd Index: openacs-4/packages/acs-core-docs/www/cvs-guidelines.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/cvs-guidelines.adp,v diff -u -r1.5.2.7 -r1.5.2.8 --- openacs-4/packages/acs-core-docs/www/cvs-guidelines.adp 7 Sep 2021 09:39:21 -0000 1.5.2.7 +++ openacs-4/packages/acs-core-docs/www/cvs-guidelines.adp 15 Sep 2021 16:11:17 -0000 1.5.2.8 @@ -18,7 +18,7 @@
All OpenACS code is available anonymously. To get code
anonymously, use the parameter -d:pserver:anonymous\@cvs.openacs.org:/cvsroot
immediately after cvs
in a cvs
command to check out or export code.
If you are an OpenACS developer, you should check out code so @@ -77,7 +77,7 @@
If you are actively developing a non-core package, you should work from the latest core release branch. Currently this is oacs-5-9. This ensures that you are working on top of a stable OpenACS core, but still allows you to commit feature changes to @@ -94,7 +94,7 @@ packages and their current state.
If you are actively developing packages in the OpenACS Core, work from the HEAD branch. HEAD is used for active development of the next version of core OpenACS. It may be very buggy; it may not even install correctly. Do not use this branch for development of @@ -103,7 +103,7 @@ developer account:
cvs -d:ext:cvs.openacs.org:/cvsroot checkout acs-core
To check out HEAD anonymously:
cvs -d:pserver:anonymous\@cvs.openacs.org:/cvsroot checkout acs-core
.LRN consists of a given version OpenACS core, plus a set of packages. These are collectively packages together to form a distribution of .LRN. F .LRN 2.0.0 sits on top of OpenACS 5.0.0. .LRN also uses an OpenACS install.xml file during installation; @@ -128,7 +128,7 @@
All OpenACS code resides within a single CVS module,
openacs-4
. (The openacs-4
directory contains code for all versions of OpenACS 4 and later,
and .LRN 1 and later.) Checking out this module retrieves all
@@ -163,7 +163,7 @@
module of the same name.
Tags and Branches look similar in commands, but behave differently. A tag is a fixed point on a branch. Check out a tag to get a specific version of OpenACS. Check out a branch to get the most current code for that major-minor version (e.g., 5.0.x or @@ -403,7 +403,7 @@
Informal guidelines which may be obsolete in places and should be reviewed:
Before committing to cvs you must submit a bug report and patch to the OpenACS bug Index: openacs-4/packages/acs-core-docs/www/cvs-guidelines.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/cvs-guidelines.html,v diff -u -r1.14.2.6 -r1.14.2.7 --- openacs-4/packages/acs-core-docs/www/cvs-guidelines.html 7 Sep 2021 09:39:21 -0000 1.14.2.6 +++ openacs-4/packages/acs-core-docs/www/cvs-guidelines.html 15 Sep 2021 16:11:17 -0000 1.14.2.7 @@ -6,7 +6,7 @@
OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff. -
All OpenACS code is available anonymously. To get code
anonymously, use the parameter
-d:pserver:anonymous@cvs.openacs.org:/cvsroot
immediately after cvs
in a cvs command to check out or export code.
@@ -53,7 +53,7 @@
cd CVSROOT
emacs avail
Add an avail line of the form:
avail|username|openacs-4
cvs commit -m "added commit on X for username" avail
If you are actively developing a non-core package, you + User yournamehere
into your ~/.ssh/config
file, then you can use -d :ext:cvs-server:/cvsroot
instead of -d :ext:cvs.openacs.org:/cvsroot
. You can then change the definition of cvs-server
by changing one file instead of editing hundreds of CVSROOT/Repository
files.
If you are actively developing a non-core package, you should work from the latest core release branch. Currently this is oacs-5-9. This ensures that you are working on top of a stable OpenACS core, but still allows you to commit feature @@ -68,13 +68,13 @@ Inventory and Package maintainers and status for a list of available packages and their current state. -
If you are actively developing packages in the OpenACS
Core, work from the HEAD branch. HEAD is used for active
development of the next version of core OpenACS. It may be very
buggy; it may not even install correctly. Do not use this branch for
development of non-core features unless your work depends on some
of the HEAD core work. To check out HEAD, omit the
- -r
tag.
To check out HEAD for development, which requires an OpenACS developer account:
cvs -d:ext:cvs.openacs.org:/cvsroot checkout acs-core
To check out HEAD anonymously:
cvs -d:pserver:anonymous@cvs.openacs.org:/cvsroot checkout acs-core
+ -r
tag.
To check out HEAD for development, which requires an OpenACS developer account:
cvs -d:ext:cvs.openacs.org:/cvsroot checkout acs-core
To check out HEAD anonymously:
cvs -d:pserver:anonymous@cvs.openacs.org:/cvsroot checkout acs-core
.LRN consists of a given version OpenACS core, plus a set of packages. These are collectively packages together to form a distribution of .LRN. F .LRN 2.0.0 sits on top of OpenACS 5.0.0. @@ -89,7 +89,7 @@ mv dotlrn/install.xml ..
Once you have a checkout you can use some commands to track
what has changed since you checked out your copy. cvs -n update
does not change any files, but reports which changes have been updated or locally modified, or are not present in CVS.
-
To update your files, use cvs update
. This will merge changes from the repository with your local files. It has no effect on the cvs.openacs.org repository.
All OpenACS code resides within a single CVS module, openacs-4
. (The openacs-4 directory contains code for all versions of OpenACS 4 and later, and .LRN 1 and later.) Checking out this module retrieves all OpenACS code of any type. For convenience, subsets of openacs-4
are repackaged as smaller modules.
acs-core
contains only critical common
packages. It does not have any user applications, such as forums,
@@ -117,7 +117,7 @@
project-manager-all
contains the packages required, in combination with acs-core, to run the project-manager package.
Each OpenACS package (i.e., directory in openacs-4/packages/
) is also aliased as a module of the same name.
-
Informal guidelines which may be obsolete in places and should be reviewed: Index: openacs-4/packages/acs-core-docs/www/cvs-tips.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/cvs-tips.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/cvs-tips.adp 7 Sep 2021 09:39:21 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/cvs-tips.adp 15 Sep 2021 16:11:17 -0000 1.4.2.7 @@ -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.
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/docbook-primer.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/docbook-primer.adp,v diff -u -r1.6.2.8 -r1.6.2.9 --- openacs-4/packages/acs-core-docs/www/docbook-primer.adp 7 Sep 2021 09:39:23 -0000 1.6.2.8 +++ openacs-4/packages/acs-core-docs/www/docbook-primer.adp 15 Sep 2021 16:11:18 -0000 1.6.2.9 @@ -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:
- 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 ofid
has to be unique throughout the book you're making since theid
's in yoursect1
'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 isxreflabel
. The value of this is the text that will appear as the link when referring to thissect1
.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
andxreflabel
attributes, and a<title>
-tag inside. Actually, thexreflabel
is never required in @@ -548,7 +548,7 @@- 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 @@- Linking falls into two different + Linking falls into two different categories: inside the book you're making and outside:
- 1. Inside linking, cross-referencing other parts of your book
By having unique
id
's you can cross-reference any part of your book with a simple tag, regardless of where that part is.-Check out how I link to a subsection of +Check out how I link to a subsection of the Developer's Guide:
Put this in your XML:
- Find information about creating a package in <xref linkend="packages-making-a-package"></xref>. @@ -594,7 +594,7 @@- 2. Linking outside the documentation
- If you're hyper-linking out of the + If you're hyper-linking out of the documentation, it works almost the same way as HTML - the tag is just a little different (
<ulink>
):<ulink url="http://www.oracle.com/">Oracle Corporation</ulink>....will create a hyper-link to Oracle in the HTML-version of the documentation.
@@ -611,7 +611,7 @@ Note: The graphics guidelines are not written in stone. Use another valid approach if it works better for you.
- To insert a graphic we use the elements + To insert a graphic we use the elements
<mediaobject>
,<imageobject>
,<imagedata>
, @@ -636,7 +636,7 @@- Here's how you make the DocBook + Here's how you make the DocBook equivalent of the three usual HTML-lists:
- 1. How to make an <ul>
- @@ -689,7 +689,7 @@
- DocBook supports several types of tables, + DocBook supports several types of tables, but in most cases, the
<informaltable>
is enough:<informaltable frame="all"> <tgroup cols="3"> @@ -735,7 +735,7 @@- Our documentation uses two flavors of + Our documentation uses two flavors of emphasis - italics and bold type. DocBook uses one -
<emphasis>
.The
<emphasis>
tag defaults to italics when parsed. If you're looking for emphasizing with bold type, use<emphasis Index: openacs-4/packages/acs-core-docs/www/docbook-primer.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/docbook-primer.html,v diff -u -r1.56.2.6 -r1.56.2.7 --- openacs-4/packages/acs-core-docs/www/docbook-primer.html 7 Sep 2021 09:39:23 -0000 1.56.2.6 +++ openacs-4/packages/acs-core-docs/www/docbook-primer.html 15 Sep 2021 16:11:18 -0000 1.56.2.7 @@ -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.- + 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 ofid
has to be unique throughout the book you're making since theid
's in yoursect1
'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 thissect1
.@@ -741,7 +741,7 @@ </sect1>
- + Inside this container your document will be split up into
<sect2>
's, each with the same requirements -id
andxreflabel
@@ -750,7 +750,7 @@ When it comes to naming yoursect2
's and below, prefix them with some abbreviation of theid
in thesect1
such asrequirements-overview
.- + 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>
- + 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.- + 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>- + DocBook supports several types of tables, but in most cases, the
<informaltable>
is enough: @@ -926,7 +926,7 @@<table>
for an example.- + Our documentation uses two flavors of emphasis - italics and bold type. DocBook uses one -
<emphasis>
.Index: openacs-4/packages/acs-core-docs/www/ext-auth-requirements.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/ext-auth-requirements.adp,v diff -u -r1.6.2.7 -r1.6.2.8 --- openacs-4/packages/acs-core-docs/www/ext-auth-requirements.adp 7 Sep 2021 09:39:24 -0000 1.6.2.7 +++ openacs-4/packages/acs-core-docs/www/ext-auth-requirements.adp 15 Sep 2021 16:11:21 -0000 1.6.2.8 @@ -12,7 +12,7 @@ External Authentication Requirements
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 @@
+New API
Feature Status Description Index: openacs-4/packages/acs-core-docs/www/form-builder.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/form-builder.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/form-builder.adp 7 Sep 2021 09:39:24 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/form-builder.adp 15 Sep 2021 16:11:23 -0000 1.4.2.7 @@ -25,7 +25,7 @@ Multi-part Elements New API Some elements have more than one choice, or can submit more than one value.
Creating the form element. Populate a list of lists with values for the option list.
set foo_options [db_list_of_lists foo_option_list " @@ -96,7 +96,7 @@ ErrorsHere are some common errors and what to do when you encounter them:
This generally happens when there is an error in your query.
Index: openacs-4/packages/acs-core-docs/www/form-builder.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/form-builder.html,v diff -u -r1.33.2.5 -r1.33.2.6 --- openacs-4/packages/acs-core-docs/www/form-builder.html 7 Sep 2021 09:39:24 -0000 1.33.2.5 +++ openacs-4/packages/acs-core-docs/www/form-builder.html 15 Sep 2021 16:11:24 -0000 1.33.2.6 @@ -6,7 +6,7 @@ adaptable UI. Error handling includes inline error reporting, and is customizable. However, ad_form can be tricky to use. In addition to this document, the ad_form api - documentation is helpful.Index: openacs-4/packages/acs-core-docs/www/high-avail.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/high-avail.html,v diff -u -r1.27.2.5 -r1.27.2.6 --- openacs-4/packages/acs-core-docs/www/high-avail.html 7 Sep 2021 09:39:25 -0000 1.27.2.5 +++ openacs-4/packages/acs-core-docs/www/high-avail.html 15 Sep 2021 16:11:25 -0000 1.27.2.6 @@ -1,2 +1,2 @@ -Some elements have more than one choice, or can submit more than one value.
Creating the form element. Populate a list of lists with values for the option list.
set foo_options [db_list_of_lists foo_option_list " + documentation is helpful.Some elements have more than one choice, or can submit more than one value.
Creating the form element. Populate a list of lists with values for the option list.
set foo_options [db_list_of_lists foo_option_list " select foo, foo_id from foos @@ -51,5 +51,5 @@ ns_set print $mypage }Index: openacs-4/packages/acs-core-docs/www/high-avail.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/high-avail.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/high-avail.adp 7 Sep 2021 09:39:25 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/high-avail.adp 15 Sep 2021 16:11:25 -0000 1.4.2.7 @@ -12,7 +12,7 @@ High Availability/High Performance ConfigurationsHere are some common errors and what to do when you - encounter them:
See also the section called “Running a PostgreSQL database on another server”.
High Availability/High Performance Configurations +High Availability/High Performance Configurations Index: openacs-4/packages/acs-core-docs/www/how-do-I.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/how-do-I.adp,v diff -u -r1.5.2.6 -r1.5.2.7 --- openacs-4/packages/acs-core-docs/www/how-do-I.adp 7 Sep 2021 09:39:25 -0000 1.5.2.6 +++ openacs-4/packages/acs-core-docs/www/how-do-I.adp 15 Sep 2021 16:11:26 -0000 1.5.2.7 @@ -11,20 +11,20 @@The easiest way is to install the Edit-This-Page package.
Log in to the web site as an administrator.
Click on Admin > Install Software > Install from OpenACS Repository / Install new application
Choose Edit This Page and install
Follow the instructions within Edit This Page (the link will only work after Edit This Page is installed).
Go to
/admin/permissions
and grant Create to Registered UsersSuppose you install a new site and install Weblogger, and you want all visitors to see weblogger automatically.
On the front page, click the
Admin
button.On the administration page, click
Parameters
link.Change the parameter
IndexRedirectUrl
to be the URI of the @@ -34,7 +34,7 @@Every page within an OpenACS site is part of a subsiteMore information). The home page of the entire site is the front page is a special, default instance of a subsite, served from
/var/lib/aolserver/$OPENACS_SERVICE_NAME/www
. If an @@ -49,7 +49,7 @@Almost all pages on an OpenACS site use ACS Templating, and so +How do I change the site-wide style?
Almost all pages on an OpenACS site use ACS Templating, and so their appearance is driven by a layer of different files. Let's examine how this works:
- @@ -71,12 +71,12 @@ navigation "meta" elements such as Translator widgets and Admin widgets.
@@ -117,12 +117,12 @@
To grant permissions on a package, start at the site map. Find the event package and click "Set permissions".
Click "Grant Permission"
Grant the write permission to Registered Users.
OpenACS 5.0 offers a prettier version at /admin/applications.
Index: openacs-4/packages/acs-core-docs/www/how-do-I.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/how-do-I.html,v diff -u -r1.31.2.5 -r1.31.2.6 --- openacs-4/packages/acs-core-docs/www/how-do-I.html 7 Sep 2021 09:39:25 -0000 1.31.2.5 +++ openacs-4/packages/acs-core-docs/www/how-do-I.html 15 Sep 2021 16:11:26 -0000 1.31.2.6 @@ -1,7 +1,7 @@ -How Do I? Index: openacs-4/packages/acs-core-docs/www/i18n-convert.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/i18n-convert.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/i18n-convert.adp 7 Sep 2021 09:39:25 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/i18n-convert.adp 15 Sep 2021 16:11:26 -0000 1.4.2.7 @@ -144,7 +144,7 @@The easiest way is to install the Edit-This-Page package.
Log in to the web site as an administrator.
Click on Admin > Install Software > Install from OpenACS Repository / Install new application
Choose Edit This Page and install
Follow the instructions within Edit This Page (the link will only work after Edit This Page is installed).
Go to
/admin/permissions
and grant Create to Registered UsersSuppose you install a new site and install Weblogger, and you want all visitors to see weblogger automatically.
On the front page, click the
Admin
button.On the administration page, click
Parameters
link.Change the parameter
IndexRedirectUrl
to be the URI of the desired application. For a default weblogger installation, this would be. Note the trailing slash.
weblogger/
Every page within an OpenACS site is part of a subsite More information). The home page of the entire site is the front page is a special, default instance of a subsite, served from
/var/lib/aolserver/$OPENACS_SERVICE_NAME/www
. If an index page is not found there, the default index page for all subsites is used. To customize the code on the front page, copy the default index page from the Subsite package to the Main site and edit it:
cp
/var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-subsite/www/index*
/var/lib/aolserver/$OPENACS_SERVICE_NAME/www
Edit the new
index.adp
to change the text; you shouldn't need to editindex.tcl
unless you are adding new functionality.Almost all pages on an OpenACS site use ACS Templating, and so their appearance is driven by a layer of different files. Let's examine how this works:
+
How Do I? The easiest way is to install the Edit-This-Page package.
Log in to the web site as an administrator.
Click on Admin > Install Software > Install from OpenACS Repository / Install new application
Choose Edit This Page and install
Follow the instructions within Edit This Page (the link will only work after Edit This Page is installed).
Go to
/admin/permissions
and grant Create to Registered UsersSuppose you install a new site and install Weblogger, and you want all visitors to see weblogger automatically.
On the front page, click the
Admin
button.On the administration page, click
Parameters
link.Change the parameter
IndexRedirectUrl
to be the URI of the desired application. For a default weblogger installation, this would be. Note the trailing slash.
weblogger/
Every page within an OpenACS site is part of a subsite More information). The home page of the entire site is the front page is a special, default instance of a subsite, served from
/var/lib/aolserver/$OPENACS_SERVICE_NAME/www
. If an index page is not found there, the default index page for all subsites is used. To customize the code on the front page, copy the default index page from the Subsite package to the Main site and edit it:
cp
/var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-subsite/www/index*
/var/lib/aolserver/$OPENACS_SERVICE_NAME/www
Edit the new
index.adp
to change the text; you shouldn't need to editindex.tcl
unless you are adding new functionality.Almost all pages on an OpenACS site use ACS Templating, and so their appearance is driven by a layer of different files. Let's examine how this works:
A templated page uses an ADP/Tcl pair. The first line in the ADP file is usually:
<master>If it appears exactly like this, without any arguments, the template processor uses
default-master
for that subsite. For pages in/var/lib/aolserver/$OPENACS_SERVICE_NAME/www
, this is/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/default-master.adp
and the associated .tcl file. -The
default-master
is itself a normal ADP page. It draws the subsite navigation elements and invokessite-master
(/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/site-master.adp
and .tcl)The
site-master
draws site-wide navigation elements and invokesblank-master
(/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/blank-master.adp
and .tcl).
Blank-master
does HTML housekeeping and provides a framework for special sitewide navigation "meta" elements such as Translator widgets and Admin widgets.+
Steps to Reproduce. The events package does not allow users to register for new events.
Go to the http://yourserver.net/events as a visitor (ie, log out and, if necessary, clear cookies). This in on a 4.6.3 site with events version 0.1d3.
Select an available event
A link such as
Registration: Deadline is 03/15/2004 10:00am. +
The
default-master
is itself a normal ADP page. It draws the subsite navigation elements and invokessite-master
(/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/site-master.adp
and .tcl)The
site-master
draws site-wide navigation elements and invokesblank-master
(/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/blank-master.adp
and .tcl).
Blank-master
does HTML housekeeping and provides a framework for special sitewide navigation "meta" elements such as Translator widgets and Admin widgets.
Steps to Reproduce. The events package does not allow users to register for new events.
Go to the http://yourserver.net/events as a visitor (ie, log out and, if necessary, clear cookies). This in on a 4.6.3 site with events version 0.1d3.
Select an available event
A link such as
Registration: Deadline is 03/15/2004 10:00am. » Login or sign up to register for this event.
is visible. Click on "Login or sign up" -Complete a new registration. Afterwards, you should be redirected back to the same page.
Actual Results: The page says
"You do not have permission to register for this event."
Expected results: A link or form to sign up for the event is shown.
Finding the problem. We start with the page that has the error. In the URL it's
http://myserver.net/events/event-info.tcl
, so open the file/var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/events/www/event-info.tcl
. It contains this line:set can_register_p [events::security::can_register_for_event_p -event_id $event_id]We need to know what that procedure does, so go to /api-doc, paste events::security::can_register_for_event_p into the ACS Tcl API Search box, and click Feeling Lucky. The next pages shows the proc, and we click "show source" to see more information. The body of the proc is simply
return [permission::permission_p -party_id $user_id -object_id $event_id -privilege write]This means that a given user must have the write privilege on the event in order to register. Let's assume that the privileges inherit, so that if a user has the write privilege on the whole package, they will have the write privilege on the event.
Setting Permissions. A permission has three parts: the privilege, the object of the privilege, and the subject being granted the privilege. In this case the privilege is "write," the object is the Events package, and the subject is all Registered Users.
To grant permissions on a package, start at the site map. Find the event package and click "Set permissions".
Click "Grant Permission"
Grant the write permission to Registered Users.
OpenACS 5.0 offers a prettier version at /admin/applications.
Complete a new registration. Afterwards, you should be redirected back to the same page.
Actual Results: The page says
"You do not have permission to register for this event."
Expected results: A link or form to sign up for the event is shown.
Finding the problem. We start with the page that has the error. In the URL it's
http://myserver.net/events/event-info.tcl
, so open the file/var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/events/www/event-info.tcl
. It contains this line:set can_register_p [events::security::can_register_for_event_p -event_id $event_id]We need to know what that procedure does, so go to /api-doc, paste events::security::can_register_for_event_p into the ACS Tcl API Search box, and click Feeling Lucky. The next pages shows the proc, and we click "show source" to see more information. The body of the proc is simply
return [permission::permission_p -party_id $user_id -object_id $event_id -privilege write]This means that a given user must have the write privilege on the event in order to register. Let's assume that the privileges inherit, so that if a user has the write privilege on the whole package, they will have the write privilege on the event.
Setting Permissions. A permission has three parts: the privilege, the object of the privilege, and the subject being granted the privilege. In this case the privilege is "write," the object is the Events package, and the subject is all Registered Users.
To grant permissions on a package, start at the site map. Find the event package and click "Set permissions".
Click "Grant Permission"
Grant the write permission to Registered Users.
OpenACS 5.0 offers a prettier version at /admin/applications.
Replace complicated keys with longer, simpler Index: openacs-4/packages/acs-core-docs/www/i18n-convert.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/i18n-convert.html,v diff -u -r1.29.2.5 -r1.29.2.6 --- openacs-4/packages/acs-core-docs/www/i18n-convert.html 7 Sep 2021 09:39:25 -0000 1.29.2.5 +++ openacs-4/packages/acs-core-docs/www/i18n-convert.html 15 Sep 2021 16:11:26 -0000 1.29.2.6 @@ -72,7 +72,7 @@ test. If you don't provide the package_key argument then all packages with catalog files will be checked. The script will run its checks primarily on en_US XML catalog files. -
Replace complicated keys with longer, simpler keys. When writing in one language, it is possible to create clever code to make correct text. In English, for example, you can put an
if
command at the end of a word which adds "s" if a count is anything but 1. This pluralizes nouns correctly based on the data. However, it is confusing to read and, when internationalized, may result in message keys that are both confusing and impossible to set correctly in some languages. While internationalizing, watch out that the automate converter does not create such keys. Also, refactor compound text as you encounter it.The automated system can easily get confused by tags within message texts, so that it tries to create two or three message keys for one long string with a tag in the middle. In these cases, uncheck those keys during the conversion and then edit the files directly. For example, this code:
<p class="form-help-text"><b>Invitations</b> are sent, +
Replace complicated keys with longer, simpler keys. When writing in one language, it is possible to create clever code to make correct text. In English, for example, you can put an
if
command at the end of a word which adds "s" if a count is anything but 1. This pluralizes nouns correctly based on the data. However, it is confusing to read and, when internationalized, may result in message keys that are both confusing and impossible to set correctly in some languages. While internationalizing, watch out that the automate converter does not create such keys. Also, refactor compound text as you encounter it.The automated system can easily get confused by tags within message texts, so that it tries to create two or three message keys for one long string with a tag in the middle. In these cases, uncheck those keys during the conversion and then edit the files directly. For example, this code:
<p class="form-help-text"><b>Invitations</b> are sent, when this wizard is completed and casting begins.</p>has a bold tag which confuses the converter into thinking there are two message keys for the text beginning "Invitations ..." where there should be one:
Instead, we cancel those keys, edit the file manually, and put in a single temporary message tag:
<p class="form-help-text"> <#Invitations_are_sent <b>Invitations</b> are sent, when this wizard is completed and casting begins.#> </p>Complex if statements may produce convoluted message keys that are very hard to localize. Rewrite these if statements. For example:
Select which case <if @simulation.casting_type@ eq "open">and Index: openacs-4/packages/acs-core-docs/www/index.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/index.adp,v diff -u -r1.29.2.6 -r1.29.2.7 --- openacs-4/packages/acs-core-docs/www/index.adp 7 Sep 2021 09:39:25 -0000 1.29.2.6 +++ openacs-4/packages/acs-core-docs/www/index.adp 15 Sep 2021 16:11:26 -0000 1.29.2.7 @@ -9,7 +9,7 @@
Table of Contents
- I. OpenACS For Index: openacs-4/packages/acs-core-docs/www/index.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/index.html,v diff -u -r1.56.2.5 -r1.56.2.6 --- openacs-4/packages/acs-core-docs/www/index.html 7 Sep 2021 09:39:26 -0000 1.56.2.5 +++ openacs-4/packages/acs-core-docs/www/index.html 15 Sep 2021 16:11:27 -0000 1.56.2.6 @@ -1,4 +1,4 @@ -
OpenACS Core Documentation Index: openacs-4/packages/acs-core-docs/www/install-cvs.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-cvs.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/install-cvs.adp 7 Sep 2021 09:39:26 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/install-cvs.adp 15 Sep 2021 16:11:27 -0000 1.4.2.7 @@ -9,7 +9,7 @@ rightLink="psgml-for-emacs" rightLabel="Next">Table of Contents
- I. OpenACS For Everyone
- II. Administrator's Guide
- 2. Installation Overview
- 3. Complete Installation
- 4. Configuring a new OpenACS Site
- 5. Upgrading
- 6. Production Environments
- Starting and Stopping an OpenACS instance.
- AOLserver keepalive with inittab
- Running multiple services on one machine
- High Availability/High Performance Configurations
- Staged Deployment for Production Networks
- Installing SSL Support for an OpenACS service
- Set up Log Analysis Reports
- External uptime validation
- Diagnosing Performance Problems
- 7. Database Management
- 8. Backup and Recovery
- A. Install Red Hat 8/9
- B. Install additional supporting software
- Unpack the OpenACS tarball
- Initialize CVS (OPTIONAL)
- Add PSGML commands to emacs init file (OPTIONAL)
- Install Daemontools (OPTIONAL)
- Install qmail (OPTIONAL)
- Install Analog web file analyzer
- Install nspam
- Install Full Text Search using Tsearch2
- Install nsopenssl
- Install tclwebtest.
- Install PHP for use in AOLserver
- Install Squirrelmail for use as a webmail system for OpenACS
- Install PAM Radius for use as external authentication
- Install LDAP for use as external authentication
- Install AOLserver 3.3oacs1
- C. Credits
- III. For OpenACS Package Developers
- 9. Development Tutorial
- 10. Advanced Topics
- Write the Requirements and Design Specs
- Add the new package to CVS
- OpenACS Edit This Page Templates
- Adding Comments
- Admin Pages
- Categories
- Profile your code
- Prepare the package for distribution.
- Distributing upgrades of your package
- Notifications
- Hierarchical data
- Using .vuh files for pretty URLs
- Laying out a page with CSS instead of tables
- Sending HTML email from your application
- Basic Caching
- Scheduled Procedures
- Enabling WYSIWYG
- Adding in parameters for your package
- Writing upgrade scripts
- Connect to a second database
- Future Topics
- 11. Development Reference
- OpenACS Packages
- OpenACS Data Models and the Object System
- The Request Processor
- The OpenACS Database Access API
- Using Templates in OpenACS
- Groups, Context, Permissions
- Writing OpenACS Application Pages
- Parties in OpenACS
- OpenACS Permissions Tediously Explained
- Object Identity
- Programming with AOLserver
- Using Form Builder: building html forms dynamically
- 12. Engineering Standards
- OpenACS Style Guide
- +
OpenACS Core Documentation +Table of Contents
- I. OpenACS For Everyone
- II. Administrator's Guide
- 2. Installation Overview
- 3. Complete Installation
- 4. Configuring a new OpenACS Site
- 5. Upgrading
- 6. Production Environments
- Starting and Stopping an OpenACS instance.
- AOLserver keepalive with inittab
- Running multiple services on one machine
- High Availability/High Performance Configurations
- Staged Deployment for Production Networks
- Installing SSL Support for an OpenACS service
- Set up Log Analysis Reports
- External uptime validation
- Diagnosing Performance Problems
- 7. Database Management
- 8. Backup and Recovery
- A. Install Red Hat 8/9
- B. Install additional supporting software
- Unpack the OpenACS tarball
- Initialize CVS (OPTIONAL)
- Add PSGML commands to emacs init file (OPTIONAL)
- Install Daemontools (OPTIONAL)
- Install qmail (OPTIONAL)
- Install Analog web file analyzer
- Install nspam
- Install Full Text Search using Tsearch2
- Install nsopenssl
- Install tclwebtest.
- Install PHP for use in AOLserver
- Install Squirrelmail for use as a webmail system for OpenACS
- Install PAM Radius for use as external authentication
- Install LDAP for use as external authentication
- Install AOLserver 3.3oacs1
- C. Credits
- III. For OpenACS Package Developers
- 9. Development Tutorial
- 10. Advanced Topics
- Write the Requirements and Design Specs
- Add the new package to CVS
- OpenACS Edit This Page Templates
- Adding Comments
- Admin Pages
- Categories
- Profile your code
- Prepare the package for distribution.
- Distributing upgrades of your package
- Notifications
- Hierarchical data
- Using .vuh files for pretty URLs
- Laying out a page with CSS instead of tables
- Sending HTML email from your application
- Basic Caching
- Scheduled Procedures
- Enabling WYSIWYG
- Adding in parameters for your package
- Writing upgrade scripts
- Connect to a second database
- Future Topics
- 11. Development Reference
- OpenACS Packages
- OpenACS Data Models and the Object System
- The Request Processor
- The OpenACS Database Access API
- Using Templates in OpenACS
- Groups, Context, Permissions
- Writing OpenACS Application Pages
- Parties in OpenACS
- OpenACS Permissions Tediously Explained
- Object Identity
- Programming with AOLserver
- Using Form Builder: building html forms dynamically
- 12. Engineering Standards
- 13. Documentation Standards
- 14. Internationalization
- D. Using CVS with an OpenACS Site
- IV. For OpenACS Platform Developers
- 15. Kernel Documentation
- Overview
- Object Model Requirements
- Object Model Design
- Permissions Requirements
- Permissions Design
- Groups Requirements
- Groups Design
- Subsites Requirements
- Subsites Design Document
- Package Manager Requirements
- Package Manager Design
- Database Access API
- OpenACS Internationalization Requirements
- Security Requirements
- Security Design
- Security Notes
- Request Processor Requirements
- Request Processor Design
- Documenting Tcl Files: Page Contracts and Libraries
- Bootstrapping OpenACS
- External Authentication Requirements
- 16. Releasing OpenACS
- Index
List of Figures
- 4.1. Site Templates
- 4.2. Granting Permissions
- 4.3. Granting Permissions in 5.0
- 5.1. Upgrading with the APM
- 5.2. Upgrading a local CVS repository
- 6.1. Multiple-server configuration
- 6.2. Simple A/B Deployment - Step 1
- 6.3. Simple A/B Deployment - Step 2
- 6.4. Simple A/B Deployment - Step 3
- 6.5. Complex A/B Deployment - Step 1
- 6.6. Complex A/B Deployment - Step 2
- 6.7. Complex A/B Deployment - Step 3
- 6.8. Query Analysis example
- 8.1. Backup and Recovery Strategy
- 9.1. Assumptions in this section
- 9.2. Tutorial Data Model
- 9.3. The Database Creation Script
- 9.4. Database Deletion Script
- 9.5. Page Map
- 10.1. Upgrading a local CVS repository
- 11.1. Server file layout diagram
- 11.2. Package file layout diagram
List of Tables
List of Examples
- Release Version Numbering
- Constraint naming standard
- ACS File Naming and Formatting Standards
- PL/SQL Standards
- Variables
- Automated Testing
- 13. Documentation Standards
- 14. Internationalization
- D. Using CVS with an OpenACS Site
- IV. For OpenACS Platform Developers
- 15. Kernel Documentation
- Overview
- Object Model Requirements
- Object Model Design
- Permissions Requirements
- Permissions Design
- Groups Requirements
- Groups Design
- Subsites Requirements
- Subsites Design Document
- Package Manager Requirements
- Package Manager Design
- Database Access API
- OpenACS Internationalization Requirements
- Security Requirements
- Security Design
- Security Notes
- Request Processor Requirements
- Request Processor Design
- Documenting Tcl Files: Page Contracts and Libraries
- Bootstrapping OpenACS
- External Authentication Requirements
- 16. Releasing OpenACS
- Index
List of Figures
- 4.1. Site Templates
- 4.2. Granting Permissions
- 4.3. Granting Permissions in 5.0
- 5.1. Upgrading with the APM
- 5.2. Upgrading a local CVS repository
- 6.1. Multiple-server configuration
- 6.2. Simple A/B Deployment - Step 1
- 6.3. Simple A/B Deployment - Step 2
- 6.4. Simple A/B Deployment - Step 3
- 6.5. Complex A/B Deployment - Step 1
- 6.6. Complex A/B Deployment - Step 2
- 6.7. Complex A/B Deployment - Step 3
- 6.8. Query Analysis example
- 8.1. Backup and Recovery Strategy
- 9.1. Assumptions in this section
- 9.2. Tutorial Data Model
- 9.3. The Database Creation Script
- 9.4. Database Deletion Script
- 9.5. Page Map
- 10.1. Upgrading a local CVS repository
- 11.1. Server file layout diagram
- 11.2. Package file layout diagram
List of Tables
List of Examples
CVS is a source control system. Create and initialize a directory for a local cvs repository.
[root tmp]#mkdir /cvsroot
[root tmp]#cvs -d /cvsroot init
[root tmp]# Index: openacs-4/packages/acs-core-docs/www/install-cvs.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-cvs.html,v diff -u -r1.43.2.5 -r1.43.2.6 --- openacs-4/packages/acs-core-docs/www/install-cvs.html 7 Sep 2021 09:39:26 -0000 1.43.2.5 +++ openacs-4/packages/acs-core-docs/www/install-cvs.html 15 Sep 2021 16:11:27 -0000 1.43.2.6 @@ -1,5 +1,5 @@ -Initialize CVS (OPTIONAL) CVS is a source control system. Create and initialize a +
Initialize CVS (OPTIONAL) CVS is a source control system. Create and initialize a directory for a local cvs repository.
[root tmp]#mkdir /cvsroot
[root tmp]#cvs -d /cvsroot init
[root tmp]# Index: openacs-4/packages/acs-core-docs/www/install-daemontools.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-daemontools.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/install-daemontools.adp 7 Sep 2021 09:39:26 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/install-daemontools.adp 15 Sep 2021 16:11:28 -0000 1.4.2.7 @@ -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 -r1.44.2.5 -r1.44.2.6 --- openacs-4/packages/acs-core-docs/www/install-daemontools.html 7 Sep 2021 09:39:27 -0000 1.44.2.5 +++ openacs-4/packages/acs-core-docs/www/install-daemontools.html 15 Sep 2021 16:11:28 -0000 1.44.2.6 @@ -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 -r1.5.2.6 -r1.5.2.7 --- openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.adp 7 Sep 2021 09:39:27 -0000 1.5.2.6 +++ openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.adp 15 Sep 2021 16:11:28 -0000 1.5.2.7 @@ -17,7 +17,7 @@ OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff.In earlier versions of PostgreSQL (7.4), tsearch2 was a contrib module. With PostgreSQL 9.*, it was included in the standard PostgreSQL package with minor naming changes (e.g. the function "rank" became "ts_rank"). PostgreSQL 9 included Index: openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.html,v diff -u -r1.15.2.5 -r1.15.2.6 --- openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.html 7 Sep 2021 09:39:27 -0000 1.15.2.5 +++ openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.html 15 Sep 2021 16:11:29 -0000 1.15.2.6 @@ -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. -In earlier versions of PostgreSQL (7.4), tsearch2 was a contrib module. With PostgreSQL 9.*, it was included in the standard PostgreSQL package with minor naming changes (e.g. the function "rank" became "ts_rank"). PostgreSQL 9 included a backward Index: openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.adp 7 Sep 2021 09:39:27 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.adp 15 Sep 2021 16:11:29 -0000 1.4.2.7 @@ -105,7 +105,7 @@ commands.
More information can be found on the AOLserver Daemontools page.
-Table 6.1. How it +
Table 6.1. How it Works
Index: openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.html,v diff -u -r1.27.2.5 -r1.27.2.6 --- openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.html 7 Sep 2021 09:39:27 -0000 1.27.2.5 +++ openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.html 15 Sep 2021 16:11:30 -0000 1.27.2.6 @@ -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)
Index: openacs-4/packages/acs-core-docs/www/install-qmail.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-qmail.adp,v diff -u -r1.5.2.7 -r1.5.2.8 --- openacs-4/packages/acs-core-docs/www/install-qmail.adp 7 Sep 2021 09:39:27 -0000 1.5.2.7 +++ openacs-4/packages/acs-core-docs/www/install-qmail.adp 15 Sep 2021 16:11:30 -0000 1.5.2.8 @@ -19,7 +19,7 @@ available from QMail wiki page- -
Replace sendmail with qmail's wrapper.
[root qmail-1.03]#rm -f /usr/bin/sendmail /usr/sbin/sendmail
+Replace sendmail with qmail's wrapper.
[root qmail-1.03]#rm -f /usr/bin/sendmail /usr/sbin/sendmail
[root qmail-1.03]#ln -s /var/qmail/bin/sendmail /usr/sbin/sendmail
[root qmail-1.03]# rm -f /usr/bin/sendmail /usr/sbin/sendmail @@ -55,7 +55,7 @@ chmod 644 ~alias/.qmail* /var/qmail/bin/maildirmake ~alias/Maildir/ chown -R alias.nofiles /var/qmail/alias/Maildir -Configure qmail to use the Maildir delivery format (instead of +
Configure qmail to use the Maildir delivery format (instead of mbox), and install a version of the qmail startup script modified to use Maildir.
[root alias]#echo "./Maildir" > /var/qmail/bin/.qmail
[root alias]#cp /tmp/openacs-5.9.0/packages/acs-core-docs/www/files/qmail.rc.txt /var/qmail/rc
Index: openacs-4/packages/acs-core-docs/www/install-qmail.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-qmail.html,v diff -u -r1.45.2.5 -r1.45.2.6 --- openacs-4/packages/acs-core-docs/www/install-qmail.html 7 Sep 2021 09:39:28 -0000 1.45.2.5 +++ openacs-4/packages/acs-core-docs/www/install-qmail.html 15 Sep 2021 16:11:30 -0000 1.45.2.6 @@ -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
+ pageReplace 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/MaildirConfigure qmail to use the Maildir delivery format +chown -R alias.nofiles /var/qmail/alias/Maildir
Configure qmail to use the Maildir delivery format (instead of mbox), and install a version of the qmail startup script modified to use Maildir.
[root alias]#echo "./Maildir" > /var/qmail/bin/.qmail
[root alias]#cp /tmp/openacs-5.9.0/packages/acs-core-docs/www/files/qmail.rc.txt /var/qmail/rc
[root alias]#chmod 755 /var/qmail/rc
Index: openacs-4/packages/acs-core-docs/www/install-redhat.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-redhat.adp,v diff -u -r1.5.2.8 -r1.5.2.9 --- openacs-4/packages/acs-core-docs/www/install-redhat.adp 7 Sep 2021 09:39:28 -0000 1.5.2.8 +++ openacs-4/packages/acs-core-docs/www/install-redhat.adp 15 Sep 2021 16:11:30 -0000 1.5.2.9 @@ -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
Choose your timezone and click
check Editors
-(this installs emacs),click Details
next +(this installs emacs),click Details
next toText-based Internet
, checklynx
, and click;
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,uncheck isdn4k-utils
+(required for the photo-album packages,uncheck isdn4k-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 -r1.44.2.6 -r1.44.2.7 --- openacs-4/packages/acs-core-docs/www/install-redhat.html 7 Sep 2021 09:39:28 -0000 1.44.2.6 +++ openacs-4/packages/acs-core-docs/www/install-redhat.html 15 Sep 2021 16:11:30 -0000 1.44.2.7 @@ -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 clickOn the pop-up window asking "Are you sure you want to do this?" click
- IF YOU ARE WIPING YOUR HARD DRIVE.
Click
on the boot loader screen
Click
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 @@ -75,7 +75,7 @@
Mail (SMTP)
. In theOther ports
box, enter443, 8000, 8443
. Click. -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
Choose your timezone and click
.
Type in a root password, twice.
On the Package selection page, we're going to @@ -87,13 +87,13 @@ risk that's still screened by the firewall, or a resource hog. Just don't install a database or web server, because that would conflict with the database and web server we'll install later. -
At the bottom, check
Select Individual Packages
and clickWe need to fine-tune the exact list of packages. +
At the bottom, check
Select Individual Packages
and clickWe 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.Red Hat isn't completely happy with the combination +list of packages will appear.
Red Hat isn't completely happy with the combination of packages we've selected, and wants to satisfy some dependencies. Don't let it. On the next screen, choose
Ignore Package @@ -119,7 +119,7 @@ upgrading all of that. Since you are upgrading the kernel, reboot after this step.
Lock down SSH
- + SSH is the protocol we use to connect securely to the computer (replacing telnet, which is insecure). sshd is the daemon that listens for incoming Index: openacs-4/packages/acs-core-docs/www/install-steps.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-steps.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/install-steps.adp 7 Sep 2021 09:39:28 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/install-steps.adp 15 Sep 2021 16:11:31 -0000 1.4.2.7 @@ -99,8 +99,8 @@
+Table 2.1. Default directories for a standard install
@@ -111,7 +111,7 @@ 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 Index: openacs-4/packages/acs-core-docs/www/install-steps.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-steps.html,v diff -u -r1.38.2.5 -r1.38.2.6 --- openacs-4/packages/acs-core-docs/www/install-steps.html 7 Sep 2021 09:39:29 -0000 1.38.2.5 +++ openacs-4/packages/acs-core-docs/www/install-steps.html 15 Sep 2021 16:11:31 -0000 1.38.2.6 @@ -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
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 +createdb $OPENACS_SERVICE_NAME Setting a global shell variable for cut and paste. In order to cut and paste the instructions into your shell, you must set the environment variable $OPENACS_SERVICE_NAME. In order to set it globally so that it works for any new users or special service users you may create, edit the file
/etc/profile
(/etc/share/skel/dot.profile
for FreeBSD) and add this line:export OPENACS_SERVICE_NAME=service0
Table 2.1. Default directories for a standard install
Index: openacs-4/packages/acs-core-docs/www/ix01.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/ix01.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/ix01.adp 7 Sep 2021 09:39:29 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/ix01.adp 15 Sep 2021 16:11:31 -0000 1.4.2.7 @@ -8,23 +8,23 @@ rightLink="" rightLabel="">
A
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
L
-
- language
- installation, Install Red Hat 8/9 -
- Linking, Links -
- lists, Lists +
- language
- installation, Install Red Hat 8/9 +
- Linking, Links +
- lists, Lists
P
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
-
Index: openacs-4/packages/acs-core-docs/www/ix01.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/ix01.html,v diff -u -r1.32.2.5 -r1.32.2.6 --- openacs-4/packages/acs-core-docs/www/ix01.html 7 Sep 2021 09:39:29 -0000 1.32.2.5 +++ openacs-4/packages/acs-core-docs/www/ix01.html 15 Sep 2021 16:11:31 -0000 1.32.2.6 @@ -1,3 +1,3 @@ -- XML guidelines, OpenACS +
- XML guidelines, OpenACS Documentation Strategy: Why DocBook? -
- xref
- linkend, Links -
- xreflabel, Headlines, +
- xref
- linkend, Links +
- xreflabel, Headlines, Sections
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
Index Index: openacs-4/packages/acs-core-docs/www/maint-performance.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/maint-performance.adp,v diff -u -r1.4.2.7 -r1.4.2.8 --- openacs-4/packages/acs-core-docs/www/maint-performance.adp 7 Sep 2021 09:39:30 -0000 1.4.2.7 +++ openacs-4/packages/acs-core-docs/www/maint-performance.adp 15 Sep 2021 16:11:31 -0000 1.4.2.8 @@ -31,7 +31,7 @@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
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.
@@ -109,7 +109,7 @@ query, install "autotrace". I usually follow the instructions here http://asktom.oracle.com/~tkyte/article1/autotrace.html.The Oracle Cost Based optimizer is a piece of software that tries to find the "optimal" execution plan for a given SQL statement. For that it estimates the costs of running a SQL Index: openacs-4/packages/acs-core-docs/www/maint-performance.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/maint-performance.html,v diff -u -r1.32.2.5 -r1.32.2.6 --- openacs-4/packages/acs-core-docs/www/maint-performance.html 7 Sep 2021 09:39:30 -0000 1.32.2.5 +++ openacs-4/packages/acs-core-docs/www/maint-performance.html 15 Sep 2021 16:11:32 -0000 1.32.2.6 @@ -2,7 +2,7 @@
Diagnosing Performance Problems
Did performance problems happen overnight, or did they sneak up on you? Any clue what caused the performance problems (e.g. loading 20K users into .LRN)
Is the filesystem out of space? Is the machine swapping to disk constantly?
Isolating and solving database problems.
Without daily internal maintenance, most databases slowly degrade in performance. For PostGreSQL, see the section called “Vacuum Postgres nightly”. For Oracle, use
exec dbms_stats.gather_schema_stats('SCHEMA_NAME')
(Andrew Piskorski's Oracle notes).You can track the exact amount of time each database query on a page takes:
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.
Identify a runaway Oracle query: first, use
ps aux
ortop
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.
Identify a runaway Oracle query: first, use
ps aux
ortop
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. -
+
The Oracle Cost Based optimizer is a piece of software that tries to find the "optimal" execution plan for a given SQL statement. For that it estimates the costs of running a SQL query in a particular way (by default Index: openacs-4/packages/acs-core-docs/www/maintenance-deploy.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/maintenance-deploy.adp,v diff -u -r1.5.2.7 -r1.5.2.8 --- openacs-4/packages/acs-core-docs/www/maintenance-deploy.adp 7 Sep 2021 09:39:30 -0000 1.5.2.7 +++ openacs-4/packages/acs-core-docs/www/maintenance-deploy.adp 15 Sep 2021 16:11:32 -0000 1.5.2.8 @@ -24,7 +24,7 @@ working configuration safely and quickly.
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 ...
The approach taken in this section is to always create a new service with the desired changes, running in parallel with the existing site. This guarantees control, at least at the final step of the process: you know what changes you are about to make because @@ -118,28 +118,28 @@ risk losing data in the shuffle. It also requires extra steps if the database will be affected.
Index: openacs-4/packages/acs-core-docs/www/maintenance-deploy.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/maintenance-deploy.html,v diff -u -r1.28.2.5 -r1.28.2.6 --- openacs-4/packages/acs-core-docs/www/maintenance-deploy.html 7 Sep 2021 09:39:30 -0000 1.28.2.5 +++ openacs-4/packages/acs-core-docs/www/maintenance-deploy.html 15 Sep 2021 16:11:32 -0000 1.28.2.6 @@ -2,7 +2,7 @@
Staged Deployment for Production Networks + run the upgrade scripts from the package manager.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.
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.
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 ...
The approach taken in this section is to always create a new service with the desired changes, running in parallel with the existing site. This guarantees control, at least at the final step of the process: you know what changes you are about to make because you can see them directly. It does not, by itself, guarantee the entire control chain. You need additional measures to make sure that the change you are making is exactly and completely the change you intended to make and tested previously, and nothing more. Those additional measures typically take the form of source control tags and system version numbers. The parallel-server approach also guarantees rollback because the original working service is not touched; it is merely set aside.
This approach can has limitations. If the database or filesystem regularly receiving new data, you must interrupt this function or risk losing data in the shuffle. It also requires extra steps if the database will be affected.
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 ...
Index: openacs-4/packages/acs-core-docs/www/objects.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/objects.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/objects.adp 7 Sep 2021 09:39:30 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/objects.adp 15 Sep 2021 16:11:32 -0000 1.4.2.7 @@ -86,7 +86,7 @@ for the PG version) file created when we created the package. Then, do the following:The approach taken in this section is to always create a new service with the desired changes, running in parallel with the existing site. This guarantees control, at least at the final step of the process: you know what changes you are about to make because you can see them directly. It does not, by itself, guarantee the entire control chain. You need additional measures to make sure that the change you are making is exactly and completely the change you intended to make and tested previously, and nothing more. Those additional measures typically take the form of source control tags and system version numbers. The parallel-server approach also guarantees rollback because the original working service is not touched; it is merely set aside.
This approach can has limitations. If the database or filesystem regularly receiving new data, you must interrupt this function or risk losing data in the shuffle. It also requires extra steps if the database will be affected.
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.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 typenote
, but also anacs_object
. The new table definition looks @@ -166,7 +166,7 @@acs_objects
.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.The PL/SQL package body contains the implementations of the procedures defined above. The only subtle thing going on here is that we must use
acs_object.new
Index: openacs-4/packages/acs-core-docs/www/objects.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/objects.html,v diff -u -r1.55.2.5 -r1.55.2.6 --- openacs-4/packages/acs-core-docs/www/objects.html 7 Sep 2021 09:39:31 -0000 1.55.2.5 +++ openacs-4/packages/acs-core-docs/www/objects.html 15 Sep 2021 16:11:33 -0000 1.55.2.6 @@ -79,7 +79,7 @@ Fire up your text editor and open theROOT/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: -+
First, add an entry to the
acs_object_types
table with the following PL/SQL call:begin @@ -139,7 +139,7 @@ because the new typenote
is a subtype ofacs_object
, it will inherit these attributes, so there is no need for us to define them. -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 theacs_objects
table to find objects will transparently find any objects that are instances of any subtype ofacs_objects
. -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. -
The PL/SQL package body contains the implementations of the procedures defined above. The only subtle thing going on here is that we must use
acs_object.new
to insert a row into Index: openacs-4/packages/acs-core-docs/www/openacs.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/openacs.adp,v diff -u -r1.4.2.7 -r1.4.2.8 --- openacs-4/packages/acs-core-docs/www/openacs.adp 7 Sep 2021 09:39:31 -0000 1.4.2.7 +++ openacs-4/packages/acs-core-docs/www/openacs.adp 15 Sep 2021 16:11:33 -0000 1.4.2.8 @@ -314,7 +314,7 @@ automate vacuuming is to edit the cron file for the database user. Recommended:VACUUM ANALYZE
every hour andVACUUM FULL -ANALYZE
every day.[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$export EDITOR=emacs;crontab -e
+ANALYZE every day.[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$export EDITOR=emacs;crontab -e
Add these lines to the file. The vacuum command cleans up temporary structures within a PostGreSQL database, and can improve performance. We vacuum gently every hour and completely every day. @@ -346,7 +346,7 @@ specific port, e.g. port 80. In order for OpenACS to work, you need to configure a virtual server. The Reference Platform uses a configuration file included in the OpenACS tarball,
/var/lib/aolserver/$OPENACS_SERVICE_NAME/etc/config.tcl
. -Open it in an editor to adjust the parameters.[root root]#su - $OPENACS_SERVICE_NAME +Open it in an editor to adjust the parameters.
[root root]#su - $OPENACS_SERVICE_NAME
[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/etc
[$OPENACS_SERVICE_NAME etc]$emacs config.tcl
Index: openacs-4/packages/acs-core-docs/www/openacs.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/openacs.html,v diff -u -r1.54.2.5 -r1.54.2.6 --- openacs-4/packages/acs-core-docs/www/openacs.html 7 Sep 2021 09:39:31 -0000 1.54.2.5 +++ openacs-4/packages/acs-core-docs/www/openacs.html 15 Sep 2021 16:11:33 -0000 1.54.2.6 @@ -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_NAMEAutomate 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 andVACUUM 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_NAMEAutomate 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 andVACUUM 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_NAMEDepending on your distribution, you may receive email when the crontab items are executed. If you don't want to receive email for those crontab items, @@ -250,7 +250,7 @@ need to configure a virtual server. The Reference Platform uses a configuration file included in the OpenACS tarball,
/var/lib/aolserver/$OPENACS_SERVICE_NAME/etc/config.tcl
. - Open it in an editor to adjust the parameters.[root root]#su - $OPENACS_SERVICE_NAME
+ Open it in an editor to adjust the parameters.[root root]#su - $OPENACS_SERVICE_NAME
[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/etc
[$OPENACS_SERVICE_NAME etc]$emacs config.tcl
Index: openacs-4/packages/acs-core-docs/www/packages.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/packages.adp,v diff -u -r1.7.2.7 -r1.7.2.8 --- openacs-4/packages/acs-core-docs/www/packages.adp 7 Sep 2021 09:39:32 -0000 1.7.2.7 +++ openacs-4/packages/acs-core-docs/www/packages.adp 15 Sep 2021 16:11:34 -0000 1.7.2.8 @@ -25,7 +25,7 @@
Here is how an OpenACS 5 server is laid out starting from the Server root (ROOT):
-Figure 11.1. Server file layout +
Figure 11.1. Server file layout diagram
ROOT/ bin/ @@ -64,7 +64,7 @@ To illustrate the general structure of a package, let's see what the package for the "notes" application should look like.-Figure 11.2. Package file layout +
Figure 11.2. Package file layout diagram
ROOT/ +-- packages/ APM Root @@ -134,7 +134,7 @@ files are not sourced in these directories. This makes it suitable for storing icons, css files, javascript, and other static content which can be treated this way.-Table 11.1. Package +
Table 11.1. Package files
Index: openacs-4/packages/acs-core-docs/www/packages.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/packages.html,v diff -u -r1.57.2.6 -r1.57.2.7 --- openacs-4/packages/acs-core-docs/www/packages.html 7 Sep 2021 09:39:32 -0000 1.57.2.6 +++ openacs-4/packages/acs-core-docs/www/packages.html 15 Sep 2021 16:11:34 -0000 1.57.2.7 @@ -13,7 +13,7 @@ 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 -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.adp 7 Sep 2021 09:39:32 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.adp 15 Sep 2021 16:11:35 -0000 1.4.2.7 @@ -127,7 +127,7 @@ Context Hierarchy Suppose objects A, B, ..., and F form the following hierarchy.
This can be represented in the acs_objects table by the following entries:
-Table 11.3. acs_objects example +
Table 11.3. acs_objects example data
Index: openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.html,v diff -u -r1.49.2.5 -r1.49.2.6 --- openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.html 7 Sep 2021 09:39:33 -0000 1.49.2.5 +++ openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.html 15 Sep 2021 16:11:35 -0000 1.49.2.6 @@ -105,7 +105,7 @@ 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: -+
The first entry tells us that object 20 is the descendant of object 10, and the third entry shows that object 40 is the descendant of object 20. By running a CONNECT BY query, Index: openacs-4/packages/acs-core-docs/www/psgml-for-emacs.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/psgml-for-emacs.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/psgml-for-emacs.adp 7 Sep 2021 09:39:33 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/psgml-for-emacs.adp 15 Sep 2021 16:11:36 -0000 1.4.2.7 @@ -11,7 +11,7 @@
- If you plan to write or edit any + If you plan to write or edit any documentation with emacs, install a customized emacs configuration file with DocBook commands in the skeleton directory, so it will be used for all new users. The file also fixes the backspace -> Index: openacs-4/packages/acs-core-docs/www/psgml-for-emacs.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/psgml-for-emacs.html,v diff -u -r1.44.2.5 -r1.44.2.6 --- openacs-4/packages/acs-core-docs/www/psgml-for-emacs.html 7 Sep 2021 09:39:33 -0000 1.44.2.5 +++ openacs-4/packages/acs-core-docs/www/psgml-for-emacs.html 15 Sep 2021 16:11:36 -0000 1.44.2.6 @@ -1,5 +1,5 @@ -
Add PSGML commands to emacs init file (OPTIONAL) Add PSGML commands to emacs init file (OPTIONAL) If you plan to write or edit any documentation with emacs, install a customized emacs configuration file with DocBook commands in the skeleton directory, so it will be used for all new users. The file also Index: openacs-4/packages/acs-core-docs/www/release-notes.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/release-notes.adp,v diff -u -r1.8.2.9 -r1.8.2.10 --- openacs-4/packages/acs-core-docs/www/release-notes.adp 7 Sep 2021 09:39:34 -0000 1.8.2.9 +++ openacs-4/packages/acs-core-docs/www/release-notes.adp 15 Sep 2021 16:11:36 -0000 1.8.2.10 @@ -19,11 +19,7 @@
Functional improvements
Features:
--
Added additional page_contract filter: oneof(red|green|blue)
-
template::add_event_listener
-andtemplate::add_confirm_handler
now can -target elements by CSS selectorAdded text/markdown to the accepted text formats or rich-text -widget
- +
Support for range types in .xql files:
PostgreSQL supports range types since 9.5. When using range types, square braces have to be used in SQL statements. Since OpenACS uses always Tcl substitution in .xql files, and OpenACS @@ -35,13 +31,6 @@ for
--subst
areall
,none
,vars
, andcommands
, default isall
which is exactly the behavior of previous releases. Therefore, this change is fully backward compatible.Improved API browser: Visualization for code dependencies (which -procs calls what, from where is a proc being called) and -test-coverage
Warn site administrators about expiring certificates
- -
Additional input types (and widgets) for
ad_form
:-
checkbox_text
color
tel
url
number
file (multiple)
- -
h5date and h5time: date and time fields using native HTML5 -visualization and input normalization
Registry for .js and .css libraries: allow besides classical URLs symbolic names for loading external resources (e.g. jquery), @@ -73,7 +62,18 @@ template::head::includes -container urn:js::style.js -parts {urn:ad:js:jquery ...}
Improved support for streaming HTML: The new API function +
Improved API browser: Visualization for code dependencies (which +procs calls what, from where is a proc being called) and +test-coverage
Warn site administrators about expiring certificates
Added text/markdown to the accepted text formats or rich-text +widget
- +
Additional input types (and widgets) for
ad_form
:++
checkbox_text
color
tel
url
number
file (multiple)
- +
h5date and h5time: date and time fields using native HTML5 +visualization and input normalization
Added additional page_contract filter: oneof(red|green|blue)
+
template::add_event_listener
+andtemplate::add_confirm_handler
now can +target elements by CSS selectorImproved support for streaming HTML: The new API function
template::collect_body_scripts
can be used to get the content of template::script or CSP calls (template::add_body_script
, @@ -86,21 +86,6 @@- -
Reforms:
- -
Dynamic blueprint reloading:
--
When reloading apm packages, watched files, etc. the NaviServer -blueprint is now updated correctly. This solves the long-standing -problem that changes for scheduled procedures required a restart of -the server. Furthermore, the old-style reloading was based on a -ever-growing list of reload operations each time a new reload was -requested, causing slow-downs in long running server instances, -especially, when new threads are started.
Now changes are applied to all NaviServer threads, including -threads for schedules procedures, ns_jobs and the like. Note that -the current job has to be finished before the changes can be -applied.
- -
For the transition, it is possible to switch between the -classical reloading style and blueprint reloading by changing a -variable in acs-tcl/tcl/apm-procs.tcl
Login:
@@ -385,7 +371,7 @@ February 2021), tdom 0.9
Get rid of bugging "login page expired" messages. The 17 years old construct was replaced by newer means to avoid caching of form values from the login form. Admins of existing sites should @@ -184,7 +169,8 @@ many user administration tests outside the context of a "real authority": in cases where the real authority depends on external services to proof identity, (e.g. Kerberos), those tests -would just fail.
Introduce the display of warnings in the UI
Added test coverage information in the automated testing pages, +would just fail.
Introduce the display of warnings in the UI of automated +testing
Added test coverage information in the automated testing pages, using the new proc-coverage API and providing test coverage information for packages and system wide.
Increased overall coverage of public API
New tests checking various data-model properties and smells
Altogether, OpenACS 5.10.0 differs from OpenACS 5.9.1 by the following statistics
- 3442 files changed, 120847 insertions(+), 92002 deletions(-) + 3445 files changed, 215464 insertions(+), 193642 deletions(-)contributed by 7 committers (Antonio Pisano, Gustaf Neumann, Günter Ernst, Hector Romojaro, Michael Aram, Stefan Sobernig, Thomas Renner) and additional 13 patch/bugfix providers (Felix @@ -1201,20 +1187,20 @@ turned off by default via the acs-kernel parameter ExcludedFiles in section request-processor (The variable provides a string match glob list of files and is defaulted to "*/CVS/* *~")
($Id: release-notes.xml,v 1.39.2.5 2021/09/06 -17:42:35 gustafn Exp $)+($Id: release-notes.xml,v 1.39.2.6 2021/09/07 +09:39:44 gustafn Exp $)Functional improvements
Features: -
Added additional page_contract filter: oneof(red|green|blue)
template::add_event_listener
andtemplate::add_confirm_handler
now can target elements by CSS selectorAdded text/markdown to the accepted text formats or rich-text widget
Support for range types in .xql files: +
Support for range types in .xql files:
PostgreSQL supports range types since 9.5. When using range types, square braces have to be used in SQL statements. Since OpenACS uses always Tcl substitution in .xql files, and OpenACS does NOT allow backslash substitution in these files, square brackets could not be escaped and therefore not be used in .xql files so far. This change allows now a developer to deactivate the substitution by passing e.g.
-subst none
to the db_* command using the .xql file. Valid values for-subst
areall
,none
,vars
, andcommands
, default isall
which is exactly the behavior of previous releases. Therefore, this change is fully backward compatible.-
Improved API browser: Visualization for code dependencies (which procs calls what, from where is a proc being called) and test-coverage
Warn site administrators about expiring certificates
Additional input types (and widgets) for
ad_form
: -
checkbox_text
color
tel
url
number
file (multiple)
h5date and h5time: date and time fields using native HTML5 visualization and input normalization
Registry for .js and .css libraries: allow besides classical URLs symbolic names for loading external resources (e.g. jquery), this makes it easier to upgrade libraries in multiple packages (without running into problems with duplicate versions) and supports switching between CDN and local pathsURN. The existing implementation is based on URNs and extends the existing template-head API to support registration for URNs. A URN provides an abstraction and a single place for e.g. updating references to external resources when switching between a CDN and a locally stored resource, or when a resource should be updated. Instead of adding e.g. a CDN URL via template::head::add_script, one can add an URN and control its content from a single place. Use common namespaces for OpenACS such as
urn:ad:css:*
andurn:ad:js:*
.
Register URNs:
@@ -31,13 +29,13 @@
template::head::includes -container urn:js::style.js -parts {urn:ad:js:jquery ...}
-
+
Improved API browser: Visualization for code dependencies (which procs calls what, from where is a proc being called) and test-coverage
Warn site administrators about expiring certificates
Added text/markdown to the accepted text formats or rich-text widget
Additional input types (and widgets) for
ad_form
: +
checkbox_text
color
tel
url
number
file (multiple)
h5date and h5time: date and time fields using native HTML5 visualization and input normalization
+
Added additional page_contract filter: oneof(red|green|blue)
template::add_event_listener
andtemplate::add_confirm_handler
now can target elements by CSS selector
Improved support for streaming HTML: The new API function
template::collect_body_scripts
can be used to get the content of template::script or CSP calls (template::add_body_script
,template::add_event_listener
,template::add_body_handler
,template::add_script
) when streaming HTML (incremental HTML) is used. Before, these call could bot be used for streaming HTML.
Reforms: -
+
Dynamic blueprint reloading: -
When reloading apm packages, watched files, etc. the NaviServer blueprint is now updated correctly. This solves the long-standing problem that changes for scheduled procedures required a restart of the server. Furthermore, the old-style reloading was based on a ever-growing list of reload operations each time a new reload was requested, causing slow-downs in long running server instances, especially, when new threads are started.
Now changes are applied to all NaviServer threads, including threads for schedules procedures, ns_jobs and the like. Note that the current job has to be finished before the changes can be applied.
For the transition, it is possible to switch between the classical reloading style and blueprint reloading by changing a variable in acs-tcl/tcl/apm-procs.tcl
-
Login: +
Login:
Get rid of bugging "login page expired" messages. The 17 years old construct was replaced by newer means to avoid caching of form values from the login form. Admins of existing sites should set the kernel parameter
LoginPageExpirationTime
to 0
Forums:
Removed hard-coded dependency with registered_users group when checking forum permissions
Don't rely so heavily on acs_permissions to model forum configuration, as this can have unexpected consequences in convoluted multi-group/multi-subsite scenarios. Prefer simpler table attributes instead
New style of attachments to the forums, allowing multiple attachments to a single message directly from the message post page, using the multiple file input widget. Retain compatibility with old style attachments, using the new 'AttachmentStyle' package instance parameter. Currently, this supports two values: 'simple' (new behavior) and 'complex' previous behavior.
@@ -55,7 +53,7 @@
Non-functional Changes
Improved automated regression test infrastructure and test coverage -
All packages in the
oacs-5-10
branch pass regression testWeb testing was separated from non-maintained tcltest and was built on the standard OpenACS infrastructure
Include web testing per default in standard regression testing
Introduced new test authentication authority, allowing to run many user administration tests outside the context of a "real authority": in cases where the real authority depends on external services to proof identity, (e.g. Kerberos), those tests would just fail.
Introduce the display of warnings in the UI
Added test coverage information in the automated testing pages, using the new proc-coverage API and providing test coverage information for packages and system wide.
Increased overall coverage of public API
New tests checking various data-model properties and smells +
All packages in the
oacs-5-10
branch pass regression testWeb testing was separated from non-maintained tcltest and was built on the standard OpenACS infrastructure
Include web testing per default in standard regression testing
Introduced new test authentication authority, allowing to run many user administration tests outside the context of a "real authority": in cases where the real authority depends on external services to proof identity, (e.g. Kerberos), those tests would just fail.
Introduce the display of warnings in the UI of automated testing
Added test coverage information in the automated testing pages, using the new proc-coverage API and providing test coverage information for packages and system wide.
Increased overall coverage of public API
New tests checking various data-model properties and smells
Improved scalability:
@@ -108,7 +106,7 @@
Require Tcl 8.6, XOTcl 2.1, PostgreSQL 9.6 (PostgreSQL 9.5 EOL: February 2021), tdom 0.9
Altogether, OpenACS 5.10.0 differs from OpenACS 5.9.1 by the following statistics
- 3442 files changed, 120847 insertions(+), 92002 deletions(-) + 3445 files changed, 215464 insertions(+), 193642 deletions(-)contributed by 7 committers (Antonio Pisano, Gustaf Neumann, Günter Ernst, Hector Romojaro, Michael Aram, Stefan Sobernig, Thomas Renner) and additional 13 patch/bugfix providers (Felix Mödritscher, Florian Mosböck, Frank Bergmann, Franz Penz, Hanifa Hasan, Keith Paskett, Markus Moser, Maurizio Martignano, Monika Andergassen, Nathan Coulter, Rainer Bachleitner, Stephan Adelsberger, Tony Kirkham). @@ -1286,4 +1284,4 @@
Serving backup files and files from the CVS directories is turned off by default via the acs-kernel parameter ExcludedFiles in section request-processor (The variable provides a string match glob list of files and is defaulted to "*/CVS/* *~") -
($Id$)($Id$)Index: openacs-4/packages/acs-core-docs/www/tutorial-css-layout.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-css-layout.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/tutorial-css-layout.adp 7 Sep 2021 09:39:39 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/tutorial-css-layout.adp 15 Sep 2021 16:11:40 -0000 1.4.2.7 @@ -12,7 +12,7 @@ Laying out a page with CSS instead of tablesA sample of the HTML code (full source)
<table border="0" width="100%"> <tr> <td valign="top" width="50%"> @@ -38,7 +38,7 @@ MBA 101A sample of the HTML code (full source)
<div class="left"> +.LRN Home with CSS-based layoutA sample of the HTML code (full source)
<div class="left"> <div class="portlet-wrap-shadow"> <div class="portlet-wrap-bl"> <div class="portlet-wrap-tr"> Index: openacs-4/packages/acs-core-docs/www/tutorial-css-layout.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-css-layout.html,v diff -u -r1.15.2.5 -r1.15.2.6 --- openacs-4/packages/acs-core-docs/www/tutorial-css-layout.html 7 Sep 2021 09:39:39 -0000 1.15.2.5 +++ openacs-4/packages/acs-core-docs/www/tutorial-css-layout.html 15 Sep 2021 16:11:41 -0000 1.15.2.6 @@ -1,5 +1,5 @@ -Laying out a page with CSS instead of tables Index: openacs-4/packages/acs-core-docs/www/tutorial-database.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-database.adp,v diff -u -r1.4.2.7 -r1.4.2.8 --- openacs-4/packages/acs-core-docs/www/tutorial-database.adp 7 Sep 2021 09:39:39 -0000 1.4.2.7 +++ openacs-4/packages/acs-core-docs/www/tutorial-database.adp 15 Sep 2021 16:11:41 -0000 1.4.2.8 @@ -15,7 +15,7 @@ OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff.A sample of the HTML code (full source)
<table border="0" width="100%"> +Laying out a page with CSS instead of tables +[$OPENACS_SERVICE_NAME myfirstpackage]$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 101Index: openacs-4/packages/acs-core-docs/www/tutorial-cvs.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-cvs.html,v diff -u -r1.29.2.5 -r1.29.2.6 --- openacs-4/packages/acs-core-docs/www/tutorial-cvs.html 7 Sep 2021 09:39:39 -0000 1.29.2.5 +++ openacs-4/packages/acs-core-docs/www/tutorial-cvs.html 15 Sep 2021 16:11:41 -0000 1.29.2.6 @@ -59,4 +59,4 @@ initial revision: 1.1 done (many lines omitted) -[$OPENACS_SERVICE_NAME myfirstpackage]$A sample of the HTML code (full source)
<div class="left"> <div class="portlet-wrap-shadow"> <div class="portlet-wrap-bl"> <div class="portlet-wrap-tr"> Index: openacs-4/packages/acs-core-docs/www/tutorial-cvs.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-cvs.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/tutorial-cvs.adp 7 Sep 2021 09:39:39 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/tutorial-cvs.adp 15 Sep 2021 16:11:41 -0000 1.4.2.7 @@ -69,7 +69,7 @@ done (many lines omitted) [$OPENACS_SERVICE_NAME myfirstpackage]$
We create all database objects with scripts in the
myfirstpackage/sql/
directory. All database +Code the data modelWe create all database objects with scripts in the
myfirstpackage/sql/
directory. All database scripts are database-specific and are thus in either themyfirstpackage/sql/oracle
ormyfirstpackage/sql/postgresql
@@ -42,15 +42,15 @@ simplify our database creation. (More information about ACS Objects. More information about the Content Repository.)The top of each SQL file has some standard comments, including doc tags such as
\@author
which will be picked up by the API browser. The string$Id:$
will automatically be expanded when the file is checked in to cvs.[$OPENACS_SERVICE_NAME ~]$cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/sql/postgresql
[$OPENACS_SERVICE_NAME postgresql]$emacs myfirstpackage-create.sql
Paste the text below into the file, save, and close.
-Figure 9.3. The Database +
Figure 9.3. The Database Creation Script
-- creation script -- -- \@author joel\@aufrecht.org @@ -79,7 +79,7 @@ uninstalled.[$OPENACS_SERVICE_NAME postgresql]$emacs myfirstpackage-drop.sql
-Figure 9.4. Database Deletion +
Figure 9.4. Database Deletion Script
-- drop script -- -- \@author joel\@aufrecht.org Index: openacs-4/packages/acs-core-docs/www/tutorial-database.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-database.html,v diff -u -r1.47.2.5 -r1.47.2.6 --- openacs-4/packages/acs-core-docs/www/tutorial-database.html 7 Sep 2021 09:39:39 -0000 1.47.2.5 +++ openacs-4/packages/acs-core-docs/www/tutorial-database.html 15 Sep 2021 16:11:41 -0000 1.47.2.6 @@ -2,7 +2,7 @@Setting Up Database Objects We create all database objects with scripts in the
myfirstpackage/sql/
directory. All database scripts are database-specific and are thus in either themyfirstpackage/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.) -The top of each SQL file has some +
The top of each SQL file has some standard comments, including doc tags such as
@author
which will be picked up by the API browser. The string$Id$
will automatically be expanded when the file is checked in to cvs.[$OPENACS_SERVICE_NAME ~]$cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/sql/postgresql
-[$OPENACS_SERVICE_NAME postgresql]$emacs myfirstpackage-create.sql
Paste the text below into the file, save, and close.
Figure 9.3. The Database Creation Script
-- creation script +[$OPENACS_SERVICE_NAME postgresql]$emacs myfirstpackage-create.sql
Paste the text below into the file, save, and close.
Figure 9.3. The Database Creation Script
-- creation script -- -- @author joel@aufrecht.org -- @cvs-id &Id:$ @@ -62,7 +62,7 @@ object. Notice the use of "mfp." This is derived from "My First Package" and ensures that our object is unlikely to conflict with objects from other packages.Create a database file to drop everything if the package is uninstalled.
-[$OPENACS_SERVICE_NAME postgresql]$emacs myfirstpackage-drop.sql
Figure 9.4. Database Deletion Script
-- drop script +[$OPENACS_SERVICE_NAME postgresql]$emacs myfirstpackage-drop.sql
Figure 9.4. Database Deletion Script
-- drop script -- -- @author joel@aufrecht.org -- @cvs-id &Id:$ Index: openacs-4/packages/acs-core-docs/www/tutorial-debug.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-debug.adp,v diff -u -r1.4.2.7 -r1.4.2.8 --- openacs-4/packages/acs-core-docs/www/tutorial-debug.adp 7 Sep 2021 09:39:40 -0000 1.4.2.7 +++ openacs-4/packages/acs-core-docs/www/tutorial-debug.adp 15 Sep 2021 16:11:41 -0000 1.4.2.8 @@ -15,7 +15,7 @@ OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff.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 @@
Make a list of basic tests to make sure it works
+Manual testing
Make a list of basic tests to make sure it works
@@ -69,11 +69,11 @@ to delete your own note. Edit your own note. Search for a note. Test Num Action Expected Result - 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.
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.
Now we can add the rest of the API tests, including a test with deliberately bad data. The complete test looks like:
ad_library { Test cases for my first package. } Index: openacs-4/packages/acs-core-docs/www/tutorial-debug.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-debug.html,v diff -u -r1.46.2.5 -r1.46.2.6 --- openacs-4/packages/acs-core-docs/www/tutorial-debug.html 7 Sep 2021 09:39:40 -0000 1.46.2.5 +++ openacs-4/packages/acs-core-docs/www/tutorial-debug.html 15 Sep 2021 16:11:42 -0000 1.46.2.6 @@ -2,7 +2,7 @@Debugging and Automated Testing 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.
-
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 + 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.
It seems to me that a lot of people have been asking for some guidelines on how to write automated tests. I've done several tests by now and have found the process to be extremely easy and useful. It's a joy to work with automated testing once you get the hang of it.
Create the directory that will contain the test script and edit the script file. The directory location and filename are standards which are recognized by the automated testing package:
[$OPENACS_SERVICE_NAME www]$mkdir /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/tcl/test
[$OPENACS_SERVICE_NAME www]$cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/tcl/test
@@ -68,7 +68,7 @@ goes inside-test_code {}
. We want to implement test case API-001, "Given an object id from API-001, invoke mfp::note::get. Proc should return the specific word in the title."set name [ad_generate_random_string] set new_id [mfp::note::add -title $name] - aa_true "Note add succeeded" {$new_id ne ""}To test our simple case, we must load the test file into the system (just as with the /tcl file in the basic tutorial, since the file didn't exist when the system started, the system doesn't know about it.) To make this file take effect, go to the APM and choose "Reload changed" for "MyFirstPackage". Since we'll be changing it frequently, select "watch this file" on the next page. This will cause the system to check this file every time any page is requested, which is bad for production systems but convenient for developing. We can also add some aa_register_case flags to make it easier to run the test. The
-procs
flag, which indicates which procs are tested by this test case, makes it easier to find procs in your package that aren't tested at all. The-cats
flag, setting categories, makes it easier to control which tests to run. Thesmoke
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.
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.
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. Thesmoke
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.
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.
Now we can add the rest of the API tests, including a test with deliberately bad data. The complete test looks like:
ad_library { Test cases for my first package. } Index: openacs-4/packages/acs-core-docs/www/tutorial-distribute.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-distribute.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/tutorial-distribute.adp 7 Sep 2021 09:39:40 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/tutorial-distribute.adp 15 Sep 2021 16:11:42 -0000 1.4.2.7 @@ -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 labelDistribution 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.Package development guidelines
Index: openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.adp 7 Sep 2021 09:39:41 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.adp 15 Sep 2021 16:11:42 -0000 1.4.2.7 @@ -80,7 +80,7 @@The template should provide us with the following ETP layout:
-Table 10.1. table showing ETP +
Table 10.1. table showing ETP layout
Index: openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.html,v diff -u -r1.12.2.5 -r1.12.2.6 --- openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.html 7 Sep 2021 09:39:41 -0000 1.12.2.5 +++ openacs-4/packages/acs-core-docs/www/tutorial-etp-templates.html 15 Sep 2021 16:11:42 -0000 1.12.2.6 @@ -13,5 +13,5 @@ cvs -d:pserver:anonymous@openacs.org:/cvsroot co edit-this-page Go to the package manager at http://yoursite/acs-admin/apm. And install the new package: edit-this-page.
Or use the "Add Application" form available on the Main site.
Work out how to change the ETP application.
Investigate each of the available ETP templates:
Default
News
FAQ
Browse the files for each of the above ETP templates at:
cd ~/openacs/packages/edit-this-page/templatesUse 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.tclThe template should provide us with the following ETP layout:
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.
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.tclThe template should provide us with the following ETP layout:
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.
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.tclUse 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.
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.
Index: openacs-4/packages/acs-core-docs/www/tutorial-newpackage.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-newpackage.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/tutorial-newpackage.adp 7 Sep 2021 09:39:41 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/tutorial-newpackage.adp 15 Sep 2021 16:11:42 -0000 1.4.2.7 @@ -18,7 +18,7 @@ The intended page mapThis 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$)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.
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 @@
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).
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
.The remainder of the tutorial walks you through each file one at a time as you create the package. You can skip all this, and get a working package, by doing the following:
cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-core-docs/www/files/tutorial psql $OPENACS_SERVICE_NAME -f myfirstpackage-create.sql Index: openacs-4/packages/acs-core-docs/www/tutorial-newpackage.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-newpackage.html,v diff -u -r1.46.2.5 -r1.46.2.6 --- openacs-4/packages/acs-core-docs/www/tutorial-newpackage.html 7 Sep 2021 09:39:41 -0000 1.46.2.5 +++ openacs-4/packages/acs-core-docs/www/tutorial-newpackage.html 15 Sep 2021 16:11:42 -0000 1.46.2.6 @@ -2,7 +2,7 @@Creating an Application Package 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. -
You will need:
A computer with a working installation of +
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 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 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).In order to see your work in progress, you must create a + packages).
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
.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
.The remainder of the tutorial walks you through each file one at a time as you create the package. You can skip all this, and get a working package, by doing the following:
cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-core-docs/www/files/tutorial psql $OPENACS_SERVICE_NAME -f myfirstpackage-create.sql cp note-edit.* note-delete.tcl index.* ../../../../myfirstpackage/www/ mkdir ../../../../myfirstpackage/lib Index: openacs-4/packages/acs-core-docs/www/tutorial-pages.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-pages.adp,v diff -u -r1.6.2.6 -r1.6.2.7 --- openacs-4/packages/acs-core-docs/www/tutorial-pages.adp 7 Sep 2021 09:39:41 -0000 1.6.2.6 +++ openacs-4/packages/acs-core-docs/www/tutorial-pages.adp 15 Sep 2021 16:11:43 -0000 1.6.2.7 @@ -15,23 +15,23 @@ OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff.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".
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.
Each user-visible page in your package has, typically, three parts. The
tcl
file holds the procedural logic for the page, including Tcl and database-independent SQL code, and does things like check Index: openacs-4/packages/acs-core-docs/www/tutorial-pages.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-pages.html,v diff -u -r1.49.2.5 -r1.49.2.6 --- openacs-4/packages/acs-core-docs/www/tutorial-pages.html 7 Sep 2021 09:39:42 -0000 1.49.2.5 +++ openacs-4/packages/acs-core-docs/www/tutorial-pages.html 15 Sep 2021 16:11:43 -0000 1.49.2.6 @@ -2,8 +2,8 @@Creating Web Pages 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".
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.
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".
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.
Each user-visible page in your package has, typically, three parts. The
tcl
file holds the procedural logic for the page, including Tcl and database-independent SQL code, and does things like Index: openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.adp,v diff -u -r1.4.2.7 -r1.4.2.8 --- openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.adp 7 Sep 2021 09:39:42 -0000 1.4.2.7 +++ openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.adp 15 Sep 2021 16:11:43 -0000 1.4.2.8 @@ -8,7 +8,7 @@ rightLink="upgrade-4.6.3-to-5" rightLabel="Next">The required platform for OpenACS 4.6 is the same as 4.5, with the exception of OpenFTS. OpenACS 4.6 and later require OpenFTS 0.3.2 for full text search on PostGreSQL. If you have OpenFTS 0.2, you'll need to upgrade.
If upgrading from 4.4, you need to manually run Index: openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.html,v diff -u -r1.30.2.5 -r1.30.2.6 --- openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.html 7 Sep 2021 09:39:42 -0000 1.30.2.5 +++ openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.html 15 Sep 2021 16:11:43 -0000 1.30.2.6 @@ -1,5 +1,5 @@ -
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 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 filesystem (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 filesystem. 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 -r1.5.2.7 -r1.5.2.8 --- openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.adp 7 Sep 2021 09:39:42 -0000 1.5.2.7 +++ openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.adp 15 Sep 2021 16:11:44 -0000 1.5.2.8 @@ -11,7 +11,7 @@ Upgrading the OpenACS files
OpenACS is distributed in many different ways:
as a collection of files
as one big tarball
via CVS
via automatic download from within the APM (package manager)
Upgrades work by first changing the filesystem (via any of the @@ -25,7 +25,7 @@
Upgrading files for a site which is not in a CVS @@ -53,7 +53,7 @@ version, without overriding your own local customizations.
This diagram explains the basic idea. However, the labels are incorrect. Step 1(a) has been removed, and Step 1(b) should be labelled Step 1.
- @@ -180,7 +180,7 @@ [$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$
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 -r1.31.2.5 -r1.31.2.6 --- openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.html 7 Sep 2021 09:39:42 -0000 1.31.2.5 +++ openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.html 15 Sep 2021 16:11:44 -0000 1.31.2.6 @@ -1,5 +1,5 @@ -
Upgrading the OpenACS files OpenACS is distributed in many different ways: +
Upgrading the OpenACS files OpenACS is distributed in many different ways:
as a collection of files
as one big tarball
via CVS
via automatic download from within the APM (package manager)
Upgrades work by first changing the filesystem (via any @@ -11,7 +11,7 @@ describes whether or not you need to be upgrading using this page or not: the section called “Upgrading an OpenACS 5.0.0 or greater installation” -
Upgrading files for a site which is not in a CVS repository. Unpack the tarball into a new directory and copy its +
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.
Step 0: Set up a working CVS checkout. To get your OpenACS code into your local CVS + 1(b) should be labelled Step 1.
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]$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]$
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 -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/upgrade-overview.adp 7 Sep 2021 09:39:43 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/upgrade-overview.adp 15 Sep 2021 16:11:44 -0000 1.4.2.7 @@ -25,11 +25,11 @@ upgrade scripts, and prompt you to restart the server. After restarting the server again, the upgrade is complete.
It's always a good idea to precede an upgrade attempt with a snapshot backup.
-Table 5.1. Assumptions in this +
Table 5.1. Assumptions in this section
Index: openacs-4/packages/acs-core-docs/www/upgrade-overview.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/upgrade-overview.html,v diff -u -r1.30.2.5 -r1.30.2.6 --- openacs-4/packages/acs-core-docs/www/upgrade-overview.html 7 Sep 2021 09:39:43 -0000 1.30.2.5 +++ openacs-4/packages/acs-core-docs/www/upgrade-overview.html 15 Sep 2021 16:11:44 -0000 1.30.2.6 @@ -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.
It's always a good idea to precede an upgrade attempt with a snapshot backup.
Table 5.1. Assumptions in this section
name of OpenACS user $OPENACS_SERVICE_NAME OpenACS server name $OPENACS_SERVICE_NAME Root of OpenACS file tree /var/lib/aolserver/$OPENACS_SERVICE_NAME Database backup directory /var/lib/aolserver/$OPENACS_SERVICE_NAME/database-backup
+ OpenACS prior to 4.5, upgrading will require manual effort.If all of these conditions are true:
Your OpenACS Core is 5.0.0 or later
You do not keep your OpenACS site in a local CVS repository
You do not have any custom code
then you can upgrade automatically using the automated installer in the OpenACS Package Manager (APM), and you can probably skip the rest of this chapter. To upgrade directly from the OpenACS repository using the APM:
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.
It's always a good idea to precede an upgrade attempt with a snapshot backup.
Table 5.1. Assumptions in this section
name of OpenACS user $OPENACS_SERVICE_NAME OpenACS server name $OPENACS_SERVICE_NAME Root of OpenACS file tree /var/lib/aolserver/$OPENACS_SERVICE_NAME Database backup directory /var/lib/aolserver/$OPENACS_SERVICE_NAME/database-backup
Index: openacs-4/packages/acs-core-docs/www/variables.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/variables.adp,v diff -u -r1.4.2.6 -r1.4.2.7 --- openacs-4/packages/acs-core-docs/www/variables.adp 7 Sep 2021 09:39:43 -0000 1.4.2.6 +++ openacs-4/packages/acs-core-docs/www/variables.adp 15 Sep 2021 16:11:44 -0000 1.4.2.7 @@ -19,7 +19,7 @@ OpenACS documentation staff.Starting with OpenACS 5.0 and the introduction of acs-lang, we recommend retrieving date/time information from the database in ANSI format and then using lc_time_fmt to format it for display.
-Example 12.1. Getting datetime +
Example 12.1. Getting datetime from the database ANSI-style
db_multirow -extend { mydate_pretty } { select to_char(mydate, 'YYYY-MM-DD HH24:MI:SS') as mydate_ansi, ... Index: openacs-4/packages/acs-core-docs/www/variables.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/variables.html,v diff -u -r1.33.2.5 -r1.33.2.6 --- openacs-4/packages/acs-core-docs/www/variables.html 7 Sep 2021 09:39:43 -0000 1.33.2.5 +++ openacs-4/packages/acs-core-docs/www/variables.html 15 Sep 2021 16:11:44 -0000 1.33.2.6 @@ -4,7 +4,7 @@ by OpenACS documentation staff.Starting with OpenACS 5.0 and the introduction of acs-lang, we recommend retrieving date/time information from the database in - ANSI format and then using lc_time_fmt to format it for display.
Example 12.1. Getting datetime from the database ANSI-style
db_multirow -extend { mydate_pretty } { + ANSI format and then using lc_time_fmt to format it for display.Example 12.1. Getting datetime from the database ANSI-style
db_multirow -extend { mydate_pretty } { select to_char(mydate, 'YYYY-MM-DD HH24:MI:SS') as mydate_ansi, ... ... Index: openacs-4/packages/acs-core-docs/www/xml/for-everyone/release-notes-5-10.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/for-everyone/release-notes-5-10.xml,v diff -u -r1.1.2.3 -r1.1.2.4 --- openacs-4/packages/acs-core-docs/www/xml/for-everyone/release-notes-5-10.xml 14 Sep 2021 18:00:51 -0000 1.1.2.3 +++ openacs-4/packages/acs-core-docs/www/xml/for-everyone/release-notes-5-10.xml 15 Sep 2021 16:11:44 -0000 1.1.2.4 @@ -315,7 +315,7 @@Altogether, OpenACS 5.10.0 differs from OpenACS 5.9.1 by the following statistics - 3442 files changed, 120847 insertions(+), 92002 deletions(-) + 3445 files changed, 215464 insertions(+), 193642 deletions(-) contributed by 7 committers (Antonio Pisano, Gustaf Neumann, Günter Ernst, Hector Romojaro, Michael Aram, Stefan Sobernig, Thomas Renner) and additional 13 patch/bugfix providers (Felix Mödritscher, Florian Mosböck, Frank Bergmann, Franz Penz, Hanifa Hasan, Keith Paskett, Markus Moser, Maurizio Martignano, Monika Andergassen, Nathan Coulter, Rainer Bachleitner, Stephan Adelsberger, Tony Kirkham). Index: openacs-4/packages/acs-datetime/acs-datetime.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-datetime/acs-datetime.info,v diff -u -r1.21.2.1 -r1.21.2.2 --- openacs-4/packages/acs-datetime/acs-datetime.info 2 Sep 2021 17:22:30 -0000 1.21.2.1 +++ openacs-4/packages/acs-datetime/acs-datetime.info 15 Sep 2021 16:11:45 -0000 1.21.2.2 @@ -7,20 +7,20 @@f t -+ OpenACS An API for date and time functions 2017-08-06 OpenACS Note: this version of the package requires acs-event(s) for a helper function. This requirement may go away in the future. 2 -- + + - + - + Index: openacs-4/packages/acs-developer-support/acs-developer-support.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-developer-support/acs-developer-support.info,v diff -u -r1.26.2.2 -r1.26.2.3 --- openacs-4/packages/acs-developer-support/acs-developer-support.info 2 Sep 2021 17:22:30 -0000 1.26.2.2 +++ openacs-4/packages/acs-developer-support/acs-developer-support.info 15 Sep 2021 16:11:45 -0000 1.26.2.3 @@ -8,7 +8,7 @@ t ds -+ Lars Pind Profiling for requests including database timing information. 2017-08-06 @@ -18,10 +18,10 @@3 -- - - + + + + Index: openacs-4/packages/acs-events/acs-events.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-events/acs-events.info,v diff -u -r1.32.2.1 -r1.32.2.2 --- openacs-4/packages/acs-events/acs-events.info 2 Sep 2021 17:22:30 -0000 1.32.2.1 +++ openacs-4/packages/acs-events/acs-events.info 15 Sep 2021 16:11:45 -0000 1.32.2.2 @@ -15,7 +15,7 @@ The events service is primarily intended for use by writers of application packages and other service packages. The service allows developers to specify and manipulate relationships (possibly recurring) between an object and another object. 2 - + Index: openacs-4/packages/acs-kernel/acs-kernel.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-kernel/acs-kernel.info,v diff -u -r1.150.2.31 -r1.150.2.32 --- openacs-4/packages/acs-kernel/acs-kernel.info 2 Sep 2021 17:22:30 -0000 1.150.2.31 +++ openacs-4/packages/acs-kernel/acs-kernel.info 15 Sep 2021 16:11:45 -0000 1.150.2.32 @@ -9,15 +9,15 @@ f t -+ OpenACS Core Team Routines and data models providing the foundation for OpenACS-based Web services. 2017-08-06 OpenACS The OpenACS kernel contains the core datamodel create and drop scripts for such things as objects, groups, parties and the supporting PL/SQL and PL/pgSQL procedures. 3 -+ Index: openacs-4/packages/acs-lang/acs-lang.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-lang/acs-lang.info,v diff -u -r1.64.2.14 -r1.64.2.15 --- openacs-4/packages/acs-lang/acs-lang.info 2 Sep 2021 17:22:30 -0000 1.64.2.14 +++ openacs-4/packages/acs-lang/acs-lang.info 15 Sep 2021 16:11:46 -0000 1.64.2.15 @@ -9,7 +9,7 @@ f t -+ Peter Marklund OpenACS Internationalization Support. 2017-08-06 @@ -20,11 +20,11 @@GPL 3 -- - - - + + + + + Index: openacs-4/packages/acs-mail-lite/acs-mail-lite.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-mail-lite/acs-mail-lite.info,v diff -u -r1.62.2.7 -r1.62.2.8 --- openacs-4/packages/acs-mail-lite/acs-mail-lite.info 2 Sep 2021 17:22:31 -0000 1.62.2.7 +++ openacs-4/packages/acs-mail-lite/acs-mail-lite.info 15 Sep 2021 16:11:46 -0000 1.62.2.8 @@ -9,7 +9,7 @@ f t -+ Timo Hentschel Malte Sussdorff Simplified reliable email transmission with bounce management. @@ -18,10 +18,10 @@This package provides a service for sending and receiving messages, messages are queued in the database to ensure reliable sending and make sending a message 'transactional'. Replacement for acs-mail. 3 -- - - + + + + Index: openacs-4/packages/acs-messaging/acs-messaging.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-messaging/acs-messaging.info,v diff -u -r1.41.2.2 -r1.41.2.3 --- openacs-4/packages/acs-messaging/acs-messaging.info 2 Sep 2021 17:22:31 -0000 1.41.2.2 +++ openacs-4/packages/acs-messaging/acs-messaging.info 15 Sep 2021 16:11:46 -0000 1.41.2.3 @@ -9,7 +9,7 @@ f t -+ Anukul Kapoor John Prevost Vinod Kurup @@ -21,10 +21,10 @@GPL 3 -- - - + + + + Index: openacs-4/packages/acs-reference/acs-reference.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-reference/acs-reference.info,v diff -u -r1.39.2.2 -r1.39.2.3 --- openacs-4/packages/acs-reference/acs-reference.info 2 Sep 2021 17:22:31 -0000 1.39.2.2 +++ openacs-4/packages/acs-reference/acs-reference.info 15 Sep 2021 16:11:47 -0000 1.39.2.3 @@ -7,7 +7,7 @@ t t -+ Jon Griffin Tools and API for managing reference data. 2017-08-06 @@ -20,8 +20,8 @@ <li> Running standard reports on this data. <li> Monitoring the usage of reference data. </ul> -- + + Index: openacs-4/packages/acs-service-contract/acs-service-contract.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-service-contract/acs-service-contract.info,v diff -u -r1.49.2.1 -r1.49.2.2 --- openacs-4/packages/acs-service-contract/acs-service-contract.info 2 Sep 2021 17:22:31 -0000 1.49.2.1 +++ openacs-4/packages/acs-service-contract/acs-service-contract.info 15 Sep 2021 16:11:47 -0000 1.49.2.2 @@ -7,7 +7,7 @@ t t -+ OpenACS API and UI for service contracts 2017-08-06 @@ -17,8 +17,8 @@ Examples are the contracts used for search which provide a means to get content on a given object and to translate an object_id to a URL or the contracts used by dotlrn and new-portals to allow packages to provide portalized panes.GPL version 2 -- + + Index: openacs-4/packages/acs-subsite/acs-subsite.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-subsite/acs-subsite.info,v diff -u -r1.131.2.21 -r1.131.2.22 --- openacs-4/packages/acs-subsite/acs-subsite.info 2 Sep 2021 17:22:31 -0000 1.131.2.21 +++ openacs-4/packages/acs-subsite/acs-subsite.info 15 Sep 2021 16:11:47 -0000 1.131.2.22 @@ -9,7 +9,7 @@ t t -+ OpenACS Subsite 2017-08-06 @@ -18,13 +18,13 @@GPL 3 -- - - - - - + + + + + + + Index: openacs-4/packages/acs-tcl/acs-tcl.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/acs-tcl.info,v diff -u -r1.95.2.28 -r1.95.2.29 --- openacs-4/packages/acs-tcl/acs-tcl.info 2 Sep 2021 17:22:32 -0000 1.95.2.28 +++ openacs-4/packages/acs-tcl/acs-tcl.info 15 Sep 2021 16:11:47 -0000 1.95.2.29 @@ -9,7 +9,7 @@ f t -+ OpenACS The Kernel Tcl API library. 2017-08-06 @@ -18,9 +18,9 @@GPL version 2 3 -- - + + + Index: openacs-4/packages/acs-templating/acs-templating.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/acs-templating.info,v diff -u -r1.66.2.15 -r1.66.2.16 --- openacs-4/packages/acs-templating/acs-templating.info 2 Sep 2021 17:22:32 -0000 1.66.2.15 +++ openacs-4/packages/acs-templating/acs-templating.info 15 Sep 2021 16:11:47 -0000 1.66.2.16 @@ -9,7 +9,7 @@ f t -+ OpenACS Templating library. 2019-01-23 @@ -27,9 +27,9 @@GPL version 2 3 -- - + + + Index: openacs-4/packages/acs-translations/acs-translations.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-translations/acs-translations.info,v diff -u -r1.19.2.1 -r1.19.2.2 --- openacs-4/packages/acs-translations/acs-translations.info 2 Sep 2021 17:22:32 -0000 1.19.2.1 +++ openacs-4/packages/acs-translations/acs-translations.info 15 Sep 2021 16:11:48 -0000 1.19.2.2 @@ -7,14 +7,14 @@ t t -+ Malte Sussdorff Package for storing dynamic translations 2017-08-06 Package for storing dynamic translations 3 -+ Index: openacs-4/packages/ajaxhelper/ajaxhelper.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/ajaxhelper/ajaxhelper.info,v diff -u -r1.12.2.1 -r1.12.2.2 --- openacs-4/packages/ajaxhelper/ajaxhelper.info 2 Sep 2021 17:22:32 -0000 1.12.2.1 +++ openacs-4/packages/ajaxhelper/ajaxhelper.info 15 Sep 2021 16:11:48 -0000 1.12.2.2 @@ -16,8 +16,8 @@ 1 - - + + Index: openacs-4/packages/assessment/assessment.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/assessment/assessment.info,v diff -u -r1.57.2.8 -r1.57.2.9 --- openacs-4/packages/assessment/assessment.info 2 Sep 2021 17:22:32 -0000 1.57.2.8 +++ openacs-4/packages/assessment/assessment.info 15 Sep 2021 16:11:48 -0000 1.57.2.9 @@ -7,7 +7,7 @@ f f -+ Eduardo Perez Ureta Assessment package that will replace the surveys quizz, complex survey, poll and other data collection packages @@ -18,14 +18,14 @@ 2 #assessment.Assessment# -- - - - + + + + + - - + + Index: openacs-4/packages/assessment-portlet/assessment-portlet.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/assessment-portlet/assessment-portlet.info,v diff -u -r1.14.2.2 -r1.14.2.3 --- openacs-4/packages/assessment-portlet/assessment-portlet.info 2 Sep 2021 17:22:33 -0000 1.14.2.2 +++ openacs-4/packages/assessment-portlet/assessment-portlet.info 15 Sep 2021 16:11:48 -0000 1.14.2.3 @@ -9,15 +9,15 @@ f t -+ Jose Pablo Escobedo Del Cid Portlet for the "new-portal" system for the Assessment package 2017-08-06 2 -- - + + + Index: openacs-4/packages/attachments/attachments.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/attachments/attachments.info,v diff -u -r1.20.2.3 -r1.20.2.4 --- openacs-4/packages/attachments/attachments.info 2 Sep 2021 17:22:33 -0000 1.20.2.3 +++ openacs-4/packages/attachments/attachments.info 15 Sep 2021 16:11:48 -0000 1.20.2.4 @@ -17,8 +17,8 @@ Provide widgets and datamodel to support attachments on arbitrary objects. Used by forums. - - + + Index: openacs-4/packages/bm-portlet/bm-portlet.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/bm-portlet/bm-portlet.info,v diff -u -r1.23.2.1 -r1.23.2.2 --- openacs-4/packages/bm-portlet/bm-portlet.info 2 Sep 2021 17:22:33 -0000 1.23.2.1 +++ openacs-4/packages/bm-portlet/bm-portlet.info 15 Sep 2021 16:11:48 -0000 1.23.2.2 @@ -9,16 +9,16 @@ f t -+ OpenACS Portlet for the "new-portal" system for the bulk-mail package 2017-08-06 DotLRN Consortium 2 -- - + + + Index: openacs-4/packages/boomerang/boomerang.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/boomerang/boomerang.info,v diff -u -r1.3.2.2 -r1.3.2.3 --- openacs-4/packages/boomerang/boomerang.info 2 Sep 2021 17:22:33 -0000 1.3.2.2 +++ openacs-4/packages/boomerang/boomerang.info 15 Sep 2021 16:11:49 -0000 1.3.2.3 @@ -34,8 +34,8 @@ 0 - - + + Index: openacs-4/packages/bulk-mail/bulk-mail.info =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/bulk-mail/bulk-mail.info,v diff -u -r1.19.2.3 -r1.19.2.4 --- openacs-4/packages/bulk-mail/bulk-mail.info 2 Sep 2021 17:22:33 -0000 1.19.2.3 +++ openacs-4/packages/bulk-mail/bulk-mail.info 15 Sep 2021 16:11:49 -0000 1.19.2.4 @@ -7,7 +7,7 @@ f f -+