Index: openacs-4/packages/acs-core-docs/www/packages.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/packages.adp,v diff -u -r1.7 -r1.7.2.1 --- openacs-4/packages/acs-core-docs/www/packages.adp 25 Apr 2018 08:38:28 -0000 1.7 +++ openacs-4/packages/acs-core-docs/www/packages.adp 2 Mar 2019 19:30:05 -0000 1.7.2.1 @@ -1,5 +1,5 @@ -{/doc/acs-core-docs {ACS Core Documentation}} {OpenACS Packages} +{/doc/acs-core-docs/ {ACS Core Documentation}} {OpenACS Packages} OpenACS Packages

-OpenACS Packages

<authorblurb>

By Pete Su and Bryan Quinn

</authorblurb>
+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

This document is a guide on how to write a software package for OpenACS. OpenACS packages are installed and maintained with the @@ -22,7 +25,7 @@

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 +

Figure 11.1. Server file layout diagram

 ROOT/
     bin/
@@ -61,7 +64,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 +

Figure 11.2. Package file layout diagram

 ROOT/
   +-- packages/    APM Root
@@ -124,14 +127,14 @@
 this case is ROOT/packages/notes. The following table
 describes in detail what each of the files up in the diagram
 contain.

A special note on the -PACKAGE-KEY/www/resources -directory. Files in this directory are available at http://yourserver/resources/PACKAGE-KEY/... and are -returned without any permissions checking or even checks that the -package is installed or mounted. Files are returned directly, so -.tcl or .adp files are not sourced in these 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 +PACKAGE-KEY/www/resources +directory. Files in this directory are available at http://yourserver/resources/PACKAGE-KEY/... and are returned +without any permissions checking or even checks that the package is +installed or mounted. Files are returned directly, so .tcl or .adp +files are not sourced in these 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

@@ -370,7 +373,7 @@ to add a new sub-folder called notes to the root of the site, then click "new application" to mount a new instance of the notes application to the site. -Name the new instance notes-1.

Then type this URL into your browser: http://yourserver/notes/hello.html +Name the new instance notes-1.

Then type this URL into your browser: http://yourserver/notes/hello.html

Now you should see the contents of the page that you added. What has happened is that all URLs that start with /notes have been mapped in such a way as to serve content from the directory ROOT/packages/notes/www. At this point, you @@ -394,8 +397,8 @@ Additional Reading

($‌Id: packages.xml,v 1.13 2018/04/22 -19:24:37 gustafn Exp $)

+
($‌Id: packages.xml,v 1.13 2018/04/22 19:24:37 +gustafn Exp $)