You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by ek...@apache.org on 2006/01/25 22:45:53 UTC
svn commit: r372327 - in /beehive/trunk:
docs/forrest/release/src/documentation/content/xdocs/
docs/forrest/release/src/documentation/content/xdocs/netui/
docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/
docs/forrest/release/sr...
Author: ekoneil
Date: Wed Jan 25 13:45:40 2006
New Revision: 372327
URL: http://svn.apache.org/viewcvs?rev=372327&view=rev
Log:
Fixup a bunch of doc stuff:
- rename all of the system-controls docs to be "tutorial.xml" and "guide.xml"
- move the system-controls docs into their own separate sub-directories for Javadoc
BB: self
Test: docs build pass
Added:
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/guide.xml
- copied unchanged from r372224, beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejbDoc.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/tutorial.xml
- copied unchanged from r372224, beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejbControlTutorial.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/guide.xml
- copied unchanged from r372224, beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlDevGuide.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/tutorial.xml
- copied unchanged from r372224, beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlTutorial.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/guide.xml
- copied unchanged from r372224, beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jmsDoc.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/tutorial.xml
- copied unchanged from r372224, beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jmsControlTutorial.xml
Removed:
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejbControlTutorial.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/ejb/ejbDoc.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlDevGuide.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jdbc/jdbcControlTutorial.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jmsControlTutorial.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/system-controls/jms/jmsDoc.xml
Modified:
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/index.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/getting_started.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tutorial_pageflow.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/setup.xml
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml
beehive/trunk/system-controls/ant/javadoc.xml
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/index.xml?rev=372327&r1=372326&r2=372327&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/index.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/index.xml Wed Jan 25 13:45:40 2006
@@ -57,14 +57,14 @@
</p>
<ul>
<li><a href="site:docs/controls/getting_started">Controls</a></li>
- <li><a href="site:pageflow_getting_started">NetUI</a></li>
+ <li><a href="site:docs/pageflow/netuiIntro/getting_started">NetUI</a></li>
</ul>
<p>
The <strong>tutorials</strong> are end-to-end examples of how to build projects with Beehive features:
</p>
<ul>
<li><a href="site:docs/controls/tutorial">Controls</a></li>
- <li><a href="site:tutorial_pageflow">NetUI</a></li>
+ <li><a href="site:docs/tutorials/pageflow">NetUI</a></li>
</ul>
<p>
The <strong>samples</strong> are another good starting point for learning about Beehive.
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/getting_started.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/getting_started.xml?rev=372327&r1=372326&r2=372327&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/getting_started.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/getting_started.xml Wed Jan 25 13:45:40 2006
@@ -13,7 +13,7 @@
</ul>
<p>The following <strong>tutorial</strong> will familiarize with the basic development cycle NetUI web applications:</p>
<ul>
- <li><a href="site:tutorial_pageflow">NetUI Tutorial</a></li>
+ <li><a href="site:docs/tutorials/pageflow">NetUI Tutorial</a></li>
</ul>
<p>
The following <strong>sample</strong> demonstrates a complete NetUI web application that uses
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tutorial_pageflow.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tutorial_pageflow.xml?rev=372327&r1=372326&r2=372327&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tutorial_pageflow.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/tutorial_pageflow.xml Wed Jan 25 13:45:40 2006
@@ -610,7 +610,7 @@
<p>In this step you will add a simple 'Hello World' control to your web application.</p>
<p>You will edit the web application to become a client of the control. The web app will pass the user submitted
name to the control, and the control will return a simple 'Hello World' message back to the web app.
- For more details on how this control works see the <a href="site:tutorial_control">control tutorial</a>.</p>
+ For more details on how this control works see the <a href="site:docs/tutorials/control">control tutorial</a>.</p>
<section>
<title>Create the HelloWorld Control</title>
<p>Inside the <code>netui-tutorial/src</code> directory, create a new directory named <code>controls</code>.</p>
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/setup.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/setup.xml?rev=372327&r1=372326&r2=372327&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/setup.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/setup.xml Wed Jan 25 13:45:40 2006
@@ -29,10 +29,11 @@
<p>(3) Ensure that <code>$JAVA_HOME/bin</code> and <code>$ANT_HOME/bin</code> are on your <code>$PATH</code>.</p>
<p>
You are now ready to begin developing Beehive applications!
- If you plan on running the Beehive tutorials, follow the tutorial specific steps <a href="site:tutorial_setup">here</a>.
+ If you plan on running the Beehive tutorials, follow the tutorial specific steps
+ <a href="site:docs/tutorials/setup">here</a>.
</p>
<p>
- Information on tutorials and samples is <a href="site:sam_index">here</a>.
+ Information on tutorials and samples is <a href="site:docs/samples/index">here</a>.
</p>
</body>
<footer>
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml?rev=372327&r1=372326&r2=372327&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/site.xml Wed Jan 25 13:45:40 2006
@@ -1,21 +1,38 @@
<?xml version="1.0"?>
+<!--
+ Copyright 2004-2006 The Apache Software Foundation.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ $Header:$
+ -->
<site label="Beehive" href="" xmlns="http://apache.org/forrest/linkmap/1.0" tab="release-svn">
<docs label="Documentation" tab="release-svn">
<setup label="Setup" href="setup.html"/>
<tutorials label="Tutorials">
- <tutorial_setup label="Setup" href="tutorial/setup.html"/>
- <tutorial_pageflow label="NetUI" href="netui/tutorial_pageflow.html"/>
- <tutorial_control label="Controls" href="controls/tutorial.html"/>
- <tutorial_system-controls label="System Controls">
- <control label="EJB Control" href="system-controls/ejb/ejbControlTutorial.html"/>
- <control label="JDBC Control" href="system-controls/jdbc/jdbcControlTutorial.html"/>
- <control label="JMS Control" href="system-controls/jms/jmsControlTutorial.html"/>
- </tutorial_system-controls>
+ <setup label="Setup" href="tutorial/setup.html"/>
+ <pageflow label="NetUI" href="netui/tutorial_pageflow.html"/>
+ <control label="Controls" href="controls/tutorial.html"/>
+ <system-controls label="System Controls">
+ <ejb label="EJB Control" href="system-controls/ejb/tutorial.html"/>
+ <jdbc label="JDBC Control" href="system-controls/jdbc/tutorial.html"/>
+ <jms label="JMS Control" href="system-controls/jms/tutorial.html"/>
+ </system-controls>
</tutorials>
<pageflow label="NetUI">
<netuiIntro label="Introduction">
- <pageflow_getting_started label="Getting Started" href="netui/getting_started.html"/>
+ <getting_started label="Getting Started" href="netui/getting_started.html"/>
<pageflow_overview label="NetUI Overview" href="netui/overview.html"/>
<pageflow_controllers label="Controller Classes" href="netui/pageFlowControllers.html"/>
<pageflow_jsp label="JSP Files" href="netui/jspOverview.html">
@@ -103,12 +120,12 @@
<tutorial label="Tutorial" href="controls/tutorial.html"/>
</controls>
<controls label="System Controls">
- <ejb label="EJB Control" href="system-controls/ejb/ejbDoc.html"/>
- <jdbc label="JDBC Control" href="system-controls/jdbc/jdbcControlDevGuide.html"/>
- <jms label="JMS Control" href="system-controls/jms/jmsDoc.html"/>
+ <ejb label="EJB Control" href="system-controls/ejb/guide.html"/>
+ <jdbc label="JDBC Control" href="system-controls/jdbc/guide.html"/>
+ <jms label="JMS Control" href="system-controls/jms/guide.html"/>
</controls>
<samples label="Samples">
- <sam_index label="Overview" href="samples/index.html"/>
+ <index label="Overview" href="samples/index.html"/>
<petstore label="Petstore" href="samples/petstore.html"/>
<netui-samples label="NetUI Samples" href="netui/netui-samples.html"/>
<netui-jsf label="NetUI + JSF Integration" href="netui/sample_jpf_jsf_integration.html"/>
@@ -139,21 +156,23 @@
<system-controls label="System Controls">
<ejb_control_reference label="EJB">
<annotations label="Annotations" href="system-controls/ejb/ejb-annotations.html"/>
- <javadoc label="API Javadoc" href="apidocs/classref_systemcontrols/index.html"/>
+ <javadoc label="API Javadoc" href="apidocs/system-controls/ejb/index.html"/>
</ejb_control_reference>
<jdbc_control_reference label="JDBC">
<annotations label="Annotations" href="system-controls/jdbc/jdbc-annotations.html"/>
- <javadoc label="API Javadoc" href="apidocs/classref_systemcontrols/index.html"/>
+ <javadoc label="API Javadoc" href="apidocs/system-controls/jdbc/index.html"/>
</jdbc_control_reference>
<jms_control_reference label="JMS">
<annotations label="Annotations" href="system-controls/jms/jms-annotations.html"/>
- <javadoc label="API Javadoc" href="apidocs/classref_systemcontrols/index.html"/>
+ <javadoc label="API Javadoc" href="apidocs/system-controls/jms/index.html"/>
</jms_control_reference>
</system-controls>
<javadoc label="API Javadoc">
<controls label="Controls" href="apidocs/classref_controls/index.html"/>
<netui label="NetUI" href="apidocs/classref_netui/index.html"/>
- <system-controls label="System Controls" href="apidocs/classref_systemcontrols/index.html"/>
+ <sc-ejb label="EJB Control" href="apidocs/system-controls/ejb/index.html"/>
+ <sc-jdbc label="JDBC Control" href="apidocs/system-controls/jdbc/index.html"/>
+ <sc-jms label="JMS Control" href="apidocs/system-controls/jms/index.html"/>
</javadoc>
</reference>
<release_notes label="Release Notes" href="release-notes.html"/>
Modified: beehive/trunk/system-controls/ant/javadoc.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/system-controls/ant/javadoc.xml?rev=372327&r1=372326&r2=372327&view=diff
==============================================================================
--- beehive/trunk/system-controls/ant/javadoc.xml (original)
+++ beehive/trunk/system-controls/ant/javadoc.xml Wed Jan 25 13:45:40 2006
@@ -17,7 +17,7 @@
$Header:$
-->
-<project name="Beehive/SystemControls/DocBuild" default="usage" basedir=".">
+<project name="Beehive/SystemControls/Documentation" default="usage" basedir=".">
<import file="../systemcontrols-imports.xml"/>
@@ -52,13 +52,12 @@
<echo message="build - Cleans and builds all doc, copies the result to the forrest site. "/>
<echo message="clean - Deletes the built netui docs and associated temp files."/>
<echo message="generate-class-ref - Generates the Page Flow class reference, using the standard Javadoc doclet."/>
- <echo message="copy-to-forrest - Copies the built netui docs to the forrest site."/>
<echo message="================================================================================"/>
<echo message="| |"/>
<echo message="================================================================================"/>
</target>
- <target name="build" depends="check-for-resources" description="Generates Javadoc for all core classes and tags, copies all docs to the build directory for distribution, also copies all docs to the forrest directory.">
+ <target name="build" description="Generates Javadoc for all classes.">
<antcall target="clean"/>
<antcall target="generate-class-ref"/>
<fixcrlf srcDir="${build.dir}/docs/apidocs" includes="**/*.html"/>
@@ -75,27 +74,30 @@
Track the bug at: http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=5055723
When the fix arrives in JDK5, set use="true". -->
<target name="generate-class-ref">
- <javadoc destdir="${build.dir}/docs/apidocs/classref_systemcontrols"
- maxmemory="256M"
- windowtitle="Apache Beehive System Controls API Documentation (Version ${beehive.version})"
- doctitle="Apache Beehive System Controls API Documentation (Version ${beehive.version})"
- version="true"
- author="false"
- use="false"
- additionalparam="-breakiterator -noqualifier all -notimestamp"
- useexternalfile="true"
- classpathref="javadoc.classpath"
- source="1.5">
-
- <packageset dir="${src.dir}/jdbc"/>
- <packageset dir="${src.dir}/webservice"/>
- <packageset dir="${src.dir}/ejb"/>
- <packageset dir="${src.dir}/jms"/>
- </javadoc>
+ <_javadoc controlname="jdbc" displayname="JDBC"/>
+ <_javadoc controlname="ejb" displayname="EJB"/>
+ <_javadoc controlname="jms" displayname="JMS"/>
+<!-- <_javadoc controlname="webservice" displayname="Web Service"/> -->
</target>
- <target name="check-for-resources" unless="resources.present">
- <ant dir="../../" target="deploy"/>
- </target>
+ <macrodef name="_javadoc">
+ <attribute name="controlname" description="The name of the control to Javadoc"/>
+ <attribute name="displayname" description="The display name of the Javadoc'ed control"/>
+ <sequential>
+ <javadoc destdir="${build.dir}/docs/apidocs/system-controls/@{controlname}/classref/"
+ maxmemory="256M"
+ windowtitle="Apache Beehive @{displayname} Controls API Documentation (Version ${beehive.version})"
+ doctitle="Apache Beehive @{displayname} Controls API Documentation (Version ${beehive.version})"
+ version="true"
+ author="false"
+ use="false"
+ additionalparam="-breakiterator -noqualifier all -notimestamp"
+ useexternalfile="true"
+ classpathref="javadoc.classpath"
+ source="1.5">
+ <packageset dir="${src.dir}/@{controlname}"/>
+ </javadoc>
+ </sequential>
+ </macrodef>
</project>