Index: openacs-4/packages/acs-core-docs/www/xml/Makefile =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/Makefile,v diff -u -r1.3 -r1.4 --- openacs-4/packages/acs-core-docs/www/xml/Makefile 22 Sep 2002 05:16:25 -0000 1.3 +++ openacs-4/packages/acs-core-docs/www/xml/Makefile 28 Feb 2003 05:25:48 -0000 1.4 @@ -29,4 +29,4 @@ cd .. ; $(XSLTPROC) xml/openacs.xsl xml/index.xml pdf: html - $(HTMLDOC) --batch ../for-everyone.book ../for-admins.book ../for-developers.book +# $(HTMLDOC) --batch ../for-everyone.book ../for-admins.book ../for-developers.book Index: openacs-4/packages/acs-core-docs/www/xml/index.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/index.xml,v diff -u -r1.10 -r1.11 --- openacs-4/packages/acs-core-docs/www/xml/index.xml 30 Nov 2002 17:16:43 -0000 1.10 +++ openacs-4/packages/acs-core-docs/www/xml/index.xml 28 Feb 2003 05:25:49 -0000 1.11 @@ -21,6 +21,8 @@ + + @@ -68,8 +70,11 @@ + + + @@ -78,50 +83,59 @@ OpenACS Documentation - + OpenACS For Everyone - - High level information: What is OpenACS? - - + High level information: What is OpenACS? Overview - OpenACS (Open Architecture Community System) is an advanced - toolkit for building scalable, community-oriented web applications. - If you're thinking of building an enterprise-level web application, - OpenACS is a solid, proven foundation that will give you a 3-6 month headstart. + OpenACS (Open Architecture Community System) is an + advanced toolkit for building scalable, community-oriented + web applications. If you're thinking of building an + enterprise-level web application, OpenACS is a solid, + proven foundation that will give you a 3-6 month + headstart. - OpenACS is also a collection of pre-built applications and services that - you can use to build your web site/application. Through a modular architecture, - OpenACS has packages for user/groups management, content management, e-commerce, - news, FAQ, calendar, forums, bug tracking, full-text searching, and - much more. + OpenACS is also a collection of pre-built applications and + services that you can use to build your web + site/application. Through a modular architecture, OpenACS + has packages for user/groups management, content + management, e-commerce, news, FAQ, calendar, forums, bug + tracking, full-text searching, and much + more. - OpenACS relies on AOLserver, - the free, multithreaded, scalable, Tcl-enabled, web/application server used by - America On-Line for most of its web sites, and a true acid-compliant - Relational Database Management System (RDBMS). Currently OpenACS supports - PostgreSQL, an open source RDBMS, and Oracle. (read more) + OpenACS relies on AOLserver, the + free, multithreaded, scalable, Tcl-enabled, + web/application server used by America On-Line for most of + its web sites, and a true acid-compliant Relational + Database Management System (RDBMS). Currently OpenACS + supports PostgreSQL, an open source RDBMS, and + Oracle. (read + more) - The OpenACS toolkit is based on the ArsDigita Community System. ArsDigita - (now part of Red Hat, Inc.) kindly made their work available under the - GPL, - making all of this possible. + The OpenACS toolkit is based on the ArsDigita Community + System. ArsDigita (now part of Red Hat, Inc.) kindly made + their work available under the GPL, + making all of this possible. - The OpenACS community would like to hear your comments and help you - in your endeavors with the system. Stop by our web site - and feel free to ask a question, post ideas or whatever. + The OpenACS community would like to hear your comments and + help you in your endeavors with the system. Stop by our + web site and feel + free to ask a question, post ideas or whatever. @@ -131,13 +145,12 @@ - - For OpenACS Admins + + Administrator's Guide - Help to the folks keeping an OpenACS installation up and running. + Guide to installation, upgrade, and maintenance. - Installing on Unix/Linux @@ -155,22 +168,32 @@ Installing on Windows - - Overview - This walks you through an OpenACS installation under Windows. - - &win2k; + + Installing on a Macintosh + + &mac; + + + + + Upgrading + How to upgrade an installation of OpenACS to a new version. + + &upgrade; + + + - + For OpenACS Developers - This is the place to look if you want to extend OpenACS and build on top - of what's already here. Here you can find out about the guts of the system. + How to extend and customize OpenACS. How to create your + own package. How to contribute your work back to the community. @@ -181,13 +204,15 @@ A tour of what you need to know in order to extend OpenACS. + &tutorial; &packages; &objects; &rp; &api; &templates; &permissions; &subsites; + &submissions; &i18n-devel; @@ -267,14 +292,15 @@ &objects-design; &permissions-req; &permissions-design; + &i18n-req; &groups-req; &groups-design; &subsites-req; &subsites-design; &apm-req; &apm-design; - &i18n-req; + &security-req; &security-design; &security-notes; @@ -288,4 +314,6 @@ + + Index: openacs-4/packages/acs-core-docs/www/xml/openacs.css =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/openacs.css,v diff -u -r1.1 -r1.2 --- openacs-4/packages/acs-core-docs/www/xml/openacs.css 10 Aug 2002 21:38:38 -0000 1.1 +++ openacs-4/packages/acs-core-docs/www/xml/openacs.css 28 Feb 2003 05:25:49 -0000 1.2 @@ -1,13 +1,28 @@ +/* These are aimed at DocBook output, specifically from the chunk.xsl style and derivatives /* + body, ol, td, th, hr, h1, h2, h3, strong, dl, a, blockquote, em, .force, dt, dd, ul, li, p{font-family:verdana,helvetica,arial,sans-serif} a:link{color:0000ff} a:visited{color:000099} -a.topnav{font-size:11pt} -a.bottomnav{font-size:11pt} +a.topnav{font-size:1.2em} +a.bottomnav{font-size:1.2em} code{font-family:mono-space} .CVS, .cvstag{font-family:mono-space; font-size:small; color:#999999; text-align:right} .codeblock{background-color:#ffffff;font-family:monospace} -.programlisting{background-color:#CCCCCC} .strong{font-weight:bold} .authorblurb{font-size:small} + +/* this is intended to catch docbook Screen stuff */ +pre {background-color:#eeeeee;} + +/* DocBook stuff */ +.guibutton{background-color:white;border: solid#eeeeee; padding:1px;} +.replaceable{color:red; font-style:italic;} +.guilabel{background-color:silver; padding:2px;} +.programlisting{background-color:#eeeeee} +.strong{font-weight:bold} +.authorblurb{font-size:small} +.screen{padding:3px;} +.action{padding:0.5em; margin:0.5em;font-weight:bold;} + Index: openacs-4/packages/acs-core-docs/www/xml/openacs.xsl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/openacs.xsl,v diff -u -r1.5 -r1.6 --- openacs-4/packages/acs-core-docs/www/xml/openacs.xsl 30 Nov 2002 17:16:43 -0000 1.5 +++ openacs-4/packages/acs-core-docs/www/xml/openacs.xsl 28 Feb 2003 05:25:49 -0000 1.6 @@ -5,7 +5,7 @@ - + @@ -289,4 +289,36 @@ + + + + + + + + + + + + + + +
+ +
+
+ + + + + + + + + + + + + + Index: openacs-4/packages/acs-core-docs/www/xml/developers-guide/i18n.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/developers-guide/i18n.xml,v diff -u -r1.3 -r1.4 --- openacs-4/packages/acs-core-docs/www/xml/developers-guide/i18n.xml 18 Nov 2002 18:09:13 -0000 1.3 +++ openacs-4/packages/acs-core-docs/www/xml/developers-guide/i18n.xml 28 Feb 2003 05:26:59 -0000 1.4 @@ -1,5 +1,5 @@ - - + + Internationalization @@ -421,4 +421,8 @@ - + Index: openacs-4/packages/acs-core-docs/www/xml/developers-guide/submissions.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/developers-guide/submissions.xml,v diff -u --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/acs-core-docs/www/xml/developers-guide/submissions.xml 28 Feb 2003 05:26:59 -0000 1.1 @@ -0,0 +1,22 @@ + + Contributions + + + by Joel Aufrecht + + + + Overview + How to contribute work back to the community. Bugs, + patches, new packages. Forthcoming. + + + + + + + Index: openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial.xml,v diff -u --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/acs-core-docs/www/xml/developers-guide/tutorial.xml 28 Feb 2003 05:26:59 -0000 1.1 @@ -0,0 +1,63 @@ + + OpenACS &version; Package Tutorial + + + by Joel Aufrecht + + + + Overview + How to create a package. Includes + + + Using the APM + + + Package create scripts, including using acs_objects and + standard __new, __delete, and __name stored procedures. + + + Integrating with the content management system + + + Integrating with OpenFTS/Oracle full text search + + + Integrating with notifications + + + Creating .tcl/adp pairs, including ad_page_contract and the + template system + + + Integrating with general_comments + + + Ad_form (draw from http://jongriffin.com/static/openacs/ad_form/using-ad-form) + + + Automated testing + + + caching + + + writing procs, ad_proc, tcl namespaces + + + putting all sql code in .xql, including using partialquery + + + using the html/text entry widget + + + + + + + + Index: openacs-4/packages/acs-core-docs/www/xml/install-guide/macinstall.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/install-guide/macinstall.xml,v diff -u --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ openacs-4/packages/acs-core-docs/www/xml/install-guide/macinstall.xml 28 Feb 2003 05:27:39 -0000 1.1 @@ -0,0 +1,15 @@ + +OpenACS Installation Guide for Mac OS X + + Forthcoming. + + +($Id: macinstall.xml,v 1.1 2003/02/28 05:27:39 joela Exp $) + + + + Index: openacs-4/packages/acs-core-docs/www/xml/install-guide/overview.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/install-guide/overview.xml,v diff -u -r1.6 -r1.7 --- openacs-4/packages/acs-core-docs/www/xml/install-guide/overview.xml 30 Nov 2002 17:17:46 -0000 1.6 +++ openacs-4/packages/acs-core-docs/www/xml/install-guide/overview.xml 28 Feb 2003 05:27:39 -0000 1.7 @@ -22,9 +22,7 @@ What's OpenACS? OpenACS was born when Don Baccus, Ben Adida, - et al decided to port ACS from Oracle to - PostgreSQL, thus making it a fully open-source solution. - + et al decided to port ACS from Oracle to PostgreSQL, thus making it a fully open-source solution. OpenACS &version; is the next generation of the web toolkit. It's based on @@ -42,12 +40,9 @@ Purpose of this document - This document will describe how to install OpenACS &version; from scratch, - using the source code. We will assume that you have an OS installed, - but we'll discuss this more in the next section. For most of this - guide, we will assume that you are using Linux on a PC, but we'll - also point you to excellent step-by-step guides for other operating - systems. + This document will describe how to install an operating + system, OpenACS &version;, and all supporting software, from + scratch. @@ -63,25 +58,28 @@ (much more if you want Oracle) 4 GB hard drive - + If you want to serve pages to people outside of your machine, you'll need a network connection of some type. Note that these are minimum requirements to get a development system - up and running. For a production system, we recommend you read about - the ArsDigita - Server Architecture + up and running. For a large production system, we recommend you read about + the (now slightly obsolete) ArsDigita + Server Architecture article. Running a reliable database-backed web server requires experience with the server's environment, in this case UNIX. UNIX is not always an intuitive environment and this guide cannot hope to explain every - nuance. You should be comfortable with the following tasks before + nuance. If you follow the reference implementation, all of + the unix commands you need will be in the text. However, + you will have trouble indentifying typos or other problems. + Ideally, you should be comfortable with the following tasks before attempting an installation: @@ -91,7 +89,7 @@ - Starting an X server and running an X program remotely + (For Oracle) Starting an X server and running an X program remotely @@ -100,7 +98,7 @@ - Compiling a program using a Makefile + Compiling a program using ./config and make. @@ -121,30 +119,72 @@ - Steps involved - + Steps involved + The basic steps to getting OpenACS up and running are: - - - Install an OS - - - Install a webserver (AOLServer) - - - Install a database (Oracle or + + + Install an OS and supporting software + + + Install a webserver (AOLServer) + + + Install a database (Oracle or PostgreSQL) - - Install a database - driver (allows the webserver to talk to the database) - Configure the webserver and - database Start the OpenACS - installer + + + Install a database driver (allows the webserver to talk to the database) + + + + Start the OpenACS + installer, which will configure a database. + + How to use this guide + + + This is text that + tells you to do something, like click a + Button or + link + + + This is an option you will see + on screen, such as in a radio button list or menu. + + This is text that you will type. + + This is text from a program or file which you may need to +examine or edit: + if {$database == "oracle"} { + set db_password "mysitepassword" +} + + + This is text that you will +see and type in a command shell, including text you may have to +change. It is followed by a list of just the commands, +which you can copy and paste. + [root@localhost root]# su - nsadmin +[nsadmin@localhost aolserver]$ svc -d /service/openacs-dev +[nsadmin@localhost aolserver]$ dropdb openacs-dev +DROP DATABASE +[nsadmin@localhost aolserver]$ createdb openacs-dev +CREATE DATABASE +su - nsadmin +svc -d /service/openacs-dev +dropdb openacs-dev +createdb openacs-dev + + + + What if I get stuck? @@ -172,7 +212,7 @@ worry if you feel overwhelmed by all the information in the error logs. Over time, you'll find that they make more and more sense. Soon, you'll actually look forward to errors so that you - can run to the log and diagnose the problem. + can find the problem in the log. @@ -258,11 +298,18 @@ - My own Brief OpenACS4 - installation guide + Vinod + Kurup's Brief OpenACS4 installation guide + + Joel + Aufrecht's OpenACS 4.5 Quick Guide. + + + Please also see the section for more acknowledgements. @@ -372,6 +419,7 @@ ($Id$) +