Index: openacs-4/packages/acs-core-docs/www/acs-admin.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/acs-admin.html,v diff -u -r1.8.2.6 -r1.8.2.7 --- openacs-4/packages/acs-core-docs/www/acs-admin.html 29 Apr 2003 05:58:33 -0000 1.8.2.6 +++ openacs-4/packages/acs-core-docs/www/acs-admin.html 4 May 2003 06:30:02 -0000 1.8.2.7 @@ -1,2 +1,2 @@ -
Table of Contents
Table of Contents
For a simple illustration of the difference between ACS without APM (pre-3.3) and ACS with APM (3.3 and beyond), consider a hypothetical ACS installation that uses only two of the thirty-odd modules available circa ACS -3.2 (say, bboard and e-commerce):
APM itself is part of a package, the OpenACS Kernel, an OpenACS +3.2 (say, bboard and e-commerce):
APM itself is part of a package, the OpenACS Kernel, an OpenACS service that is the only mandatory component of an OpenACS installation.
The OpenACS is a platform for web-based application software, and any software platform has the potential to develop problems like those described above. Fortunately, there are many precedents for systematic solutions, 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.1.2.6 -r1.1.2.7 --- openacs-4/packages/acs-core-docs/www/backup-recovery.html 29 Apr 2003 05:58:33 -0000 1.1.2.6 +++ openacs-4/packages/acs-core-docs/www/backup-recovery.html 4 May 2003 06:30:02 -0000 1.1.2.7 @@ -47,7 +47,7 @@ unneccesary and has complicated permissions. Make sure that you are using the cron job to back up the database to a file in /web/service0/database-backup so that the tar command will include the database.
[root@yourserver root]# su - service0 [service0@yourserver service0]$ tar -cpsj --exclude /web/service0/etc/daemontools/supervise --file /tmp/service0-backup.tar.bz2 /web/service0/ tar: Removing leading `/' from member names -[service0@yourserver service0]$
On a test service, make sure that your backup-recovery process work. After backing up the database and file system, delete the service as detailed below and then recover it.
[root@yourserver root]# svc -d /service/service0 +[service0@yourserver service0]$
On a test service, make sure that your backup-recovery process work. After backing up the database and file system, delete the service as detailed below and then recover it.
[root@yourserver root]# svc -d /service/service0 [root@yourserver root]# mv /web/service0/ /web/service0.lost [root@yourserver root]# rm /service/service0 rm: remove symbolic link `/service/service0'? y 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.8.2.8 -r1.8.2.9 --- openacs-4/packages/acs-core-docs/www/docbook-primer.html 29 Apr 2003 05:58:33 -0000 1.8.2.8 +++ openacs-4/packages/acs-core-docs/www/docbook-primer.html 4 May 2003 06:30:02 -0000 1.8.2.9 @@ -32,7 +32,7 @@ In order to separate content and presentation, all OpenACS documentation will be marked up to conform to the DocBook XML DTD - + This enables us to publish in a variety of formats and relieves each contributor of the burden of presentation, freeing him to focus on content and sharing knowledge. @@ -53,7 +53,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 @@ -99,7 +99,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 @@ -123,20 +123,20 @@ sources of these DocBook documents to get an idea of how they are tied together.- + Given that your job starts at the sect1-level, all your documents should open with a <sect1>-tag and end with the corresponding </sect1>.
- + You need to feed every <sect1> two attributes. The first attribute, id, is standard and can be used with all elements. It comes in very handy when interlinking between documents (more about this when talking about links in the section called “Links”). The value 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.
@@ -151,7 +151,7 @@ </sect1>
- + Inside this container your document will be split up into <sect2>'s, each with the same requirements - id and xreflabel @@ -160,7 +160,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.
- + For displaying a snippet of code, a filename or anything else you just want to appear as a part of a sentence, we will use the tag <computeroutput>. @@ -170,12 +170,12 @@ <programlisting> is used. Just wrap your code block in it; mono-spacing, indents and all that stuff is taken care of automatically.
- + 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:
+Check out how I link to a subsection of the Developer's Guide:
Put this in your XML: @@ -213,7 +213,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 @@ -234,7 +234,7 @@ do it, so if you want to start converting your documents right away, start out with the ones without graphics ;)
- + To insert a graphic we use the elements <mediaobject>, <imageobject>, @@ -260,7 +260,7 @@ Put your graphics in a separate directory ("images") and link to them only with relative paths.
- + Here's how you make the DocBook equivalent of the three usual HTML-lists:
- 1. How to make an <ul>
Making an unordered list is pretty much like doing the same thing in HTML - if you close your <li>, that is. The only differences are that each list item has to be wrapped in something more, such as @@ -305,7 +305,7 @@ </variablelist>
- + DocBook supports several types of tables, but in most cases, the <informaltable> is enough: @@ -342,7 +342,7 @@ <table> for an example.
- + Our documentation uses two flavors of emphasis - italics and bold type. DocBook uses one - <emphasis>.
Index: openacs-4/packages/acs-core-docs/www/index.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/index.html,v diff -u -r1.6.2.8 -r1.6.2.9 --- openacs-4/packages/acs-core-docs/www/index.html 29 Apr 2003 05:58:33 -0000 1.6.2.8 +++ openacs-4/packages/acs-core-docs/www/index.html 4 May 2003 06:30:02 -0000 1.6.2.9 @@ -1,2 +1,2 @@ -
OpenACS Documentation Table of Contents
- I. OpenACS For Everyone
- II. Administrator's Guide
- III. For OpenACS Package Developers
- 8. Development Tutorial
- 9. Development Reference
- OpenACS 4.6.3 Packages
- OpenACS 4.6.3 Data Models and the Object System
- The Request Processor
- The OpenACS Database Access API
- Using Templates in OpenACS 4.6.3
- Groups, Context, Permissions
- Writing OpenACS 4.6.3 Application Pages
- Parties in OpenACS 4.6.3
- OpenACS 4.x Permissions Tediously Explained
- Object Identity
- Programming with AOLserver
- 10. Engineering Standards
- IV. For OpenACS Platform Developers
- 11. Kernel Documentation
- Overview
- OpenACS 4 Object Model Requirements
- OpenACS 4 Object Model Design
- OpenACS 4 Permissions Requirements
- OpenACS 4 Permissions Design
- OpenACS 4 Groups Requirements
- OpenACS 4 Groups Design
- OpenACS 4 Subsites Requirements
- OpenACS 4 Subsites Design Document
- OpenACS 4.6.3 Package Manager Requirements
- OpenACS 4.6.3 Package Manager Design
- Database Access API
- OpenACS 4 Security Requirements
- OpenACS 4 Security Design
- OpenACS 4 Security Notes
- OpenACS 4 Request Processor Requirements
- OpenACS 4 Request Processor Design
- Documenting Tcl Files: Page Contracts and Libraries
- Bootstrapping OpenACS
List of Figures
View comments on this page at openacs.org +OpenACS Documentation Table of Contents
- I. OpenACS For Everyone
- II. Administrator's Guide
- III. For OpenACS Package Developers
- 8. Development Tutorial
- 9. Development Reference
- OpenACS 4.6.3 Packages
- OpenACS 4.6.3 Data Models and the Object System
- The Request Processor
- The OpenACS Database Access API
- Using Templates in OpenACS 4.6.3
- Groups, Context, Permissions
- Writing OpenACS 4.6.3 Application Pages
- Parties in OpenACS 4.6.3
- OpenACS 4.x Permissions Tediously Explained
- Object Identity
- Programming with AOLserver
- 10. Engineering Standards
- IV. For OpenACS Platform Developers
- 11. Kernel Documentation
- Overview
- OpenACS 4 Object Model Requirements
- OpenACS 4 Object Model Design
- OpenACS 4 Permissions Requirements
- OpenACS 4 Permissions Design
- OpenACS 4 Groups Requirements
- OpenACS 4 Groups Design
- OpenACS 4 Subsites Requirements
- OpenACS 4 Subsites Design Document
- OpenACS 4.6.3 Package Manager Requirements
- OpenACS 4.6.3 Package Manager Design
- Database Access API
- OpenACS 4 Security Requirements
- OpenACS 4 Security Design
- OpenACS 4 Security Notes
- OpenACS 4 Request Processor Requirements
- OpenACS 4 Request Processor Design
- Documenting Tcl Files: Page Contracts and Libraries
- Bootstrapping OpenACS
List of Figures
View comments on this page at openacs.org Index: openacs-4/packages/acs-core-docs/www/individual-programs.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/individual-programs.html,v diff -u -r1.1.2.6 -r1.1.2.7 --- openacs-4/packages/acs-core-docs/www/individual-programs.html 29 Apr 2003 05:58:33 -0000 1.1.2.6 +++ openacs-4/packages/acs-core-docs/www/individual-programs.html 4 May 2003 06:30:02 -0000 1.1.2.7 @@ -72,7 +72,8 @@ work for binary files is available at sourceforge.netThe patch that makes AOLserver respect the - -g flag is available at sourceforge.net + -g flag is available at + sourceforge.net
AolServer startup wrapper Version 1, REQUIRED.�This file automates the startup of AOLserver. You need it to run AOLserver.
nsopenssl 2.1, OPTIONAL.�Provides SSL capabilities for AOLserver. It requires @@ -81,9 +82,7 @@ driver for AOLserver. You need this if you want users to be able to search for any text on your site.
Analog 5.31, OPTIONAL.�This program examines web server request logs, looks up DNS values, and produces a report. You need this if you - want to see how much traffic your site is getting.
Analog configuration file, OPTIONAL.�This file is an Analog configuration file set up for a standard - OpenACS installation. You need this file if you are using - Analog.
Database.�The data on your site (for example, user names and passwords, + want to see how much traffic your site is getting.
Database.�The data on your site (for example, user names and passwords, calender entries, and notes) is stored in the database. OpenACS seperates the database with an abstraction layer, which means that several different databases all function @@ -104,18 +103,13 @@ restarts that software if it fails. On Linux, we recommend using Daemontools to control AOLserver and qmail.
Daemontools 0.76, OPTIONAL.�You need this if you want AOLserver and qmail to run "supervised," meaning that they are monitored and - automatically restarted if they fail.
AolServer - restart permissions script version 1, OPTIONAL.�If you are running daemontools, you need this file to - set the permissions of the control files for new OpenACS instances.
Mail Transport Agent.�A Mail Transport Agent is a program that handles all + automatically restarted if they fail.
Mail Transport Agent.�A Mail Transport Agent is a program that handles all incoming and outgoing mail. The Reference Platform uses Qmail; any MTA that provides a sendmail wrapper (that is, that can be invoked by calling the sendmail program with the - same variables that sendmail expects) can be used.
Qmail 1.03, OPTIONAL.�You need this if you want your webserver to send or - receive email.
qmail startup script version 1, OPTIONAL.�This file is used to start qmail. You need this if - you are running qmail.
Qmail relay filter version 1, OPTIONAL.�This file is used to tell ucspi that SMTP connections from - programs on the same computer (such as AOLserver) are - allowed to relay mail to other computers. You need this - file if you are running qmail.
ucspi-tcp 0.88, OPTIONAL.�This program listens for incoming TCP connections and + same variables that sendmail expects) can be used.
Qmail 1.03, OPTIONAL.�You need this (or a different Mail Transport + Agent) if you want your webserver to send and + receive email.
ucspi-tcp 0.88, OPTIONAL.�This program listens for incoming TCP connections and hands them to a program. We use it instead of inetd, which is insecure. You need this if you are running qmail.
DocBook, OPTIONAL.�(docbook-xml v4.2, docbook-xsl v1.56, libxslt 1.0.21, xsltproc 1.0.21). You need this to write or edit documentation. @@ -124,7 +118,7 @@ compare versions of file, and identify specific versions of files. You can use any source control system; the Reference Platform and the OpenACS.org repository (where you can - get patched and development code in between releases) use cvs.
cvs 1.11.2, OPTIONAL.�cvs is included in most unix distributions. You + get patched and development code in between releases) use cvs.
cvs 1.11.2, OPTIONAL.�cvs is included in most unix distributions. You need this if you want to track old versions of your files, do controlled deployment of code from development - to production, or get or contribute development code from openacs.org.