Index: openacs-4/packages/acs-core-docs/www/subsites-requirements.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/subsites-requirements.html,v
diff -u -r1.32 -r1.33
--- openacs-4/packages/acs-core-docs/www/subsites-requirements.html	11 Dec 2010 23:36:32 -0000	1.32
+++ openacs-4/packages/acs-core-docs/www/subsites-requirements.html	31 Jul 2011 23:11:46 -0000	1.33
@@ -1,31 +1,31 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 'http://www.w3.org/TR/html4/loose.dtd"'>
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Subsites Requirements</title><link rel="stylesheet" type="text/css" href="openacs.css"><meta name="generator" content="DocBook XSL Stylesheets V1.76.0"><link rel="home" href="index.html" title="OpenACS Core Documentation"><link rel="up" href="kernel-doc.html" title="Chapter 14. Kernel Documentation"><link rel="previous" href="groups-design.html" title="Groups Design"><link rel="next" href="subsites-design.html" title="Subsites Design Document"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><a href="http://openacs.org"><img src="/doc/images/alex.jpg" style="border:0" alt="Alex logo"></a><table width="100%" summary="Navigation header" border="0"><tr><td width="20%" align="left"><a accesskey="p" href="groups-design.html">Prev</a> </td><th width="60%" align="center">Chapter 14. Kernel Documentation</th><td width="20%" align="right"> <a accesskey="n" href="subsites-design.html">Next</a></td></tr></table><hr></div><div class="sect1" title="Subsites Requirements"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="subsites-requirements"></a>Subsites Requirements</h2></div></div></div><div class="authorblurb"><p>By <a class="ulink" href="http://planitia.org" target="_top">Rafael H. Schloming</a> and Dennis Gregorovic</p>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 'http://www.w3.org/TR/html4/loose.dtd"'>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Subsites Requirements</title><link rel="stylesheet" href="openacs.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"><link rel="home" href="index.html" title="OpenACS Core Documentation"><link rel="up" href="kernel-doc.html" title="Chapter 13. Kernel Documentation"><link rel="previous" href="groups-design.html" title="Groups Design"><link rel="next" href="subsites-design.html" title="Subsites Design Document"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><a href="http://openacs.org"><img src="/doc/images/alex.jpg" style="border:0" alt="Alex logo"></a><table width="100%" summary="Navigation header" border="0"><tr><td width="20%" align="left"><a accesskey="p" href="groups-design.html">Prev</a> </td><th width="60%" align="center">Chapter 13. Kernel Documentation</th><td width="20%" align="right"> <a accesskey="n" href="subsites-design.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="subsites-requirements"></a>Subsites Requirements</h2></div></div><div></div></div><div class="authorblurb"><p>By <a href="http://planitia.org" target="_top">Rafael H. Schloming</a> and Dennis Gregorovic</p>
           OpenACS docs are written by the named authors, and may be edited
           by OpenACS documentation staff.
-        </div><div class="sect2" title="Introduction"><div class="titlepage"><div><div><h3 class="title"><a name="subsites-requirements-intro"></a>Introduction</h3></div></div></div><p>The following is a requirements document for OpenACS 4 Subsites, part of the
+        </div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="subsites-requirements-intro"></a>Introduction</h3></div></div><div></div></div><p>The following is a requirements document for OpenACS 4 Subsites, part of the
 OpenACS 4 Kernel. The Subsites system allows one OpenACS server instance to serve
 multiple user communities, by enabling the suite of available OpenACS
-applications to be customized for defined user communities.</p></div><div class="sect2" title="Vision Statement"><div class="titlepage"><div><div><h3 class="title"><a name="subsites-requirements-vision"></a>Vision Statement</h3></div></div></div><p>Many online communities are also collections of discrete subcommunities,
+applications to be customized for defined user communities.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="subsites-requirements-vision"></a>Vision Statement</h3></div></div><div></div></div><p>Many online communities are also collections of discrete subcommunities,
 reflecting real-world relationships. For example, a corporate
 intranet/extranet website serves both units within the company (e.g.,
 offices, departments, teams, projects) and external parties (e.g., customers,
 partners, vendors). Subsites enable a single OpenACS instance to provide each
-subcommunity with its own "virtual website," by assembling OpenACS
+subcommunity with its own &quot;virtual website,&quot; by assembling OpenACS
 packages that together deliver a feature set tailored to the needs of the
-subcommunity.</p></div><div class="sect2" title="System Overview"><div class="titlepage"><div><div><h3 class="title"><a name="subsites-requirements-system-overview"></a>System Overview</h3></div></div></div><p>The OpenACS subsite system allows a single OpenACS installation to serve multiple
+subcommunity.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="subsites-requirements-system-overview"></a>System Overview</h3></div></div><div></div></div><p>The OpenACS subsite system allows a single OpenACS installation to serve multiple
 communities. At an implementation level this is primarily accomplished by
-having an application "scope" its content to a particular package
-instance. The <a class="link" href="rp-design.html" title="Request Processor Design">request
+having an application &quot;scope&quot; its content to a particular package
+instance. The <a href="rp-design.html" title="Request Processor Design">request
 processor</a> then figures out which package_id a particular URL references
-and then provides this information through the <code class="computeroutput">ad_conn</code> api (<code class="computeroutput">[ad_conn
-package_id]</code>, <code class="computeroutput">[ad_conn package_url]</code>).</p><p>The other piece of the subsite system is a subsite package that provides
-subsite admins a "control panel" for administering their subsite.
+and then provides this information through the <tt class="computeroutput">ad_conn</tt> api (<tt class="computeroutput">[ad_conn
+package_id]</tt>, <tt class="computeroutput">[ad_conn package_url]</tt>).</p><p>The other piece of the subsite system is a subsite package that provides
+subsite admins a &quot;control panel&quot; for administering their subsite.
 This is the same package used to provide all the community core functionality
-available at the "main" site which is in fact simply another
-subsite.</p></div><div class="sect2" title="Use-cases and User-scenarios"><div class="titlepage"><div><div><h3 class="title"><a name="subsites-requirements-use-cases"></a>Use-cases and User-scenarios</h3></div></div></div><p>The Subsites functionality is intended for use by two different classes of
-users:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p>Package programmers (referred to as 'the programmer') must
-develop subcommunity-aware applications.</p></li><li class="listitem"><p>Site administrators (referred to as 'the administrator') use
-subsites to provide tailored "virtual websites" to different
+available at the &quot;main&quot; site which is in fact simply another
+subsite.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="subsites-requirements-use-cases"></a>Use-cases and User-scenarios</h3></div></div><div></div></div><p>The Subsites functionality is intended for use by two different classes of
+users:</p><div class="orderedlist"><ol type="1"><li><p>Package programmers (referred to as 'the programmer') must
+develop subcommunity-aware applications.</p></li><li><p>Site administrators (referred to as 'the administrator') use
+subsites to provide tailored &quot;virtual websites&quot; to different
 subcommunities.</p></li></ol></div><p>Joe Programmer is working on the forum package and wants to make it
 subsite-aware. Using [ad_conn package_id], Joe adds code that only displays
 forum messages associated with the current package instance. Joe is happy to
@@ -40,18 +40,18 @@
 http://www.company.com/offices/boston/forum, and similarly for the Austin
 office. At this point, the Boston and Austin office admins can customize the
 configurations for each of their forums, or they can just use the
-defaults.</p></div><div class="sect2" title="Related Links"><div class="titlepage"><div><div><h3 class="title"><a name="subsites-requirements-links"></a>Related Links</h3></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><a class="xref" href="subsites-design.html" title="Subsites Design Document">OpenACS 4 Subsites Design Document</a></p></li><li class="listitem"><p>Test plan (Not available yet)</p></li></ul></div></div><div class="sect2" title="Requirements: Programmer's API"><div class="titlepage"><div><div><h3 class="title"><a name="subsites-requirements-api"></a>Requirements: Programmer's API</h3></div></div></div><p>A subsite API is required for programmers to ensure their packages are
-subsite-aware. The following functions should be sufficient for this:</p><p><span class="strong"><strong>10.10.0 Package creation</strong></span></p><p>The system must provide an API call to create a package, and it must be
-possible for the context (to which the package belongs) to be specified.</p><p><span class="strong"><strong>10.20.0 Package deletion</strong></span></p><p>The system must provide an API call to delete a package and all related
-objects in the subsite's context.</p><p><span class="strong"><strong>10.30.0 Object's package information</strong></span></p><p>Given an object ID, the system must provide an API call to determine the
-package (ID) to which the object belongs.</p><p><span class="strong"><strong>10.40.0 URL from package</strong></span></p><p>Given a package (ID), the system must provide an API call to return the
-canonical URL for that package.</p><p><span class="strong"><strong>10.50.0 Main subsite's package_id</strong></span></p><p>The system must provide an API call to return a package ID corresponding
-to the main subsite's package ID (the degenerate subsite).</p></div><div class="sect2" title="Requirements: The User Interface"><div class="titlepage"><div><div><h3 class="title"><a name="subsites-requirements-ui"></a>Requirements: The User Interface</h3></div></div></div><p><span class="strong"><strong>The Programmer's User Interface</strong></span></p><p>There is no programmer's UI, other than the API described above.</p><p><span class="strong"><strong>The Administrator's User Interface</strong></span></p><p>The UI for administrators is a set of HTML pages that are used to drive
+defaults.</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="subsites-requirements-links"></a>Related Links</h3></div></div><div></div></div><div class="itemizedlist"><ul type="disc"><li><p><a href="subsites-design.html">OpenACS 4 Subsites Design Document</a></p></li><li><p>Test plan (Not available yet)</p></li></ul></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="subsites-requirements-api"></a>Requirements: Programmer's API</h3></div></div><div></div></div><p>A subsite API is required for programmers to ensure their packages are
+subsite-aware. The following functions should be sufficient for this:</p><p><span class="strong">10.10.0 Package creation</span></p><p>The system must provide an API call to create a package, and it must be
+possible for the context (to which the package belongs) to be specified.</p><p><span class="strong">10.20.0 Package deletion</span></p><p>The system must provide an API call to delete a package and all related
+objects in the subsite's context.</p><p><span class="strong">10.30.0 Object's package information</span></p><p>Given an object ID, the system must provide an API call to determine the
+package (ID) to which the object belongs.</p><p><span class="strong">10.40.0 URL from package</span></p><p>Given a package (ID), the system must provide an API call to return the
+canonical URL for that package.</p><p><span class="strong">10.50.0 Main subsite's package_id</span></p><p>The system must provide an API call to return a package ID corresponding
+to the main subsite's package ID (the degenerate subsite).</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="subsites-requirements-ui"></a>Requirements: The User Interface</h3></div></div><div></div></div><p><span class="strong">The Programmer's User Interface</span></p><p>There is no programmer's UI, other than the API described above.</p><p><span class="strong">The Administrator's User Interface</span></p><p>The UI for administrators is a set of HTML pages that are used to drive
 the underlying API for package instance management (i.e. adding, removing, or
 altering packages). It is restricted to administrators of the current subsite
 such that administrators can only manage their own subsites. Of course,
-Site-Wide Administrators can manage all subsites.</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><span class="strong"><strong>20.10.0 Package creation</strong></span></p><p><span class="strong"><strong>20.10.1</strong></span> The administrator should be able to create a
-package and make it available at a URL underneath the subsite.</p></li><li class="listitem"><p><span class="strong"><strong>20.20.0 Package deactivation</strong></span></p><p><span class="strong"><strong>20.20.1</strong></span> The administrator should be able to deactivate
-any package, causing it to be inaccessible to users.</p><p><span class="strong"><strong>20.20.5</strong></span> Deactivating a package makes the package no
+Site-Wide Administrators can manage all subsites.</p><div class="itemizedlist"><ul type="disc"><li><p><span class="strong">20.10.0 Package creation</span></p><p><span class="strong">20.10.1</span> The administrator should be able to create a
+package and make it available at a URL underneath the subsite.</p></li><li><p><span class="strong">20.20.0 Package deactivation</span></p><p><span class="strong">20.20.1</span> The administrator should be able to deactivate
+any package, causing it to be inaccessible to users.</p><p><span class="strong">20.20.5</span> Deactivating a package makes the package no
 longer accessible, but it does not remove data created within the context of
-that package.</p></li></ul></div></div><div class="sect2" title="Revision History"><div class="titlepage"><div><div><h3 class="title"><a name="subsites-requirements-rev-history"></a>Revision History</h3></div></div></div><div class="informaltable"><table cellspacing="0" border="1"><colgroup><col><col><col><col></colgroup><tbody><tr><td><span class="strong"><strong>Document Revision #</strong></span></td><td><span class="strong"><strong>Action Taken, Notes</strong></span></td><td><span class="strong"><strong>When?</strong></span></td><td><span class="strong"><strong>By Whom?</strong></span></td></tr><tr><td>0.1</td><td>Creation</td><td>08/18/2000</td><td>Dennis Gregorovic</td></tr><tr><td>0.2</td><td>Edited, reviewed</td><td>08/29/2000</td><td>Kai Wu</td></tr></tbody></table></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="groups-design.html">Prev</a> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right"> <a accesskey="n" href="subsites-design.html">Next</a></td></tr><tr><td width="40%" align="left">Groups Design </td><td width="20%" align="center"><a accesskey="u" href="kernel-doc.html">Up</a></td><td width="40%" align="right"> Subsites Design Document</td></tr></table><hr><address><a href="mailto:docs@openacs.org">docs@openacs.org</a></address></div><a name="comments"></a><center><a href="http://openacs.org/doc/current/subsites-requirements.html#comments">View comments on this page at openacs.org</a></center></body></html>
+that package.</p></li></ul></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="subsites-requirements-rev-history"></a>Revision History</h3></div></div><div></div></div><div class="informaltable"><table cellspacing="0" border="1"><colgroup><col><col><col><col></colgroup><tbody><tr><td><span class="strong">Document Revision #</span></td><td><span class="strong">Action Taken, Notes</span></td><td><span class="strong">When?</span></td><td><span class="strong">By Whom?</span></td></tr><tr><td>0.1</td><td>Creation</td><td>08/18/2000</td><td>Dennis Gregorovic</td></tr><tr><td>0.2</td><td>Edited, reviewed</td><td>08/29/2000</td><td>Kai Wu</td></tr></tbody></table></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="groups-design.html">Prev</a> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right"> <a accesskey="n" href="subsites-design.html">Next</a></td></tr><tr><td width="40%" align="left">Groups Design </td><td width="20%" align="center"><a accesskey="u" href="kernel-doc.html">Up</a></td><td width="40%" align="right"> Subsites Design Document</td></tr></table><hr><address><a href="mailto:docs@openacs.org">docs@openacs.org</a></address></div><a name="comments"></a><center><a href="http://openacs.org/doc/current/subsites-requirements.html#comments">View comments on this page at openacs.org</a></center></body></html>