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.6 -r1.7 --- openacs-4/packages/acs-core-docs/www/xml/developers-guide/packages.xml 20 Aug 2003 16:20:18 -0000 1.6 +++ openacs-4/packages/acs-core-docs/www/xml/developers-guide/packages.xml 11 Dec 2003 21:39:48 -0000 1.7 @@ -5,10 +5,10 @@ %myvars; ]> - OpenACS &version; Packages + OpenACS Packages - By Pete Su and Bryan Quinn + By Pete Su and Bryan Quinn @@ -37,7 +37,6 @@ - ROOT/ bin/ parameters/ @@ -46,19 +45,19 @@ core tcl libraries here www/ admin/ - bboard/ - site wide admin for bboard + forums/ + site wide admin for forums intranet/ site wide admin for intranet ... and so on for all modules ... - bboard/ - pages for bboard + forums/ + pages for forums admin/ - other admin pages for bboard + other admin pages for forums intranet/ - pages for bboard + pages for intranet admin/ other admin pages for intranet doc/ @@ -67,9 +66,8 @@ core and application data models here ... and so on for all modules ... + - - In previous versions of OpenACS, you wrote a new application like this: @@ -98,7 +96,6 @@ - ROOT/ bin/ packages/ @@ -115,8 +112,12 @@ acs-test-harness/ acs-util/ acs-workflow/ - bboard/ - bboard.info + forums/ + forums.info + catalog/ + i18n message catalogs + lib/ + includable page fragments (.tcl/.adp pairs) sql/ oracle/ oracle data model @@ -125,11 +126,11 @@ tcl/ tcl library code www/ + user visible pages admin/ - administration pages - other pages + administration pages doc/ - documentation + documentation message-catalog/ news/ notification/ @@ -138,12 +139,12 @@ bootstrap code www/ misc pages - + Note that a major reorganization has happened here. The diagram only - expands the structure of the bboard/ package directory, + expands the structure of the forums/ package directory, but all the others are basically the same. Each package encapsulates all of its data model, library code, logic, adminstration pages and user pages in a single part of the file tree. This organization has @@ -347,9 +348,9 @@ files. In Oracle this can be done by including @@ filename in the creation or drop scripts. See the - Oracle SQL*Plus documentation for examples. In - PostgreSQL the same is acomplished by including \i. + url="http://www.orafaq.com/faqplus.htm#AT"> + Oracle FAQ for examples. In + PostgreSQL the same is acomplished by including \i filename. sql/<database>/*.sql @@ -436,9 +437,9 @@ Administration UI The administration UI is used to administer the instances of - the package. For example, the bboard administration UI is + the package. For example, the forums administration UI is used to create new forums, moderate postings, and create new - categories for bboard postings. + categories for forums postings. www/admin/* @@ -552,7 +553,7 @@ 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 - package keys in the current system include: bboard, + package keys in the current system include: forums, acs-kernel and so on. For the example application, we will use the package key notes. @@ -586,7 +587,7 @@ Generally we think of packages as either being applications, meaning that the package is meant primarily for use by end-users, or services meaning that the package is meant to be a reusable - library of code, to be used by other packages. bboard is + library of code, to be used by other packages. forums is a good example of an application, while acs-templating is a good example of a service. Our example is an application, so pick that. @@ -687,7 +688,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 - these instructions. If so, then you just do this: + this appendix. If so, then you just do this: @@ -710,7 +711,7 @@ Now you can start developing the package. In addition to writing code, - you should also consider the tasks outlined in the package submission guidelines. + you should also consider the tasks outlined in the package development tutorial. @@ -840,7 +841,7 @@ - Package submission guidelines + package development tutorial ($Id$)