Author: steveh Date: Thu Jan 13 16:10:07 2005 New Revision: 125121 URL: http://svn.apache.org/viewcvs?view=rev&rev=125121 Log: Adding tabs to the Forrest site (Home and Docs tabs). Checkin includes some misc. updates to particular docs. Added: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/docs/ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/docs/index.xml (contents, props changed) Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_controllers.xml incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/tabs.xml incubator/beehive/trunk/docs/forrest/src/documentation/skinconf.xml
Added: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/docs/index.xml Url: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/docs/index.xml?view=auto&rev=125121 ============================================================================== --- (empty file) +++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/docs/index.xml Thu Jan 13 16:10:07 2005 @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd";> +<document> + <header> + <title>Apache Beehive 1.0 Beta Documentation</title> + </header> + <body> + <section> + <title>Getting Started</title> + <p>Beehive documetation contains documentation for all three Beehive sub-projects: Controls, + Page Flows, and Web Services.</p> + <p>If your are new to Beehive, begin by following the + <a href="../setup.html">Installation and Startup</a> instructions.</p> + <p>The following topics will familiarize with the basic development cycles for Beehive + applications:</p> + <ul> + <li><a href="../controls/tutorial_controls.html">Beehive Controls Tutorial</a></li> + <li><a href="../pageflow/tutorial_pageflow.html">Beehive Page Flow Tutorial</a></li> + <li><a href="../wsm/tutorial_wsm.html">Beehive Web Service Tutorial</a></li> + </ul> + <p>You can also begin running the following samples:</p> + <ul> + <li><a href="../jpetstore.html">Beehive Sample: Petstore</a></li> + <li><a href="../wsm/sample_Dashboard.html">Beehive Web Service Sample: Petstore Dashboard</a></li> + <li><a href="../wsm/sample_AddressBook.html">Beehive AddressBookWS and EmployeeWS Samples</a></li> + <li><a href="../controls/sample_controls-db.html">Database Control Sample</a></li> + </ul> + <p>The following application templates will help you get a project started:</p> + <ul> + <li><a href="../pageflow/sample_netui-blank.html">Page Flow Project Template</a></li> + <li><a href="../controls/sample_controls-blank.html">Control Project Template</a></li> + <li><a href="../wsm/sample_wsm-blank.html">Web Service Project Template</a></li> + </ul> + </section> + </body> + <footer> + <legal>Java, J2EE, and JCP are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.<br/> + © 2004, Apache Software Foundation + </legal> + </footer> +</document> 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?view=diff&rev=125121&p1=incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml&r1=125120&p2=incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml&r2=125121 ============================================================================== --- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml (original) +++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/jpetstore.xml Thu Jan 13 16:10:07 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://forrest.apache.org/dtd/document-v13.dtd";> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd";> <document> <header> <title>Beehive Sample: Petstore</title> @@ -9,7 +9,7 @@ <title>Introduction</title> <p>The Petstore sample demonstrates how to integrate all three Beehive technologies (Page Flows, Controls and Web Services) in one application.</p> <p>The Page Flows provide customers with web access to the Petstore. There are separate Page Flows for different customer activities: the 'shop' Page Flow (located at: <code>petstoreWeb/shop/</code>) lets users browse the catalog of pets, the 'checkout' Page Flow (petstoreWeb/checkout) lets users purchase selected items from a shopping cart, etc.</p> - <p>The Web Service provides employee access to the Petstore. Through the web service (located at <code>petstoreWeb/WEB-INF/src/PetstoreInventoryManager.jws</code>) employees can update the current inventory and prices displayed to customers through the web site. A Swing client for the web service is provided in the sample <link href="http://incubator.apache.org/beehive/wsm/sample_Dashboard.html";>Petstore Dashboard</link>. </p> + <p>The Web Service provides employee access to the Petstore. Through the web service (located at <code>petstoreWeb/WEB-INF/src/PetstoreInventoryManager.jws</code>) employees can update the current inventory and prices displayed to customers through the web site. A Swing client for the web service is provided in the sample <a href="http://incubator.apache.org/beehive/wsm/sample_Dashboard.html";>Petstore Dashboard</a>. </p> <p>Most of the Page Flows have associated Control files (located at: <code>petstoreWeb/WEB-INF/src/org/apache/beehive/samples/petstore/controls/</code>). The Controls handle the backend data traffic and encupsulate the operations of the web application, such as retrieving data from a database and handling user orders.</p> </section> <section> @@ -94,7 +94,7 @@ <section> <title>Setup</title> <p>In the descriptions below, <code>BEEHIVE_HOME</code> refers to the root of the -Beehive distribution. (The Beehive binary distribution can be downloaded from <fork href="http://cvs.apache.org/dist/incubator/beehive/v1.0-alpha/bin/";>http://cvs.apache.org/dist/incubator/beehive/v1.0-alpha/bin/</fork>.) For example, if Beehive is installed in: +Beehive distribution. (The Beehive binary distribution can be downloaded from <a class="fork" href="http://cvs.apache.org/dist/incubator/beehive/v1.0-alpha/bin/";>http://cvs.apache.org/dist/incubator/beehive/v1.0-alpha/bin/</a>.) For example, if Beehive is installed in: </p> <source> c:\java\beehive-0.3alpha @@ -179,7 +179,7 @@ -Dcontext.path=petstoreWeb</source> <p>To see the running application, visit the URL: </p> - <p> <link href=" http://localhost:8080/petstoreWeb/Controller.jpf";>http://localhost:8080/petstoreWeb/Controller.jpf</link></p> + <p> <a href=" http://localhost:8080/petstoreWeb/Controller.jpf";>http://localhost:8080/petstoreWeb/Controller.jpf</a></p> </section> </section> </body> Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_controllers.xml Url: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_controllers.xml?view=diff&rev=125121&p1=incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_controllers.xml&r1=125120&p2=incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_controllers.xml&r2=125121 ============================================================================== --- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_controllers.xml (original) +++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/pageflow_controllers.xml Thu Jan 13 16:10:07 2005 @@ -573,12 +573,11 @@ <section> <title>Handling Exceptions</title> <p> - Suppose a new user completes the signup form and clicks the submit button. It is very common - to make mistakes when filling out a long HTML form with many fields. Suppose that a mistake has occured, - like a required field was left out, or the phone number did not have the proper format. Suppose - that an exception was thrown by the processSignUp() method? What then?</p> + Suppose a new user completes the signup form and submits her user profile. But when the profile is processed, + it is discovered that the username has already been taken by another user. What then?</p> <p>A natural design choice would be to have the - <code>myPage</code> action throw an exception and handle the exception by returning the user to + <code>processSignUp</code> action throw an exception and then have the controller class handle the + exception by returning the user to the original signup page. The following diagram shows how you can interweave exception handling into the page flow to further refine the paths through the flow. @@ -588,8 +587,9 @@ </p> <p>You can implement exception handling using the <code>@Jpf.Catch</code> and <code>@Jpf.ExceptionHandler</code> annotations. The <code>@Jpf.Catch</code> defines - some exception to intercept should it arise within the page flow. The <code>@Jpf.ExceptionHandler</code> - annotation is used to define some standard way of handling the intercepted exception.</p> + some exception to intercept should it arise within the controller class. + The <code>@Jpf.ExceptionHandler</code> + annotation is used to define a dedicated method for handling the exception.</p> <source> @Jpf.Controller( <strong>catches={ @@ -654,10 +654,12 @@ } </source> - </section> - </section> +<section><title>Form Validation</title> + <p>[tbd]</p> + + </section> <section id="next"> <title>Next...</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?view=diff&rev=125121&p1=incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml&r1=125120&p2=incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml&r2=125121 ============================================================================== --- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml (original) +++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/setup.xml Thu Jan 13 16:10:07 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "document-v12.dtd"> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd";> <document> <header> <title>Beehive Installation and Setup</title> @@ -8,24 +8,24 @@ <p>This topic explains how to install a Beehive binary distribution on your machine. Once you have completed these installation instructions, you can begin developing Beehive applications.</p> <section> <title>To Download and Install a Beehive Binary Distribution</title> - <p>Visit (<fork href="http://cvs.apache.org/dist/incubator/beehive/v1.0-alpha/bin/";>http://cvs.apache.org/dist/incubator/beehive/v1.0-alpha/bin/</fork>) and download the latest binary distribution of Beehive. Note that the current release of Beehive is an alpha: it is <em>not</em> for building production-level applcations.</p> + <p>Visit (<a class="fork" href="http://cvs.apache.org/dist/incubator/beehive/v1.0-alpha/bin/";>http://cvs.apache.org/dist/incubator/beehive/v1.0-alpha/bin/</a>) and download the latest binary distribution of Beehive. Note that the current release of Beehive is an alpha: it is <em>not</em> for building production-level applcations.</p> <p>Unzip the Beehive distribution file on your machine</p> </section> <section> <title>To Download and Install J2SE5</title> - <p>If you do not have J2SE5 installed, visit <fork href="http://java.sun.com/j2se/1.5.0/download.jsp";>http://java.sun.com/j2se/1.5.0/download.jsp</fork>. + <p>If you do not have J2SE5 installed, visit <a class="fork" href="http://java.sun.com/j2se/1.5.0/download.jsp";>http://java.sun.com/j2se/1.5.0/download.jsp</a>. </p> <p>Download and install the latest version of J2SE5.</p> </section> <section> <title>To Install ANT 1.6.2</title> - <p>If you do not have Ant 1.6.2 installed, visit <fork href="http://svn.apache.org/repos/asf/incubator/beehive/trunk/external/ant/apache-ant-1.6.2-bin.zip";>http://svn.apache.org/repos/asf/incubator/beehive/trunk/external/ant/apache-ant-1.6.2-bin.zip</fork>. + <p>If you do not have Ant 1.6.2 installed, visit <a class="fork" href="http://svn.apache.org/repos/asf/incubator/beehive/trunk/external/ant/apache-ant-1.6.2-bin.zip";>http://svn.apache.org/repos/asf/incubator/beehive/trunk/external/ant/apache-ant-1.6.2-bin.zip</a>. </p> <p>Download the ZIP file and unzip it on your machine.</p> </section> <section> <title>To Download and Install Tomcat 5</title> - <p>If you do not have Tomcat 5 installed, visit <fork href="http://svn.apache.org/repos/asf/incubator/beehive/trunk/external/tomcat/jakarta-tomcat-5.0.25.zip";>http://svn.apache.org/repos/asf/incubator/beehive/trunk/external/tomcat/jakarta-tomcat-5.0.25.zip</fork> + <p>If you do not have Tomcat 5 installed, visit <a class="fork" href="http://svn.apache.org/repos/asf/incubator/beehive/trunk/external/tomcat/jakarta-tomcat-5.0.25.zip";>http://svn.apache.org/repos/asf/incubator/beehive/trunk/external/tomcat/jakarta-tomcat-5.0.25.zip</a> </p> <p>Download the ZIP file and unzip it on your machine.</p> </section> @@ -76,22 +76,22 @@ <title>What Now?</title> <p>You are now ready to begin developing Beehive applications. The following tutorials introduce the basic development cycle:</p> <ul> - <li><link href="controls/tutorial_controls.html">Beehive Controls Tutorial</link></li> - <li><link href="pageflow/tutorial_pageflow.html">Beehive Page Flow Tutorial</link></li> - <li><link href="wsm/tutorial_wsm.html">Beehive Web Service Tutorial</link></li> + <li><a href="controls/tutorial_controls.html">Beehive Controls Tutorial</a></li> + <li><a href="pageflow/tutorial_pageflow.html">Beehive Page Flow Tutorial</a></li> + <li><a href="wsm/tutorial_wsm.html">Beehive Web Service Tutorial</a></li> </ul> <p>You can also begin running the following samples:</p> <ul> - <li><link href="jpetstore.html">Beehive Sample: Petstore</link></li> - <li><link href="wsm/sample_Dashboard.html">Beehive Web Service Sample: Petstore Dashboard</link></li> - <li><link href="wsm/sample_AddressBook.html">Beehive AddressBookWS and EmployeeWS Samples</link></li> - <li><link href="controls/sample_controls-db.html">Database Control Sample</link></li> + <li><a href="jpetstore.html">Beehive Sample: Petstore</a></li> + <li><a href="wsm/sample_Dashboard.html">Beehive Web Service Sample: Petstore Dashboard</a></li> + <li><a href="wsm/sample_AddressBook.html">Beehive AddressBookWS and EmployeeWS Samples</a></li> + <li><a href="controls/sample_controls-db.html">Database Control Sample</a></li> </ul> <p>The following application templates will help you get a project started:</p> <ul> - <li><link href="pageflow/sample_netui-blank.html">Page Flow Project Template</link></li> - <li><link href="controls/sample_controls-blank.html">Control Project Template</link></li> - <li><link href="wsm/sample_wsm-blank.html">Web Service Project Template</link></li> + <li><a href="pageflow/sample_netui-blank.html">Page Flow Project Template</a></li> + <li><a href="controls/sample_controls-blank.html">Control Project Template</a></li> + <li><a href="wsm/sample_wsm-blank.html">Web Service Project Template</a></li> </ul> </section> @@ -99,15 +99,15 @@ <title>Troubleshooting</title> <p><strong>I Can't Decompress the <code>.tar.gz</code> File</strong></p> <p>Note: The <code>.tar.gz</code> distribution files are created using Ant's <code><tar></code> task - (<fork href="http://ant.apache.org/manual/CoreTasks/tar.html";>http://ant.apache.org/manual/CoreTasks/tar.html</fork>). + (<a class="fork" href="http://ant.apache.org/manual/CoreTasks/tar.html";>http://ant.apache.org/manual/CoreTasks/tar.html</a>). This generates <code>.tar</code> files that can only be decompressed using a compatible <code>tar</code> utility.</p> <p>Known compatible utilities include: </p> <ul> - <li>GNU tar 1.14 (<fork href="http://www.gnu.org/software/tar/manual/html_mono/tar.html";>http://www.gnu.org/software/tar/manual/html_mono/tar.html</fork>)</li> + <li>GNU tar 1.14 (<a class="fork" href="http://www.gnu.org/software/tar/manual/html_mono/tar.html";>http://www.gnu.org/software/tar/manual/html_mono/tar.html</a>)</li> <li>WinZip 8.0</li> - <li>Ant's <code><untar></code> task (<fork href="http://ant.apache.org/manual/CoreTasks/unzip.html";>http://ant.apache.org/manual/CoreTasks/unzip.html</fork>)</li> + <li>Ant's <code><untar></code> task (<a class="fork" href="http://ant.apache.org/manual/CoreTasks/unzip.html";>http://ant.apache.org/manual/CoreTasks/unzip.html</a>)</li> </ul> </section> </body> Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml Url: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml?view=diff&rev=125121&p1=incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml&r1=125120&p2=incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml&r2=125121 ============================================================================== --- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml (original) +++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/site.xml Thu Jan 13 16:10:07 2005 @@ -1,16 +1,18 @@ <?xml version="1.0"?> -<site label="Beehive" href="" xmlns="http://apache.org/forrest/linkmap/1.0";> - <about label="Beehive"> - <index label="Welcome" href="index.html"/> +<site label="Beehive" href="" xmlns="http://apache.org/forrest/linkmap/1.0"; tab="welcome"> + <about label="Welcome" tab="welcome"> + <introduction label="Introduction" href="index.html"/> <license label="License" href="license.html"/> <downloads label="Downloads" href="downloads.html"/> <faq label="FAQ" href="faq.html"/> </about> - <documentation label="Documentation"> + <community label="Community" tab="welcome"> + <mailinglists label="Mailing Lists" href="mailinglists.html"/> + <contributors label="Contributors" href="contributors.html"/> + </community> + <docs label="Documentation" tab="docs"> + <docs label="Introduction" href="docs/index.html"/> <setup label="Installation and Setup" href="setup.html" /> - <!--<beehive label="Beehive"> - <guide label="Putting the Pieces Together" href="beehive/guide.html"/> - </beehive>--> <pageflow label="Page Flows"> <pageflow_overview label="Overview" href="pageflow/pageflow_overview.html"/> <pageflow_controllers label="Controller Files" href="pageflow/pageflow_controllers.html"/> @@ -53,16 +55,12 @@ <ws label="Web Services Javadoc" href="apidocs/classref_wsm/index.html"/> </ws> </ref> - <!--<gloss label="Glossary" href="glossary.html"/>--> - <!--<source label="Beehive Source"> - <building label="Building Beehive" href="building.html"/> - </source>--> - </documentation> - <community label="Community"> - <mailinglists label="Mailing Lists" href="mailinglists.html"/> - <contributors label="Contributors" href="contributors.html"/> - </community> + <gloss label="Glossary" href="glossary.html"/> + + </docs> +</site> + <!-- <external-refs> <xml.apache.org href="http://xml.apache.org/"/> </external-refs> -</site> + --> 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?view=diff&rev=125121&p1=incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/tabs.xml&r1=125120&p2=incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/tabs.xml&r2=125121 ============================================================================== --- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/tabs.xml (original) +++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/tabs.xml Thu Jan 13 16:10:07 2005 @@ -1,10 +1,22 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE tabs PUBLIC "-//APACHE//DTD Cocoon Documentation Tab V1.0//EN" "tab-cocoon-v10.dtd"> +<!DOCTYPE tabs PUBLIC "-//APACHE//DTD Cocoon Documentation Tab V1.1//EN" "tab-cocoon-v11.dtd"> <tabs software="Apache Beehive" title="Apache Beehive" copyright="Apache Software Foundation" xmlns:xlink="http://www.w3.org/1999/xlink";> - <tab label="Home" dir=""/> + <!-- The rules for tabs are: + @dir will always have '/@indexfile' added. + @indexfile gets appended to @dir if the tab is selected. Defaults to 'index.html' + @href is not modified unless it is root-relative and obviously specifies a + directory (ends in '/'), in which case /index.html will be added + If @id's are present, site.xml entries with a matching @tab will be in that tab. + + Tabs can be embedded to a depth of two. The second level of tabs will only + be displayed when their parent tab is selected. + --> + + <tab id="welcome" label="Welcome" dir="" indexfile="index.html"/> + <tab id="docs" label="Documentation" dir="docs" indexfile="index.html"/> </tabs> Modified: incubator/beehive/trunk/docs/forrest/src/documentation/skinconf.xml Url: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/skinconf.xml?view=diff&rev=125121&p1=incubator/beehive/trunk/docs/forrest/src/documentation/skinconf.xml&r1=125120&p2=incubator/beehive/trunk/docs/forrest/src/documentation/skinconf.xml&r2=125121 ============================================================================== --- incubator/beehive/trunk/docs/forrest/src/documentation/skinconf.xml (original) +++ incubator/beehive/trunk/docs/forrest/src/documentation/skinconf.xml Thu Jan 13 16:10:07 2005 @@ -305,13 +305,13 @@ (if the skin supports it). --> <credits> - <credit box-location="alt"> + <!--<credit box-location="alt"> <name>Built with Apache Forrest</name> <url>http://forrest.apache.org/</url> <image>images/built-with-forrest-button.png</image> <width>88</width> <height>31</height> - </credit> + </credit>--> <!-- A credit with @role="pdf" will be used to compose a footer for each page in the PDF, using either "name" or "url" or both. -->
