Index: openacs-4/packages/acs-core-docs/www/aolserver.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/aolserver.html,v diff -u -r1.8.2.1 -r1.8.2.2 --- openacs-4/packages/acs-core-docs/www/aolserver.html 24 Nov 2002 21:29:17 -0000 1.8.2.1 +++ openacs-4/packages/acs-core-docs/www/aolserver.html 20 Dec 2002 04:42:24 -0000 1.8.2.2 @@ -18,7 +18,14 @@ internationalization patches, nscache, nsrewrite, nssha1 and the oracle driver) is available at arsdigita.com

  • - The OpenACS PostgreSQL driver is available from OpenACS + + The OpenACS PostgreSQL driver (nspostgres.so) is available from + SourceForge. If + you do decide to use nspostgres.so, you have to remember to + change the AOLserver config file to point to nspostgres.so + instead of postgres.so. This guide uses Mat Kovach's distro + (i.e. postgres.so) +

  • nsxml is available at http://acs-misc.sourceforge.net.

  • 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.1 -r1.8.2.2 --- openacs-4/packages/acs-core-docs/www/docbook-primer.html 24 Nov 2002 21:29:17 -0000 1.8.2.1 +++ openacs-4/packages/acs-core-docs/www/docbook-primer.html 20 Dec 2002 04:42:24 -0000 1.8.2.2 @@ -10,12 +10,12 @@ OpenACS a superb documentation, so that users, developers and administrators of OpenACS installations can enjoy the system.

    - OpenACS is a powerful system, with + OpenACS™ is a powerful system, with incredible possibilities and applications, but with this power comes some complexity and a learning curve that will only be atenuated by good documentation. This is what we are after.

    - The documentation for OpenACS is + The documentation for OpenACS™ is written using DocBook XML. The reasons why we are using DocBook are explained in more details in the Why DocBook? section. I will add the reasons why @@ -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: - +

    Document Structure

    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
    @@ -120,23 +120,23 @@
           sect1-level. These are then tied together in a top-level document that 
           contains all the information above the line. This will be explained in more detail in a later document, 
           and we will provide a set of templates for documenting an entire package. 

    For now you can take a look at the - sources of these DocBook documents + 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.

    @@ -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.

    Code

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

    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:

    +	  

    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.

    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 @@ -305,7 +305,7 @@ </variablelist>

    Tables

    - + DocBook supports several types of tables, but in most cases, the <informaltable> is enough: @@ -342,7 +342,7 @@ <table> for an example.

    Emphasis

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

    Index: openacs-4/packages/acs-core-docs/www/index.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/index.adp,v diff -u -r1.7 -r1.7.2.1 --- openacs-4/packages/acs-core-docs/www/index.adp 12 Sep 2002 23:57:17 -0000 1.7 +++ openacs-4/packages/acs-core-docs/www/index.adp 20 Dec 2002 04:42:24 -0000 1.7.2.1 @@ -28,7 +28,7 @@

    For Everyone
    -        - OpenACS 4.5 Release Notes
    +        - OpenACS 4.6 Release Notes
             - Older Release Notes
     
     For OpenACS-admins
    @@ -115,7 +115,7 @@
     Questions or comments about the documentation? 
     
    Please visit the -OpenACS bboards +OpenACS forums or shoot email at vinod@kurup.com or rmello at fslc.usu.edu.

    Index: openacs-4/packages/acs-core-docs/www/oracle.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/oracle.html,v diff -u -r1.8.2.2 -r1.8.2.3 --- openacs-4/packages/acs-core-docs/www/oracle.html 24 Nov 2002 21:29:18 -0000 1.8.2.2 +++ openacs-4/packages/acs-core-docs/www/oracle.html 20 Dec 2002 04:42:24 -0000 1.8.2.3 @@ -41,6 +41,13 @@ Environment built-in to the distribution, so you no longer have to download and install it separately. +

  • + + See these + instructions to download the 8.1.7.4 patchset. Note + that you can't back out of an Oracle patchset once it's + installed. You have to reinstall the whole thing from scratch. +

  • After the download is complete, untar the file @@ -65,7 +72,9 @@

    - For additional resources/documentation, please see this thread. + For additional resources/documentation, please see this thread + and Andrew + Piskorski's mini-guide..

    Pre-Installation Tasks

    @@ -326,11 +335,6 @@

    1. - Install the compat-glibc, compat-egcs, compat-libs RPM for - 2.1.3. - -

    2. - Execute the following command: /usr/i386-glib21-linux/bin/i386-glibc21-linux-env.sh Index: openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.html,v diff -u -r1.1.2.1 -r1.1.2.2 --- openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.html 24 Nov 2002 21:29:18 -0000 1.1.2.1 +++ openacs-4/packages/acs-core-docs/www/permissions-tediously-explained.html 20 Dec 2002 04:42:24 -0000 1.1.2.2 @@ -9,8 +9,8 @@ of code and trying to understand exactly what went wrong. It is geared towards developers who understand the general permissions system to the extent that is described in the - - OpenACS 4.x Permisisons documentation, + + OpenACS 4.x Permissions documentation, but who haven't had the opportunity to take a long, careful look at the system internals.

      @@ -86,7 +86,7 @@ to store permission information explicitly about every object, i.e. if the system has 100,000 and 1,000 users who have the read privilege on all objects, then we would need to store 100,000,000 entries of the form: -

      Table�5.1.�

      object_idgrantee_idprivilege
      object_id_1user_id_1'read'
      object_id_1user_id_2'read'
      ...
      object_id_1user_id_n'read'
      object_id_2user_id_1'read'
      object_id_2user_id_2'read'
      ...
      object_id_2user_id_n'read'
      ...
      ...
      object_id_muser_id_1'read'
      object_id_muser_id_2'read'
      ...
      object_id_muser_id_n'read'

      +

      Table�5.1.�

      object_idgrantee_idprivilege
      object_id_1user_id_1'read'
      object_id_1user_id_2'read'
      ...
      object_id_1user_id_n'read'
      object_id_2user_id_1'read'
      object_id_2user_id_2'read'
      ...
      object_id_2user_id_n'read'
      ...
      ...
      object_id_muser_id_1'read'
      object_id_muser_id_2'read'
      ...
      object_id_muser_id_n'read'

      Although quite feasible, this approach fails to take advantage of the fact that objects in the system are commonly organized hierarchally, and permissions usually follow the hierarchical structure, so that if user @@ -101,7 +101,7 @@

    Context Hierarchy

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

    Table�5.2.�

    A

    +

    Table�5.2.�

    A

    object_id=10

    B

    object_id=20 @@ -117,23 +117,23 @@ This can be represented in the acs_objects table by the following entries: -

    Table�5.3.�

    object_idcontext_id
    2010
    3010
    4020
    5020
    6030

    +

    Table�5.3.�

    object_idcontext_id
    2010
    3010
    4020
    5020
    6030

    The first entry tells us that object 20 is the descendant of object 10, and the third entry shows that object 40 is the descendant of object 20. By running a CONNECT BY query, we can compute that object 40 is the second-generation descendant of object 10. With this in mind, if we want to record the fact that user Joe has the read privilege on objects A, ..., F, we only need to record one entry in the acs_permissions table. -

    Table�5.4.�

    objectgranteeprivilege
    AJoeread

    +

    Table�5.4.�

    objectgranteeprivilege
    AJoeread

    The fact that Joe can also read B, C, ..., and F can be derived by ascertaining that these objects are children of A by traversing the context hierarchy. As it turns out, hierarchical queries are expensive. As Rafael Schloming put it so aptly, Oracle can't deal with hierarchies for shit.

    One way to solve this problem is to cache a flattened view of the context tree like so: -

    Table�5.5.�

    objectancestorn_generations
    AA0
    BB0
    BA1
    CC0
    CA1
    DD0
    DB1
    DA2
    EE0
    EB1
    EA2
    FF0
    FC1
    FA2

    +

    Table�5.5.�

    objectancestorn_generations
    AA0
    BB0
    BA1
    CC0
    CA1
    DD0
    DB1
    DA2
    EE0
    EB1
    EA2
    FF0
    FC1
    FA2

    Note that the number of entries in the flattened view grows exponentially with respect to the depth of the context tree. For instance, if you have a fully populated binary tree with a depth of n, then the number of entries @@ -204,7 +204,7 @@ an object's security_inherit_p column to 'f', you can stop permissions from cascading down the context tree. In the following example, Joe does not have the read permissions on C and F. -

    Table�5.6.�


    +

    Table�5.6.�


    A
    object_id=10
    readable�by�Joe
    @@ -232,7 +232,7 @@ Privileges are also organized hierarchically. In addition to the five main system privileges defined in the ACS Kernel data model, application developers may define their own. For instance, the Bboard package defines the following privileges: -

    Table�5.7.�

    privilege
    create_category
    create_forum
    create_message
    delete_category
    delete_forum
    delete_message
    moderate_forum
    read_category
    read_forum
    read_message
    write_category
    write_forum
    write_message

    +

    Table�5.7.�

    privilege
    create_category
    create_forum
    create_message
    delete_category
    delete_forum
    delete_message
    moderate_forum
    read_category
    read_forum
    read_message
    write_category
    write_forum
    write_message

    By defining parent-child relationship between privileges, the OpenACS data model makes it easier for developers to manage permissions. Instead of granting a user explicit read, write, delete, @@ -241,7 +241,7 @@ privilege to which the first four privileges are tied. To give a more detailed example, the Bboard privileges are structured as follows. -

    Table�5.8.�

    admin
    createdeletereadwritemoderate forum
    create categorycreate forumcreate messagedelete categorydelete forumdelete messageread categoryread forumread messagewrite categorywrite forumwrite message

    +

    Table�5.8.�

    admin
    createdeletereadwritemoderate forum
    create categorycreate forumcreate messagedelete categorydelete forumdelete messageread categoryread forumread messagewrite categorywrite forumwrite message

    The parent-child relationship between privileges is represented in the acs_privilege_hierarchy table:

    @@ -287,7 +287,7 @@
         

    Party Hierarchy

    Now for the third hierarchy playing a promiment role in the permission system. The party data model is set up as follows. -

    +    

       create table parties (
           party_id
               not null
    @@ -371,7 +371,7 @@
         

    The acs_rels table entries would look like so: -

    Table�5.10.�

    rel_typeobject_oneobject_two
    +

    Table�5.10.�

    rel_typeobject_oneobject_two
    membership_rel Pranksters @@ -406,7 +406,7 @@

    The relevant entries in the acs_rels look like so. -

    Table�5.11.�

    rel_typeobject_oneobject_two
    +

    Table�5.11.�

    rel_typeobject_oneobject_two
    composition_rel Pranksters @@ -617,7 +617,7 @@

    Note that in the above example, acs_permissions had only one entry that needed to be deleted: -

    Table�5.12.�

    object_idgrantee_idprivilege
    +

    Table�5.12.�

    object_idgrantee_idprivilege
    default_context registered_users Index: openacs-4/packages/acs-core-docs/www/release-notes.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/release-notes.html,v diff -u -r1.9.2.1 -r1.9.2.2 --- openacs-4/packages/acs-core-docs/www/release-notes.html 24 Nov 2002 21:29:18 -0000 1.9.2.1 +++ openacs-4/packages/acs-core-docs/www/release-notes.html 20 Dec 2002 04:42:24 -0000 1.9.2.2 @@ -9,17 +9,17 @@ in the process of developing testing tools, methodology, and scripts.

    Please report bugs using our - - Software Development Manager at the OpenACS website. The latest - information on installing this release under Oracle 8.1.6/7 - or PostgreSQL 7.1.* can be found there as well. Currently the + + Bug Tracker at the OpenACS website. The latest + information on installing this release under Oracle 8.1.7 + or PostgreSQL 7.2.* can be found there as well. Currently the toolkit will not install under Oracle 9i due to Oracle having made "delete" an illegal name for PL/SQL procedures and functions.

    You may want to begin by reading our installation documentation for - Installing on Unix/Linux or Installing on Windows. Note - that the Windows documentation is not current for OpenACS 4.6, - but an alternative is to use John Sequeira's Oasis VM + Installing on Unix/Linux. Note that the Windows documentation is + not current for OpenACS 4.6, but an alternative is to use John + Sequeira's Oasis VM project.

    After installation, the full documentation set can be found by visiting @@ -44,163 +44,11 @@ are steps you must take manually in order to get this feature working.

    Testing Notes

    - Here are some notes from our testing group. While not quite up to - date it should give you some ideas of where things stand. -

    - Summarised Testing Status
     
    -Skin
    -Minimal
    -Release w/caution
    -Comments:
    +	  OpenMSG has organized the
    +	  OpenACS 4.6 testing process with test servers provided by
    +	  Hub.org. Visit the acceptance test server to
    +	  see the current status of various packages. This may not be a
    +	  permanent link. If it's not working, do a search of the OpenACS forums.
     
    -Package: Page
    -Test Coverage: Minimal
    -Release w/caution
    -Comments:
    -
    -Package: Bboard
    -Test Coverage: Reasonable
    -Suggested Status: Alpha
    -Comments:
    -
    -Package: Static Pages
    -Test Coverage: Minimal
    -Suggested Status: Release w/caution
    -Comments:
    -
    -Package: Ticket Tracker
    -Test Coverage: Reasonable
    -Suggested Status: Alpha
    -Comments: Don tested personally
    -
    -Package: Ticket Tracker Lite
    -Test Coverage: Unknown
    -Suggested Status: 
    -Comments:
    -
    -Package: Acs-lang
    -Test Coverage: Reasonable
    -Suggested Status: Alpha
    -Comments: Oracle only
    -
    -Package: Simple-survey
    -Test Coverage: Reasonable
    -Suggested Status: Alpha
    -Comments:
    -
    -Package: Portal
    -Test Coverage: Extensive
    -Suggested Status: Alpha
    -Comments:
    -
    -Package: Notes
    -Test Coverage: Extensive
    -Suggested Status: Alpha
    -Comments:
    -
    -Package: Bookmarks
    -Test Coverage: Extensive
    -Suggested Status: Alpha
    -Comments:
    -
    -Package: Clickthrough
    -Test Coverage: Extensive
    -Suggested Status: Alpha
    -Comments:
    -
    -Package: Acs-mail
    -Test Coverage: Reasonable
    -Suggested Status: Release w/caution
    -Comments:
    -
    -Package: Acs-messaging
    -Test Coverage: Reasonable
    -Suggested Status: Release w/caution
    -Comments:
    -
    -Package: File manager
    -Test Coverage: Minimal
    -Suggested Status: Release w/caution
    -Comments:
    -
    -Package: File Storage
    -Test Coverage: Minimal
    -Suggested Status: Release w/caution
    -Comments:
    -
    -Package: Site-wide-search
    -Test Coverage: Minimal
    -Suggested Status: Release w/caution
    -Comments:
    -
    -Package: General Comments
    -Test Coverage: Extensive
    -Suggested Status: Alpha
    -Comments:
    -
    -Package: Acs-events
    -Test Coverage: None
    -Suggested Status: 
    -Comments: Automated Testing
    -
    -Package: Acs-datetime
    -Test Coverage: None
    -Suggested Status: 
    -Comments: Automated Testing
    -
    -Package: Acs-tcl
    -Test Coverage: Reasonable
    -Suggested Status: Release w/caution
    -Comments: Automated Testing
    -
    -Package: Acs-templating
    -Test Coverage: Reasonable
    -Suggested Status: Release w/caution
    -Comments: Automated Testing
    -
    -Package: Acs-util
    -Test Coverage: Reasonable
    -Suggested Status: Release w/caution
    -Comments: Automated Testing
    -
    -Package: Acs-Content-repository
    -Test Coverage: Minimal
    -Suggested Status: Release w/caution
    -Comments: Automated Testing
    -
    -Package: Acs-content
    -Test Coverage: Minimal
    -Suggested Status: Release w/caution
    -Comments: Automated Testing
    -
    -Package: Acs-kernel
    -Test Coverage: Reasonable
    -Suggested Status: Alpha
    -Comments: Automated Testing
    -
    -Package: Acs-subsite
    -Test Coverage: Reasonable
    -Suggested Status: Alpha
    -Comments: 
    -
    -Package: Acs-bootstrap-installer
    -Test Coverage: Extensive
    -Suggested Status: Alpha
    -Comments: Developers have used this extensively
    -
    -Package: Acs-api-browser
    -Test Coverage: Minimal
    -Suggested Status: Release w/caution
    -Comments: Automated Testing
    -
    -Package: Acs-workflow
    -Test Coverage: Minimal
    -Suggested Status: Release w/caution
    -Comments: 
    -
    -Package: calendar
    -Test Coverage: Minimal
    -Suggested Status: Alpha
    -Comments: Don tested personally
    -	
    ($Id$)
    View comments on this page at openacs.org
    +

    ($Id$)
    View comments on this page at openacs.org