Index: openacs-4/packages/acs-core-docs/www/xml/developers-guide/packages.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/developers-guide/packages.xml,v diff -u -r1.9 -r1.10 --- openacs-4/packages/acs-core-docs/www/xml/developers-guide/packages.xml 17 Jul 2006 05:38:37 -0000 1.9 +++ openacs-4/packages/acs-core-docs/www/xml/developers-guide/packages.xml 7 Aug 2017 23:47:54 -0000 1.10 @@ -62,7 +62,7 @@ Each package encapsulates all of its data model, library code, - logic, adminstration pages and user pages in a single part of + logic, administration pages and user pages in a single part of the file tree. This means developers can track down everything that is related to a particular package without hunting all over the file system. Encapsulating @@ -75,14 +75,14 @@ packages that have been installed in the server, where those packages have been installed, and a standard way to map URLs that a client sends to our server to the right page in the appropriate - package. While we're at it, this tool should also automate + package. While we're at it, this tool should also automate package installation, dependency checking, upgrades, and package removal. In OpenACS &majorversion;, this tool is called the APM. OpenACS Package - To illustrate the general structure of a package, let's see what the + To illustrate the general structure of a package, let's see what the package for the "notes" application should look like. @@ -221,9 +221,9 @@ files. In Oracle this can be done by including @@ filename in the creation or drop scripts. See the + url="http://www.orafaq.com/wiki/Scripts"> Oracle FAQ for examples. In - PostgreSQL the same is acomplished by including \i filename. + PostgreSQL the same is accomplished by including \i filename. sql/<database>/*.sql @@ -415,7 +415,7 @@ The following sections will show you how to make a package for the Notes application. In addition, they will discuss some site - management features in OpenACS &majorversion; that take advantage of the APM's package + management features in OpenACS &majorversion; that take advantage of the APM's package instance model. The two most important of these are subsites, and the site map tool, which can be used to map applications to one or more arbitrary URLs in a running site. @@ -452,7 +452,7 @@ Fill out the form for adding a new package. The form explains what - everything means, but we'll repeat the important bits here for easy + everything means, but we'll repeat the important bits here for easy reference: @@ -486,8 +486,8 @@ If your package name is a nice singular noun, this should be the plural form of it. I assume the plural form is used when multiple - instances of the package are used by a single service. We'll talk more - about package instances later. Our example apllication doesn't really + instances of the package are used by a single service. We'll talk more + about package instances later. Our example apllication doesn't really have a good plural name. So just make it also be "Notes". @@ -558,7 +558,7 @@ The directory that APM created will be empty except for the notes.info file. Create a file called - ROOT/packages/notes/sql/oracle/notes-create.sql. We'll + ROOT/packages/notes/sql/oracle/notes-create.sql. We'll fill this file with our data model very soon. Create a file called ROOT/packages/notes/sql/oracle/notes-drop.sql. This @@ -599,7 +599,7 @@ The new package has been created and installed in the server. At this point, you should add your package files to your CVS repository. - I'll assume that you have set up your development repository according + 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: @@ -637,11 +637,11 @@ 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 + action. But, we haven't added any user visible pages yet. By convention, user visible pages go in the ROOT/packages/notes/www directory. So go there and add a file called hello.html with some text in it. Now we have - to make the user pages visible in the site. Since we didn't put the + to make the user pages visible in the site. Since we didn't put the pages underneath ROOT/www they will not appear on their own. What we have to do is mount the application into the site map. That is, we have to define the URL from which the application @@ -690,7 +690,7 @@ ROOT/packages/notes/www. At this point, you can experiment with the site map by mounting multiple instances of the not 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 + 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. @@ -721,7 +721,7 @@ Writes out package distribution files for other people to download and - install. We'll cover this later. + install. We'll cover this later.