You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by st...@apache.org on 2005/05/17 19:58:32 UTC

svn commit: r170627 - in /incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs: jpetstore.xml release_notes.xml setup.xml tabs.xml

Author: steveh
Date: Tue May 17 10:58:31 2005
New Revision: 170627

URL: http://svn.apache.org/viewcvs?rev=170627&view=rev
Log:
Misc. fixes:
(1) Removing Beta branding
(2) Update to jpetstore sample doc.
(3) adding release note about problems with TOC display on IE.

Modified:
    incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml
    incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/release_notes.xml
    incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml
    incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/tabs.xml

Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml?rev=170627&r1=170626&r2=170627&view=diff
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml Tue May 17 10:58:31 2005
@@ -38,73 +38,105 @@
 					<td/>
 				</tr>
 				<tr>
-					<td>&nbsp;&nbsp;&nbsp;&nbsp;account</td>
-					<td>Page Flow (=Controller.java + JSP files) user interface 
-						for managing user accounts</td>
+					<td>
+						&nbsp;&nbsp;&nbsp;&nbsp;src</td>
+					<td>This directory contains the back-end data and controls used by the web app.
+						</td>
+				</tr>
+				<tr>
+					<td>
+						&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.../controller/AccountController.java</td>
+					<td>Class controls some of the internationalization settings for the site.</td>
 				</tr>
 				<tr>
-					<td>&nbsp;&nbsp;&nbsp;&nbsp;auth</td>
-					<td>Page Flow user interface for managing login and 
-						logout</td>
+					<td>
+						&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.../controls</td>
+					<td>Beehive Controls encapsulating different 
+						functionalities, including handling user account data, 
+						catalogue data, and order processing.</td>
+				</tr>
+				<tr>
+					<td>
+						&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.../forms</td>
+					<td>Form Beans: each form bean is a server-side 
+						representation of an HTML form appearing in the user 
+						interface.</td>
+				</tr>
+				<tr>
+					<td>
+						&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.../model</td>
+					<td>Java object classes (java beans) used to represent the basic 
+						types in the app:
+						addresses, orders, products, etc.</td>
+				</tr>
+				<tr>
+					<td>
+						&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;.../resources</td>
+					<td>Various .properties files</td>
+				</tr>
+				<tr>
+					<td>
+						&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sql</td>
+					<td>A SQL file to initialize the database.</td>
 				</tr>
 				<tr>
-					<td>&nbsp;&nbsp;&nbsp;&nbsp;checkout</td>
+					<td>&nbsp;&nbsp;&nbsp;&nbsp;test-src</td>
+					<td>Java types used by the application's internal tests.</td>
+				</tr>
+				<tr>
+					<td>&nbsp;&nbsp;&nbsp;&nbsp;web</td>
+					<td>Contains the Page Flow web application modules.</td>
+				</tr>
+				<tr>
+					<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;account</td>
+					<td>Page Flow user interface for managing user accounts</td>
+				</tr>
+				<tr>
+					<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;auth</td>
+					<td>Page Flow user interface for managing login</td>
+				</tr>
+				<tr>
+					<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;checkout</td>
 					<td>Page Flow user interface for managing the shopping 
 						cart</td>
 				</tr>
 				<tr>
-					<td>&nbsp;&nbsp;&nbsp;&nbsp;search</td>
+					<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;search</td>
 					<td>Page Flow user interface for searching the 
 						Petstore</td>
 				</tr>
 				<tr>
-					<td>&nbsp;&nbsp;&nbsp;&nbsp;shop</td>
+					<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;shop</td>
 					<td>Page Flow user interface for browsing the catalogue of 
 						pets</td>
 				</tr>
 				<tr>
-					<td>&nbsp;&nbsp;&nbsp;&nbsp;site</td>
+					<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;site</td>
 					<td>Contains the Petstore "skin", including the CSS file, 
 						HTML frameset, and template file</td>
 				</tr>
 				<tr>
-					<td>&nbsp;&nbsp;&nbsp;&nbsp;webappRoot</td>
+					<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;webappRoot</td>
 					<td>
 						<!--[todo]-->
 					</td>
 				</tr>
 				<tr>
-					<td>&nbsp;&nbsp;&nbsp;&nbsp;WEB-INF</td>
+					<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;WEB-INF</td>
 					<td>Contains configuration files for deployment, 
-						validation, and security (web.xml)</td>
-				</tr>
-				<tr>
-					<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lib</td>
-					<td>JAR resources</td>
+						validation, security (web.xml), and generated Struts config files.</td>
 				</tr>
 				<tr>
-					<td>
-						&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;src/PetstoreInventoryManager.java</td>
-					<td>Web service for employee access to the store</td>
-				</tr>
-				<tr>
-					<td>
-						&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;src/.../controls</td>
-					<td>Beehive Controls encapsulating different 
-						functionalities, including handling user account data, 
-						catalogue data, and order processing</td>
+					<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;tags</td>
+					<td>Contains <code>.tag</code> files.</td>
 				</tr>
 				<tr>
-					<td>
-						&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;src/.../forms</td>
-					<td>Form Beans: each form bean is a server-side 
-						representation of an HTML form appearing in the user 
-						interface</td>
+					<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lib</td>
+					<td>JAR resources -- this directory is created and populated when you call the ant target <code>deploy-beehive</code>.</td>
 				</tr>
 				<tr>
-					<td>
-						&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;src/.../model</td>
-					<td>Java object classes used by the Controls</td>
+					<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ws</td>
+					<td>Contains the web service interface for the web app.</td>
 				</tr>
 			</table>
 		</section>

Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/release_notes.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/release_notes.xml?rev=170627&r1=170626&r2=170627&view=diff
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/release_notes.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/release_notes.xml Tue May 17 10:58:31 2005
@@ -29,6 +29,15 @@
 <p>These items will not validate against HTML-401-Quirks, HTML-401-Loose, or 
 XHTML-10-Transitional. </p>
         </section>
+		<section id="beehive-742">
+			<title>Documentation Table of Contents Display Problems on Internet Explorer</title>
+			<p>On some versions of Internet Explorer (6.0 SP2, and possibly others) the 
+				doucumentation table of contents does not display property.  The table of 
+				contents appears further to the right-hand side of the page than is expected.
+				</p>
+			<p>To fix the display, enbable "active content" in Internet Explorer.</p>
+			<p>This problem is not seen on the Firefox browser.</p>
+		</section>
     </section>
     <section>
         <title>Issues Fixed in this Release</title>

Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml?rev=170627&r1=170626&r2=170627&view=diff
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml Tue May 17 10:58:31 2005
@@ -24,14 +24,14 @@
 			</ul>
             <p>(2) Make sure that the following environmental variables are set in your shell.</p>
 			    <ul>
-					<li><code>BEEHIVE_HOME</code></li>
+					<!--<li><code>BEEHIVE_HOME</code></li>-->
 					<li><code>ANT_HOME</code></li>
 					<li><code>JAVA_HOME</code></li>
 			    </ul>
 			<p>Typical values for these variables would be as follows.</p>
-			<source>BEEHIVE_HOME = C:\apache\apache-beehive-incubating-svn-snapshot
+			<source><!--BEEHIVE_HOME = C:\apache\apache-beehive-incubating-svn-snapshot
 
-ANT_HOME = C:\apache\apache-ant-1.6.2
+-->ANT_HOME = C:\apache\apache-ant-1.6.2
 
 JAVA_HOME = C:\jdk1.5.0</source>
 			<p>(3) Finally, ensure that <code>JAVA_HOME/bin</code> and <code>ANT_HOME/bin</code> are on your <code>PATH</code>.</p>

Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/tabs.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/tabs.xml?rev=170627&r1=170626&r2=170627&view=diff
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/tabs.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/tabs.xml Tue May 17 10:58:31 2005
@@ -17,6 +17,6 @@
     be displayed when their parent tab is selected.    
   -->
 
-  <tab id="welcome" label="Beehive 1.0 Beta" dir="" indexfile="index.html"/>
+  <tab id="welcome" label="Beehive 1.0" dir="" indexfile="index.html"/>
   <!--<tab id="docs" label="Documentation" dir="docs" indexfile="index.html"/>-->
 </tabs>