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 -r1.57.2.4 -r1.57.2.5 --- openacs-4/packages/acs-core-docs/www/packages.html 5 Jan 2021 17:33:40 -0000 1.57.2.4 +++ openacs-4/packages/acs-core-docs/www/packages.html 3 Sep 2021 09:15:21 -0000 1.57.2.5 @@ -7,13 +7,13 @@ OpenACS. OpenACS packages are installed and maintained with the OpenACS Package Manager (APM) which is part of the acs-admin package. This document presents reasons for packaging software, - conventions for the file system and naming that must be + conventions for the filesystem and naming that must be followed, and step by step instructions for creating a new package for the "Notes" example package.

Server file layout

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 maintenance.
@@ -36,7 +36,7 @@
       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
+      package without hunting all over the filesystem.  Encapsulating
       everything about a package in one place also makes it much
       easier to distribute packages independently from the OpenACS Core.
     

@@ -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 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 @@ -239,7 +239,7 @@ administrator can create as many instances of the package as she likes, and map these instances to any URL in the site that she wants. If packages are analogous to executable programs in an - operating system, then package instances are analgous to multiple + operating system, then package instances are analogous to multiple running copies of a single program. Each instance can be independently administered and each instance maintains its own set of application parameters and options. @@ -266,8 +266,7 @@

This is a short text string that should uniquely name your package to distinguish it from all the others. It is used as a database key to - keep track of the package and as the name of the directory in the file - system where all the files related to your package will live. Example + keep track of the package and as the name of the directory in the filesystem where all the files related to your package will live. Example package keys in the current system include: forums, acs-kernel and so on. For the example application, we will use the package key notes. @@ -331,7 +330,7 @@ file information", then the "Scan the packages/notes directory for additional files in this package" link on that page to scan - the file system for new files. This will bring you to a page + the filesystem for new files. This will bring you to a page that lists all the files you just added and lets you add them to the notes package.

@@ -375,7 +374,7 @@ will serve its pages.

In OpenACS 5, administrators can define an arbitrary mapping between the - URLs the user types and the actual file in the file system that is + URLs the user types and the actual file in the filesystem that is served. This mapping is called the site map and entries in the site map are called site nodes. Each site node maps a URL to an OpenACS object. Since package instances are objects, the site map allows