Browse to the authentication administration page, http://yourserver/acs-admin/auth/
- and choose an authority for
+
Browse to the authentication administration page, http://yourserver/acs-admin/auth/
+ and choose an authority for
batch sync.
Set Batch sync enabled to Yes. Set GetDocument Implementation to
HTTP GET. Set ProcessDocument Implementation to IMS Enterprise 1.1.
These settings will cause OpenACS to attempt to retrieve via HTTP a
list of users in XML format from a location we will specify in a
-few steps.
Click OK.
On the next page, click Configure on the GetDocument Implementation
+few steps.
Click OK.
On the next page, click Configure on the GetDocument Implementation
line.
Enter either or both the IncrementalURL and SnapshotURL. These
are the URLs which the external Authority will supply with XML
files in IMS Enterprise 1.1 format.
Troubleshooting. If you're
having trouble figuring out some the values for the ldapm, see this
-useful page on setting up Active Directory integration with Bugzilla.
-It explains how distinguished names are defined in Active
-Directory, and how to test that you have the correct values for
-connectivity and base DN using the OpenLDAP command-line utility
-ldapsearch.John had an issue where nsldap was not loading because
-AOLServer couldn't find the openldap client libraries, but he
-was able to fix it by adding the openldap libraries to his
+useful page on setting up Active Directory integration with
+Bugzilla. It explains how distinguished names are defined in
+Active Directory, and how to test that you have the correct values
+for connectivity and base DN using the OpenLDAP command-line
+utility ldapsearch.John had an issue where nsldap was not loading
+because AOLServer couldn't find the openldap client libraries,
+but he was able to fix it by adding the openldap libraries to his
LD_LIBRARY_PATH (e.g. /usr/local/openldap/lib)
@@ -28,7 +28,7 @@
an excellent, helpful tutorial for people new to the content
repository.
Introduction
-
For the sake of an example, I'm going to use a Tasks
+
For the sake of an example, I'm going to use a Tasks
application. This application will keep track of all the tasks of
an organization, deadlines for those tasks, and who needs to work
on them.
@@ -80,7 +80,7 @@
Convention: often, developers will name the first table
by what it is (in my case pm_tasks), and the
second, versioned table by the same name, but with _revisions at
-the end. Thus, I'll name my second table
+the end. Thus, I'll name my second table
pm_tasks_revisions.
This is actually very easy:
@@ -123,7 +123,7 @@
pm_tasks_revisions table revision_id. Why? There are
some views that are automatically generated that combine these
tables for you, but they won't be created if the names
-conflict. I'll describe what these views are later, but they
+conflict. I'll describe what these views are later, but they
are useful. You were warned.
Notice that each table uses as its primary key a reference to
either the cr_revisions table or the
@@ -230,18 +230,18 @@
them.
A lot of the intelligent things you can do with this
information is still being built. But imagine for example that you
-are using the project manager package I've written. You work at
+are using the project manager package I've written. You work at
an ice cream company, and every task that is done also has an
associated ice cream flavor with it (yeah, this isn't a good
-example, but pay attention anyway). If I've written the project
+example, but pay attention anyway). If I've written the project
manager to take advantage of it, when you add in this extra
attribute to the pm_tasks_revisions table, the UI aspects will be
automatically taken care of. You'll be able to select a flavor
when you edit a task, and it will be shown on the task view page.
This is the direction OpenACS development is going, and it will be
really really cool!
-
First, I'm going to describe how to extend other content
-repository tables using the CR API. Then, I'll describe how to
+
First, I'm going to describe how to extend other content
+repository tables using the CR API. Then, I'll describe how to
set up your own tables as well:
As you recall from earlier in this page, attributes are just
another term for columns in a table. The Content Repository has a
@@ -343,8 +343,9 @@
You can see the actual functions used in project manager via the
GitHub browser's entry for project-manager
-. Note these are a
-little more expanded than what I've used in the examples above.
+. Note these are
+a little more expanded than what I've used in the examples
+above.
select define_function_args('pm_task__new_task_item', 'task_id, project_id, title, description, end_date, percent_complete, estimated_hours_work, estimated_hours_work_min, estimated_hours_work_max, creation_date, creation_user, creation_ip, package_id');
@@ -578,7 +579,7 @@
(cr_items
), or a subclass of a content_item (such as
cr_folders
-). I'll explain more later about
+). I'll explain more later about
cr_folders
.
One thing that you might want to do for your application is to
@@ -655,7 +656,7 @@
Note that this example is for projects rather than tasks. This is
-because for the application I'm writing, projects are what
+because for the application I'm writing, projects are what
tasks are stored inside of. A project has many component tasks. If
you were writing another application, or if I wasn't doing
anythign with projects, then this would be creating a folder for
@@ -818,7 +819,7 @@
Really, however, what you need to do is make sure your __delete and
drop scripts first go through and delete all children of those
-items. I'm not sure if you need to delete the items themselves
+items. I'm not sure if you need to delete the items themselves
-- I believe they may be dropped by themselves when the tables are
dropped, because of the cascade
portion of the SQL
Index: openacs-4/packages/acs-content-repository/www/doc/uninstall.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-content-repository/www/doc/uninstall.adp,v
diff -u -r1.2.2.5 -r1.2.2.6
--- openacs-4/packages/acs-content-repository/www/doc/uninstall.adp 1 Jul 2016 09:17:32 -0000 1.2.2.5
+++ openacs-4/packages/acs-content-repository/www/doc/uninstall.adp 6 Aug 2017 11:31:20 -0000 1.2.2.6
@@ -1,5 +1,5 @@
-{/doc/acs-content-repository {Content Repository}} {Content Repository: Uninstalling}
+{/doc/acs-content-repository {ACS Content Repository}} {Content Repository: Uninstalling}Content Repository: Uninstalling
Index: openacs-4/packages/acs-core-docs/www/backup-recovery.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/backup-recovery.adp,v
diff -u -r1.1.2.25 -r1.1.2.26
--- openacs-4/packages/acs-core-docs/www/backup-recovery.adp 20 Jun 2017 07:16:41 -0000 1.1.2.25
+++ openacs-4/packages/acs-core-docs/www/backup-recovery.adp 6 Aug 2017 11:31:20 -0000 1.1.2.26
@@ -30,7 +30,7 @@
to set up, are far from the best solution).
There are three basic things which need to be backed up, the
database data, the server source tree, and the
acs-content-repository (which is in the server source tree).
-
Figure 8.1. Backup
+
Figure 8.1. Backup
and Recovery Strategy
OpenACS docs are written by the named authors, and may be edited by
Index: openacs-4/packages/acs-core-docs/www/backup-recovery.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/backup-recovery.html,v
diff -u -r1.43.2.23 -r1.43.2.24
--- openacs-4/packages/acs-core-docs/www/backup-recovery.html 20 Jun 2017 07:16:41 -0000 1.43.2.23
+++ openacs-4/packages/acs-core-docs/www/backup-recovery.html 6 Aug 2017 11:31:20 -0000 1.43.2.24
@@ -6,7 +6,7 @@
oracle, while easy to set up, are far from the best solution).
There are three basic things which need to be backed up, the database data, the server
source tree, and the acs-content-repository (which is in the server source tree).
-
Figure 8.1. Backup and Recovery Strategy
+
Figure 8.1. Backup and Recovery Strategy
OpenACS docs are written by the named authors, and may be edited
by OpenACS documentation staff.
Index: openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.adp,v
diff -u -r1.1.2.23 -r1.1.2.24
--- openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.adp 20 Jun 2017 07:16:41 -0000 1.1.2.23
+++ openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.adp 6 Aug 2017 11:31:20 -0000 1.1.2.24
@@ -17,7 +17,7 @@
OpenACS docs are written by the named authors, and may be edited by
OpenACS documentation staff.
-Configuring an OpenACS package
After you've installed and mounted your package, you can
+Configuring an OpenACS package
After you've installed and mounted your package, you can
configure each instance to act as you would like.
This is done from the Applications page. Log in, go to the Admin
or Control Panel, click on the subsite the application is in, and
click on Applications. If you click on the 'Parameters'
Index: openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.html,v
diff -u -r1.10.2.23 -r1.10.2.24
--- openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.html 20 Jun 2017 07:16:41 -0000 1.10.2.23
+++ openacs-4/packages/acs-core-docs/www/configuring-configuring-packages.html 6 Aug 2017 11:31:20 -0000 1.10.2.24
@@ -2,7 +2,7 @@
OpenACS docs are written by the named authors, and may be edited
by OpenACS documentation staff.
-
Configuring an OpenACS package
After you've installed and mounted your package, you can
+
Configuring an OpenACS package
After you've installed and mounted your package, you can
configure each instance to act as you would like.
This is done from the Applications page. Log in, go to the
Admin or Control Panel, click on the subsite the application is
in, and click on Applications. If you click on the 'Parameters'
Index: openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.adp,v
diff -u -r1.1.2.23 -r1.1.2.24
--- openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.adp 20 Jun 2017 07:16:41 -0000 1.1.2.23
+++ openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.adp 6 Aug 2017 11:31:20 -0000 1.1.2.24
@@ -17,7 +17,7 @@
OpenACS docs are written by the named authors, and may be edited by
OpenACS documentation staff.
-Setting Permission on an OpenACS
+Setting Permission on an OpenACS
package
After you've installed and mounted your package, you can
configure each instance to act as you would like.
This is done from the Applications page. Log in, go to the Admin
or Control Panel, click on the subsite the application is in, and
Index: openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.html,v
diff -u -r1.10.2.23 -r1.10.2.24
--- openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.html 20 Jun 2017 07:16:41 -0000 1.10.2.23
+++ openacs-4/packages/acs-core-docs/www/configuring-configuring-permissions.html 6 Aug 2017 11:31:20 -0000 1.10.2.24
@@ -2,7 +2,7 @@
OpenACS docs are written by the named authors, and may be edited
by OpenACS documentation staff.
-
Setting Permission on an OpenACS package
After you've installed and mounted your package, you can
+
Setting Permission on an OpenACS package
After you've installed and mounted your package, you can
configure each instance to act as you would like.
This is done from the Applications page. Log in, go to the
Admin or Control Panel, click on the subsite the application is
in, and click on Applications. If you click on the 'Permissions'
Index: openacs-4/packages/acs-core-docs/www/configuring-install-packages.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-install-packages.adp,v
diff -u -r1.1.2.24 -r1.1.2.25
--- openacs-4/packages/acs-core-docs/www/configuring-install-packages.adp 20 Jun 2017 07:16:41 -0000 1.1.2.24
+++ openacs-4/packages/acs-core-docs/www/configuring-install-packages.adp 6 Aug 2017 11:31:20 -0000 1.1.2.25
@@ -16,7 +16,7 @@
OpenACS docs are written by the named authors, and may be edited by
OpenACS documentation staff.
-Installing OpenACS packages
An OpenACS package extends your website and lets it do things it
+Installing OpenACS packages
An OpenACS package extends your website and lets it do things it
wasn't able to do before. You can have a weblog, a forums, a
calendar, or even do sophisticated project-management via your
website.
After you've installed OpenACS, you can congratulate
Index: openacs-4/packages/acs-core-docs/www/configuring-install-packages.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-install-packages.html,v
diff -u -r1.10.2.23 -r1.10.2.24
--- openacs-4/packages/acs-core-docs/www/configuring-install-packages.html 20 Jun 2017 07:16:41 -0000 1.10.2.23
+++ openacs-4/packages/acs-core-docs/www/configuring-install-packages.html 6 Aug 2017 11:31:20 -0000 1.10.2.24
@@ -2,7 +2,7 @@
OpenACS docs are written by the named authors, and may be edited
by OpenACS documentation staff.
-
Installing OpenACS packages
An OpenACS package extends your website and lets it do
+
Installing OpenACS packages
An OpenACS package extends your website and lets it do
things it wasn't able to do before. You can have a weblog, a
forums, a calendar, or even do sophisticated project-management
via your website.
After you've installed OpenACS, you can congratulate
Index: openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.adp,v
diff -u -r1.1.2.23 -r1.1.2.24
--- openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.adp 20 Jun 2017 07:16:41 -0000 1.1.2.23
+++ openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.adp 6 Aug 2017 11:31:20 -0000 1.1.2.24
@@ -16,7 +16,7 @@
OpenACS docs are written by the named authors, and may be edited by
OpenACS documentation staff.
-Mounting OpenACS packages
After you've installed your packages, you have to
+Mounting OpenACS packages
After you've installed your packages, you have to
'mount' them in order to make them appear on your
website.
Make sure you are logged in, and then click on the
'Admin' or 'Control Panel' link to get to the
Index: openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.html,v
diff -u -r1.10.2.23 -r1.10.2.24
--- openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.html 20 Jun 2017 07:16:41 -0000 1.10.2.23
+++ openacs-4/packages/acs-core-docs/www/configuring-mounting-packages.html 6 Aug 2017 11:31:20 -0000 1.10.2.24
@@ -2,7 +2,7 @@
OpenACS docs are written by the named authors, and may be edited
by OpenACS documentation staff.
-
Mounting OpenACS packages
After you've installed your packages, you have to 'mount'
+
Mounting OpenACS packages
After you've installed your packages, you have to 'mount'
them in order to make them appear on your website.
Make sure you are logged in, and then click on the
'Admin' or 'Control Panel' link to get to the Site-Wide
Administration page (at /acs-admin). Click on the subsite you'd
Index: openacs-4/packages/acs-core-docs/www/cvs-guidelines.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/cvs-guidelines.adp,v
diff -u -r1.1.2.27 -r1.1.2.28
--- openacs-4/packages/acs-core-docs/www/cvs-guidelines.adp 20 Jun 2017 07:16:41 -0000 1.1.2.27
+++ openacs-4/packages/acs-core-docs/www/cvs-guidelines.adp 6 Aug 2017 11:31:20 -0000 1.1.2.28
@@ -18,7 +18,7 @@
Using CVS with OpenACS
-Getting Started
All OpenACS code is available anonymously. To get code
+Getting Started
All OpenACS code is available anonymously. To get code
anonymously, use the parameter -d:pserver:anonymous\@cvs.openacs.org:/cvsroot
immediately after cvs in a cvs
command to check out or export code.
If you are an OpenACS developer, you should check out code so
@@ -81,7 +81,7 @@
-Checkout for Package Development
If you are actively developing a non-core package, you should
+Checkout for Package Development
If you are actively developing a non-core package, you should
work from the latest core release branch. Currently this is
oacs-5-9. This ensures that you are working on top of a stable
OpenACS core, but still allows you to commit feature changes to
@@ -98,7 +98,7 @@
packages and their current state.
-Checkout for Core Development
If you are actively developing packages in the OpenACS Core,
+Checkout for Core Development
If you are actively developing packages in the OpenACS Core,
work from the HEAD branch. HEAD is used for active development of
the next version of core OpenACS. It may be very buggy; it may not
even install correctly. Do not use this branch for development of
@@ -107,7 +107,7 @@
developer account:
.LRN consists of a given version OpenACS core, plus a set of
+Checkout .LRN
.LRN consists of a given version OpenACS core, plus a set of
packages. These are collectively packages together to form a
distribution of .LRN. F .LRN 2.0.0 sits on top of OpenACS 5.0.0.
.LRN also uses an OpenACS install.xml file during installation;
@@ -132,7 +132,7 @@
OpenACS CVS Concepts
-Modules
All OpenACS code resides within a single CVS module,
+Modules
All OpenACS code resides within a single CVS module,
openacs-4. (The openacs-4
directory contains code for all versions of OpenACS 4 and later,
and .LRN 1 and later.) Checking out this module retrieves all
@@ -169,7 +169,7 @@
module of the same name.
- Tags and Branches
Tags and Branches look similar in commands, but behave
+ Tags and Branches
Tags and Branches look similar in commands, but behave
differently. A tag is a fixed point on a branch. Check out a tag to
get a specific version of OpenACS. Check out a branch to get the
most current code for that major-minor version (e.g., 5.0.x or
@@ -415,7 +415,7 @@
- Informal Guidelines
Informal guidelines which may be obsolete in places and should
+ Informal Guidelines
Informal guidelines which may be obsolete in places and should
be reviewed:
OpenACS docs are written by the named authors, and may be edited
by OpenACS documentation staff.
-
Using CVS with OpenACS
Getting Started
+
Using CVS with OpenACS
Getting Started
All OpenACS code is available anonymously. To get code
anonymously, use the parameter
-d:pserver:anonymous@cvs.openacs.org:/cvsroot immediately after cvs in a cvs command to check out or export code.
@@ -53,7 +53,7 @@
cd CVSROOT
emacs avail
Add an avail line of the form:
avail|username|openacs-4
cvs commit -m "added commit on X for username" avail
Branimir suggests an additional level of abstraction. If you put
Host cvs-server
HostName cvs.openacs.org
- User yournamehere
into your ~/.ssh/config file, then you can use -d :ext:cvs-server:/cvsroot instead of -d :ext:cvs.openacs.org:/cvsroot. You can then change the definition of cvs-server by changing one file instead of editing hundreds of CVSROOT/Repository files.
Checkout for Package Development
If you are actively developing a non-core package, you
+ User yournamehere
into your ~/.ssh/config file, then you can use -d :ext:cvs-server:/cvsroot instead of -d :ext:cvs.openacs.org:/cvsroot. You can then change the definition of cvs-server by changing one file instead of editing hundreds of CVSROOT/Repository files.
Checkout for Package Development
If you are actively developing a non-core package, you
should work from the latest core release branch. Currently this
is oacs-5-9. This ensures that you are working on top
of a stable OpenACS core, but still allows you to commit feature
@@ -68,13 +68,13 @@
Inventory and Package
maintainers and status for a list of available
packages and their current state.
-
Checkout for Core Development
If you are actively developing packages in the OpenACS
+
Checkout for Core Development
If you are actively developing packages in the OpenACS
Core, work from the HEAD branch. HEAD is used for active
development of the next version of core OpenACS. It may be very
buggy; it may not even install correctly. Do not use this branch for
development of non-core features unless your work depends on some
of the HEAD core work. To check out HEAD, omit the
- -r tag.
To check out HEAD for development, which requires an OpenACS developer account:
.LRN consists of a given version OpenACS core, plus a set of
packages. These are collectively packages together to form a
distribution of .LRN. F .LRN 2.0.0 sits on top of OpenACS 5.0.0.
@@ -89,7 +89,7 @@
mv dotlrn/install.xml ..
Working with CVS
Once you have a checkout you can use some commands to track
what has changed since you checked out your copy. cvs -n update does not change any files, but reports which changes have been updated or locally modified, or are not present in CVS.
-
To update your files, use cvs update. This will merge changes from the repository with your local files. It has no effect on the cvs.openacs.org repository.
OpenACS CVS Concepts
Modules
+
To update your files, use cvs update. This will merge changes from the repository with your local files. It has no effect on the cvs.openacs.org repository.
OpenACS CVS Concepts
Modules
All OpenACS code resides within a single CVS module, openacs-4. (The openacs-4 directory contains code for all versions of OpenACS 4 and later, and .LRN 1 and later.) Checking out this module retrieves all OpenACS code of any type. For convenience, subsets of openacs-4 are repackaged as smaller modules.
acs-core contains only critical common
packages. It does not have any user applications, such as forums,
@@ -117,7 +117,7 @@
project-manager-all contains the packages required, in combination with acs-core, to run the project-manager package.
Each OpenACS package (i.e., directory in openacs-4/packages/) is also aliased as a module of the same name.
-
+
Tags and Branches
Tags and Branches look similar in commands, but behave differently. A tag is a fixed point on a branch. Check out
@@ -317,7 +317,7 @@
flag which defaults to no-effect wouldn't require a TIP. Added a
new mandatory flag to an existing function would require a
TIP.
-
+
Informal Guidelines
Informal guidelines which may be obsolete in places and should be reviewed:
Index: openacs-4/packages/acs-core-docs/www/cvs-tips.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/cvs-tips.adp,v
diff -u -r1.1.2.23 -r1.1.2.24
--- openacs-4/packages/acs-core-docs/www/cvs-tips.adp 20 Jun 2017 07:16:41 -0000 1.1.2.23
+++ openacs-4/packages/acs-core-docs/www/cvs-tips.adp 6 Aug 2017 11:31:20 -0000 1.1.2.24
@@ -19,7 +19,7 @@
OpenACS docs are written by the named authors, and may be edited by
OpenACS documentation staff.
Add the Service to CVS -
-OPTIONAL. These steps take
+OPTIONAL. These steps take
an existing OpenACS directory and add it to a CVS
repository.
Index: openacs-4/packages/acs-core-docs/www/cvs-tips.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/cvs-tips.html,v
diff -u -r1.34.2.23 -r1.34.2.24
--- openacs-4/packages/acs-core-docs/www/cvs-tips.html 20 Jun 2017 07:16:41 -0000 1.34.2.23
+++ openacs-4/packages/acs-core-docs/www/cvs-tips.html 6 Aug 2017 11:31:20 -0000 1.34.2.24
@@ -2,7 +2,7 @@
Appendix D. Using CVS with an OpenACS Site
OpenACS docs are written by the named authors, and may be edited
by OpenACS documentation staff.
-
Add the Service to CVS - OPTIONAL. These steps take an existing OpenACS directory and add
+
Add the Service to CVS - OPTIONAL. These steps take an existing OpenACS directory and add
it to a CVS
repository.
Create and set permissions on a subdirectory in the local cvs repository.
[root root]# mkdir /cvsroot/$OPENACS_SERVICE_NAME
[root root]# chown $OPENACS_SERVICE_NAME.$OPENACS_SERVICE_NAME /cvsroot/$OPENACS_SERVICE_NAME
Index: openacs-4/packages/acs-core-docs/www/docbook-primer.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/docbook-primer.adp,v
diff -u -r1.1.2.24 -r1.1.2.25
--- openacs-4/packages/acs-core-docs/www/docbook-primer.adp 20 Jun 2017 07:16:41 -0000 1.1.2.24
+++ openacs-4/packages/acs-core-docs/www/docbook-primer.adp 6 Aug 2017 11:31:20 -0000 1.1.2.25
@@ -410,7 +410,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
@@ -450,7 +450,7 @@
of elements and use more exotic features in your documents. The
list is made up of SGML-elements but basically the same elements
are valid in the XML DTD as long as
-you remember to:
+you remember to:
Always close your tags with corresponding end-tags and to
not use other tag
@@ -491,7 +491,7 @@
Document Structure
The documentation for each package will make up a little
"book" that is structured like this - examples are
-emphasized:
+emphasized:
book : Docs for one package - templating
|
@@ -516,11 +516,11 @@
Headlines, Sections
- Given that your job starts at the
+ Given that your job starts at the
sect1-level, all your documents
should open with a <sect1>-tag
and end with the corresponding </sect1>.
- You need to feed every <sect1> two attributes. The first
+ You need to feed every <sect1> two attributes. The first
attribute, id, is standard and
can be used with all elements. It comes in very handy when
interlinking between documents (more about this when talking about
@@ -529,7 +529,7 @@
id has to be unique throughout
the book you're making since the id's in your sect1's will turn into filenames when
the book is parsed into HTML.
- The other attribute is xreflabel. The value of this is the text
+ The other attribute is xreflabel. The value of this is the text
that will appear as the link when referring to this sect1.
Right after the opening tag you put the title of the document -
this is usually the same as xreflabel-attribute. E.g. the top level of
the document you're reading right now looks like this:
@@ -540,7 +540,7 @@
</sect1>
- Inside this container your document will
+ Inside this container your document will
be split up into <sect2>'s,
each with the same requirements - id and xreflabel attributes, and a <title>-tag inside. Actually, the
xreflabel is never required in
@@ -550,7 +550,7 @@
Code
- For displaying a snippet of code, a
+ For displaying a snippet of code, a
filename or anything else you just want to appear as a part of a
sentence, we use <computeroutput> and <code> tags. These
replace the HTML-tag <code> tag,
@@ -564,15 +564,15 @@
Links
- Linking falls into two different
+ Linking falls into two different
categories: inside the book you're making and outside:
1. Inside
linking, cross-referencing other parts of your
book
By having unique id's
you can cross-reference any part of your book with a simple tag,
regardless of where that part is.
-Check out how I link to a subsection of
+Check out how I link to a subsection of
the Developer's Guide:
Put this in your XML:
- Find information about creating a package in
<xref linkend="packages-making-a-package"></xref>.
@@ -596,7 +596,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>
@@ -615,7 +615,7 @@
Note: The graphics guidelines are
not written in stone. Use another valid approach if it works better
for you.
- 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.52.2.23 -r1.52.2.24
--- openacs-4/packages/acs-core-docs/www/docbook-primer.html 20 Jun 2017 07:16:41 -0000 1.52.2.23
+++ openacs-4/packages/acs-core-docs/www/docbook-primer.html 6 Aug 2017 11:31:20 -0000 1.52.2.24
@@ -578,7 +578,7 @@
DTD. The remaining discussion is about publishing using
Docbook.
-
+
is a publishing standard based on XML with
similar goals to the OpenACS Documentation project. Some specific reasons why we are using DocBook:
@@ -640,7 +640,7 @@
list of elements and use more exotic features in your
documents. The list is made up of SGML-elements but basically
the same elements are valid in the XML DTD as long as you remember to:
-
+
Always close your tags with corresponding end-tags and to
not use other tag minimization
@@ -689,7 +689,7 @@
The documentation for each package will make up a little "book" that is structured like this
- examples are emphasized:
-
+
book : Docs for one package - templating
@@ -713,20 +713,20 @@
sources of these DocBook documents
to get an idea of how they are tied together.
Headlines, Sections
-
+
Given that your job starts at the sect1-level, all your documents should open with a
<sect1>-tag and end
with the corresponding </sect1>.
-
+
You need to feed every <sect1> two attributes. The first attribute,
id, is standard and can be used with all elements. It comes in very
handy when interlinking between documents (more about this when talking about links in the section called “Links”).
The value of id has to be unique
throughout the book you're making since the id's in your
sect1's will turn into filenames when the book is parsed into HTML.
-
+
The other attribute is xreflabel. The value of this is the text that will appear
as the link when referring to this sect1.
@@ -741,7 +741,7 @@
</sect1>
-
+
Inside this container your document will be split up into
<sect2>'s,
each with the same requirements - id and xreflabel
@@ -750,7 +750,7 @@
When it comes to naming your
sect2's and below, prefix them with some abbreviation of the id in the sect1 such as requirements-overview.
Code
-
+
For displaying a snippet of code, a filename or anything else you just want to appear as a part of
a sentence, we use
<computeroutput>
@@ -768,12 +768,12 @@
tag around text that has been wrapped by combinations of <computeroutput>
and <userinput>
Links
-
+
Linking falls into two different categories: inside the book you're making and outside:
1. Inside linking, cross-referencing other parts of your book
By having unique id's you can cross-reference any part of your book
with a simple tag, regardless of where that part is.
-
Check out how I link to a subsection of the Developer's Guide:
Put this in your XML:
+
Check out how I link to a subsection of the Developer's Guide:
Put this in your XML:
- Find information about creating a package in
<xref linkend="packages-making-a-package"></xref>.
And the output is:
@@ -797,7 +797,7 @@
packages-looks, the
parser will try its best to explain where the link takes you.
2. Linking outside the documentation
-
+
If you're hyper-linking out of the documentation, it works almost the same way as HTML - the tag is just
a little different
@@ -818,7 +818,7 @@
for you.
-
+
To insert a graphic we use the elements
<mediaobject>,
<imageobject>,
@@ -844,7 +844,7 @@
Put your graphics in a separate directory ("images") and link to them
only with relative paths.
Lists
-
+
Here's how you make the DocBook equivalent of the three usual HTML-lists:
1. How to make an <ul>
Making an unordered list is pretty much like doing the same thing in HTML - if you close your <li>, that is. The only differences are that each list item has to be wrapped in something more, such as
@@ -889,7 +889,7 @@
</variablelist>
Tables
-
+
DocBook supports several types of tables, but in most cases, the
<informaltable>
is enough:
@@ -926,7 +926,7 @@
<table>
for an example.
Emphasis
-
+
Our documentation uses two flavors of emphasis - italics and bold type. DocBook uses one -
<emphasis>.
People have plenty of usernames and passwords already, we
+Vision
People have plenty of usernames and passwords already, we
don't want them to have yet another. We want people to be able
to log in to OpenACS with the same password they use to log in to
any other system.
Besides, administrators have better things to do than create
@@ -74,7 +74,7 @@
People have plenty of usernames and passwords already, we
don't want them to have yet another. We want people to be able to
log in to OpenACS with the same password they use to log in to any
other system.
Besides, administrators have better things to do than create
@@ -45,7 +45,7 @@
only one implementation of the authentication API, namly the one
included in OpenACS Core.
Authentication Driver API: The service contract which
authentication drivers implement.
Conceptual Pictures
Authentication:
-
Account Management (NO PICTURE YET)
Batch Synchronization (NO PICTURE YET)
Requirements
New API
Feature
Status
Description
New API
EXT-AUTH-01
A
Extend Authentication/Acct Status API
EXT-AUTH-03
A
Account Creation API
EXT-AUTH-05
A
Password Management API
EXT-AUTH-30
A
Authority Management API
Login
Feature
Status
Description
Login
EXT-AUTH-04
A
Rewrite login, register, and admin pages to use APIs
EXT-AUTH-38
A
ad_form complain feature
EXT-AUTH-19
A
Rewrite password recovery to use API
EXT-AUTH-21
A
Rewrite email verification with API
EXT-AUTH-28
A
Username is email switch
Users will log in using a username, a authority, and a
+
Account Management (NO PICTURE YET)
Batch Synchronization (NO PICTURE YET)
Requirements
New API
Feature
Status
Description
New API
EXT-AUTH-01
A
Extend Authentication/Acct Status API
EXT-AUTH-03
A
Account Creation API
EXT-AUTH-05
A
Password Management API
EXT-AUTH-30
A
Authority Management API
Login
Feature
Status
Description
Login
EXT-AUTH-04
A
Rewrite login, register, and admin pages to use APIs
EXT-AUTH-38
A
ad_form complain feature
EXT-AUTH-19
A
Rewrite password recovery to use API
EXT-AUTH-21
A
Rewrite email verification with API
EXT-AUTH-28
A
Username is email switch
Users will log in using a username, a authority, and a
password. The authority is the source for user/password
verification. OpenACS can be an authority itself.
Each user in OpenACS will belong to exactly one authority, which
can either be the "local" OpenACS users table, in which case the
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.1.2.25 -r1.1.2.26
--- openacs-4/packages/acs-core-docs/www/form-builder.adp 20 Jun 2017 07:16:41 -0000 1.1.2.25
+++ openacs-4/packages/acs-core-docs/www/form-builder.adp 6 Aug 2017 11:31:21 -0000 1.1.2.26
@@ -25,7 +25,7 @@
Multi-part Elements
Some elements have more than one choice, or can submit more than
one value.
-SELECT elements
+SELECT elements
Creating the form element. Populate
a list of lists with values for the option list.
@@ -106,7 +106,7 @@
Errors
Here are some common errors and what to do when you encounter
them:
-Error when selecting values
This generally happens when there is an error in your query.
+Error when selecting values
This generally happens when there is an error in your query.
Index: openacs-4/packages/acs-core-docs/www/form-builder.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/form-builder.html,v
diff -u -r1.30.2.23 -r1.30.2.24
--- openacs-4/packages/acs-core-docs/www/form-builder.html 20 Jun 2017 07:16:41 -0000 1.30.2.23
+++ openacs-4/packages/acs-core-docs/www/form-builder.html 6 Aug 2017 11:31:21 -0000 1.30.2.24
@@ -6,7 +6,7 @@
adaptable UI. Error handling includes inline error reporting, and is customizable.
However, ad_form can be tricky to use. In addition to this document,
the ad_form api
- documentation is helpful.
Multi-part Elements
Some elements have more than one choice, or can submit more than one value.
SELECT elements
Creating the form element. Populate a list of lists with values for the option list.
set foo_options [db_list_of_lists foo_option_list "
+ documentation is helpful.
Multi-part Elements
Some elements have more than one choice, or can submit more than one value.
SELECT elements
Creating the form element. Populate a list of lists with values for the option list.
set foo_options [db_list_of_lists foo_option_list "
select foo,
foo_id
from foos
@@ -51,5 +51,5 @@
ns_set print $mypage
}
Tips for form widgets
Here are some tips for dealing with some of the form widgets:
On the administration page, click Parameters link.
Change the parameter IndexRedirectUrl to be the URI of the
@@ -35,7 +35,7 @@
-How do I put custom functionality on front
+How do I put custom functionality on front
page of a new site?
Every page within an OpenACS site is part of a subsiteMore information). The home
page of the entire site is the front page is a special, default
instance of a subsite, served from /var/lib/aolserver/$OPENACS_SERVICE_NAME/www. If an
@@ -50,7 +50,7 @@
-How do I change the site-wide style?
Almost all pages on an OpenACS site use ACS Templating, and so
+How do I change the site-wide style?
Almost all pages on an OpenACS site use ACS Templating, and so
their appearance is driven by a layer of different files. Let's
examine how this works:
@@ -74,12 +74,12 @@
navigation "meta" elements such as Translator widgets and
Admin widgets.
-
Figure 4.1. Site
+
Figure 4.1. Site
Templates
-How do I diagnose a permissions
+How do I diagnose a permissions
problem?
@@ -124,12 +124,12 @@
To grant permissions on a package, start at the site map. Find the event
package and click "Set permissions".
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 weblogger/. Note the trailing slash.
How do I put custom functionality on front page of a new site?
Every page within an OpenACS site is part of a 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 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:
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 weblogger/. Note the trailing slash.
How do I put custom functionality on front page of a new site?
Every page within an OpenACS site is part of a 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 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:
Edit the new index.adp to change the text; you shouldn't need to edit index.tcl unless you are adding new functionality.
How do I change the site-wide style?
Almost all pages on an OpenACS site use ACS Templating, and so their appearance is driven by a layer of different files. Let's examine how this works:
A templated page uses an ADP/Tcl pair. The first line in the ADP file is usually:
<master>
If it appears exactly like this, without any arguments, the template processor uses default-master for that subsite. For pages in /var/lib/aolserver/$OPENACS_SERVICE_NAME/www, this is /var/lib/aolserver/$OPENACS_SERVICE_NAME/www/default-master.adp and the associated .tcl file.
-
The default-master is itself a normal ADP page. It draws the subsite navigation elements and invokes site-master (/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/site-master.adp and .tcl)
The site-master draws site-wide navigation elements and invokes blank-master (/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/blank-master.adp and .tcl).
Blank-master does HTML housekeeping and provides a framework for special sitewide navigation "meta" elements such as Translator widgets and Admin widgets.
Figure 4.1. Site Templates
How do I diagnose a permissions problem?
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 invokes site-master (/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/site-master.adp and .tcl)
The site-master draws site-wide navigation elements and invokes blank-master (/var/lib/aolserver/$OPENACS_SERVICE_NAME/www/blank-master.adp and .tcl).
Blank-master does HTML housekeeping and provides a framework for special sitewide navigation "meta" elements such as Translator widgets and Admin widgets.
Figure 4.1. Site Templates
How do I diagnose a permissions problem?
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
This means that a given user must have the write privilige on the event in order to register. Let's assume that the priviliges inherit, so that if a user has the write privilige on the whole package, they will have the write privilege on the event.
Setting Permissions. A permission has three parts: the privilige, the object of the privilige, and the subject being granted the privilige. In this case the privilige is "write," the object is the Events package, and the subject is all Registered Users.
To grant permissions on a package, start at the site map. Find the event package and click "Set permissions".
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
This means that a given user must have the write privilige on the event in order to register. Let's assume that the priviliges inherit, so that if a user has the write privilige on the whole package, they will have the write privilege on the event.
Setting Permissions. A permission has three parts: the privilige, the object of the privilige, and the subject being granted the privilige. In this case the privilige is "write," the object is the Events package, and the subject is all Registered Users.
To grant permissions on a package, start at the site map. Find the event package and click "Set permissions".
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.26.2.25 -r1.26.2.26
--- openacs-4/packages/acs-core-docs/www/i18n-convert.html 20 Jun 2017 07:16:41 -0000 1.26.2.25
+++ openacs-4/packages/acs-core-docs/www/i18n-convert.html 6 Aug 2017 11:31:21 -0000 1.26.2.26
@@ -72,7 +72,7 @@
test. If you don't provide the package_key argument then all
packages with catalog files will be checked.
The script will run its checks primarily on en_US xml catalog files.
-
Avoiding common i18n mistakes
Replace complicated keys with longer, simpler keys. When writing in one language, it is possible to create clever code to make correct text. In English, for example, you can put an if command at the end of a word which adds "s" if a count is anything but 1. This pluralizes nouns correctly based on the data. However, it is confusing to read and, when internationalized, may result in message keys that are both confusing and impossible to set correctly in some languages. While internationalizing, watch out that the automate converter does not create such keys. Also, refactor compound text as you encounter it.
The automated system can easily get confused by tags within message texts, so that it tries to create two or three message keys for one long string with a tag in the middle. In these cases, uncheck those keys during the conversion and then edit the files directly. For example, this code:
<p class="form-help-text"><b>Invitations</b> are sent,
+
Avoiding common i18n mistakes
Replace complicated keys with longer, simpler keys. When writing in one language, it is possible to create clever code to make correct text. In English, for example, you can put an if command at the end of a word which adds "s" if a count is anything but 1. This pluralizes nouns correctly based on the data. However, it is confusing to read and, when internationalized, may result in message keys that are both confusing and impossible to set correctly in some languages. While internationalizing, watch out that the automate converter does not create such keys. Also, refactor compound text as you encounter it.
The automated system can easily get confused by tags within message texts, so that it tries to create two or three message keys for one long string with a tag in the middle. In these cases, uncheck those keys during the conversion and then edit the files directly. For example, this code:
<p class="form-help-text"><b>Invitations</b> are sent,
when this wizard is completed and casting begins.</p>
has a bold tag which confuses the converter into thinking there are two message keys for the text beginning "Invitations ..." where there should be one:
Instead, we cancel those keys, edit the file manually, and put in a single temporary message tag:
<p class="form-help-text"> <#Invitations_are_sent <b>Invitations</b> are sent,
when this wizard is completed and casting begins.#>
</p>
Complex if statements may produce convoluted message keys that are very hard to localize. Rewrite these if statements. For example:
Select which case <if @simulation.casting_type@ eq "open">and
Index: openacs-4/packages/acs-core-docs/www/index.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/index.adp,v
diff -u -r1.26.2.25 -r1.26.2.26
--- openacs-4/packages/acs-core-docs/www/index.adp 20 Jun 2017 07:16:41 -0000 1.26.2.25
+++ openacs-4/packages/acs-core-docs/www/index.adp 6 Aug 2017 11:31:21 -0000 1.26.2.26
@@ -9,7 +9,7 @@
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.41.2.23 -r1.41.2.24
--- openacs-4/packages/acs-core-docs/www/install-daemontools.html 20 Jun 2017 07:16:41 -0000 1.41.2.23
+++ openacs-4/packages/acs-core-docs/www/install-daemontools.html 6 Aug 2017 11:31:21 -0000 1.41.2.24
@@ -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.
[root root]# mkdir -p /package
[root root]# chmod 1755 /package/
[root root]# cd /package/
[root package]# tar xzf /tmp/daemontools-0.76.tar.gz
Index: openacs-4/packages/acs-core-docs/www/install-full-text-search-openfts.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-full-text-search-openfts.adp,v
diff -u -r1.1.2.23 -r1.1.2.24
--- openacs-4/packages/acs-core-docs/www/install-full-text-search-openfts.adp 20 Jun 2017 07:16:41 -0000 1.1.2.23
+++ openacs-4/packages/acs-core-docs/www/install-full-text-search-openfts.adp 6 Aug 2017 11:31:21 -0000 1.1.2.24
@@ -24,7 +24,7 @@
with an automated install process using the tsearch2-driver
package.
-Install OpenFTS module
If you want full text search, and you are running PostgreSQL,
+Install OpenFTS module
If you want full text search, and you are running PostgreSQL,
install this module to support FTS. Do this step after you have
installed both PostgreSQL and AOLserver. You will need the
openfts tarball in
@@ -119,7 +119,7 @@
Install OpenFTS prerequisites in
-PostgreSQL instance
If you are installing Full Text Search, add required packages to
+PostgreSQL instance
If you are installing Full Text Search, add required packages to
the new database. (In order for full text search to work, you must
also install the PostgreSQL OpenFTS module
and prerequisites.)
Index: openacs-4/packages/acs-core-docs/www/install-full-text-search-openfts.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-full-text-search-openfts.html,v
diff -u -r1.11.2.24 -r1.11.2.25
--- openacs-4/packages/acs-core-docs/www/install-full-text-search-openfts.html 20 Jun 2017 07:16:41 -0000 1.11.2.24
+++ openacs-4/packages/acs-core-docs/www/install-full-text-search-openfts.html 6 Aug 2017 11:31:21 -0000 1.11.2.25
@@ -6,7 +6,7 @@
Tsearch2. See
Install Full Text Search using Tsearch2. Tsearch2 is much easier to install, requiring only
compilation of one module from PostgreSQL contrib, with an
- automated install process using the tsearch2-driver package.
Install OpenFTS module
If you want full text search, and you are running PostgreSQL, install this module to support FTS. Do this step after you have installed both PostgreSQL and
+ automated install process using the tsearch2-driver package.
Install OpenFTS module
If you want full text search, and you are running PostgreSQL, install this module to support FTS. Do this step after you have installed both PostgreSQL and
AOLserver. You will need the openfts
tarball in /tmp.
Install Tsearch. This is a PostgreSQL module that
OpenFTS requires.
[root root]# su - postgres
@@ -81,7 +81,7 @@
make
su postgres
make install
-exit
Install OpenFTS prerequisites in PostgreSQL instance
If you are installing Full Text Search, add required
+exit
Install OpenFTS prerequisites in PostgreSQL instance
If you are installing Full Text Search, add required
packages to the new database. (In order for full text search
to work, you must also install the PostgreSQL
OpenFTS module and prerequisites.)
[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ /usr/local/pgsql/bin/psql $OPENACS_SERVICE_NAME -f /usr/local/src/postgresql-7.3.4/contrib/tsearch/tsearch.sql
Index: openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.adp,v
diff -u -r1.1.2.24 -r1.1.2.25
--- openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.adp 20 Jun 2017 07:16:41 -0000 1.1.2.24
+++ openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.adp 6 Aug 2017 11:31:21 -0000 1.1.2.25
@@ -18,7 +18,7 @@
OpenACS docs are written by the named authors, and may be edited by
OpenACS documentation staff.
-Install Tsearch2 module
If you want full text search, and you are running PostgreSQL,
+Install Tsearch2 module
If you want full text search, and you are running PostgreSQL,
install this module to support FTS. Do this step after you have
installed both PostgreSQL and AOLserver. You will need the tsearch2
module form PostgreSQL contrib. This is included with the
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.11.2.24 -r1.11.2.25
--- openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.html 20 Jun 2017 07:16:41 -0000 1.11.2.24
+++ openacs-4/packages/acs-core-docs/www/install-full-text-search-tsearch2.html 6 Aug 2017 11:31:21 -0000 1.11.2.25
@@ -6,7 +6,7 @@
V2 Introduction by Andrew J. Kopciuch
OpenACS docs are written by the named authors, and may be edited
by OpenACS documentation staff.
-
Install Tsearch2 module
If you want full text search, and you are running PostgreSQL, install this module to support FTS. Do this step after you have installed both PostgreSQL and
+
Install Tsearch2 module
If you want full text search, and you are running PostgreSQL, install this module to support FTS. Do this step after you have installed both PostgreSQL and
AOLserver. You will need the tsearch2 module form PostgreSQL
contrib. This is included with the PostgreSQL full source
distribution. It is also available with the PostgreSQL contrib
Index: openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.adp,v
diff -u -r1.1.2.23 -r1.1.2.24
--- openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.adp 20 Jun 2017 07:16:41 -0000 1.1.2.23
+++ openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.adp 6 Aug 2017 11:31:21 -0000 1.1.2.24
@@ -112,7 +112,7 @@
commands.
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.24.2.23 -r1.24.2.24
--- openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.html 20 Jun 2017 07:16:41 -0000 1.24.2.23
+++ openacs-4/packages/acs-core-docs/www/install-openacs-keepalive.html 6 Aug 2017 11:31:21 -0000 1.24.2.24
@@ -64,6 +64,6 @@
More information can be found on the AOLserver
Daemontools page.
-
- (I'm not sure if this next step is
+ (I'm not sure if this next step is
100% necessary, but when I skip it I get problems. If you get the
error 553 sorry, that domain isn't
in my list of allowed rcpthosts (#5.7.1) then you need to do
@@ -68,7 +68,7 @@
-Install Qmail.
+Install Qmail.
Download qmail, set up the
standard supporting users and build the binaries:
@@ -131,7 +131,7 @@
./collate.sh
cd netqmail-1.04
make setup check
-
(I'm not sure if this next step is 100% necessary, but when I skip it
I get problems. If you get the error 553 sorry, that domain isn't in my list of allowed rcpthosts (#5.7.1) then you need to do this.) AOLserver sends outgoing mail via the ns_sendmail
command, which pipes a command to the sendmail executable. Or, in our
@@ -44,7 +44,7 @@
send outgoing mail.
Configure qmail to use the Maildir delivery format
+chown -R alias.nofiles /var/qmail/alias/Maildir
Configure qmail to use the Maildir delivery format
(instead of mbox), and install a version of the qmail startup script modified to use Maildir.
[root alias]# echo "./Maildir" > /var/qmail/bin/.qmail
[root alias]# cp /tmp/openacs-5.9.0/packages/acs-core-docs/www/files/qmail.rc.txt /var/qmail/rc
[root alias]# chmod 755 /var/qmail/rc
Index: openacs-4/packages/acs-core-docs/www/install-redhat.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-redhat.adp,v
diff -u -r1.1.2.23 -r1.1.2.24
--- openacs-4/packages/acs-core-docs/www/install-redhat.adp 20 Jun 2017 07:16:41 -0000 1.1.2.23
+++ openacs-4/packages/acs-core-docs/www/install-redhat.adp 6 Aug 2017 11:31:21 -0000 1.1.2.24
@@ -38,7 +38,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
@@ -76,7 +76,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
@@ -105,7 +105,7 @@
development server we'll be setting up.
-Select any additional languages you want
+Select any additional languages you want
the computer to support and then click Next
Choose your time zone and click
@@ -121,11 +121,11 @@
web server, because that would conflict with the database and web
server we'll install later.
check Editors
-(this installs emacs),
click Details next
+(this installs emacs),
click Details next
to Text-based Internet, check
lynx, and click OK;
check Authoring and
-Publishing (this installs
+Publishing (this installs
docbook),
uncheck Server Configuration
Tools,
uncheck Web
Server,
uncheck Windows File
@@ -150,7 +150,7 @@
will appear.
uncheck apmd
(monitors power, not very useful for servers),
check ImageMagick
-(required for the photo-album packages,
uncheckisdn4k-utils
+(required for the photo-album packages,
uncheckisdn4k-utils
(unless you are using isdn, this installs a useless daemon),
check mutt (a mail
program that reads Maildir),
uncheck nfs-utils
(nfs is a major security risk),
uncheck pam-devel (I
@@ -197,7 +197,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.41.2.23 -r1.41.2.24
--- openacs-4/packages/acs-core-docs/www/install-redhat.html 20 Jun 2017 07:16:41 -0000 1.41.2.23
+++ openacs-4/packages/acs-core-docs/www/install-redhat.html 6 Aug 2017 11:31:21 -0000 1.41.2.24
@@ -27,7 +27,7 @@
Unplug the network cable from your
computer. We don't want to connect to the network
until we're sure the computer is secure.
-
+
(Wherever you see
the word secure, you should always read it as, "secure
enough for our purposes, given the amount of work we're
@@ -55,7 +55,7 @@
Review (and modify if needed) the partitions created and click Next
On the pop-up window asking "Are you sure
you want to do this?" click
Yes
- IF YOU ARE WIPING YOUR HARD DRIVE.
Click Next on the boot loader screen
Configure Networking.
+ IF YOU ARE WIPING YOUR HARD DRIVE.
Click Next on the boot loader screen
Configure Networking.
Again, if you know what you're doing, do this step
yourself, being sure to note the firewall holes. Otherwise,
follow the instructions in this step to set up a computer directly connected to the internet with a dedicated IP address.
DHCP is a system by which a computer that
@@ -76,7 +76,7 @@
Mail (SMTP). In the Other ports
box, enter 443, 8000, 8443. Click
Next.
-Port 443 is for https (http over ssl), and 8000 and 8443 are http and https access to the development server we'll be setting up.
Select any additional languages you want the
+Port 443 is for https (http over ssl), and 8000 and 8443 are http and https access to the development server we'll be setting up.
Select any additional languages you want the
computer to support and then click
Next
Choose your time zone and click Next.
Type in a root
password, twice.
On the Package selection page, we're going to
@@ -88,13 +88,13 @@
risk that's still screened by the firewall, or a resource hog. Just
don't install a database or web server, because that would conflict
with the database and web server we'll install later.
-
check Editors (this installs emacs),
click Details next to Text-based Internet, check lynx, and click OK;
check Authoring and Publishing (this installs docbook),
uncheck Server Configuration Tools,
uncheck Web Server,
uncheck Windows File Server,
check SQL Database Server (this installs PostgreSQL),
check Development Tools (this installs gmake and other build tools),
uncheck Administration Tools, and
uncheck Printing Support.
At the bottom, check Select Individual Packages and click Next
We need to fine-tune the exact list of packages.
+
check Editors (this installs emacs),
click Details next to Text-based Internet, check lynx, and click OK;
check Authoring and Publishing (this installs docbook),
uncheck Server Configuration Tools,
uncheck Web Server,
uncheck Windows File Server,
check SQL Database Server (this installs PostgreSQL),
check Development Tools (this installs gmake and other build tools),
uncheck Administration Tools, and
uncheck Printing Support.
At the bottom, check Select Individual Packages and click Next
We need to fine-tune the exact list of packages.
The same rules apply as in the last step - you can add more stuff, but
you shouldn't remove anything the guide adds. We're going to go
through all the packages in one big list, so select
Flat
View and wait. In a minute, a
-list of packages will appear.
uncheck apmd (monitors power, not very useful for servers),
check ImageMagick (required for the photo-album packages,
uncheckisdn4k-utils (unless you are using isdn, this installs a useless daemon),
check mutt (a mail program that reads Maildir),
uncheck nfs-utils (nfs is a major security risk),
uncheck pam-devel (I don't remember why, but we don't want this),
uncheck portmap,
uncheck postfix (this is an MTA, but we're going to install qmail later),
check postgresql-devel,
uncheck rsh (rsh is a security hole),
uncheck sendmail (sendmail is an insecure MTA; we're going to install qmail instead later),
check tcl (we need tcl), and
uncheck xinetd (xinetd handles incoming tcp connections. We'll install a different, more secure program, ucspi-tcp).
Click Next
Red Hat isn't completely happy with the combination
+list of packages will appear.
uncheck apmd (monitors power, not very useful for servers),
check ImageMagick (required for the photo-album packages,
uncheckisdn4k-utils (unless you are using isdn, this installs a useless daemon),
check mutt (a mail program that reads Maildir),
uncheck nfs-utils (nfs is a major security risk),
uncheck pam-devel (I don't remember why, but we don't want this),
uncheck portmap,
uncheck postfix (this is an MTA, but we're going to install qmail later),
check postgresql-devel,
uncheck rsh (rsh is a security hole),
uncheck sendmail (sendmail is an insecure MTA; we're going to install qmail instead later),
check tcl (we need tcl), and
uncheck xinetd (xinetd handles incoming tcp connections. We'll install a different, more secure program, ucspi-tcp).
Click Next
Red Hat isn't completely happy with the combination
of packages we've selected, and wants to satisfy some dependencies.
Don't let it. On the next screen, choose
Ignore Package
@@ -120,7 +120,7 @@
upgrading all of that. Since you are upgrading the kernel,
reboot after this step.
Lock down SSH
-
+
SSH is the protocol we use to connect
securely to the computer (replacing telnet, which is
insecure). sshd is the daemon that listens for incoming
Index: openacs-4/packages/acs-core-docs/www/install-steps.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/install-steps.adp,v
diff -u -r1.1.2.26 -r1.1.2.27
--- openacs-4/packages/acs-core-docs/www/install-steps.adp 20 Jun 2017 07:16:41 -0000 1.1.2.26
+++ openacs-4/packages/acs-core-docs/www/install-steps.adp 6 Aug 2017 11:31:21 -0000 1.1.2.27
@@ -106,8 +106,8 @@
-Paths and Users
-
Table 2.1. Default
+Paths and Users
+
Table 2.1. Default
directories for a standard install
@@ -118,7 +118,7 @@
name of administrative access account
remadmin
OpenACS service
-$OPENACS_SERVICE_NAME (set to service0
+$OPENACS_SERVICE_NAME (set to service0
in default install)
Setting a global shell variable for cut and paste. In order to cut and paste the instructions into your shell, you must set the environment variable $OPENACS_SERVICE_NAME. In order to set it globally so that it works for any new users or special service users you may create, edit the file /etc/profile ( /etc/share/skel/dot.profile for FreeBSD) and add this line:
export OPENACS_SERVICE_NAME=service0
Paths and Users
Table 2.1. Default directories for a standard install
Fully qualified domain name of your 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
Paths and Users
Table 2.1. Default directories for a standard install
Fully qualified domain name of your server
yourserver.test
name of administrative access account
remadmin
OpenACS service
$OPENACS_SERVICE_NAME (set to service0 in default install)
OpenACS service account
$OPENACS_SERVICE_NAME
OpenACS database name
$OPENACS_SERVICE_NAME
Root of OpenACS service file tree (SERVERROOT)
/var/lib/aolserver/$OPENACS_SERVICE_NAME
Location of source code tarballs for new software
/var/tmp
The OpenACS tarball contains some files which
are useful while setting up other software. Those
files are located at:
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.
-Make sure, that the Oracle CBO works with
+Make sure, that the Oracle CBO works with
adequate statistics
The Oracle Cost Based optimizer is a piece of software that
tries to find the "optimal" execution plan for a given
SQL statement. For that it estimates the costs of running a SQL
Index: openacs-4/packages/acs-core-docs/www/maint-performance.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/maint-performance.html,v
diff -u -r1.29.2.23 -r1.29.2.24
--- openacs-4/packages/acs-core-docs/www/maint-performance.html 20 Jun 2017 07:16:41 -0000 1.29.2.23
+++ openacs-4/packages/acs-core-docs/www/maint-performance.html 6 Aug 2017 11:31:21 -0000 1.29.2.24
@@ -2,7 +2,7 @@
Did performance problems happen overnight, or did they sneak up on
you? Any clue what caused the performance problems (e.g. loading 20K
users into .LRN)
Is the file system out of space? Is the machine swapping to disk constantly?
Click on "Install New Application" in "Install from OpenACS Repository"
Choose "ACS Developer Support">
After install is complete, restart the server.
Browse to Developer Support, which is automatically mounted at /ds.
-
Turn on Database statistics
Browse directly to a slow page and click "Request Information" at the bottom of the page.
This should return a list of database queries on the page, including the exact query (so it can be cut-paste into psql or oracle) and the time each query took.
Figure 6.8. Query Analysis example
Identify a runaway Oracle query: first, use ps aux or top to get the UNIX process ID of a runaway Oracle process.
Log in to SQL*Plus as the admin:
[$OPENACS_SERVICE_NAME ~]$ svrmgrl
+
Turn on Database statistics
Browse directly to a slow page and click "Request Information" at the bottom of the page.
This should return a list of database queries on the page, including the exact query (so it can be cut-paste into psql or oracle) and the time each query took.
Figure 6.8. Query Analysis example
Identify a runaway Oracle query: first, use ps aux or top to get the UNIX process ID of a runaway Oracle process.
Log in to SQL*Plus as the admin:
[$OPENACS_SERVICE_NAME ~]$ svrmgrl
Oracle Server Manager Release 3.1.7.0.0 - Production
@@ -59,7 +59,7 @@
Make sure, that the Oracle CBO works with adequate statistics
+
Make sure, that the Oracle CBO works with adequate statistics
The Oracle Cost Based optimizer is a piece of software that tries to find
the "optimal" execution plan for a given SQL statement. For that it
estimates the costs of running a SQL query in a particular way (by default
Index: openacs-4/packages/acs-core-docs/www/maintenance-deploy.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/maintenance-deploy.adp,v
diff -u -r1.1.2.25 -r1.1.2.26
--- openacs-4/packages/acs-core-docs/www/maintenance-deploy.adp 20 Jun 2017 07:16:41 -0000 1.1.2.25
+++ openacs-4/packages/acs-core-docs/www/maintenance-deploy.adp 6 Aug 2017 11:31:21 -0000 1.1.2.26
@@ -24,7 +24,7 @@
working configuration safely and quickly.
-Method 1: Deployment with CVS
With this method, we control the files on a site via CVS. This
+Method 1: Deployment with CVS
With this method, we control the files on a site via CVS. This
example uses one developmental server (service0-dev) and one
production server (service0). Depending on your needs, you can also
have a staging server for extensive testing before you go live. The
@@ -103,7 +103,7 @@
tags to follow ...
-Method 2: A/B Deployment
The approach taken in this section is to always create a new
+Method 2: A/B Deployment
The approach taken in this section is to always create a new
service with the desired changes, running in parallel with the
existing site. This guarantees control, at least at the final step
of the process: you know what changes you are about to make because
@@ -119,28 +119,28 @@
function or risk losing data in the shuffle. It also requires extra
steps if the database will be affected.
-Simple A/B Deployment: Database is not
+Simple A/B Deployment: Database is not
changed
-
Figure 6.2. Simple
+
Figure 6.2. Simple
A/B Deployment - Step 1
-
Figure 6.3. Simple
+
Figure 6.3. Simple
A/B Deployment - Step 2
-
Figure 6.4. Simple
+
Figure 6.4. Simple
A/B Deployment - Step 3
-Complex A/B Deployment: Database is
+Complex A/B Deployment: Database is
changed
-
Figure 6.5. Complex A/B Deployment
+
Figure 6.5. Complex A/B Deployment
- Step 1
-
Figure 6.6. Complex A/B Deployment
+
Figure 6.6. Complex A/B Deployment
- Step 2
-
Figure 6.7. Complex A/B Deployment
+
Figure 6.7. Complex A/B Deployment
- Step 3
Index: openacs-4/packages/acs-core-docs/www/maintenance-deploy.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/maintenance-deploy.html,v
diff -u -r1.24.2.23 -r1.24.2.24
--- openacs-4/packages/acs-core-docs/www/maintenance-deploy.html 20 Jun 2017 07:16:41 -0000 1.24.2.23
+++ openacs-4/packages/acs-core-docs/www/maintenance-deploy.html 6 Aug 2017 11:31:21 -0000 1.24.2.24
@@ -2,7 +2,7 @@
Staged Deployment for Production Networks
OpenACS docs are written by the named authors, and may be edited
by OpenACS documentation staff.
-
This section describes two minimal-risk methods for deploying changes on a production network. The important characteristics of a safe change deployment include: (THIS SECTION IN DEVELOPMENT)
Control: You know for sure that the change you are making is the change that you intend to make and is the change that you tested.
Rollback: If anything goes wrong, you can return to the previous working configuration safely and quickly.
Method 1: Deployment with CVS
With this method, we control the files on a site via
+
This section describes two minimal-risk methods for deploying changes on a production network. The important characteristics of a safe change deployment include: (THIS SECTION IN DEVELOPMENT)
Control: You know for sure that the change you are making is the change that you intend to make and is the change that you tested.
Rollback: If anything goes wrong, you can return to the previous working configuration safely and quickly.
Method 1: Deployment with CVS
With this method, we control the files on a site via
CVS. This example uses one developmental server (service0-dev) and one
production server (service0). Depending on your needs, you can also
have a staging server for extensive testing before you go
@@ -67,4 +67,4 @@
cvs up -Pd index.adp
If you make changes that require changes to the database,
test them out first on service0-dev, using either -create.sql or
upgrade scripts. Once you've tested them, you then update and
- run the upgrade scripts from the package manager.
The production site can run "HEAD" from cvs.
The drawback to using HEAD as the live code is that you cannot commit new work on the development server without erasing the definition of 'working production code.' So a better method is to use a tag. This guarantees that, at any time in the future, you can retrieve exactly the same set of code. This is useful for both of the characteristics of safe change deployment. For control, you can use tags to define a body of code, test that code, and then know that what you are deploying is exactly that code. For rollback, you can use return to the last working tag if the new tag (or new, untagged changes) cause problems. .... example of using tags to follow ...
Method 2: A/B Deployment
The approach taken in this section is to always create a new service with the desired changes, running in parallel with the existing site. This guarantees control, at least at the final step of the process: you know what changes you are about to make because you can see them directly. It does not, by itself, guarantee the entire control chain. You need additional measures to make sure that the change you are making is exactly and completely the change you intended to make and tested previously, and nothing more. Those additional measures typically take the form of source control tags and system version numbers. The parallel-server approach also guarantees rollback because the original working service is not touched; it is merely set aside.
This approach can has limitations. If the database or file system regularly receiving new data, you must interrupt this function or risk losing data in the shuffle. It also requires extra steps if the database will be affected.
Simple A/B Deployment: Database is not changed
Figure 6.2. Simple A/B Deployment - Step 1
Figure 6.3. Simple A/B Deployment - Step 2
Figure 6.4. Simple A/B Deployment - Step 3
Complex A/B Deployment: Database is changed
Figure 6.5. Complex A/B Deployment - Step 1
Figure 6.6. Complex A/B Deployment - Step 2
Figure 6.7. Complex A/B Deployment - Step 3
+ run the upgrade scripts from the package manager.
The production site can run "HEAD" from cvs.
The drawback to using HEAD as the live code is that you cannot commit new work on the development server without erasing the definition of 'working production code.' So a better method is to use a tag. This guarantees that, at any time in the future, you can retrieve exactly the same set of code. This is useful for both of the characteristics of safe change deployment. For control, you can use tags to define a body of code, test that code, and then know that what you are deploying is exactly that code. For rollback, you can use return to the last working tag if the new tag (or new, untagged changes) cause problems. .... example of using tags to follow ...
Method 2: A/B Deployment
The approach taken in this section is to always create a new service with the desired changes, running in parallel with the existing site. This guarantees control, at least at the final step of the process: you know what changes you are about to make because you can see them directly. It does not, by itself, guarantee the entire control chain. You need additional measures to make sure that the change you are making is exactly and completely the change you intended to make and tested previously, and nothing more. Those additional measures typically take the form of source control tags and system version numbers. The parallel-server approach also guarantees rollback because the original working service is not touched; it is merely set aside.
This approach can has limitations. If the database or file system regularly receiving new data, you must interrupt this function or risk losing data in the shuffle. It also requires extra steps if the database will be affected.
Simple A/B Deployment: Database is not changed
Figure 6.2. Simple A/B Deployment - Step 1
Figure 6.3. Simple A/B Deployment - Step 2
Figure 6.4. Simple A/B Deployment - Step 3
Complex A/B Deployment: Database is changed
Figure 6.5. Complex A/B Deployment - Step 1
Figure 6.6. Complex A/B Deployment - Step 2
Figure 6.7. Complex A/B Deployment - Step 3
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.1.2.25 -r1.1.2.26
--- openacs-4/packages/acs-core-docs/www/objects.adp 20 Jun 2017 07:16:41 -0000 1.1.2.25
+++ openacs-4/packages/acs-core-docs/www/objects.adp 6 Aug 2017 11:31:21 -0000 1.1.2.26
@@ -86,7 +86,7 @@
for the PG version) file created when we created the package.
Then, do the following:
-Describe the new type to the type
+Describe the new type to the type
system
First, add an entry to the acs_object_types table with the following
PL/SQL call:
begin
@@ -142,7 +142,7 @@
attributes, so there is no need for us to define them.
-Define a table in which to store your
+Define a table in which to store your
objects
The next thing we do is make a small modification to the data
model to reflect the fact that each row in the notes table represents something that is
not only an object of type note, but also an acs_object. The new table definition looks
@@ -166,7 +166,7 @@
acs_objects.
-Define a package for type specific
+Define a package for type specific
procedures
The next step is to define a PL/SQL package for your new type,
and write some basic procedures to create and delete objects. Here
is a package definition for our new type:
@@ -213,7 +213,7 @@
only" by default. We'll talk about this more later.
-Define a package body for type specific
+Define a package body for type specific
procedures
The PL/SQL package body contains the implementations of the
procedures defined above. The only subtle thing going on here is
that we must use acs_object.new
Index: openacs-4/packages/acs-core-docs/www/objects.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/objects.html,v
diff -u -r1.52.2.23 -r1.52.2.24
--- openacs-4/packages/acs-core-docs/www/objects.html 20 Jun 2017 07:16:41 -0000 1.52.2.23
+++ openacs-4/packages/acs-core-docs/www/objects.html 6 Aug 2017 11:31:21 -0000 1.52.2.24
@@ -79,7 +79,7 @@
Fire up your text editor and open the
ROOT/packages/notes/sql/oracle/notes-create.sql (ROOT/packages/notes/sql/postgresql/notes-create.sql for the PG version) file created
when we created the package. Then, do the following:
-
Describe the new type to the type system
+
Describe the new type to the type system
First, add an entry to the acs_object_types table with the following PL/SQL call:
begin
@@ -139,7 +139,7 @@
because the new type note is a subtype of
acs_object, it will inherit these attributes, so there is
no need for us to define them.
-
Define a table in which to store your objects
+
Define a table in which to store your objects
The next thing we do is make a small modification to the data model to
reflect the fact that each row in the notes table
represents something that is not only an object of type
@@ -164,7 +164,7 @@
use the acs_objects table to find objects will
transparently find any objects that are instances of any subtype of
acs_objects.
-
Define a package for type specific procedures
+
Define a package for type specific procedures
The next step is to define a PL/SQL package for your new type, and
write some basic procedures to create and delete objects. Here is a
package definition for our new type:
@@ -212,7 +212,7 @@
object OBJ was "read only", then any other object that used OBJ as its
context would also be "read only" by default. We'll talk about this more
later.
-
Define a package body for type specific procedures
+
Define a package body for type specific procedures
The PL/SQL package body contains the implementations of the procedures
defined above. The only subtle thing going on here is that we must use
acs_object.new to insert a row into
Index: openacs-4/packages/acs-core-docs/www/openacs.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/openacs.adp,v
diff -u -r1.1.2.26 -r1.1.2.27
--- openacs-4/packages/acs-core-docs/www/openacs.adp 20 Jun 2017 07:16:41 -0000 1.1.2.26
+++ openacs-4/packages/acs-core-docs/www/openacs.adp 6 Aug 2017 11:31:21 -0000 1.1.2.27
@@ -336,7 +336,7 @@
automate vacuuming is to edit the cron file for the database user.
Recommended: VACUUM ANALYZE
every hour and VACUUM FULL
-ANALYZE every day.
Add these lines to the file. The vacuum command cleans up
temporary structures within a PostGreSQL database, and can improve
@@ -370,7 +370,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.
+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
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.51.2.23 -r1.51.2.24
--- openacs-4/packages/acs-core-docs/www/openacs.html 20 Jun 2017 07:16:41 -0000 1.51.2.23
+++ openacs-4/packages/acs-core-docs/www/openacs.html 6 Aug 2017 11:31:21 -0000 1.51.2.24
@@ -237,7 +237,7 @@
CREATE DATABASE
[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$
su - $OPENACS_SERVICE_NAME
-/usr/local/pgsql/bin/createdb -E UNICODE $OPENACS_SERVICE_NAME
Automate daily database Vacuuming. This is a process which cleans out discarded data from the database. A quick way to automate vacuuming is to edit the cron file for the database user. Recommended: VACUUM ANALYZE every hour and VACUUM FULL ANALYZE every day.
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.
Automate daily database Vacuuming. This is a process which cleans out discarded data from the database. A quick way to automate vacuuming is to edit the cron file for the database user. Recommended: VACUUM ANALYZE every hour and VACUUM FULL ANALYZE every day.
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.
Depending on your distribution, you may receive
email when the crontab items are executed. If you
don't want to receive email for those crontab items,
@@ -250,7 +250,7 @@
need to configure a virtual server. The Reference Platform
uses a configuration file included in the OpenACS tarball,
/var/lib/aolserver/$OPENACS_SERVICE_NAME/etc/config.tcl.
- Open it in an editor to adjust the parameters.
[root root]# su - $OPENACS_SERVICE_NAME
+ Open it in an editor to adjust the parameters.
[root root]# su - $OPENACS_SERVICE_NAME
[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/etc
[$OPENACS_SERVICE_NAME etc]$ emacs config.tcl
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/
@@ -65,7 +65,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
@@ -136,7 +136,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.
Here is how an OpenACS 5 server is laid out
starting from the Server root (ROOT):
-
Figure 11.1. Server file layout diagram
+
Figure 11.1. Server file layout diagram
ROOT/
bin/
Various executables and scripts for server maintanence.
@@ -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.
Suppose objects A, B, ...,
and F form the following hierarchy.
-
Table 11.2. Context Hierarchy Example
+
Table 11.2. Context Hierarchy Example
A
object_id=10
@@ -139,7 +139,7 @@
This can be represented in the
acs_objects table
by the following entries:
-
Table 11.3. acs_objects example data
object_id
context_id
20
10
30
10
40
20
50
20
60
30
+
Table 11.3. acs_objects example data
object_id
context_id
20
10
30
10
40
20
50
20
60
30
The first entry tells us that object 20 is the descendant of object 10, and
the third entry shows that object 40 is the descendant of object 20. By
running a CONNECT BY query,
Index: openacs-4/packages/acs-core-docs/www/psgml-for-emacs.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/psgml-for-emacs.adp,v
diff -u -r1.1.2.23 -r1.1.2.24
--- openacs-4/packages/acs-core-docs/www/psgml-for-emacs.adp 20 Jun 2017 07:16:41 -0000 1.1.2.23
+++ openacs-4/packages/acs-core-docs/www/psgml-for-emacs.adp 6 Aug 2017 11:31:22 -0000 1.1.2.24
@@ -12,7 +12,7 @@
Add PSGML commands to emacs init file
(OPTIONAL)
- If you plan to write or edit any
+ If you plan to write or edit any
documentation with emacs, install a customized emacs configuration
file with DocBook commands in the skeleton directory, so it will be
used for all new users. The file also fixes the backspace ->
Index: openacs-4/packages/acs-core-docs/www/psgml-for-emacs.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/psgml-for-emacs.html,v
diff -u -r1.41.2.23 -r1.41.2.24
--- openacs-4/packages/acs-core-docs/www/psgml-for-emacs.html 20 Jun 2017 07:16:41 -0000 1.41.2.23
+++ openacs-4/packages/acs-core-docs/www/psgml-for-emacs.html 6 Aug 2017 11:31:22 -0000 1.41.2.24
@@ -1,5 +1,5 @@
-
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.1.2.26 -r1.1.2.27
--- openacs-4/packages/acs-core-docs/www/release-notes.adp 20 Jun 2017 07:16:41 -0000 1.1.2.26
+++ openacs-4/packages/acs-core-docs/www/release-notes.adp 6 Aug 2017 11:31:22 -0000 1.1.2.27
@@ -12,6 +12,422 @@
OpenACS Release Notes
+Release 5.9.2
+
The release of OpenACS 5.9.1 contains the 88 packages of the
+oacs-5-9 branch. These packages include the OpenACS core packages,
+the major application packages (e.g. most the ones used on
+OpenACS.org), and DotLRN 2.9.1.
+
Summary of changes:
+
+
Refactoring of rich-text editor integration
+
Driving force: Debian packaging (e.g. js minified code is not
+allowed)
Moved out code from acs-templating, provided interfaces to add
+many different richtext editors as separate packages
+
New OpenACS packages:
+
richtext-xinha
richtext-tinymce
richtext-ckeditor4 (has ability to choose between CDN and local
+installation via web interface)
+
+
+
+
+
Improving admin interface
+
+
New theme manager:
+
+
Goals:
+
Make it easier to keep track of themes with local
+modifications
Make it easier to create local modification a new themes and to
+update these
Show differences between default theme parameter (in DB) and
+actual settings (in subsite parameters)
Allow to delete unused themes
Give site admin hints, which theme is used at which subsite
Ease theme switching
+
+
Added a subsite::theme_changed callback to be able to handle
+theme changes in custom themes (was also necessary for proper
+integration with DotLRN theming)
Added support for these features under subsite admin
+(/admin/)
Improved support for themed templates via
+[template::themed_template]
+
+
Improved (broken) interface to define/manage groups over web
+interface
Allow to send as well mail, when membership was rejected
New functions [membership_rel::get_user_id],
+[membership_rel::get] and [membership_rel::get_group_id] to avoid
+code duplication
Added support to let user include %forgotten_password_url% in
+self-registration emails (e.g. in message key
+acs-subsite.email_body_Registration_password)
+
Improved subsite/www/members
+
Make it possible to manage members of arbitrary groups
Improved performance for large groups
Improved configurability: when ShowMembersListTo is set to
+"3", show list to members only, when this is not the
+whole subsite
+
+
Improved user interface for /admin/applications for large number
+of applications
Various fixes for sitewide-admin pages (under /acs-admin)
Update blueprint in "install from repository"
+(currently just working in NaviServer)
+
+
+
SQL
+
+
Further cleanup of .xql files (like what as done for acs-subsite
+in OpenACS 5.9.0):
+
36 files deleted
Removed more than 100 obsolete named queries
Stripped misleading SQL statements
+
+
Marked redundant / uncalled sql functions as deprecated
Replaced usages of obsolete view
+"all_object_party_privilege_map" by
+"acs_object_party_privilege_map"
+
Removed type discrepancy introduced in 2002:
+
acs_object_types.object_type has type varchar(1000), while
acs_object_types.supertype has type varchar(100)
... several more data types are involved, using
+acs_object_types.object_type as foreign key
+
+
+
Simplified core sql functions by using defaults:
+
Number of functions reduced by a factor of 2 compared to OpenACS
+5.9.0 (while providing compatibility for clients using old
+versions),
Reduced code redundancy
+
Affected functions:
+
Reduced content_item__new from 12 versions to 6,
Reduce content_revision__new from 7 to 4
Similar in image__new, image__new_revision, content_item__copy,
+content_item__get_title, content_item__move
+
+
PostgreSQL 9.5 supports named parameter in the same syntax as in
+Oracle. Further reduction of variants will be possible, once
+OpenACS requires at least PostgreSQL 9.5
+
+
Reduced usage of deprecated versions of SQL functions (mostly
+content repository calls)
Reduced generation of dead tuples by combining multiple DML
+statements to one (reduces costs of checkpoint cleanups in
+PostgreSQL)
+
Permission queries:
+
Improved performance
Support PACKAGE.FUNCTION notation for PostgreSQL to allow calls
+permission queries exactly the same way as in Oracle (e.g.
+"acs_permission.permission_p()"). This helps to reduce
+the number of postgres specific .xql files.
+
+
+
Modernize SQL:
+
Use real Boolean types instead of character(1) (done for
+new-portal, forums, faq, attachments, categories, dotlrn,
+dotlrn-forums, evaluation)
Use real enumeration types rather than check constraints (done
+for storage_type text/file/lob)
+
+
+
+
+
CR hygienics (reduce cr bloat)
+
+
Provided means to avoid insert/update/delete operations in the
+search queue:
OpenACS adds for every new revision often multiple entries to
+the search_queue, without providing any means to prevent this. This
+requires for busy sites very short intervals between queue sweeps
+(otherwise too many entries pile up). Another consequence is that
+this behavior keeps the PostgreSQL auto-vacuum daemons permanently
+active. Many of these operations are useless in cases where the
+content repository is used for content that should not be provided
+via search. The changed behavior should honors a publish-date set
+to the future, since it will not add any content with future
+publish dates to the search-queue.
+
+
Reduced number of insert cr_child_rels operations, just when
+needed:
cr_child_rels provide only little benefit (allow to use roles in
+a child-rel), but the common operation is a well available in
+cr_items via the parent_id. cr_child_rels do not help for recursive
+queries either. One option would be to add an additional argument
+for content_item__new to omit child-rel creation (default is old
+behavior) and adapt the other cases.
+
+
+
+
Security improvements
+
+
Added support against CSRF (cross site request forgery)
+
OpenACS maintains a per-request CSRF token that ensures that
+form replies are coming just from sites that received the form
CSRF support is optional for packages where CSRF is less
+dangerous, and such requests are wanted (e.g. search and
+api-browser)
+
+
+
Added Support for W3C "Upgrade-Insecure-Headers" (see
+https://www.w3.org/TR/upgrade-insecure-requests/):
For standard compliant upgrade for requests from HTTP to
+HTTPS
+
Added support for W3C "Subresource Integrity" (SRI;
+see https://www.w3.org/TR/SRI/)
+
Added support for W3C "Content Security Policy"
+(CSP; see
+https://www.w3.org/TR/CSP/)
+
Removed "javascript:*" links (all such urls are
+removed from the 90 packages in oacs-5-9, excluding js libraries
+(ajaxhelper) and richtext code)
Removed "onclick", "onfocus",
+"onblur", "onchange" handlers from all .adp and
+.tcl files in the 90 packages in oacs-5-9 (excluding js libraries
+(ajaxhelper) and richtext code)
Added optional nonces to all <script> elements with
+literal JavaScript content
+
+
Removed "generic downloader", which allowed to
+download arbitrary content items, when item_id was known
+(bug-fix)
Improved protection against XSS and SQL-injection (strengthen
+page contracts, add validators, added page_contract_filter
+"localurl", improve HTML escaping, and URI encoding)
Fixed for potential traversal attack
+(acs-api-documentation-procs)
+
+
+
Improvements for "host-node mapped" subsites
+
Fixed links from host-node mapped subsite pages to swa-functions
+(must be always on main subsite)
Made "util_current_directory" aware of
+host-node-mapped subsites
Added ability to pass "-cookie_domain" to make it
+possible to use the same cookie for different domains
Fixed result of affected commands
+"util_current_location", "ad_return_url",
+"ad_get_login_url" and "ad_get_logout_url" for
+HTTP and HTTPS, when UseHostnameDomainforReg is 0 or 1.
Improved UI for host-node maps when a large number of site nodes
+exists
+
+
+
Reform of acs-rels
+
Made acs-rels configurable to give the developer the option to
+specify, whether these are composable or not (default fully
+backward compatible). This is required to control transitivity in
+rel-segments
+
The code changes are based on a patch provided by Michael
+Steigmann. For details, see:
Don't report data source errors with status code 200 (use
+422 instead)
Let "permission::require_permission" return forbidden
+(403) in AJAX calls (determined via [ad_conn ajaxp])
+
+
+
Improved Internationalization
+
+
Extended language catalogs for
+
Russian (thanks to v v)
Italian (thanks to Antonio Pisano)
Spanish (thanks to Hector Romojaro)
German (thanks to Markus Moser)
+
+
Added (missing) message keys
Improved wording of entries
Added message keys for member_state changes, provide API via
+group::get_member_state_pretty
+
+
+
Improved online documentation (/doc)
+
Fixed many broken links
Removed fully obsolete sections
Improved markup (modernize HTML)
Updated various sections
+
+
+
Misc code improvements:
+
18 issues from the OpenACS-bug-tracker fixed
Made code more robust against invalid/incorrect input
+(page_contracts, validators, values obtained from header fields
+such as Accept-Language)
Fixed quoting of message keys on many places
Improved exception handling (often, a "catch" swallows
+to much, e.g. script_aborts), introducing
+"ad_exception".
+
Generalized handling of leading zeros:
+
Fixed cases where leading zeros could lead to unwanted octal
+interpretations
Switch to use of " util::trim_leading_zeros" instead
+of "template::util::leadingTrim",
+"dt_trim_leading_zeros" and
+"template::util::leadingTrim", marked the latter as
+deprecated
+
+
+
URL encoding
+
"ad_urlencode_folder_path": new function to perform an
+urlencode operation on the segments of the provided folder path
"export_vars": encode path always correctly, except
+-no_base_encode is specified
Fixed encoding of the URL path in
+"ad_returnredirect"
+
+
+
Improvements for "ad_conn":
+
Added [ad_conn behind_proxy_p] to check, whether the request is
+coming from behind a proxy server
Added [ad_conn behind_secure_proxy_p] to check, whether the
+request is coming from behind a secure proxy server
Added [ad_conn ajax_p] to check, whether the request is an AJAX
+requests (assumption: AJAX request sets header-field
+Requested-With: XMLHttpRequest")
Added [ad_conn vhost_url] to obtain the url of host-node-mapped
+subsites
+
+
Added various missing upgrade scripts (missing since many years)
+of changes that were implemented for new installs to reduce
+differences between "new"-and "old" (upgraded)
+installations
+
Templating
+
Get rid of various pesky "MISSING FORMWIDGET:
+...formbutton:ok" messages
Improved support for javascript event handlers in
+template::head
New functions "template::add_event_listener" and
+"template::add_confirm_handler"
Fix handling, when "page_size_variable_p" is set (was
+broken since ages)
+
+
+
Improved location and URL handling:
+
Refactored and commented "util_current_location" to
+address security issues, handle IPv6 addresses, IP literal
+notation, multiple drivers, "
Improved "security::get_secure_location" (align with
+documentation)
+
New functions:
+
"util::configured_location"
"util::join_location",
+"util::split_location"
+
for working on HTTP locations to reduce scattered regexps
+handling URL components
+
Improved IPv6 support
Use native "ns_parseurl" when available, provide
+backward compatible version for AOLserver
+
+
+
MIME types:
+
Added more Open XML formats for MS-Office to allowed content
+types
Modernized entries to IANA recommendations
New function "cr_check_mime_type" centralizing the
+retrieval of the mime_type from uploaded content
+
+
+
Finalized cleanup of permissions (started in OpenACS 5.9.0):
+
Get rid of "acs_object_context_index " (and therefore
+on "acs_object_party_privilege_map " as well) on
+PostgreSQL.
Reasons:
+
huge table,
expensive maintenance, used only in a few places,
+
+
+
+
Misc new functions:
+
"lang::util::message_key_regexp": factor out scattered
+regexp for detecting message keys
"ns_md5" and "ns_parseurl": improve
+compatibility between AOLserver and NaviServer
"ad_dom_sanitize_html": allow to specify different
+sets of tags, attributes and protocols and
+"ad_dom_fix_html", which is a light weight tidy
+variant.
+
+
Improved HTML rendering (acs-api-browser), provide width and
+height to speed up rendering
Improved ADP files (e.g. missing doc(title))
Added usage of "ad_include_contract" on more
+occasions
Modernize Tcl and HTML coding
Reduced dependency on external programs (use Tcl functions
+instead)
Improved robustness of "file delete" operations all
+over the code
Improved documentation, fix demo pages
Aligned usages of log notification levels (distinction between
+"error", "warning" and "notice") with
+coding-standards
+
Cleaned up deprecated calls:
+
Removed usage of deprecated API functions (e.g.
+"cc_lookup_email_user", "cc_email_from_party",
+"util_unlist", ...)
Moved more deprecated procs to acs-outdated
Marked remaining (and unused) "cc_*" functions as well
+as deprecated.
+
+
Improved Oracle and windows support
Fixed common spelling errors and standardize spelling of product
+names all over the code (comments, documentation, ...)
Many more small bug fixes
+
+
+
Packages:
+
New Package Parameters
+
+
acs-kernel:
+
MaxUrlLength: remove hard-coded constant in request processor
+for max accepted url paths
SecureSessionCookie: Let site admin determine, whether or not to
+use secured session cookies (useful, when not all requests are over
+HTTPS)
CSPEnabledP: activate/deactivate CSP
+
+
+
acs-kernel (recommended to be set via config file in section
+"ns/server/${server}/>acs"
+
NsShutdownWithNonZeroExitCode: tell NaviServer to return with a
+non-zero return code to cause restart (important under windows)
LogIncludeUserId: include user_id in access log
+
+
+
acs-api-browser:
ValidateCSRFP: make checking of CSRF optional (default 1)
+
+
acs-content-repository:
AllowMimeTypeCreationP: Decides whether we allow unknown mime
+types to be automatically registered (default: 0}
+
+
news-portlet:
display_item_lead_p: Should we display news leads in the
+portlet? (default 0)
+
+
search:
ValidateCSRFP: make checking of CSRF optional (default 1)
+
+
xotcl-request-monitor:
do_track_activity: turn activity monitoring on or off (default
+0)
+
+
+
+
New OpenACS packages:
+
richtext-xinha
richtext-tinymce
richtext-ckeditor4 (has ability to choose between CDN and local
+installation via GUI)
openacs-bootstrap3-theme (as used on openacs.org)
dotlrn-bootstrap3-theme
+
+
+
+
xotcl-core:
+
Improved XOTcl 2.0 and NX support (e.g. api-browser)
Added "-debug", "-deprecated" to ad_*
+defined methods (such as e.g. "ad_instproc")
Make use of explicit "create" statements when creating
+XOTcl/NX objects (makes it easier to grab intentions and to detect
+typos)
Added parameter to "get_instance_from_db" to specify,
+whether the loaded objects should be initialized
Added support for PostgreSQL prepared statements of SQL
+interface in ::xo::dc (nsdb driver)
+
+
+
xowiki:
+
Named all web-callable methods www-NAME (to make it clear, what
+is called, what has to be checked especially carefully)
Moved templates from www into xowiki/resources to avoid naming
+conflicts
Improved ckeditor support
Added usage of prepared statements for common queries
Improved error handling
Better value checking for query parameter, error reporting via
+ad_return_complaint
Added option "-path_encode" to methods
+"pretty_link" and "folder_path" to allow to
+control, whether the result should be encoded or not (default
+true)
+
Form fields:
+
Improved repeatable form fields (esp. composite cases),
+don't require preallocation (can be costly in composite
+cases)
Added signing of form-fields
Added HTML5 attributes such as "multiple" (for
+"file") or "autocomplete"
Fixed generation of "orderby" attribute based on
+form-field names
richtext: allow to specify "extraAllowedContent" via
+options
Improved layout of horizontal check boxes
+
+
+
Menu bar:
+
Added dropzone (requires bootstrap): drag and drop file
+upload
Added mode toggle (requires bootstrap)
Extended default policies for handling e.g. dropzone
+(file-upload method)
Distinguish between "startpage"
+(menu.Package.Startpage) and "table of contents"
+(menu.Package.Toc)
+
+
+
Notifications:
+
Added support for better tailorable notifications: introduced
+method "notification_render" (similar to
+"search_render")
Added support for tailorable subject lines (method
+"notification_subject")
+
+
Improved bootstrap support, use "bootstrap" as
+PreferredCSSToolkit
Switched to ckeditor4 as PreferredRichtextEditor
Improved handling of script-abort from within the payload of
+::xowiki::Object payloads
Added parameter to "get_all_children" to specify,
+whether the child objects should be initialized
+
+
+
xowf:
+
Added property "payload" to
+"WorkflowConstruct" in order to simplify customized
+workflow "allocate" actions
Internationalized more menu buttons
+
+
+
xotcl-request-monitor
+
Added class "BanUser" (use. e.g. ip address to
+disallow requests from a user via request monitor)
Added support for optional user tracking in database
Added support for monitoring response-time for certain urls via
+munin
Performed some refactoring of response-time handling to allow
+site-admin to make e.g. use of NaviServer's dynamic connection
+pool management (not included in CVS)
Added support for partial times in long-calls.tcl to ease
+interpretation of unexpected slow calls
last100.tcl: Don't report hrefs to URLs, except to SWAs
+
+
+
chat:
+
Introduced new options to set chat rooms so login and/or logout
+message are not issued every time a user enters/exits a chat-room
+(important for chats with huge number of participants)
Parameterized viewing of chat-logs
Fixed cases of over-/under-quoting
Fixed JavaScript for IE, where innerHTML can cause problems
+
+
+
file-storage:
+
Don't show action keys, when user has no permissions
Added support for copying of same-named files into a folder
+(adding suffix)
Fixed old bugs in connection with "views" package
+
+
+
+
+
+
+
Altogether, OpenACS 5.9.1 differs from OpenACS 5.9.1 by the
+following statistics
contributed by 5 committers (Michael Aram, Gustaf Neumann,
+Antonio Pisano, Hector Romojaro, Thomas Renner) and 8 patch/bugfix
+providers (Frank Bergmann, Günter Ernst, Brian
+Fenton, Felix Mödritscher, Marcus Moser, Franz Penz,
+Stefan Sobernig, Michael Steigman). All packages of the release
+were tested with PostgreSQL 9.6.* and Tcl 8.5.*.
The release of OpenACS 5.9.0 contains the 78 packages of the
oacs-5-9 branch. These packages include the OpenACS core packages,
@@ -26,11 +442,11 @@
speedup operations, where the context-id is changed (could take on
large installation several minutes in earlier versions)
Removed several uncalled / redundant SQL statements and
functions.
-
Cleanup of .xql files in acs-subsite:
-
Some cleanup of .xql files: removed misleading sql-statements
-from db_* calls, which were ignored due .xql files
Removed bug where same query-name was used in different branches
+
Cleanup of .xql files in acs-subsite:
+
Some cleanup of .xql files: removed misleading sql-statements
+from db_* calls, which were ignored due .xql files
Removed bug where same query-name was used in different branches
of an if-statement for different sql statements, but the query-name
-lead to the wrong result.
Removed multiple entries of same query name from .xql files
+lead to the wrong result.
Removed multiple entries of same query name from .xql files
(e.g. the entry
"package_create_attribute_list.select_type_info" was 7
(!) times in a single .xql file)
@@ -43,10 +459,10 @@
core.js to a body requests, provide kernel parameter
ResourcesExpireInterval to specify expiration times for
resources.
Much better protection against XSS attacks.
Improved HTML validity (especially for admin pages)
-
Improved admin interface:
-
Placed all installation options to a single page.
Added pagination to /admin/applications (was unusable for large
-sites)
New admin pages for subsites linked from site-wide-admin package
-(/acs-admin).
Added explanatory text to several admin pages.
+
Improved admin interface:
+
Placed all installation options to a single page.
Added pagination to /admin/applications (was unusable for large
+sites)
New admin pages for subsites linked from site-wide-admin package
+(/acs-admin).
Added explanatory text to several admin pages.
Add lightweight support for ckeditor4 for templating::richtext
widget (configurable via package parameter
@@ -92,8 +508,9 @@
xotcl_object_types) and nsvs (e.g ds_properties)
Improved templating of OpenACS core documentation
Improved Russian Internationalization
Make pretty-names of acs-core packages more consistent
Mark unused functions of acs-tcl/tcl/table-display-procs.tcl as
deprecated
Many more bug fixes (from bug tracker and extra) and performance
improvements.
-
Version numbers:
-
Require PG 9.0 (End Of Life of PostgreSQL 8.4 was July 2014)
Require XOTcl 2.0 (presented at the Tcl conference in 2011).
+
Version numbers:
+
Require PostgreSQL 9.0 (End Of Life of PostgreSQL 8.4 was July
+2014)
Require XOTcl 2.0 (presented at the Tcl conference in 2011).
@@ -106,14 +523,13 @@
Altogether, OpenACS 5.9.0 differs from OpenACS 5.8.1 by the
following statistics
contributed by 4 committers (Michael Aram, Victor Guerra, Gustaf
Neumann, Antonio Pisano) and patch/bugfix providers (Frank
Bergmann, Andrew Helsley, Felix Mödritscher, Marcos
Moser, Franz Penz, Thomas Renner). These are significantly more
changes as the differences in the last releases. All packages of
-the release were tested with PostgreSQL 9.4.* and Tcl 8.5.*. For
-more details, consult the raw ChangeLog.
+the release were tested with PostgreSQL 9.4.* and Tcl 8.5.*.
@@ -403,20 +819,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/* *~")
-
- The release of OpenACS 5.9.0 contains the 78 packages of the oacs-5-9 branch.
- These packages include the OpenACS core packages, the major
- application packages (e.g. most the ones used on OpenACS.org), and
- DotLRN 2.9.0.
-
+ The release of OpenACS 5.9.1 contains the 88 packages of the oacs-5-9
+ branch. These packages include the OpenACS core packages, the major
+ application packages (e.g. most the ones used on OpenACS.org), and
+ DotLRN 2.9.1.
+
+ Summary of changes:
+
+ Refactoring of rich-text editor integration
+
+ Driving force: Debian packaging (e.g. js minified code is not
+ allowed)
+
+ Moved out code from acs-templating, provided interfaces to add
+ many different richtext editors as separate packages
+
+ New OpenACS packages:
+
richtext-xinha
richtext-tinymce
+ richtext-ckeditor4 (has ability to choose between CDN and local
+ installation via web interface)
+
+
- Replaced many manual referential integrity calls by
- built-in handing in PostgreSQL.
+ Improving admin interface
+
New theme manager:
+
Goals:
+
+ Make it easier to keep track of themes with local
+ modifications
+
+ Make it easier to create local modification a new themes and to
+ update these
+
+ Show differences between default theme parameter (in DB) and
+ actual settings (in subsite parameters)
+
+ Allow to delete unused themes
+
+ Give site admin hints, which theme is used at which
+ subsite
+
Ease theme switching
+
+ Added a subsite::theme_changed callback to be able to handle
+ theme changes in custom themes (was also necessary for proper
+ integration with DotLRN theming)
+
+ Added support for these features under subsite admin
+ (/admin/)
+
+ Improved support for themed templates via
+ [template::themed_template]
+
+
+ Improved (broken) interface to define/manage groups over web
+ interface
+
+ Allow to send as well mail, when membership was rejected
+
+ New functions [membership_rel::get_user_id],
+ [membership_rel::get] and [membership_rel::get_group_id] to avoid
+ code duplication
+
+ Added support to let user include %forgotten_password_url%
+ in self-registration emails (e.g. in message key
+ acs-subsite.email_body_Registration_password)
+
+ Improved subsite/www/members
+
Make it possible to manage members of arbitrary groups
Improved performance for large groups
Improved configurability: when ShowMembersListTo is set to
+ "3", show list to members only, when this is not the
+ whole subsite
+
+ Improved user interface for /admin/applications for large number of
+ applications
+
Various fixes for sitewide-admin pages (under /acs-admin)
+ Update blueprint in "install from
+ repository" (currently just working in NaviServer)
+
+
SQL
+
+ Further cleanup of .xql files (like what as done for
+ acs-subsite in OpenACS 5.9.0):
+
+ 36 files deleted
+
+ Removed more than 100 obsolete named queries
+
+ Stripped misleading SQL statements
+
+
+ Marked redundant / uncalled sql functions as deprecated
+
+ Replaced usages of obsolete view
+ "all_object_party_privilege_map" by
+ "acs_object_party_privilege_map"
+
+ Removed type discrepancy introduced in 2002:
+
+ acs_object_types.object_type has type varchar(1000), while
+
+ acs_object_types.supertype has type varchar(100)
+
+ ... several more data types are involved, using
+ acs_object_types.object_type as foreign key
+
+
+ Simplified core sql functions by using defaults:
+
+ Number of functions reduced by a factor of 2 compared to OpenACS
+ 5.9.0 (while providing compatibility for clients using old
+ versions),
+
+ Reduced code redundancy
+
+ Affected functions:
+
Reduced content_item__new from 12 versions to 6,
+
Reduce content_revision__new from 7 to 4
+
+ Similar in image__new, image__new_revision, content_item__copy,
+ content_item__get_title, content_item__move
+
+
+ PostgreSQL 9.5 supports named parameter in the same syntax as in Oracle.
+ Further reduction of variants will be possible, once OpenACS
+ requires at least PostgreSQL 9.5
+
+
+ Reduced usage of deprecated versions of SQL functions (mostly
+ content repository calls)
+
+ Reduced generation of dead tuples by combining multiple DML
+ statements to one (reduces costs of checkpoint cleanups in
+ PostgreSQL)
+
+ Permission queries:
+
+ Improved performance
+
+ Support PACKAGE.FUNCTION notation for PostgreSQL to
+ allow calls permission queries exactly
+ the same way as in Oracle (e.g. "acs_permission.permission_p()").
+ This helps to reduce the number of postgres specific .xql
+ files.
+
+
+ Modernize SQL:
+
+ Use real Boolean types instead of character(1)
+ (done for new-portal, forums, faq, attachments, categories, dotlrn,
+ dotlrn-forums, evaluation)
+
+ Use real enumeration types rather than check constraints (done
+ for storage_type text/file/lob)
+
+
- Removed various manual bookkeeping and deletion operations
- in the content repository by built-in handing in PostgreSQL.
+ CR hygienics (reduce cr bloat)
+
+ Provided means to avoid insert/update/delete operations in the
+ search queue:
OpenACS adds for every new revision often multiple
+ entries to the search_queue, without providing any means to prevent
+ this. This requires for busy sites very short intervals between
+ queue sweeps (otherwise too many entries pile up). Another
+ consequence is that this behavior keeps the PostgreSQL
+ auto-vacuum daemons permanently active. Many of these operations
+ are useless in cases where the content repository is used for
+ content that should not be provided via search. The changed
+ behavior should honors a publish-date set to the future, since it
+ will not add any content with future publish dates to the
+ search-queue.
+ Reduced number of insert cr_child_rels operations, just when
+ needed:
+
cr_child_rels provide only little benefit (allow to use
+ roles in a child-rel), but the common operation is a well available
+ in cr_items via the parent_id. cr_child_rels do not help for
+ recursive queries either. One option would be to add an additional
+ argument for content_item__new to omit child-rel creation (default
+ is old behavior) and adapt the other cases.
+
- Removed tree_sortkey on acs-objects to reduce its size and
- to speedup operations, where the context-id is changed
- (could take on large installation several minutes in
- earlier versions)
+ Security improvements
+
+ Added support against CSRF (cross site request
+ forgery)
+
+ OpenACS maintains a per-request CSRF token that ensures
+ that form replies are coming just from sites that received the
+ form
+
+ CSRF support is optional for packages where CSRF is less
+ dangerous, and such requests are wanted (e.g. search and api-browser)
+
+
+ Added Support for W3C "Upgrade-Insecure-Headers" (see
+ https://www.w3.org/TR/upgrade-insecure-requests/):
+
For standard
+ compliant upgrade for requests from HTTP to HTTPS
+
+ Added support for W3C "Subresource Integrity" (SRI;
+ see https://www.w3.org/TR/SRI/)
+
+ Added support for W3C "Content Security Policy"
+ (CSP; see https://www.w3.org/TR/CSP/)
+
+ Removed "javascript:*" links (all such urls are removed
+ from the 90 packages in oacs-5-9, excluding js libraries
+ (ajaxhelper) and richtext code)
+
+ Removed "onclick", "onfocus",
+ "onblur", "onchange" handlers from all
+ .adp and .tcl files in the 90 packages in oacs-5-9
+ (excluding js libraries (ajaxhelper) and richtext code)
+
+ Added optional nonces to all <script> elements with
+ literal JavaScript content
+
+
+ Removed "generic downloader",
+ which allowed to download arbitrary content items, when item_id was
+ known (bug-fix)
+
+ Improved protection against XSS and SQL-injection (strengthen
+ page contracts, add validators, added page_contract_filter
+ "localurl", improve HTML escaping, and
+ URI encoding)
+
+ Fixed for potential traversal attack
+ (acs-api-documentation-procs)
+
- Removed several uncalled / redundant SQL statements and functions.
-
Cleanup of .xql files in acs-subsite:
-
Some cleanup of .xql files: removed
- misleading sql-statements from db_* calls, which were
- ignored due .xql files
-
Removed bug where same query-name was
- used in different branches of an if-statement for
- different sql statements, but the query-name lead to the
- wrong result.
-
Removed multiple entries of same query
- name from .xql files (e.g. the entry
- "package_create_attribute_list.select_type_info" was
- 7 (!) times in a single .xql file)
-
-
-
-
Web Interface:
-
- Improve Performance of WebSites created with OpenACS:
- e.g. move core.js to a body requests, provide kernel
- parameter ResourcesExpireInterval to specify expiration
- times for resources.
+ Improvements for "host-node mapped" subsites
+
+ Fixed links from host-node mapped subsite pages to
+ swa-functions (must be always on main subsite)
+
+ Made "util_current_directory"
+ aware of host-node-mapped subsites
+
+ Added ability to pass
+ "-cookie_domain" to make it possible
+ to use the same cookie for different domains
+
+ Fixed result of affected commands
+ "util_current_location",
+ "ad_return_url",
+ "ad_get_login_url" and
+ "ad_get_logout_url" for HTTP and
+ HTTPS, when UseHostnameDomainforReg is 0 or 1.
+
+ Improved UI for host-node maps when a large number of site
+ nodes exists
+
+
Reform of acs-rels
+
+ Made acs-rels configurable to give the developer the option to
+ specify, whether these are composable or not (default fully
+ backward compatible). This is required to control transitivity in
+ rel-segments
+
+ The code changes are based on a patch provided
+ by Michael Steigmann. For details, see:
+
- Much better protection against XSS attacks.
+ Improved status code handlers for AJAX scenarios
+
+ Don't report data source errors with status code 200 (use
+ 422 instead)
+
+ Let "permission::require_permission" return forbidden (403) in
+ AJAX calls (determined via [ad_conn ajaxp])
+
- Improved HTML validity (especially for admin pages)
+ Improved Internationalization
+
+ Extended language catalogs for
+
+ Russian (thanks to v v)
+
+ Italian (thanks to Antonio Pisano)
+
+ Spanish (thanks to Hector Romojaro)
+
+ German (thanks to Markus Moser)
+
+
+ Added (missing) message keys
+
+ Improved wording of entries
+
+ Added message keys for member_state changes, provide API via
+ group::get_member_state_pretty
+
- Improved admin interface:
-
- Placed all installation options to a single page.
-
- Added pagination to /admin/applications (was unusable
- for large sites)
-
- New admin pages for subsites linked from
- site-wide-admin package (/acs-admin).
-
- Added explanatory text to several admin pages.
+ Improved online documentation (/doc)
+
Fixed many broken links
+
Removed fully obsolete sections
+
Improved markup (modernize HTML)
+
Updated various sections
-
Add lightweight support for ckeditor4 for
- templating::richtext widget (configurable via package
- parameter "RichTextEditor" of acs-templating. ckeditor4
- supports mobile devices (such as iPad, ...)
-
-
Templating:
-
- Improved theme-ability: Moved more information into theme
- packages in order to create responsive designs, reduce
- hard-coding of paths, HTML etc.
- Improved include-handling: All includes are now
- theme-able, interfaces of includes can be defined with
- "ad_include_contract" (similar to ad_page_contract).
-
- Improved them-ability for display_templates. One can now
- provide a display_template_name (similar to the sql
- statement name) to refer to display templates. This
- enables reusability and is theme-able.
-
- Notification chunks are now theme-able as well (using ad_include_contrat)
-
- Complete template variable suffixes (adding noi18n,
- addressing bug #2692, full list is now: noquote, noi18n, literal)
-
- Added timeout and configurable secrets for signed url
- parameters to export_vars/page_contracts.
- This can be used to secure sensitive operations
- such as granting permissions since a link can be set to
- timeout after e.g. 60 seconds; after that, the link is
- invalid. A secret (password) can be set in section
- ns/server/$server/acs parameter "parametersecret".
-
- For example, one can use now "user_id:sign(max_age=60)" in
- export_vars to let the exported variable expire after 60 seconds.
-
-
Misc:
-
- Added ability to show ns_log statements of current request
- to developer support output when developer support is
- activated (controlled via package parameter "TclTraceLogServerities"
- in the acs-tcl package parameters)
-
- Added ability to save data sent by
- ns_return in files on the file system. This can be used to
- validate HTML content also for password protected pages
- (controlled via package parameter "TclTraceSaveNsReturn" in
- the acs-tcl package parameters)
-
- New api function "ad_log" having the same interface as
- ns_log, but which logs the calling information (like URL
- and call-stack) to ease tracking of errors.
-
Use per-thread caching to reduce number of
- mutex lock operations and lock contention on various caches
- (util-memoize, xo_site_nodes, xotcl_object_types) and nsvs
- (e.g ds_properties)
- Improved templating of OpenACS core documentation
-
- Improved Russian Internationalization
-
- Make pretty-names of acs-core packages more consistent
-
- Mark unused functions of acs-tcl/tcl/table-display-procs.tcl as deprecated
-
- Many more bug fixes (from bug tracker and extra) and
- performance improvements.
-
- Version numbers:
-
- Require PG 9.0 (End Of Life of PostgreSQL 8.4 was July 2014)
-
- Require XOTcl 2.0 (presented at the Tcl conference in 2011).
+ Misc code improvements:
+
+ 18 issues from the OpenACS-bug-tracker fixed
+
+ Made code more robust against invalid/incorrect input
+ (page_contracts, validators, values obtained from header fields
+ such as Accept-Language)
+
+ Fixed quoting of message keys on many places
+
+ Improved exception handling (often, a
+ "catch" swallows to much, e.g.
+ script_aborts), introducing
+ "ad_exception".
+
+ Generalized handling of leading zeros:
+
+ Fixed cases where leading zeros could lead to unwanted octal
+ interpretations
+
+ Switch to use of "
+ util::trim_leading_zeros" instead of
+ "template::util::leadingTrim",
+ "dt_trim_leading_zeros" and
+ "template::util::leadingTrim",
+ marked the latter as deprecated
+
+
+ URL encoding
+
+ "ad_urlencode_folder_path": new
+ function to perform an urlencode operation on the segments of the
+ provided folder path
+
+ Fixed encoding of the URL path in
+ "ad_returnredirect"
+
+
+ Improvements for "ad_conn":
+
Added [ad_conn behind_proxy_p] to check, whether the request is
+ coming from behind a proxy server
+
Added [ad_conn behind_secure_proxy_p] to check, whether the
+ request is coming from behind a secure proxy server
+
Added [ad_conn ajax_p] to check, whether the request is an AJAX
+ requests (assumption: AJAX request sets header-field
+ Requested-With: XMLHttpRequest")
+
Added [ad_conn vhost_url] to obtain the url of host-node-mapped
+ subsites
+
+
Added various missing upgrade scripts (missing since many years)
+ of changes that were implemented for new installs to reduce
+ differences between "new"-and
+ "old" (upgraded) installations
+
+ Templating
+
Get rid of various pesky "MISSING FORMWIDGET:
+ ...formbutton:ok" messages
+
Improved support for javascript event handlers in
+ template::head
+
New functions
+ "template::add_event_listener" and
+ "template::add_confirm_handler"
+
Fix handling, when "page_size_variable_p" is set (was
+ broken since ages)
+
+
+ Improved location and URL handling:
+
+ Refactored and commented
+ "util_current_location" to address
+ security issues, handle IPv6 addresses, IP literal notation,
+ multiple drivers, "
+
+ Improved "security::get_secure_location"
+ (align with documentation)
+
+ for working on HTTP locations to reduce scattered regexps handling
+ URL components
+
Improved IPv6 support
+
Use native "ns_parseurl" when
+ available, provide backward compatible version for AOLserver
+
+
+ MIME types:
+
Added more Open XML formats for MS-Office to allowed content
+ types
+
Modernized entries to IANA recommendations
+
New function "cr_check_mime_type"
+ centralizing the retrieval of the mime_type from uploaded
+ content
+
+
Finalized cleanup of permissions (started in OpenACS 5.9.0):
+
Get rid of "acs_object_context_index
+ " (and therefore on "acs_object_party_privilege_map
+ " as well) on PostgreSQL.
+
Reasons:
+
huge table,
expensive maintenance, used only in a few places,
-
-
Changes in application packages:
+
+ Misc new functions:
+
"lang::util::message_key_regexp":
+ factor out scattered regexp for detecting message keys
+
"ns_md5" and
+ "ns_parseurl": improve compatibility between
+ AOLserver and NaviServer
"ad_dom_sanitize_html": allow to
+ specify different sets of tags, attributes and protocols and
+ "ad_dom_fix_html", which is a light weight tidy
+ variant.
+
+ Improved HTML rendering (acs-api-browser), provide width and
+ height to speed up rendering
+
+ Improved ADP files (e.g. missing doc(title))
+
+ Added usage of
+ "ad_include_contract" on more
+ occasions
+
- contributed by 4 committers (Michael Aram, Victor Guerra, Gustaf Neumann, Antonio Pisano) and
- patch/bugfix providers (Frank Bergmann, Andrew Helsley, Felix
- Mödritscher, Marcos Moser, Franz Penz, Thomas Renner).
-These are significantly more changes as the differences
-in the last releases. All packages of the release were tested with
-PostgreSQL 9.4.* and Tcl 8.5.*.
- For more
- details, consult the
-
- raw ChangeLog.
-
Release 5.8.1
- The release contains the 78 packages of the oacs-5-8 branch.
- These packages contain the OpenACS core packages, major
- application packages (e.g. most the ones used on OpenACS.org), and
- DotLRN.
-
- All packages have the following properties:
-
SQL:
+
- All packages are PostgreSQL 9.1+ compatible
- (tested with PostgreSQL 9.3)
-
- All SQL files with stored procedures use the
- recommended $$ quoting
-
- All SQL-functions have regular function arguments
- instead of the old-style aliases
-
- The function_args() (query-able meta-data) are
- completed and fixed
-
- Incompatible functions (e.g. for sequences) are
- replaced.
-
-
Tcl:
-
- All packages were brought up Tcl 8.5, including
- the actual Tcl idioms where appropriate (e.g.
- using the safer expand operator, range indices,
- dict, lassign, etc.)
-
- The code was updated to prefer byte-compiled functions
- instead of legacy functions from ancient Tcl versions.
-
- The code works with NaviServer and AOLserver.
+ New OpenACS packages:
+
+ richtext-xinha
+
+ richtext-tinymce
+
+ richtext-ckeditor4 (has ability to choose between CDN and local
+ installation via GUI)
+
+ openacs-bootstrap3-theme (as used on openacs.org)
+
+ dotlrn-bootstrap3-theme
+
-
API:
+
- All packages are free from calls to deprecated code
- (157 functions are marked as deprecated and will be
- moved into an "outdated" package in the 5.9 or 6.0
- release)
+ xotcl-core:
+
+ Improved XOTcl 2.0 and NX support (e.g. api-browser)
+
+ Added "-debug",
+ "-deprecated" to ad_* defined
+ methods (such as e.g.
+ "ad_instproc")
+
+ Make use of explicit "create"
+ statements when creating XOTcl/NX objects (makes it easier to grab
+ intentions and to detect typos)
+
+ Added parameter to
+ "get_instance_from_db" to specify,
+ whether the loaded objects should be initialized
+
+ Added support for PostgreSQL prepared statements of SQL
+ interface in ::xo::dc (nsdb driver)
+
- General overhaul of package management
+ xowiki:
+
+ Named all web-callable methods www-NAME (to make it clear, what
+ is called, what has to be checked especially carefully)
+
+ Moved templates from www into xowiki/resources to avoid naming
+ conflicts
+
+ Improved ckeditor support
+
+ Added usage of prepared statements for common queries
+
+ Improved error handling
+
+ Better value checking for query parameter, error reporting via
+ ad_return_complaint
+
+ Added option "-path_encode" to methods
+ "pretty_link" and "folder_path" to allow to
+ control, whether the result should be encoded or not (default
+ true)
+
+ Form fields:
+
+ Improved repeatable form fields (esp. composite cases),
+ don't require preallocation (can be costly in composite
+ cases)
+
+ Added signing of form-fields
+
+ Added HTML5 attributes such as
+ "multiple" (for
+ "file") or
+ "autocomplete"
+
+ Fixed generation of "orderby"
+ attribute based on form-field names
+
+ richtext: allow to specify
+ "extraAllowedContent" via
+ options
+
+ Improved layout of horizontal check boxes
+
+
+ Menu bar:
+
+ Added dropzone (requires bootstrap): drag and drop file upload
+
+ Added mode toggle (requires bootstrap)
+
+ Extended default policies for handling e.g. dropzone
+ (file-upload method)
+
+ Distinguish between "startpage"
+ (menu.Package.Startpage) and "table of contents"
+ (menu.Package.Toc)
+
+
+ Notifications:
+
+ Added support for better tailorable notifications: introduced
+ method "notification_render"
+ (similar to "search_render")
+
+ Added support for tailorable subject lines (method
+ "notification_subject")
+
+
+ Improved bootstrap support, use
+ "bootstrap" as
+ PreferredCSSToolkit
+
+ Switched to ckeditor4 as PreferredRichtextEditor
+
+ Improved handling of script-abort from within the payload of
+ ::xowiki::Object payloads
+
+ Added parameter to
+ "get_all_children" to specify,
+ whether the child objects should be initialized
+
- Install-from-local and install-from-repository can be used
- to install the provided packages based on a acs-core
- installation. This means that also DotLRN can be
- installed from repository or from
- local into an existing OpenACS instance.
+ xowf:
+
+ Added property "payload" to
+ "WorkflowConstruct" in order to simplify customized
+ workflow "allocate" actions
+
+ Internationalized more menu buttons
+
- Install-from-repository offers filtering functions, allows
- to install optionally from head-channel (for packages
- not in the base channel of the installed instance).
- Install-from-repository works more like an app-store,
- showing as well vendor information
-
- Packages can be equipped with xml-based configuration files
- (e.g. changing parameters for style packages)
-
- Package developers can upload .apm packages via workflow
- for review by core members and for inclusion to the
- repository. The option is integrated with package
- management, the link is offered for local packages.
- We hope to attract additional vendors (universities,
- companies) to make their packages available on this
- path.
-
- New management-functions for package instances
- (list, create, delete package instances)
-
- Substantially improved API browser:
+ xotcl-request-monitor
- Show just relevant parts of .xql files for a function
+ Added class "BanUser" (use. e.g. ip
+ address to disallow requests from a user via request monitor)
- Provide syntax-highlighting for www scripts as well
+ Added support for optional user tracking in database
- Handle more special cases like e.g. util_memoize
+ Added support for monitoring response-time for certain urls via
+ munin
- Provide links to Tcl functions depending on the installed
- Tcl version
+ Increased usage of XOTcl 2.0 variable resolver (potentially
+ speed improvement 4x)
- Provide links to NaviServer or OpenACS functions depending
- on installed version
+ Performed some refactoring of response-time handling to allow
+ site-admin to make e.g. use of NaviServer's dynamic connection
+ pool management (not included in CVS)
- Syntax highlighter uses CSS rather than hard-coded markup
+ Added support for partial times in long-calls.tcl to ease
+ interpretation of unexpected slow calls
- Significant performance improvement for large
- installations
+ last100.tcl: Don't report hrefs to URLs, except to SWAs
-
+
+ chat:
+
+ Introduced new options to set chat rooms so login and/or logout
+ message are not issued every time a user enters/exits a chat-room
+ (important for chats with huge number of participants)
+
+ Parameterized viewing of chat-logs
+
+ Fixed cases of over-/under-quoting
+
+ Fixed JavaScript for IE, where innerHTML can cause
+ problems
+
+
+ file-storage:
+
+ Don't show action keys, when user has no
+ permissions
+
+ Added support for copying of same-named files into a folder
+ (adding suffix)
+
+ Fixed old bugs in connection with
+ "views" package
+
+
-
Altogether, OpenACS 5.8.1 differs from OpenACS 5.8.0 in
- about 100,000 modifications (6145 commits) contributed by 5
- committers.
-
Release 5.8.0
- Compatibility with PostgreSQL 9.2:
- The new version installs without any need for special parameter
- settings in new PostgreSQL versions. This makes it easier to use
- e.g. shared or packaged PostgreSQL installations.
+
Altogether, OpenACS 5.9.1 differs from OpenACS 5.9.1 by the
+ following statistics
+
+ contributed by 5 committers (Michael Aram, Gustaf Neumann, Antonio
+ Pisano, Hector Romojaro, Thomas Renner) and 8 patch/bugfix providers
+ (Frank Bergmann, Günter Ernst, Brian Fenton, Felix Mödritscher, Marcus
+ Moser, Franz Penz, Stefan Sobernig, Michael Steigman). All packages of
+ the release were tested with PostgreSQL 9.6.* and Tcl 8.5.*.
+
+ The release of OpenACS 5.9.0 contains the 78 packages of the oacs-5-9 branch.
+ These packages include the OpenACS core packages, the major
+ application packages (e.g. most the ones used on OpenACS.org), and
+ DotLRN 2.9.0.
+
+ Summary of changes:
+
SQL:
+
+ Improved performance of acs-object deletion.
+
+ Replaced many manual referential integrity calls by
+ built-in handing in PostgreSQL.
+
+ Removed various manual bookkeeping and deletion operations
+ in the content repository by built-in handing in PostgreSQL.
+
+ Removed tree_sortkey on acs-objects to reduce its size and
+ to speedup operations, where the context-id is changed
+ (could take on large installation several minutes in
+ earlier versions)
+
+ Removed several uncalled / redundant SQL statements and functions.
+
Cleanup of .xql files in acs-subsite:
+
Some cleanup of .xql files: removed
+ misleading sql-statements from db_* calls, which were
+ ignored due .xql files
+
Removed bug where same query-name was
+ used in different branches of an if-statement for
+ different sql statements, but the query-name lead to the
+ wrong result.
+
Removed multiple entries of same query
+ name from .xql files (e.g. the entry
+ "package_create_attribute_list.select_type_info" was
+ 7 (!) times in a single .xql file)
+
+
+
+
Web Interface:
+
+ Improve Performance of WebSites created with OpenACS:
+ e.g. move core.js to a body requests, provide kernel
+ parameter ResourcesExpireInterval to specify expiration
+ times for resources.
+
+ Much better protection against XSS attacks.
+
+ Improved HTML validity (especially for admin pages)
+
+ Improved admin interface:
+
+ Placed all installation options to a single page.
+
+ Added pagination to /admin/applications (was unusable
+ for large sites)
+
+ New admin pages for subsites linked from
+ site-wide-admin package (/acs-admin).
+
+ Added explanatory text to several admin pages.
+
+
Add lightweight support for ckeditor4 for
+ templating::richtext widget (configurable via package
+ parameter "RichTextEditor" of acs-templating. ckeditor4
+ supports mobile devices (such as iPad, ...)
+
+
Templating:
+
+ Improved theme-ability: Moved more information into theme
+ packages in order to create responsive designs, reduce
+ hard-coding of paths, HTML etc.
+
+ Improved include-handling: All includes are now
+ theme-able, interfaces of includes can be defined with
+ "ad_include_contract" (similar to ad_page_contract).
+
+ Improved them-ability for display_templates. One can now
+ provide a display_template_name (similar to the sql
+ statement name) to refer to display templates. This
+ enables reusability and is theme-able.
+
+ Notification chunks are now theme-able as well (using ad_include_contrat)
+
+ Complete template variable suffixes (adding noi18n,
+ addressing bug #2692, full list is now: noquote, noi18n, literal)
+
+ Added timeout and configurable secrets for signed url
+ parameters to export_vars/page_contracts.
+ This can be used to secure sensitive operations
+ such as granting permissions since a link can be set to
+ timeout after e.g. 60 seconds; after that, the link is
+ invalid. A secret (password) can be set in section
+ ns/server/$server/acs parameter "parametersecret".
+
+ For example, one can use now "user_id:sign(max_age=60)" in
+ export_vars to let the exported variable expire after 60 seconds.
+
+
Misc:
+
+ Added ability to show ns_log statements of current request
+ to developer support output when developer support is
+ activated (controlled via package parameter "TclTraceLogServerities"
+ in the acs-tcl package parameters)
+
+ Added ability to save data sent by
+ ns_return in files on the file system. This can be used to
+ validate HTML content also for password protected pages
+ (controlled via package parameter "TclTraceSaveNsReturn" in
+ the acs-tcl package parameters)
+
+ New api function "ad_log" having the same interface as
+ ns_log, but which logs the calling information (like URL
+ and call-stack) to ease tracking of errors.
+
Use per-thread caching to reduce number of
+ mutex lock operations and lock contention on various caches
+ (util-memoize, xo_site_nodes, xotcl_object_types) and nsvs
+ (e.g ds_properties)
+ Improved templating of OpenACS core documentation
+
+ Improved Russian Internationalization
+
+ Make pretty-names of acs-core packages more consistent
+
+ Mark unused functions of acs-tcl/tcl/table-display-procs.tcl as deprecated
+
+ Many more bug fixes (from bug tracker and extra) and
+ performance improvements.
+
+ Version numbers:
+
+ Require PostgreSQL 9.0 (End Of Life of PostgreSQL 8.4 was July 2014)
+
+ Require XOTcl 2.0 (presented at the Tcl conference in 2011).
+
+
+
Changes in application packages:
+
+ Various bug
+ fixes and improvements for e.g. file-storage, forums, news,
+ notifications, xowiki.
+
+
+
Altogether, OpenACS 5.9.0 differs from OpenACS 5.8.1 by the
+ following statistics
+
+ contributed by 4 committers (Michael Aram, Victor Guerra, Gustaf Neumann, Antonio Pisano) and
+ patch/bugfix providers (Frank Bergmann, Andrew Helsley, Felix
+ Mödritscher, Marcos Moser, Franz Penz, Thomas Renner).
+ These are significantly more changes as the differences
+ in the last releases. All packages of the release were tested with
+ PostgreSQL 9.4.* and Tcl 8.5.*.
+
+ The release contains the 78 packages of the oacs-5-8 branch.
+ These packages contain the OpenACS core packages, major
+ application packages (e.g. most the ones used on OpenACS.org), and
+ DotLRN.
+
+ All packages have the following properties:
+
SQL:
+
+ All packages are PostgreSQL 9.1+ compatible
+ (tested with PostgreSQL 9.3)
+
+ All SQL files with stored procedures use the
+ recommended $$ quoting
+
+ All SQL-functions have regular function arguments
+ instead of the old-style aliases
+
+ The function_args() (query-able meta-data) are
+ completed and fixed
+
+ Incompatible functions (e.g. for sequences) are
+ replaced.
+
+
Tcl:
+
+ All packages were brought up Tcl 8.5, including
+ the actual Tcl idioms where appropriate (e.g.
+ using the safer expand operator, range indices,
+ dict, lassign, etc.)
+
+ The code was updated to prefer byte-compiled functions
+ instead of legacy functions from ancient Tcl versions.
+
+ The code works with NaviServer and AOLserver.
+
+
API:
+
+ All packages are free from calls to deprecated code
+ (157 functions are marked as deprecated and will be
+ moved into an "outdated" package in the 5.9 or 6.0
+ release)
+
+ General overhaul of package management
+
+ Install-from-local and install-from-repository can be used
+ to install the provided packages based on a acs-core
+ installation. This means that also DotLRN can be
+ installed from repository or from
+ local into an existing OpenACS instance.
+
+ Install-from-repository offers filtering functions, allows
+ to install optionally from head-channel (for packages
+ not in the base channel of the installed instance).
+ Install-from-repository works more like an app-store,
+ showing as well vendor information
+
+ Packages can be equipped with xml-based configuration files
+ (e.g. changing parameters for style packages)
+
+ Package developers can upload .apm packages via workflow
+ for review by core members and for inclusion to the
+ repository. The option is integrated with package
+ management, the link is offered for local packages.
+ We hope to attract additional vendors (universities,
+ companies) to make their packages available on this
+ path.
+
+ New management-functions for package instances
+ (list, create, delete package instances)
+
+ Substantially improved API browser:
+
+ Show just relevant parts of .xql files for a function
+
+ Provide syntax-highlighting for www scripts as well
+
+ Handle more special cases like e.g. util_memoize
+
+ Provide links to Tcl functions depending on the installed
+ Tcl version
+
+ Provide links to NaviServer or OpenACS functions depending
+ on installed version
+
+ Syntax highlighter uses CSS rather than hard-coded markup
+
+ Significant performance improvement for large
+ installations
+
+
+
+
Altogether, OpenACS 5.8.1 differs from OpenACS 5.8.0 in
+ about 100,000 modifications (6145 commits) contributed by 5
+ committers.
+
Release 5.8.0
+ Compatibility with PostgreSQL 9.2:
+ The new version installs without any need for special parameter
+ settings in new PostgreSQL versions. This makes it easier to use
+ e.g. shared or packaged PostgreSQL installations.
Compatibility with NaviServer 4.99.5 or newer
Performance and scalability improvements
Various bug fixes
Altogether, OpenACS 5.8.0 differs from OpenACS 5.7.0 in
more than 18.000 modifications (781 commits) contributed by 7
committers.
@@ -295,9 +1006,9 @@
Support for 3-chars language codes in acs-lang
- Added OOXML mime types in acs-content-repository
+ Added OOXML mime types in acs-content-repository
Release 5.5.0
PostgreSQL 8.3 is now fully supported, including the use of the built-in
- standard version of tsearch2.
+ standard version of tsearch2.
TinyMCE has been upgraded to 3.2.4.1 with language pack support.
acs-mail-lite now correctly implements rollout support.
@@ -307,9 +1018,9 @@
"acs-subsite" and "layout-manager" packages, resulting in a package that
combines the semantics of both.
- Added new package attribute "implements-subsite-p" (default "f"). If true,
- this package may be mounted as a subsite and is expected to implement subsite
- semantics. Typically used by packages which extend acs-subsite.
+ Added new package attribute "implements-subsite-p" (default "f"). If true,
+ this package may be mounted as a subsite and is expected to implement subsite
+ semantics. Typically used by packages which extend acs-subsite.
Added new package attribute "inherit-templates-p" (default "t"). If true,
the package inherits templates defined in the packages it extends. This means
@@ -336,49 +1047,49 @@
to be replaced with the language text for the chosen locale.
Release 5.4.2
This is a minor bugfix release.
Site node caching was removed as doesn't work correctly
Critical issues with search on oracle were fixed
More html strict work etc
Release 5.4.1
This is a minor bugfix release.
-
Release 5.4.0
New Templating API added to add scripts, css, etc to the HTML HEAD and BODY
- sections of the generated HTML document. Please see
- /packages/acs-templating/tcl/head-procs.tcl or visit the template::head procs
- in the API browser for details.
-
Templates have been modified to comply with HTML strict
The Search package's results page has been improved
TinyMCE WYSIWYG support has been added, RTE and HTMLArea support dropped
acs-mail-lite's send has been cleaned up to properly encode content, to handle
- file attachments, etc. "complex-send" will disappear from acs-core in a future
- release.
The ChangeLogs include an annotated list of changes (???) since the last release and in the
-entire 5.9 release sequence ???.
Release 5.3.1
Bug fixes.
New TIPs implemented.
All Core Automated Tests for Postgres pass.
New Site and Blank master templates and CSS compatible with the .LRN Zen
- work. Compatibility master templates are provided for existing sites.
The ChangeLogs include an annotated list of changes (???) since the last release and in the
-entire 5.9 release sequence ???.
Release 5.3.0
Bug fixes.
New TIPs implemented.
All Core Automated Tests for Postgres pass.
Release 5.2.0
Bug fixes.
New TIPs implemented.
This release does not include new translations.
Release 5.1.4
Bug fixes.
The missing CR Tcl API has been filled in, thanks to Rocael and
+
Release 5.4.0
New Templating API added to add scripts, css, etc to the HTML HEAD and BODY
+ sections of the generated HTML document. Please see
+ /packages/acs-templating/tcl/head-procs.tcl or visit the template::head procs
+ in the API browser for details.
+
Templates have been modified to comply with HTML strict
The Search package's results page has been improved
TinyMCE WYSIWYG support has been added, RTE and HTMLArea support dropped
acs-mail-lite's send has been cleaned up to properly encode content, to handle
+ file attachments, etc. "complex-send" will disappear from acs-core in a future
+ release.
The ChangeLogs include an annotated list of changes (???) since the last release and in the
+ entire 5.9 release sequence ???.
Release 5.3.1
Bug fixes.
New TIPs implemented.
All Core Automated Tests for Postgres pass.
New Site and Blank master templates and CSS compatible with the .LRN Zen
+ work. Compatibility master templates are provided for existing sites.
The ChangeLogs include an annotated list of changes (???) since the last release and in the
+ entire 5.9 release sequence ???.
Release 5.3.0
Bug fixes.
New TIPs implemented.
All Core Automated Tests for Postgres pass.
Release 5.2.0
Bug fixes.
New TIPs implemented.
This release does not include new translations.
Release 5.1.4
Bug fixes.
The missing CR Tcl API has been filled in, thanks to Rocael and
his team and Dave Bauer.
This release does not include new translations.
Release 5.1.3
Bug fixes, primarily for .LRN compatibility in support of upcoming .LRN 2.1.0 releases. This release does not include new translations since 5.1.2.
Release 5.1.2
Translations syncronized with the translation server.
Basque and Catalan added.
For a complete change list, see the Change list since
- 5.1.0 in ???.
Release 5.1.1
This is the first release using the newest adjustment to the versioning convention. The OpenACS 5.1.1 tag will apply to OpenACS core as well as to the most recent released version of every package, including .LRN.
Translations syncronized with the translation server.
+ 5.1.0 in ???.
Release 5.1.1
This is the first release using the newest adjustment to the versioning convention. The OpenACS 5.1.1 tag will apply to OpenACS core as well as to the most recent released version of every package, including .LRN.
Translations syncronized with the translation server.
Bug
- 1519 fixed. This involved renaming all catalog
- files for ch_ZH, TH_TH, AR_EG, AR_LB, ms_my, RO_RO, FA_IR,
- and HR_HR. If you work with any of those locales, you
- should do a full catalog export and then import (via
- /acs-lang/admin) after
- upgrading acs-lang. (And, of course, make a backup of both
- the files and database before upgrading.)
Other bug fixes since 5.1.0: 1785,
- 1793,
- and over a dozen additional bug fixes.
For a complete change list, see the Change list since
- 5.0.0 in ???.
All work on the translation server from 7 Nov 2003 to 7 Feb 2004 is now included in catalogs.
One new function in acs-tcl, util::age_pretty
Complete Change list since 5.0.0 in Changelog
Many documentation updates and doc bug fixes
Release 5.0.0
- This is OpenACS 5.0.0. This version contains no known security, data loss, or crashing bugs, nor any bugs judged release blockers. This version has received manual testing. It has passed current automated testing, which is not comprehensive. This release contains work done on the translation server http://translate.openacs.org through 7 Nov 2003.
-
- You may want to begin by reading our installation documentation for
- the section called “a Unix-like system”. Note that the Windows documentation is
- not current for OpenACS 5.9.0, but an alternative is to use John
- Sequeira's Oasis VM
- project.
-
- After installation, the full documentation set can be found by visiting
- http://yourserver/doc.
-
- New features in this release:
-
+ 1519 fixed. This involved renaming all catalog
+ files for ch_ZH, TH_TH, AR_EG, AR_LB, ms_my, RO_RO, FA_IR,
+ and HR_HR. If you work with any of those locales, you
+ should do a full catalog export and then import (via
+ /acs-lang/admin) after
+ upgrading acs-lang. (And, of course, make a backup of both
+ the files and database before upgrading.)
Other bug fixes since 5.1.0: 1785,
+ 1793,
+ and over a dozen additional bug fixes.
For a complete change list, see the Change list since
+ 5.0.0 in ???.
All work on the translation server from 7 Nov 2003 to 7 Feb 2004 is now included in catalogs.
One new function in acs-tcl, util::age_pretty
Complete Change list since 5.0.0 in Changelog
Many documentation updates and doc bug fixes
Release 5.0.0
+ This is OpenACS 5.0.0. This version contains no known security, data loss, or crashing bugs, nor any bugs judged release blockers. This version has received manual testing. It has passed current automated testing, which is not comprehensive. This release contains work done on the translation server http://translate.openacs.org through 7 Nov 2003.
+
+ You may want to begin by reading our installation documentation for
+ the section called “a Unix-like system”. Note that the Windows documentation is
+ not current for OpenACS 5.9.0, but an alternative is to use John
+ Sequeira's Oasis VM
+ project.
+
+ After installation, the full documentation set can be found by visiting
+ http://yourserver/doc.
+
+ New features in this release:
+
Internationalization support.
A message catalog to store translated text, localization of
@@ -432,7 +1143,7 @@
and there are automated tests for a number of packages.
Security enhancements.
-
+
HTML quoting now happens in the templating system, greatly
minimizing the chance that users can sneak malicious HTML
into the pages of other users.
@@ -443,19 +1154,19 @@
Spell checking.
- Potential incompatibilities:
-
+ Potential incompatibilities:
+
With the release of OpenACS 5, PostgreSQL 7.2 is no longer supported.
Upgrades are supported from OpenACS 4.6.3 under Oracle or
PostgreSQL 7.3.
- The undocumented special handling of ~ and +variable+ in
- formtemplates, found in packages/acs-templating/resources/*,
- has been removed in favor of using <noparse> and
- \@variable\@ (the standard templating mechanisms). Locally
- provided formtemplate styles still using these mechanisms
- will break.
+ The undocumented special handling of ~ and +variable+ in
+ formtemplates, found in packages/acs-templating/resources/*,
+ has been removed in favor of using <noparse> and
+ \@variable\@ (the standard templating mechanisms). Locally
+ provided formtemplate styles still using these mechanisms
+ will break.
- 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/* *~")
-
+ 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/* *~")
+
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.1.2.26 -r1.1.2.27
--- openacs-4/packages/acs-core-docs/www/tutorial-database.adp 20 Jun 2017 07:16:41 -0000 1.1.2.26
+++ openacs-4/packages/acs-core-docs/www/tutorial-database.adp 6 Aug 2017 11:31:22 -0000 1.1.2.27
@@ -15,7 +15,7 @@
OpenACS docs are written by the named authors, and may be edited by
OpenACS documentation staff.
-Code the data model
We create all database objects with scripts in the myfirstpackage/sql/ directory. All database
+Code the data model
We create all database objects with scripts in the myfirstpackage/sql/ directory. All database
scripts are database-specific and are thus in either the
myfirstpackage/sql/oracle or
myfirstpackage/sql/postgresql
@@ -42,7 +42,7 @@
simplify our database creation. (More information about ACS
Objects. More information about the Content
Repository.)
-
Figure 9.2. Tutorial Data
+
Figure 9.2. Tutorial Data
Model
The top of each sql file has some standard comments, including
doc tags such as \@author which
@@ -51,7 +51,7 @@
[$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.
OpenACS docs are written by the named authors, and may be edited
by OpenACS documentation staff.
-
Code the data model
We create all database objects with scripts in the
+
Code the data model
We create all database objects with scripts in the
myfirstpackage/sql/ directory. All
database scripts are database-specific and are thus in either
the myfirstpackage/sql/oracle or
@@ -32,13 +32,13 @@
repository functions to simplify our database creation. (More
information about ACS Objects. More information about the
Content Repository.)
-
Figure 9.2. Tutorial Data Model
The top of each sql file has some
+
Figure 9.2. Tutorial Data Model
The top of each sql file has some
standard comments, including doc tags such as
@author which will be picked up
by the API browser. The string
$Id$ will automatically be
expanded when the file is checked in to cvs.
[$OPENACS_SERVICE_NAME ~]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/sql/postgresql
-[$OPENACS_SERVICE_NAME postgresql]$ emacs myfirstpackage-create.sql
Paste the text below into the file, save, and close.
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.
-- 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.1.2.24 -r1.1.2.25
--- openacs-4/packages/acs-core-docs/www/tutorial-debug.adp 20 Jun 2017 07:16:41 -0000 1.1.2.24
+++ openacs-4/packages/acs-core-docs/www/tutorial-debug.adp 6 Aug 2017 11:31:22 -0000 1.1.2.25
@@ -15,7 +15,7 @@
OpenACS docs are written by the named authors, and may be edited by
OpenACS documentation staff.
-Debugging
+Debugging
Developer Support. The Developer
Support package adds several goodies: debug information for every
page; the ability to log comments to the page instead of the error
@@ -45,7 +45,7 @@
-Manual testing
Make a list of basic tests to make sure it works
+Manual testing
Make a list of basic tests to make sure it works
Test Num
Action
Expected Result
@@ -73,11 +73,11 @@
to delete your own note. Edit your own note. Search for a note.
OpenACS docs are written by the named authors, and may be edited by
OpenACS documentation staff.
- It seems to me that a lot of people have
+ It seems to me that a lot of people have
been asking for some guidelines on how to write automated tests.
I've done several tests by now and have found the process to be
extremely easy and useful. It's a joy to work with automated
@@ -148,7 +148,7 @@
myfirstpackage. You should see your test case. Run it and examine
the results.
-TCLWebtest tests
API testing can only test part of our package - it doesn't
+TCLWebtest tests
API testing can only test part of our package - it doesn't
test the code in our adp/tcl pairs. For this, we can use
TCLwebtest. TCLwebtest must be installed
for this test to work. This provides a library of functions that make it easy to call a page
@@ -158,7 +158,7 @@
integrating them.
-Example
Now we can add the rest of the API tests, including a test with
+Example
Now we can add the rest of the API tests, including a test with
deliberately bad data. The complete test looks like:
ad_library {
Test cases for my first package.
Index: openacs-4/packages/acs-core-docs/www/tutorial-debug.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-debug.html,v
diff -u -r1.43.2.24 -r1.43.2.25
--- openacs-4/packages/acs-core-docs/www/tutorial-debug.html 20 Jun 2017 07:16:41 -0000 1.43.2.24
+++ openacs-4/packages/acs-core-docs/www/tutorial-debug.html 6 Aug 2017 11:31:22 -0000 1.43.2.25
@@ -2,7 +2,7 @@
Debugging and Automated Testing
OpenACS docs are written by the named authors, and may be edited
by OpenACS documentation staff.
-
Debugging
Developer Support. The Developer Support package adds several goodies: debug
+
Debugging
Developer Support. The Developer Support package adds several goodies: debug
information for every page; the ability to log comments to the
page instead of the error log, and fast user switching so that you
can test pages as anonymous and as dummy users without logging
@@ -23,16 +23,16 @@
? searches backward
/ searches forward.
-
Manual testing
Make a list of basic tests to make sure it works
Test Num
Action
Expected Result
001
Browse to the index page while not logged in and
+
Manual testing
Make a list of basic tests to make sure it works
Test Num
Action
Expected Result
001
Browse to the index page while not logged in and
while one or more notes exist.
No edit or delete or add links should appear.
002
Browse to the index page while logged in. An Edit
link should appear. Click on it. Fill out the form and
click Submit.
The text added in the form should be visible on the
index page.
API-001
Invoke mfp::note::create with a specific word as the title.
Proc should return an object id.
API-002
Given an object id from API-001, invoke mfp::note::get.
Proc should return the specific word in the title.
API-003
Given the object id from API-001, invoke mfp::note::delete.
Proc should return 0 for success.
Other things to test: try to delete someone else's
note. Try to delete your own note. Edit your own note.
- Search for a note.
OpenACS docs are written by the named authors, and may be edited
by OpenACS documentation staff.
-
+
It seems to me that a lot of people have been asking for some guidelines on how to write automated tests. I've done several tests by now and have found the process to be extremely easy and useful. It's a joy to work with automated testing once you get the hang of it.
Create the directory that will contain the test
script and edit the script file. The directory location and file name are standards which are recognized by the automated testing package:
[$OPENACS_SERVICE_NAME www]$ mkdir /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/tcl/test
[$OPENACS_SERVICE_NAME www]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/tcl/test
@@ -68,7 +68,7 @@
goes inside -test_code {}. We want to implement test case API-001, "Given an object id from API-001, invoke mfp::note::get. Proc should return the specific word in the title."
set name [ad_generate_random_string]
set new_id [mfp::note::add -title $name]
- aa_true "Note add succeeded" ([info exists new_id] && $new_id ne "")
To test our simple case, we must load the test file into the system (just as with the /tcl file in the basic tutorial, since the file didn't exist when the system started, the system doesn't know about it.) To make this file take effect, go to the APM and choose "Reload changed" for "MyFirstPackage". Since we'll be changing it frequently, select "watch this file" on the next page. This will cause the system to check this file every time any page is requested, which is bad for production systems but convenient for developing. We can also add some aa_register_case flags to make it easier to run the test. The -procs flag, which indicates which procs are tested by this test case, makes it easier to find procs in your package that aren't tested at all. The -cats flag, setting categories, makes it easier to control which tests to run. The smoke test setting means that this is a basic test case that can and should be run any time you are doing any test. (a definition of "smoke test")
Once the file is loaded, go to ACS Automated Testing and click on myfirstpackage. You should see your test case. Run it and examine the results.
TCLWebtest tests
API testing can only test part of our package - it doesn't test the code in our adp/tcl pairs. For this, we can use TCLwebtest. TCLwebtest must be installed for this test to work. This provides a library of functions that make it easy to call a page through HTTP, examine the results, and drive forms. TCLwebtest's functions overlap slightly with acs-automated-testing; see the example provided for one approach on integrating them.
Example
Now we can add the rest of the API tests, including a test with deliberately bad data. The complete test looks like:
To test our simple case, we must load the test file into the system (just as with the /tcl file in the basic tutorial, since the file didn't exist when the system started, the system doesn't know about it.) To make this file take effect, go to the APM and choose "Reload changed" for "MyFirstPackage". Since we'll be changing it frequently, select "watch this file" on the next page. This will cause the system to check this file every time any page is requested, which is bad for production systems but convenient for developing. We can also add some aa_register_case flags to make it easier to run the test. The -procs flag, which indicates which procs are tested by this test case, makes it easier to find procs in your package that aren't tested at all. The -cats flag, setting categories, makes it easier to control which tests to run. The smoke test setting means that this is a basic test case that can and should be run any time you are doing any test. (a definition of "smoke test")
Once the file is loaded, go to ACS Automated Testing and click on myfirstpackage. You should see your test case. Run it and examine the results.
TCLWebtest tests
API testing can only test part of our package - it doesn't test the code in our adp/tcl pairs. For this, we can use TCLwebtest. TCLwebtest must be installed for this test to work. This provides a library of functions that make it easy to call a page through HTTP, examine the results, and drive forms. TCLwebtest's functions overlap slightly with acs-automated-testing; see the example provided for one approach on integrating them.
Example
Now we can add the rest of the API tests, including a test with deliberately bad data. The complete test looks like:
ad_library {
Test cases for my first package.
}
Index: openacs-4/packages/acs-core-docs/www/tutorial-distribute.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-distribute.adp,v
diff -u -r1.1.2.23 -r1.1.2.24
--- openacs-4/packages/acs-core-docs/www/tutorial-distribute.adp 20 Jun 2017 07:16:41 -0000 1.1.2.23
+++ openacs-4/packages/acs-core-docs/www/tutorial-distribute.adp 6 Aug 2017 11:31:22 -0000 1.1.2.24
@@ -13,7 +13,7 @@
distribution.
Browse to the package manager. Click on tutorialapp.
Click on Generate a distribution file for
this package from the filesystem.
Click on the file size (37.1KB) after the label
Distribution File: and save the
-file to /var/tmp.
To start developing new code in OpenACS, we build a new package.
+Overview
To start developing new code in OpenACS, we build a new package.
A package is a 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.
Example files, which are included in the standard OpenACS 5.9.0
distribution.
-
Figure 9.1. Assumptions in this
+
Figure 9.1. Assumptions in this
section
@@ -62,7 +62,7 @@
-Use the APM to initialize a new
+Use the APM to initialize a new
package
We use the ACS Package Manager (APM) to add, remove, and upgrade
packages. It handles package meta-data, such as lists of files that
belong in the package. Each package is uniquely identified by a
@@ -102,7 +102,7 @@
packages).
-Add an Application Instance to the
+Add an Application Instance to the
Server
In order to see your work in progress, you must create a map
between the URL space of incoming requests and the package
application instance. You do this by adding the application in the
@@ -121,7 +121,7 @@
to be satisfied from the files at /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/www.
-Quick start
The remainder of the tutorial walks you through each file one at
+Quick start
The remainder of the tutorial walks you through each file one at
a time as you create the package. You can skip all this, and get a
working package, by doing the following:
cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-core-docs/www/files/tutorial
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.43.2.23 -r1.43.2.24
--- openacs-4/packages/acs-core-docs/www/tutorial-newpackage.html 20 Jun 2017 07:16:41 -0000 1.43.2.23
+++ openacs-4/packages/acs-core-docs/www/tutorial-newpackage.html 6 Aug 2017 11:31:22 -0000 1.43.2.24
@@ -2,7 +2,7 @@
Creating an Application Package
OpenACS docs are written by the named authors, and may be edited
by OpenACS documentation staff.
-
The intended page map
Overview
To start developing new code in OpenACS, we build a new package. A package
+
The intended page map
Overview
To start developing new code in OpenACS, we build a new package. A package
is a a discrete collection of web pages, Tcl code, and database tables and procedures.
A package with user interface is called an application;
a package which provides functions to other packages and has no direct interface, a
@@ -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.
-
We use the ACS Package Manager (APM) to add, remove, and
upgrade packages. It handles package meta-data, such as lists of
files that belong in the package. Each package is uniquely
identified by a package key. To start developing a new
@@ -55,7 +55,7 @@
/var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage.
This is the "home directory" of our new package, and all
files in the package will be within this directory. More on the structure of
- packages).
Add an Application Instance to the Server
In order to see your work in progress, you must create a
+ packages).
Add an Application Instance to the Server
In order to see your work in progress, you must create a
map between the URL space of incoming requests and the package application instance.
You do this by adding the application in the main site administration). This
creates a link between the incoming URL requests and an
@@ -66,7 +66,7 @@
in this tutorial.
Choose "My First Package" from the list and click OK (the other fields are optional).
By mounting the package, we've caused all requests to
http://yourserver.test:8000/myfirstpackage
- to be satisfied from the files at /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/www.
Quick start
The remainder of the tutorial walks you through each file one at a time as you create the package. You can skip all this, and get a working package, by doing the following:
cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-core-docs/www/files/tutorial
+ to be satisfied from the files at /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/myfirstpackage/www.
Quick start
The remainder of the tutorial walks you through each file one at a time as you create the package. You can skip all this, and get a working package, by doing the following:
cd /var/lib/aolserver/$OPENACS_SERVICE_NAME/packages/acs-core-docs/www/files/tutorial
psql $OPENACS_SERVICE_NAME -f myfirstpackage-create.sql
cp note-edit.* note-delete.tcl index.* ../../../../myfirstpackage/www/
mkdir ../../../../myfirstpackage/lib
Index: openacs-4/packages/acs-core-docs/www/tutorial-pages.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-pages.adp,v
diff -u -r1.1.2.27 -r1.1.2.28
--- openacs-4/packages/acs-core-docs/www/tutorial-pages.adp 20 Jun 2017 07:16:41 -0000 1.1.2.27
+++ openacs-4/packages/acs-core-docs/www/tutorial-pages.adp 6 Aug 2017 11:31:22 -0000 1.1.2.28
@@ -15,23 +15,23 @@
OpenACS docs are written by the named authors, and may be edited by
OpenACS documentation staff.
-Install some API
As a workaround for missing content-repository functionality,
+Install some API
As a workaround for missing content-repository functionality,
copy a provided file into the directory for Tcl files:
To make this file take effect, go to the APM and choose "Reload
changed" for "MyFirstPackage".
-Page Map
Our package will have two visible pages. The first shows a list
+Page Map
Our package will have two visible pages. The first shows a list
of all objects; the second shows a single object in view or edit
mode, and can also be used to add an object. The index page will
display the list, but since we might reuse the list later,
we'll put it in a separate file and include it on the index
page.
-
Figure 9.5. Page
+
Figure 9.5. Page
Map
-Build the "Index" page
Each user-visible page in your package has, typically, three
+Build the "Index" page
Each user-visible page in your package has, typically, three
parts. The tcl file holds the
procedural logic for the page, including Tcl and
database-independent SQL code, and does things like check
Index: openacs-4/packages/acs-core-docs/www/tutorial-pages.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tutorial-pages.html,v
diff -u -r1.44.2.24 -r1.44.2.25
--- openacs-4/packages/acs-core-docs/www/tutorial-pages.html 20 Jun 2017 07:16:41 -0000 1.44.2.24
+++ openacs-4/packages/acs-core-docs/www/tutorial-pages.html 6 Aug 2017 11:31:22 -0000 1.44.2.25
@@ -2,8 +2,8 @@
To make this file take effect, go to the APM and choose "Reload changed" for "MyFirstPackage".
Page Map
Our package will have two visible pages. The first shows a list of all objects; the second shows a single object in view or edit mode, and can also be used to add an object. The index page will display the list, but since we might reuse the list later, we'll put it in a separate file and include it on the index page.
Figure 9.5. Page Map
Build the "Index" page
Each user-visible page in your package has, typically,
+
Install some API
As a workaround for missing content-repository functionality, copy a provided file into the directory for Tcl files:
To make this file take effect, go to the APM and choose "Reload changed" for "MyFirstPackage".
Page Map
Our package will have two visible pages. The first shows a list of all objects; the second shows a single object in view or edit mode, and can also be used to add an object. The index page will display the list, but since we might reuse the list later, we'll put it in a separate file and include it on the index page.
Figure 9.5. Page Map
Build the "Index" page
Each user-visible page in your package has, typically,
three parts. The tcl file
holds the procedural logic for the page, including Tcl and
database-independent SQL code, and does things like
Index: openacs-4/packages/acs-core-docs/www/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.1.2.25 -r1.1.2.26
--- openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.adp 20 Jun 2017 07:16:41 -0000 1.1.2.25
+++ openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.adp 6 Aug 2017 11:31:22 -0000 1.1.2.26
@@ -9,7 +9,7 @@
rightLink="upgrade-4.6.3-to-5" rightLabel="Next">
-Upgrading 4.5 or higher to 4.6.3
The required platform for OpenACS 4.6 is the same as 4.5, with
+Upgrading 4.5 or higher to 4.6.3
The required platform for OpenACS 4.6 is the same as 4.5, with
the exception of OpenFTS. OpenACS 4.6 and later require OpenFTS
0.3.2 for full text search on PostGreSQL. If you have OpenFTS 0.2,
you'll need to upgrade.
If upgrading from 4.4, you need to manually run
Index: openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.html,v
diff -u -r1.27.2.23 -r1.27.2.24
--- openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.html 20 Jun 2017 07:16:41 -0000 1.27.2.23
+++ openacs-4/packages/acs-core-docs/www/upgrade-4.5-to-4.6.html 6 Aug 2017 11:31:22 -0000 1.27.2.24
@@ -1,5 +1,5 @@
-
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
-Chosing a Method to Upgrade your
+Chosing a Method to Upgrade your
Files
OpenACS is distributed in many different ways:
as a collection of files
as one big tarball
via CVS
via automatic download from within the APM (package manager)
Upgrades work by first changing the file system (via any of the
@@ -27,7 +27,7 @@
-Methods of upgrading OpenACS files
+Methods of upgrading OpenACS files
Upgrading files for a site which is not in a CVS
@@ -56,7 +56,7 @@
version, without overriding your own local customizations.
This diagram explains the basic idea. However, the labels are
incorrect. Step 1(a) has been removed, and Step 1(b) should be
labelled Step 1.
-
Figure 5.2. Upgrading a local CVS
+
Figure 5.2. Upgrading a local CVS
repository
@@ -196,7 +196,7 @@
-Upgrading a Production Site Safely
If you are upgrading a production OpenACS site which is on a
+Upgrading a Production Site Safely
If you are upgrading a production OpenACS site which is on a
private CVS tree, this process lets you do the upgrade without
risking extended downtime or an unusable site:
Declare a freeze on new cvs updates - ie, you cannot run cvs
Index: openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.html,v
diff -u -r1.27.2.24 -r1.27.2.25
--- openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.html 20 Jun 2017 07:16:42 -0000 1.27.2.24
+++ openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.html 6 Aug 2017 11:31:22 -0000 1.27.2.25
@@ -1,5 +1,5 @@
-
Upgrading files for a site which is not in a CVS repository. Unpack the tarball into a new directory and copy its
+
Methods of upgrading OpenACS files
Upgrading files for a site which is not in a CVS repository. Unpack the tarball into a new directory and copy its
contents on top of your working directory. Or just 'install
software', select remote repository, and upgrade your files
from there.
[root root]# su - $OPENACS_SERVICE_NAME
@@ -32,7 +32,7 @@
with the latest OpenACS version, without overriding your own
local customizations.
This diagram explains the basic idea. However, the
labels are incorrect. Step 1(a) has been removed, and Step
- 1(b) should be labelled Step 1.
Figure 5.2. Upgrading a local CVS repository
Step 0: Set up a working CVS checkout. To get your OpenACS code into your local CVS
+ 1(b) should be labelled Step 1.
Figure 5.2. Upgrading a local CVS repository
Step 0: Set up a working CVS checkout. To get your OpenACS code into your local CVS
repository, you will set up a working CVS checkout of
OpenACS. When you want to update your site, you'll
update the working CVS checkout, import those changes
@@ -97,7 +97,7 @@
[$OPENACS_SERVICE_NAME ~]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME
[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ cvs up -Pd
(CVS feedback)
-[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$
Upgrading a Production Site Safely
If you are upgrading a production OpenACS site which is on a private CVS tree, this process lets you do the upgrade without risking extended downtime or an unusable site:
Declare a freeze on new cvs updates - ie, you cannot run cvs update
+[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$
Upgrading a Production Site Safely
If you are upgrading a production OpenACS site which is on a private CVS tree, this process lets you do the upgrade without risking extended downtime or an unusable site:
Declare a freeze on new cvs updates - ie, you cannot run cvs update
on the production site
Make a manual backup of the production site in addition to the
automated backups
Import the new code (for example, OpenACS 5.0.4, openacs-5-0-compat versions of
Index: openacs-4/packages/acs-core-docs/www/upgrade-overview.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/upgrade-overview.adp,v
diff -u -r1.1.2.24 -r1.1.2.25
--- openacs-4/packages/acs-core-docs/www/upgrade-overview.adp 20 Jun 2017 07:16:42 -0000 1.1.2.24
+++ openacs-4/packages/acs-core-docs/www/upgrade-overview.adp 6 Aug 2017 11:31:22 -0000 1.1.2.25
@@ -26,11 +26,11 @@
upgrade scripts, and prompt you to restart the server. After
restarting the server again, the upgrade is complete.
-
Figure 5.1. Upgrading with the
+
Figure 5.1. Upgrading with the
APM
It's always a good idea to precede an upgrade attempt with a
snapshot backup.
-
Table 5.1. Assumptions in this
+
Table 5.1. Assumptions in this
section
Index: openacs-4/packages/acs-core-docs/www/upgrade-overview.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/upgrade-overview.html,v
diff -u -r1.27.2.23 -r1.27.2.24
--- openacs-4/packages/acs-core-docs/www/upgrade-overview.html 20 Jun 2017 07:16:42 -0000 1.27.2.23
+++ openacs-4/packages/acs-core-docs/www/upgrade-overview.html 6 Aug 2017 11:31:22 -0000 1.27.2.24
@@ -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:
Click install or upgrade under "Install from OpenACS Repository" and select the packages to install or upgrade.
The APM will download the requested packages from OpenACS.org, install the files on your hard drive, run any appropriate database upgrade scripts, and prompt you to restart the server. After restarting the server again, the upgrade is complete.
Figure 5.1. Upgrading with the APM
It's always a good idea to precede an upgrade attempt with a snapshot backup.
+ 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:
Click install or upgrade under "Install from OpenACS Repository" and select the packages to install or upgrade.
The APM will download the requested packages from OpenACS.org, install the files on your hard drive, run any appropriate database upgrade scripts, and prompt you to restart the server. After restarting the server again, the upgrade is complete.
Figure 5.1. Upgrading with the APM
It's always a good idea to precede an upgrade attempt with a snapshot backup.
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
+
Example 12.1. Getting datetime from
the database ANSI-style
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-datetime/www/doc/coversheet.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-datetime/www/doc/coversheet.adp,v
diff -u -r1.2.2.2 -r1.2.2.3
--- openacs-4/packages/acs-datetime/www/doc/coversheet.adp 25 Aug 2015 18:02:06 -0000 1.2.2.2
+++ openacs-4/packages/acs-datetime/www/doc/coversheet.adp 6 Aug 2017 11:31:22 -0000 1.2.2.3
@@ -1,5 +1,5 @@
-{/doc/acs-datetime {Date and Time Utilities}} {ACS DateTime}
+{/doc/acs-datetime {ACS Date and Time Utilities}} {ACS DateTime}ACS DateTime
ACS DateTime
Index: openacs-4/packages/acs-datetime/www/doc/design.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-datetime/www/doc/design.adp,v
diff -u -r1.2.2.3 -r1.2.2.4
--- openacs-4/packages/acs-datetime/www/doc/design.adp 5 Jul 2016 12:16:50 -0000 1.2.2.3
+++ openacs-4/packages/acs-datetime/www/doc/design.adp 6 Aug 2017 11:31:22 -0000 1.2.2.4
@@ -1,5 +1,5 @@
-{/doc/acs-datetime {Date and Time Utilities}} {ACS DateTime}
+{/doc/acs-datetime {ACS Date and Time Utilities}} {ACS DateTime}ACS DateTime
ACS DateTime
Index: openacs-4/packages/acs-datetime/www/doc/index.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-datetime/www/doc/index.adp,v
diff -u -r1.2.2.3 -r1.2.2.4
--- openacs-4/packages/acs-datetime/www/doc/index.adp 25 Aug 2015 18:02:06 -0000 1.2.2.3
+++ openacs-4/packages/acs-datetime/www/doc/index.adp 6 Aug 2017 11:31:22 -0000 1.2.2.4
@@ -1,5 +1,5 @@
-{/doc/acs-datetime {Date and Time Utilities}} {ACS DateTime Documentation}
+{/doc/acs-datetime {ACS Date and Time Utilities}} {ACS DateTime Documentation}ACS DateTime Documentation
ACS DateTime Documentation
Index: openacs-4/packages/acs-datetime/www/doc/requirements.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-datetime/www/doc/requirements.adp,v
diff -u -r1.2.2.8 -r1.2.2.9
--- openacs-4/packages/acs-datetime/www/doc/requirements.adp 5 Jul 2016 12:16:50 -0000 1.2.2.8
+++ openacs-4/packages/acs-datetime/www/doc/requirements.adp 6 Aug 2017 11:31:22 -0000 1.2.2.9
@@ -1,5 +1,5 @@
-{/doc/acs-datetime {Date and Time Utilities}} {ACS DateTime}
+{/doc/acs-datetime {ACS Date and Time Utilities}} {ACS DateTime}ACS DateTime
@@ -22,11 +22,11 @@
software is doing under the hood.
Peeking Under the Hood
Our development environment previously consisted largely of
-Emacs, and tail -f
-/web/servername/log/servername-error.log. Now this has been
-augmented: ad_footer and ad_admin_footer now
+Emacs, and tail -f
+/web/servername/log/servername-error.log. Now this has been
+augmented: ad_footer and ad_admin_footer now
display a link entitled Developer Information. (You can
-use the ds_link procedure to generate the link yourself.)
+use the ds_link procedure to generate the link yourself.)
Following the link displays a screenful of information
including:
@@ -45,10 +45,10 @@
anyone else would pose a huge security risk.
Comments
-Tired of using ns_log
+Tired of using ns_log
to instrument your code, then
grokking the error log to see what's wrong with your page? Use
-the ds_comment
+the ds_comment
routine instead:
ds_comment "Foo is $foo"
@@ -68,8 +68,8 @@
How It Works
The security subsystem registers preauth and trace filters which
store relevant connection information in shared variables
-(nsvs). The security subsystem also renames the AOLserver
-ns_db procedure and registers a wrapper which aggregates
+(nsvs). The security subsystem also renames the AOLserver
+ns_db procedure and registers a wrapper which aggregates
information about database queries.
@@ -301,7 +301,7 @@
should be the default system encoding.
VI.C Loading Regular Tcl Script Files
10.50
- By default, Tcl and template files in the
+ By default, tcl and template files in the
system will be loaded using the default system encoding. This is
generally ISO-8859-1 for AOLserver running on Unix systems in
English.
@@ -421,7 +421,7 @@
bboard.iso-8859-6
-A message catalog file consists of Tcl code to define messages in a
+A message catalog file consists of tcl code to define messages in a
given language or locale:
@@ -623,7 +623,7 @@
fconfigure -encoding blah
content type in outputheaders set for encoding conversion
ad_proc adp_parse_ad_conn_file {} {
- handle a request for an adp and/or Tcl file in the template system.
+ handle a request for an adp and/or tcl file in the template system.
} {
namespace eval template variable parse_level ""
#ns_log debug "adp_parse_ad_conn_file => file '[file root [ad_conn file]]'"
Index: openacs-4/packages/acs-lang/www/doc/i18n-requirements.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-lang/www/doc/i18n-requirements.adp,v
diff -u -r1.1.2.16 -r1.1.2.17
--- openacs-4/packages/acs-lang/www/doc/i18n-requirements.adp 21 Apr 2017 16:06:05 -0000 1.1.2.16
+++ openacs-4/packages/acs-lang/www/doc/i18n-requirements.adp 6 Aug 2017 11:31:22 -0000 1.1.2.17
@@ -1,5 +1,5 @@
-{/doc/acs-lang {Localization}} {ACS 4 Globalization Requirements}
+{/doc/acs-lang {ACS Localization}} {ACS 4 Globalization Requirements}ACS 4 Globalization Requirements
ACS 4 Globalization Requirements
@@ -99,7 +99,7 @@
The site would have an end-user visible UI to support these
languages, and the content management system must allow articles to
be posted in these languages. In some cases it may be necessary to
-make the modules' admin UI's operate in more than one
+make the modules' admin UI's operate in more than one
supported language, while in other cases the backend admin
interface can operate in a single language.
A developer is writing a new module, and wants to make it easy
Index: openacs-4/packages/acs-lang/www/doc/index.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-lang/www/doc/index.adp,v
diff -u -r1.1.2.5 -r1.1.2.6
--- openacs-4/packages/acs-lang/www/doc/index.adp 25 Aug 2015 18:02:07 -0000 1.1.2.5
+++ openacs-4/packages/acs-lang/www/doc/index.adp 6 Aug 2017 11:31:22 -0000 1.1.2.6
@@ -1,5 +1,5 @@
-{/doc/acs-lang {Localization}} {ACS Localization Documentation}
+{/doc/acs-lang {ACS Localization}} {ACS Localization Documentation}ACS Localization Documentation
ACS Localization Documentation
Index: openacs-4/packages/acs-mail-lite/www/doc/index.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-mail-lite/www/doc/index.adp,v
diff -u -r1.1.2.5 -r1.1.2.6
--- openacs-4/packages/acs-mail-lite/www/doc/index.adp 21 Apr 2017 16:11:28 -0000 1.1.2.5
+++ openacs-4/packages/acs-mail-lite/www/doc/index.adp 6 Aug 2017 11:31:22 -0000 1.1.2.6
@@ -1,5 +1,5 @@
-{/doc/acs-mail-lite {Mail Services Lite}} {User Documentation for ACS Mail Lite}
+{/doc/acs-mail-lite {ACS Mail Services Lite}} {User Documentation for ACS Mail Lite}User Documentation for ACS Mail Lite
User Documentation for ACS Mail Lite
@@ -19,8 +19,8 @@
The address starts with "bounce" (can be changed by a
parameter) followed by the user_id, a hashkey and the package_id of
the package instance that sent the email, separated by
-"-". The domain name of this address can be changed with a
-parameter.
+"-". The domain name of this address can be changed with
+a parameter.
The system checks every 2 minutes (configurable) in a certain
maildirectory (configurable) for newly bounced emails, so the
mailsystem will have to place every mail to an address beginning
Index: openacs-4/packages/acs-messaging/www/doc/design.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-messaging/www/doc/design.adp,v
diff -u -r1.2.2.3 -r1.2.2.4
--- openacs-4/packages/acs-messaging/www/doc/design.adp 5 Jul 2016 12:15:32 -0000 1.2.2.3
+++ openacs-4/packages/acs-messaging/www/doc/design.adp 6 Aug 2017 11:31:22 -0000 1.2.2.4
@@ -1,5 +1,5 @@
-{/doc/acs-messaging {Messaging}} {ACS Messaging Design}
+{/doc/acs-messaging {ACS Messaging}} {ACS Messaging Design}ACS Messaging Design
ad_page_contract {
- \@cvs-id $Id: migration.html,v 1.3.2.1 2016/06/22 07:48:43 gustafn Exp $
+ \@cvs-id $Id: migration.html,v 1.3.2.2 2017/04/22 18:30:26 gustafn Exp $
} {
} -properties {
header:onevalue
@@ -571,5 +571,5 @@
Iwashima
-Last modified: $Id: migration.html,v 1.3.2.1 2016/06/22 07:48:43
+Last modified: $Id: migration.html,v 1.3.2.2 2017/04/22 18:30:26
gustafn Exp $
Index: openacs-4/packages/acs-templating/www/doc/noquote.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/noquote.adp,v
diff -u -r1.3.2.7 -r1.3.2.8
--- openacs-4/packages/acs-templating/www/doc/noquote.adp 22 Apr 2017 18:33:51 -0000 1.3.2.7
+++ openacs-4/packages/acs-templating/www/doc/noquote.adp 6 Aug 2017 11:31:22 -0000 1.3.2.8
@@ -133,8 +133,8 @@
templating still supports all the ADP features, including embedding
Tcl code in the template. Thus instead of referring to the multirow
variable with the \@forums.name\@ variable substitutions, we use
-<%= [ns_quotehtml \@forums.name\@] %>. This
-works correctly, but obviously breaks the abstraction barrier
+<%= [ns_quotehtml \@forums.name\@] %>.
+This works correctly, but obviously breaks the abstraction barrier
between ADP and Tcl syntaxes. The practical result of breaking the
abstraction is that every occurrence of Tcl code in an ADP template
will have to be painstakingly reviewed and converted once ADPs
Index: openacs-4/packages/acs-templating/www/doc/requirements.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/requirements.adp,v
diff -u -r1.2.2.7 -r1.2.2.8
--- openacs-4/packages/acs-templating/www/doc/requirements.adp 21 Apr 2017 16:50:30 -0000 1.2.2.7
+++ openacs-4/packages/acs-templating/www/doc/requirements.adp 6 Aug 2017 11:31:22 -0000 1.2.2.8
@@ -230,5 +230,5 @@
yon\@arsdigita.com
-Last modified: $Id: requirements.html,v 1.2.2.1 2016/06/22 07:48:43
+Last modified: $Id: requirements.html,v 1.2.2.2 2017/04/21 16:50:30
gustafn Exp $
Index: openacs-4/packages/acs-templating/www/doc/api/database.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/api/database.adp,v
diff -u -r1.2.2.5 -r1.2.2.6
--- openacs-4/packages/acs-templating/www/doc/api/database.adp 1 Dec 2016 20:43:45 -0000 1.2.2.5
+++ openacs-4/packages/acs-templating/www/doc/api/database.adp 6 Aug 2017 11:31:22 -0000 1.2.2.6
@@ -66,4 +66,4 @@
Oracle.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/api/element.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/api/element.adp,v
diff -u -r1.2.2.6 -r1.2.2.7
--- openacs-4/packages/acs-templating/www/doc/api/element.adp 1 Dec 2016 20:43:45 -0000 1.2.2.6
+++ openacs-4/packages/acs-templating/www/doc/api/element.adp 6 Aug 2017 11:31:22 -0000 1.2.2.7
@@ -54,4 +54,4 @@
Note(s)
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/api/form.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/api/form.adp,v
diff -u -r1.2.2.5 -r1.2.2.6
--- openacs-4/packages/acs-templating/www/doc/api/form.adp 1 Dec 2016 20:43:45 -0000 1.2.2.5
+++ openacs-4/packages/acs-templating/www/doc/api/form.adp 6 Aug 2017 11:31:22 -0000 1.2.2.6
@@ -36,4 +36,4 @@
Example
Note(s)
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/api/multirow.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/api/multirow.adp,v
diff -u -r1.2.2.6 -r1.2.2.7
--- openacs-4/packages/acs-templating/www/doc/api/multirow.adp 1 Dec 2016 20:43:45 -0000 1.2.2.6
+++ openacs-4/packages/acs-templating/www/doc/api/multirow.adp 6 Aug 2017 11:31:22 -0000 1.2.2.7
@@ -64,4 +64,4 @@
column values while building a data source from a multirow query
result.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/api/request.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/api/request.adp,v
diff -u -r1.2.2.5 -r1.2.2.6
--- openacs-4/packages/acs-templating/www/doc/api/request.adp 1 Dec 2016 20:43:45 -0000 1.2.2.5
+++ openacs-4/packages/acs-templating/www/doc/api/request.adp 6 Aug 2017 11:31:22 -0000 1.2.2.6
@@ -87,4 +87,4 @@
Community System.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/appendices/memory.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/appendices/memory.adp,v
diff -u -r1.2.2.6 -r1.2.2.7
--- openacs-4/packages/acs-templating/www/doc/appendices/memory.adp 1 Dec 2016 20:43:45 -0000 1.2.2.6
+++ openacs-4/packages/acs-templating/www/doc/appendices/memory.adp 6 Aug 2017 11:31:22 -0000 1.2.2.7
@@ -95,8 +95,8 @@
if etc.) that must be "protected" during the
first step. The templating system provides the noparse tag to do this.
-
-
+
-Last modified: $Id: memory.html,v 1.1.1.1.30.1 2016/06/22 07:48:44
-gustafn Exp $
+
+Last modified: $Id: memory.html,v 1.1.1.1.30.2 2016/12/01 20:43:45
+antoniop Exp $
Index: openacs-4/packages/acs-templating/www/doc/demo/index.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/demo/index.adp,v
diff -u -r1.3.2.9 -r1.3.2.10
--- openacs-4/packages/acs-templating/www/doc/demo/index.adp 22 Apr 2017 18:33:51 -0000 1.3.2.9
+++ openacs-4/packages/acs-templating/www/doc/demo/index.adp 6 Aug 2017 11:31:22 -0000 1.3.2.10
@@ -309,4 +309,4 @@
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/gen/proc-doc.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/gen/proc-doc.adp,v
diff -u -r1.2.2.6 -r1.2.2.7
--- openacs-4/packages/acs-templating/www/doc/gen/proc-doc.adp 1 Dec 2016 20:43:45 -0000 1.2.2.6
+++ openacs-4/packages/acs-templating/www/doc/gen/proc-doc.adp 6 Aug 2017 11:31:22 -0000 1.2.2.7
@@ -153,4 +153,4 @@
completely qualified name of the namespace or
procedure.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/guide/components.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/guide/components.adp,v
diff -u -r1.2.2.6 -r1.2.2.7
--- openacs-4/packages/acs-templating/www/doc/guide/components.adp 1 Dec 2016 20:43:45 -0000 1.2.2.6
+++ openacs-4/packages/acs-templating/www/doc/guide/components.adp 6 Aug 2017 11:31:22 -0000 1.2.2.7
@@ -30,4 +30,4 @@
Building the Container Template
Including Component Templates
-->
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/guide/composite.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/guide/composite.adp,v
diff -u -r1.2.2.7 -r1.2.2.8
--- openacs-4/packages/acs-templating/www/doc/guide/composite.adp 22 Apr 2017 18:33:51 -0000 1.2.2.7
+++ openacs-4/packages/acs-templating/www/doc/guide/composite.adp 6 Aug 2017 11:31:22 -0000 1.2.2.8
@@ -151,4 +151,4 @@
It is an error to omit both parts; this is a special case
intended to speed up debugging.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/guide/data.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/guide/data.adp,v
diff -u -r1.2.2.6 -r1.2.2.7
--- openacs-4/packages/acs-templating/www/doc/guide/data.adp 1 Dec 2016 20:43:45 -0000 1.2.2.6
+++ openacs-4/packages/acs-templating/www/doc/guide/data.adp 6 Aug 2017 11:31:22 -0000 1.2.2.7
@@ -94,4 +94,4 @@
template with the multiple
tag.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/guide/document.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/guide/document.adp,v
diff -u -r1.2.2.7 -r1.2.2.8
--- openacs-4/packages/acs-templating/www/doc/guide/document.adp 1 Dec 2016 20:43:45 -0000 1.2.2.7
+++ openacs-4/packages/acs-templating/www/doc/guide/document.adp 6 Aug 2017 11:31:22 -0000 1.2.2.8
@@ -59,4 +59,4 @@
visit the URL from which the page will be served, substituting
acs with the dat extension.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/guide/form-datatypes.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/guide/form-datatypes.adp,v
diff -u -r1.2.2.4 -r1.2.2.5
--- openacs-4/packages/acs-templating/www/doc/guide/form-datatypes.adp 1 Dec 2016 20:43:45 -0000 1.2.2.4
+++ openacs-4/packages/acs-templating/www/doc/guide/form-datatypes.adp 6 Aug 2017 11:31:22 -0000 1.2.2.5
@@ -7,4 +7,4 @@
: Developer Guide
: User Guide
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/guide/form-process.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/guide/form-process.adp,v
diff -u -r1.2.2.6 -r1.2.2.7
--- openacs-4/packages/acs-templating/www/doc/guide/form-process.adp 1 Dec 2016 20:43:45 -0000 1.2.2.6
+++ openacs-4/packages/acs-templating/www/doc/guide/form-process.adp 6 Aug 2017 11:31:22 -0000 1.2.2.7
@@ -37,4 +37,4 @@
used to create the form.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/guide/form-templates.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/guide/form-templates.adp,v
diff -u -r1.2.2.5 -r1.2.2.6
--- openacs-4/packages/acs-templating/www/doc/guide/form-templates.adp 1 Dec 2016 20:43:45 -0000 1.2.2.5
+++ openacs-4/packages/acs-templating/www/doc/guide/form-templates.adp 6 Aug 2017 11:31:22 -0000 1.2.2.6
@@ -31,4 +31,4 @@
-->
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/guide/forms.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/guide/forms.adp,v
diff -u -r1.2.2.7 -r1.2.2.8
--- openacs-4/packages/acs-templating/www/doc/guide/forms.adp 1 Dec 2016 20:43:45 -0000 1.2.2.7
+++ openacs-4/packages/acs-templating/www/doc/guide/forms.adp 6 Aug 2017 11:31:22 -0000 1.2.2.8
@@ -57,4 +57,4 @@
element create. In this case the value is set separately
to avoid the additional database query during a submission.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/guide/master.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/guide/master.adp,v
diff -u -r1.3.2.8 -r1.3.2.9
--- openacs-4/packages/acs-templating/www/doc/guide/master.adp 1 Dec 2016 20:43:45 -0000 1.3.2.8
+++ openacs-4/packages/acs-templating/www/doc/guide/master.adp 6 Aug 2017 11:31:22 -0000 1.3.2.9
@@ -131,4 +131,4 @@
the master template may use to query for additional
information.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/guide/search.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/guide/search.adp,v
diff -u -r1.2.2.6 -r1.2.2.7
--- openacs-4/packages/acs-templating/www/doc/guide/search.adp 21 Apr 2017 16:50:30 -0000 1.2.2.6
+++ openacs-4/packages/acs-templating/www/doc/guide/search.adp 6 Aug 2017 11:31:22 -0000 1.2.2.7
@@ -66,4 +66,4 @@
result (i.e. Sally).
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/guide/skins.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/guide/skins.adp,v
diff -u -r1.2.2.4 -r1.2.2.5
--- openacs-4/packages/acs-templating/www/doc/guide/skins.adp 1 Dec 2016 20:43:45 -0000 1.2.2.4
+++ openacs-4/packages/acs-templating/www/doc/guide/skins.adp 6 Aug 2017 11:31:22 -0000 1.2.2.5
@@ -11,4 +11,4 @@
(Discussion of how to do cobranding, syndication of data in XML,
etc.).
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/guide/tcl.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/guide/tcl.adp,v
diff -u -r1.2.2.6 -r1.2.2.7
--- openacs-4/packages/acs-templating/www/doc/guide/tcl.adp 22 Apr 2017 18:33:51 -0000 1.2.2.6
+++ openacs-4/packages/acs-templating/www/doc/guide/tcl.adp 6 Aug 2017 11:31:22 -0000 1.2.2.7
@@ -18,4 +18,4 @@
separation of code and layout, one of the benefits of templating.
Embedded Tcl makes templates non-portable to ACS/Java.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/guide/templates.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/guide/templates.adp,v
diff -u -r1.3.2.8 -r1.3.2.9
--- openacs-4/packages/acs-templating/www/doc/guide/templates.adp 21 Apr 2017 16:50:30 -0000 1.3.2.8
+++ openacs-4/packages/acs-templating/www/doc/guide/templates.adp 6 Aug 2017 11:31:22 -0000 1.3.2.9
@@ -79,4 +79,4 @@
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/guide/wizards.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/guide/wizards.adp,v
diff -u -r1.2.2.5 -r1.2.2.6
--- openacs-4/packages/acs-templating/www/doc/guide/wizards.adp 1 Dec 2016 20:43:45 -0000 1.2.2.5
+++ openacs-4/packages/acs-templating/www/doc/guide/wizards.adp 6 Aug 2017 11:31:22 -0000 1.2.2.6
@@ -93,4 +93,4 @@
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/tagref/formerror.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/tagref/formerror.adp,v
diff -u -r1.3.2.7 -r1.3.2.8
--- openacs-4/packages/acs-templating/www/doc/tagref/formerror.adp 1 Dec 2016 17:14:38 -0000 1.3.2.7
+++ openacs-4/packages/acs-templating/www/doc/tagref/formerror.adp 6 Aug 2017 11:31:22 -0000 1.3.2.8
@@ -72,4 +72,4 @@
information on writing the body of a dynamic form template.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/tagref/formgroup.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/tagref/formgroup.adp,v
diff -u -r1.3.2.7 -r1.3.2.8
--- openacs-4/packages/acs-templating/www/doc/tagref/formgroup.adp 1 Dec 2016 16:54:34 -0000 1.3.2.7
+++ openacs-4/packages/acs-templating/www/doc/tagref/formgroup.adp 6 Aug 2017 11:31:22 -0000 1.3.2.8
@@ -36,22 +36,19 @@
the button.
The formgroup tag may emulate either the multiple or grid tags in repeating the template
section within the tag. By default it emulates the multiple tag. If the cols
attribute is specified, the formgroup tag will emulate
-the grid tag.
-
-
- HTML attributes may be specified as attributes to
- the formgroup tag. The system will include all such
- attributes in the input tags of each radio button or
- check box in the group. Although possible, newer browser security
- features such as CSP discourage the use of inline Javascript event
- handlers.
-
HTML attributes may be specified as attributes to the
+formgroup tag. The system will include all such
+attributes in the input tags of each radio button or
+check box in the group. Although possible, newer browser security
+features such as CSP discourage the use of inline Javascript event
+handlers.
See the formtemplate
and formwidget tags for
more information on writing the body of a dynamic form
template.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/tagref/formtemplate.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/tagref/formtemplate.adp,v
diff -u -r1.3.2.7 -r1.3.2.8
--- openacs-4/packages/acs-templating/www/doc/tagref/formtemplate.adp 1 Dec 2016 16:28:58 -0000 1.3.2.7
+++ openacs-4/packages/acs-templating/www/doc/tagref/formtemplate.adp 6 Aug 2017 11:31:22 -0000 1.3.2.8
@@ -43,23 +43,17 @@
acs-templating package, and is by default set to
standard, which is included in the distribution.
-
- HTML attributes may be specified as attributes to
- the formtemplate tag. The system will include all such
- attributes in the form tag of the rendered HTML form.
- Although possible, newer browser security features such as CSP
- discourage the use of inline Javascript event handlers.
-
- This will work for both autogenerated and explicitly formatted forms.
-
-
+
HTML attributes may be specified as attributes to the
+formtemplate tag. The system will include all such
+attributes in the form tag of the rendered HTML form.
+Although possible, newer browser security features such as CSP
+discourage the use of inline Javascript event handlers.
This will work for both autogenerated and explicitly formatted
+forms.
See the formwidget and
formgroup tags for more
information on writing the body of a dynamic form template.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/tagref/formwidget.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/tagref/formwidget.adp,v
diff -u -r1.3.2.8 -r1.3.2.9
--- openacs-4/packages/acs-templating/www/doc/tagref/formwidget.adp 1 Dec 2016 16:46:13 -0000 1.3.2.8
+++ openacs-4/packages/acs-templating/www/doc/tagref/formwidget.adp 6 Aug 2017 11:31:22 -0000 1.3.2.9
@@ -33,21 +33,18 @@
complete with their proper values, options and other attributes,
while rendering the template. Explicit form tags in the template
may be used in special circumstances, but should be avoided
-wherever possible.
-
-
- HTML attributes may be specified as attributes to
- the formwidget tag. The system will include all such
- attributes in the input or
- select tag of the rendered HTML form.
- Although possible, newer browser security features such as CSP
- discourage the use of inline Javascript event handlers.
-
HTML attributes may be specified as attributes to the
+formwidget tag. The system will include all such
+attributes in the input or select tag of the
+rendered HTML form. Although possible, newer browser security
+features such as CSP discourage the use of inline Javascript event
+handlers.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/tagref/master.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/tagref/master.adp,v
diff -u -r1.2.2.5 -r1.2.2.6
--- openacs-4/packages/acs-templating/www/doc/tagref/master.adp 1 Dec 2016 17:14:38 -0000 1.2.2.5
+++ openacs-4/packages/acs-templating/www/doc/tagref/master.adp 6 Aug 2017 11:31:22 -0000 1.2.2.6
@@ -28,4 +28,4 @@
See property and slave for more information related to
master templates.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/tagref/multiple.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/tagref/multiple.adp,v
diff -u -r1.3.2.7 -r1.3.2.8
--- openacs-4/packages/acs-templating/www/doc/tagref/multiple.adp 1 Dec 2016 17:14:38 -0000 1.3.2.7
+++ openacs-4/packages/acs-templating/www/doc/tagref/multiple.adp 6 Aug 2017 11:31:22 -0000 1.3.2.8
@@ -93,4 +93,4 @@
nest.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/tagref/noparse.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/tagref/noparse.adp,v
diff -u -r1.2.2.5 -r1.2.2.6
--- openacs-4/packages/acs-templating/www/doc/tagref/noparse.adp 1 Dec 2016 17:14:38 -0000 1.2.2.5
+++ openacs-4/packages/acs-templating/www/doc/tagref/noparse.adp 6 Aug 2017 11:31:22 -0000 1.2.2.6
@@ -28,4 +28,4 @@
component templates in an include tag or to form
elements in a formwidget tag) must be
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/tagref/property.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/tagref/property.adp,v
diff -u -r1.2.2.5 -r1.2.2.6
--- openacs-4/packages/acs-templating/www/doc/tagref/property.adp 1 Dec 2016 17:14:38 -0000 1.2.2.5
+++ openacs-4/packages/acs-templating/www/doc/tagref/property.adp 6 Aug 2017 11:31:22 -0000 1.2.2.6
@@ -27,4 +27,4 @@
See master and slave for more information about master
templates.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/tagref/slave.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/tagref/slave.adp,v
diff -u -r1.2.2.5 -r1.2.2.6
--- openacs-4/packages/acs-templating/www/doc/tagref/slave.adp 1 Dec 2016 17:14:38 -0000 1.2.2.5
+++ openacs-4/packages/acs-templating/www/doc/tagref/slave.adp 6 Aug 2017 11:31:22 -0000 1.2.2.6
@@ -26,4 +26,4 @@
See property and master for more information related to
master templates.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/tagref/switch.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/tagref/switch.adp,v
diff -u -r1.3.2.7 -r1.3.2.8
--- openacs-4/packages/acs-templating/www/doc/tagref/switch.adp 1 Dec 2016 17:14:38 -0000 1.3.2.7
+++ openacs-4/packages/acs-templating/www/doc/tagref/switch.adp 6 Aug 2017 11:31:22 -0000 1.3.2.8
@@ -73,4 +73,4 @@
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/tagref/variable.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/tagref/variable.adp,v
diff -u -r1.3.2.6 -r1.3.2.7
--- openacs-4/packages/acs-templating/www/doc/tagref/variable.adp 1 Dec 2016 17:14:38 -0000 1.3.2.6
+++ openacs-4/packages/acs-templating/www/doc/tagref/variable.adp 6 Aug 2017 11:31:22 -0000 1.3.2.7
@@ -33,4 +33,4 @@
An attempt to reference a variable that does not exist will
cause an error message to appear in the browser.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/widgets/date.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/widgets/date.adp,v
diff -u -r1.2.2.5 -r1.2.2.6
--- openacs-4/packages/acs-templating/www/doc/widgets/date.adp 1 Dec 2016 20:43:45 -0000 1.2.2.5
+++ openacs-4/packages/acs-templating/www/doc/widgets/date.adp 6 Aug 2017 11:31:22 -0000 1.2.2.6
@@ -200,4 +200,4 @@
Examples of various Date widgets can be found on the demo pages.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/widgets/index.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/widgets/index.adp,v
diff -u -r1.2.2.4 -r1.2.2.5
--- openacs-4/packages/acs-templating/www/doc/widgets/index.adp 1 Dec 2016 20:43:45 -0000 1.2.2.4
+++ openacs-4/packages/acs-templating/www/doc/widgets/index.adp 6 Aug 2017 11:31:22 -0000 1.2.2.5
@@ -11,4 +11,4 @@
Table widget (preliminary)
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/widgets/input.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/widgets/input.adp,v
diff -u -r1.4.2.8 -r1.4.2.9
--- openacs-4/packages/acs-templating/www/doc/widgets/input.adp 1 Dec 2016 20:43:45 -0000 1.4.2.8
+++ openacs-4/packages/acs-templating/www/doc/widgets/input.adp 6 Aug 2017 11:31:22 -0000 1.4.2.9
@@ -57,4 +57,4 @@
contains a list of all the checked values; the value
(singular) property contains the first element in the list.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/widgets/select.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/widgets/select.adp,v
diff -u -r1.2.2.6 -r1.2.2.7
--- openacs-4/packages/acs-templating/www/doc/widgets/select.adp 1 Dec 2016 20:43:45 -0000 1.2.2.6
+++ openacs-4/packages/acs-templating/www/doc/widgets/select.adp 6 Aug 2017 11:31:22 -0000 1.2.2.7
@@ -66,4 +66,4 @@
value (singular) property contains the first selected
choice.
-
+
\ No newline at end of file
Index: openacs-4/packages/acs-templating/www/doc/widgets/table.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/widgets/table.adp,v
diff -u -r1.2.2.4 -r1.2.2.5
--- openacs-4/packages/acs-templating/www/doc/widgets/table.adp 1 Dec 2016 20:43:45 -0000 1.2.2.4
+++ openacs-4/packages/acs-templating/www/doc/widgets/table.adp 6 Aug 2017 11:31:22 -0000 1.2.2.5
@@ -11,4 +11,4 @@
layout may be based on a standard sitewide style, or on a custom
template.
-
+
\ No newline at end of file
Index: openacs-4/packages/ajaxhelper/www/doc/index.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/ajaxhelper/www/doc/index.adp,v
diff -u -r1.1.2.5 -r1.1.2.6
--- openacs-4/packages/ajaxhelper/www/doc/index.adp 7 Jun 2017 08:44:26 -0000 1.1.2.5
+++ openacs-4/packages/ajaxhelper/www/doc/index.adp 6 Aug 2017 11:31:22 -0000 1.1.2.6
@@ -6,7 +6,7 @@
Hamilton G. Chua (ham\@solutiongrove.com)
September 2007
v0.87d
Sortables are documented in the scriptaculous wiki
-http://madrobby.github.io/scriptaculous/sortable/.
-
+http://madrobby.github.io/scriptaculous/sortable/
+.
For sortables to work you will need to define a container which
Index: openacs-4/packages/assessment/www/doc/data_collection.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/assessment/www/doc/data_collection.adp,v
diff -u -r1.1.2.4 -r1.1.2.5
--- openacs-4/packages/assessment/www/doc/data_collection.adp 4 Jul 2016 11:33:12 -0000 1.1.2.4
+++ openacs-4/packages/assessment/www/doc/data_collection.adp 6 Aug 2017 11:31:22 -0000 1.1.2.5
@@ -194,7 +194,7 @@
for education apps that this belongs here, since a consent will
happen only once for a given assessment while the user may complete
the assessment during multiple sessions (if save&resume is
-enabled for instance). In fact, I've removed this from the
+enabled for instance). In fact, I've removed this from the
graffle (SK).
A final point concerns the mapping tables. The OpenACS framework
provides a variety of special-purpose mapping tables that are all
proper acs_objects (member_rels, composition_rels, acs_rels, and
-the CR's own cr_rels). These provide additional control over
+the CR's own cr_rels). These provide additional control over
permissioning but fundamentally are mapping tables. In the long run
the benefit of using them is the ability of OpenACS 6, to auto
construct code based on cr_item_types and relationships.
Index: openacs-4/packages/assessment/www/doc/user_interface/index.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/assessment/www/doc/user_interface/index.adp,v
diff -u -r1.1.2.3 -r1.1.2.4
--- openacs-4/packages/assessment/www/doc/user_interface/index.adp 4 Jul 2016 11:33:12 -0000 1.1.2.3
+++ openacs-4/packages/assessment/www/doc/user_interface/index.adp 6 Aug 2017 11:31:22 -0000 1.1.2.4
@@ -83,7 +83,7 @@
Furthermore the grading package offers to
transfer scores (which are stored as integer values) into a grade
(e.g. the american A-F scheme, or the German 1-6). This is where it
-gets the name from I'd say ;). Grading schemes are flexible and
+gets the name from I'd say ;). Grading schemes are flexible and
can be created on the fly. This allows us to support any grading
scheme across the world's universities. In addition in the area
of Knowledge Management, grades could be transfered into incentive
Index: openacs-4/packages/assessment/www/doc/user_interface/item_creation.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/assessment/www/doc/user_interface/item_creation.adp,v
diff -u -r1.1.2.4 -r1.1.2.5
--- openacs-4/packages/assessment/www/doc/user_interface/item_creation.adp 4 Jul 2016 11:33:12 -0000 1.1.2.4
+++ openacs-4/packages/assessment/www/doc/user_interface/item_creation.adp 6 Aug 2017 11:31:22 -0000 1.1.2.5
@@ -296,7 +296,7 @@
Calculation and Database Questions
-I'm not clear from your description what these are. If by
+I'm not clear from your description what these are. If by
Calculation questions you mean questions that produce some
calculated result from the user's raw response, then IMHO this
is an important type of question to support now and not defer. This
Index: openacs-4/packages/attachments/www/doc/index.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/attachments/www/doc/index.adp,v
diff -u -r1.1.2.7 -r1.1.2.8
--- openacs-4/packages/attachments/www/doc/index.adp 5 Aug 2016 14:11:57 -0000 1.1.2.7
+++ openacs-4/packages/attachments/www/doc/index.adp 6 Aug 2017 11:31:22 -0000 1.1.2.8
@@ -32,17 +32,17 @@
1.1.1 What does
attachments do?
-attachments is a service package that allows you to
-attach one or more file-storage files to any acs_object.
-attachments is mounted below a package that uses it, and
+attachments is a service package that allows you to
+attach one or more file-storage files to any acs_object.
+attachments is mounted below a package that uses it, and
the application provides links into the attachments package's
UI.
Before you can use the attachments package, each instance of
-your package must be mapped to a file-storage root
-folder.
+your package must be mapped to a file-storage root
+folder.
The root folder is a "super folder" for all the files
in that specific instance of file-storage, and it is created
automatically when the file-storage package is instanciated.
@@ -56,7 +56,7 @@
1.2.1 Mount attachments
under your package
The first step is to mount the attachments package
-under your package. In the site-map, you
+under your package. In the site-map, you
should create a new site-node (sub-folder) under your package
called "attach".
"attach" is the standard URL, however URL this can be
@@ -77,8 +77,8 @@
package_id of the instance of your package.
Two utility procs to help you do this:
-fs::get_root_folder and
-attachments::map_root_folder
+fs::get_root_folder and
+attachments::map_root_folder
1.2.3 Attaching files to
Index: openacs-4/packages/calendar/www/doc/index.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/calendar/www/doc/index.adp,v
diff -u -r1.1.2.4 -r1.1.2.5
--- openacs-4/packages/calendar/www/doc/index.adp 26 Oct 2016 12:03:38 -0000 1.1.2.4
+++ openacs-4/packages/calendar/www/doc/index.adp 6 Aug 2017 11:31:22 -0000 1.1.2.5
@@ -58,5 +58,5 @@
Dirk
Gomez
-
-Last modified: Thu Jan 22 23:51:17 CET 2004
\ No newline at end of file
+Last modified: Wed Oct 26 14:02:57 CEST 2016
+
\ No newline at end of file
Index: openacs-4/packages/calendar/www/doc/requirements.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/calendar/www/doc/requirements.adp,v
diff -u -r1.1.2.5 -r1.1.2.6
--- openacs-4/packages/calendar/www/doc/requirements.adp 22 Apr 2017 12:25:25 -0000 1.1.2.5
+++ openacs-4/packages/calendar/www/doc/requirements.adp 6 Aug 2017 11:31:22 -0000 1.1.2.6
@@ -130,7 +130,7 @@
There is one core procedure, general_comments_get_comments, that will show comments
on an object and make appropriate links to files from the
-general-comments package for
-recording and editing user comments. An optional return_url can be specified which will be
-provided as a link to the user within the general-comments pages. This is useful for
+general-comments package for
+recording and editing user comments. An optional return_url can be specified which will be
+provided as a link to the user within the general-comments pages. This is useful for
the user to return to the original page after making a comment.
The other procedure, general_comments_create_link, is a wrapper procedure
that returns an html fragment for a link which points to the
-location of the mounted general_comments package. There are various
+location of the mounted general_comments package. There are various
switches that will be useful to package developers:
object_name: A name for the object
-being commented on is displayed throughout the general-comments pages. Defaults to
+being commented on is displayed throughout the general-comments pages. Defaults to
[acs_object_name].
link_text: The text of the link
returned. Defaults to "Add a comment".
@@ -82,14 +82,14 @@
complete. The purpose is to allow separation of comments on the
same object into categories.
A problem that may occur is when any of the two tcl procedures
-are called when the general-comments package is not mounted. Both
-general_comments_get_comments and
-general_comments_create_link needs
-to find out the location of the mounted general-comments instance to generate correct
+are called when the general-comments package is not mounted. Both
+general_comments_get_comments and
+general_comments_create_link needs
+to find out the location of the mounted general-comments instance to generate correct
links. In this case, both procedures will return nothing and log a
notice.
Note: In the alpha release of
-general-comments, the tcl
+general-comments, the tcl
procedures were defined within a namespace and encountered problems
with the api browser not being able to display them properly. These
procedures have now been moved out of the namespace and the old
@@ -98,31 +98,31 @@
The majority of the functionality of general comments has been
-merged with acs-messaging. Comments are stored as acs-messages.
The general_comments table
-extends acs_messages to provide
-categorization of comments on a particular object. general_comments also stores the object_id of
+merged with acs-messaging. Comments are stored as acs-messages.
The general_comments table
+extends acs_messages to provide
+categorization of comments on a particular object. general_comments also stores the object_id of
the object the comment refers to. Relationships from attachments to
-acs-message is done by using the cr_items.parent_id column.
A general-comment can be
-associated with any object in the system by using the general_comments.object_id column. Because
+acs-message is done by using the cr_items.parent_id column.
A general-comment can be
+associated with any object in the system by using the general_comments.object_id column. Because
each comment is itself an object, we could implement comments on
comments. However, this functionality is not needed in the
-general-comments model and the UI
+general-comments model and the UI
does not support comments on comments.
There are three types of attachments a user can create: file,
image, and url. The underlying data representation of an attachment
is a content item with different content_types. File attachments
are stored with a content_revision type. Image attachments are
stored with a image type. Url attachments are stored with a
content_extlink type.
One problem we face is how to allow designers to modify the
presentation of the comments on an object without modifying tcl
-code. The proc general_comments_get_comments has html code
+code. The proc general_comments_get_comments has html code
which should really be placed into a template. Karl Goldstein code
reviewed general comments and has an interesting solution:
-
Add an -uplevel parameter to
-db_multirow.
In the general_comments_get_comments proc, create an
-upleveled datasource.
From the .tcl page, make a call
-to general_comments_get_comments,
+
Add an -uplevel parameter to
+db_multirow.
In the general_comments_get_comments proc, create an
+upleveled datasource.
From the .tcl page, make a call
+to general_comments_get_comments,
which would set up the multirow datasource in the current
-environment.
From the .adp page, loop through
+environment.
From the .adp page, loop through
the multirow datasource.
-AutoApproveCommentsP: Sets
+AutoApproveCommentsP: Sets
whether comments go live immediately.
-AllowFileAttachmentsP: Sets
+AllowFileAttachmentsP: Sets
whether files can be attached to comments.
-AllowLinkAttachmentsP: Sets
+AllowLinkAttachmentsP: Sets
whether links can be attached to comments.
-MaxFileSize: Maximum file size
+MaxFileSize: Maximum file size
that can be uploaded in bytes.
@@ -166,8 +166,8 @@
0.1
Creation
10/26/2000
Phong Nguyen
-
Last modified: $Id: design.html,v 1.2 2014/10/27 16:41:44
-victorg Exp $
+
Last modified: $Id: design.html,v 1.2.2.2 2017/04/21 20:11:53
+gustafn Exp $
Index: openacs-4/packages/general-comments/www/doc/dev-guide.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/general-comments/www/doc/dev-guide.adp,v
diff -u -r1.1.2.6 -r1.1.2.7
--- openacs-4/packages/general-comments/www/doc/dev-guide.adp 21 Apr 2017 20:11:53 -0000 1.1.2.6
+++ openacs-4/packages/general-comments/www/doc/dev-guide.adp 6 Aug 2017 11:31:23 -0000 1.1.2.7
@@ -30,12 +30,12 @@
in ACS 4.0, which gives you the benefits of the Permission System.
Comments are stored as ACS Messages.
When a user creates a comment, General Comments stores the
comment as an ACS Message and associates the comment to the object
-commented on. The value set by the administrator on whether comments
-go live immediately or needs approval first is stored along with
-the comment during this phase. After this, the user is presented
-with a page that displays contents of the comment along with
-revision history, attachments, and links to perform actions on the
-comment such as adding attachments or editing the comment.
+commented on. The value set by the administrator on whether
+comments go live immediately or needs approval first is stored
+along with the comment during this phase. After this, the user is
+presented with a page that displays contents of the comment along
+with revision history, attachments, and links to perform actions on
+the comment such as adding attachments or editing the comment.
This package supports empowering all users with the option of
@@ -136,8 +136,8 @@
0.1
Creation
10/26/2000
Phong Nguyen
-
Last modified: $Id: dev-guide.html,v 1.1.1.1 2001/04/20 20:51:11
-donb Exp $
+
Last modified: $Id: dev-guide.html,v 1.1.1.1.28.1 2017/04/21
+20:11:53 gustafn Exp $
Index: openacs-4/packages/oacs-dav/www/doc/index.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/oacs-dav/www/doc/index.adp,v
diff -u -r1.1.2.6 -r1.1.2.7
--- openacs-4/packages/oacs-dav/www/doc/index.adp 15 Apr 2017 10:43:06 -0000 1.1.2.6
+++ openacs-4/packages/oacs-dav/www/doc/index.adp 6 Aug 2017 11:31:23 -0000 1.1.2.7
@@ -15,8 +15,8 @@
tDAV specific configuration parameters to the AOLserver
configuration file. The default parameters work fine, they will
create webdav URLs like yoursite/dav/*
-
You can visit the /webdav-support/ page to control webdav
-access on a per-folder basis. Packages that support WebDAV will add
+
You can visit the /webdav-support/ page to control webdav access
+on a per-folder basis. Packages that support WebDAV will add
folders to this list and an administrator can then activate or
deactivate the folders.
RDF Site Summary (RSS) is a lightweight
multipurpose extensible metadata description and syndication
-format. RSS is an XML application, conforms to the W3C's RDF
+format. RSS is an XML application, conforms to the W3C's RDF
Specification and is extensible via XML-namespace and/or RDF based
modularization.
-
