Index: openacs-4/packages/acs-core-docs/www/packages.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/packages.html,v diff -u -N -r1.47 -r1.47.2.1 --- openacs-4/packages/acs-core-docs/www/packages.html 13 Sep 2009 23:54:40 -0000 1.47 +++ openacs-4/packages/acs-core-docs/www/packages.html 18 Jun 2010 21:29:35 -0000 1.47.2.1 @@ -1,5 +1,5 @@ -OpenACS Packages

OpenACS Packages

By Pete Su and Bryan Quinn

+OpenACS Packages

OpenACS Packages

By Pete Su and Bryan Quinn

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

Overview

@@ -13,7 +13,7 @@

Server file layout

Here is how an OpenACS 5 server is laid out starting from the Server root (ROOT): -

Figure 10.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 10.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 10.1. Package files

File TypeIts UseNaming Convention
Package Specification FileThe package specification file is an XML file generated and +

Table 11.1. Package files

File TypeIts UseNaming Convention
Package Specification FileThe package specification file is an XML file generated and maintained by the OpenACS Package Manager (APM). It specifies information about the package including its parameters and its files.notes.info
Data Model Creation Script @@ -333,7 +333,7 @@ this point, you should add your package files to your CVS repository. I'll assume that you have set up your development repository according to the standards described in - this appendix. If so, then you just do this: + this appendix. If so, then you just do this:

% cd ROOT/packages
 % cvs add notes
 % cd notes
@@ -345,7 +345,7 @@
 % cvs commit -m "add new package for notes"
     
  • Now you can start developing the package. In addition to writing code, - you should also consider the tasks outlined in the package development tutorial. + you should also consider the tasks outlined in the package development tutorial.

  • The Site Map and Package Instances

    At this point, you are probably excited to see your new package in action. But, we haven't added any user visible pages yet. By @@ -373,7 +373,7 @@ of many indedendent applications that actually run on a single shared code base. The request-processor document shows you how OpenACS figures out which instance of your application was - requested by the user at any given time. The page development tutorial shows you how to use this + requested by the user at any given time. The page development tutorial shows you how to use this information in your user interface.

    In order to make the new notes application visible to @@ -395,7 +395,7 @@ yet written Notes application at various places in the site. In a later document, we'll see how to write your application so that the code can detect from what URL it was invoked. This is the key - to supporting subsites. + to supporting subsites.

    Summary

    The APM performs the following tasks in an OpenACS site:

    • @@ -411,4 +411,4 @@

    • Writes out package distribution files for other people to download and install. We'll cover this later. -

    View comments on this page at openacs.org
    +

    View comments on this page at openacs.org