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 2004/11/16 02:34:47 UTC
svn commit: rev 75979 - in incubator/beehive/site: build/site/controls build/site/pageflow build/site/wsm src/documentation/content/xdocs/controls src/documentation/content/xdocs/pageflow src/documentation/content/xdocs/wsm
Author: steveh
Date: Mon Nov 15 17:34:46 2004
New Revision: 75979
Modified:
incubator/beehive/site/build/site/controls/sample_controls-blank.html
incubator/beehive/site/build/site/pageflow/sample_netui-blank.html
incubator/beehive/site/build/site/wsm/sample_wsm-blank.html
incubator/beehive/site/src/documentation/content/xdocs/controls/sample_controls-blank.xml
incubator/beehive/site/src/documentation/content/xdocs/pageflow/sample_netui-blank.xml
incubator/beehive/site/src/documentation/content/xdocs/wsm/sample_wsm-blank.xml
Log:
Improving the 'blank' template docs.
Docs now give explict build, deploy, and run instructions.
Modified: incubator/beehive/site/build/site/controls/sample_controls-blank.html
==============================================================================
--- incubator/beehive/site/build/site/controls/sample_controls-blank.html (original)
+++ incubator/beehive/site/build/site/controls/sample_controls-blank.html Mon Nov 15 17:34:46 2004
@@ -294,6 +294,9 @@
<li>
<a href="#intro">The Control Application Template</a>
</li>
+<li>
+<a href="#Using+the+Control+Project+Template">Using the Control Project Template</a>
+</li>
</ul>
<a name="N1000C"></a><a name="intro"></a>
@@ -304,8 +307,22 @@
</p>
<p>The template contains a basic 'Hello World' control to get you started. Control projects can be archived in a JAR file and then imported into multiple applications. Simply import the JAR archive into the application's WEB-INF/lib directory. </p>
</div>
-
-
+
+<a name="N1001C"></a><a name="Using+the+Control+Project+Template"></a>
+<h3>Using the Control Project Template</h3>
+<div style="margin-left: 0 ; border: 2px">
+<p>The following instruction assume that you have completed the basic Beehive set up procedure at <a target="_blank" href="../setup.html">Set Up the Dev Environment</a>.</p>
+<p>To use the template, (1) copy its contents into your project folder (refered to as <span class="codefrag"><Project-Folder></span> below), and (2) copy the runtime JARs to the project's WEB-INF/lib directory.
+It is important to copy the <em>contents</em> of <span class="codefrag">netui-blank</span> into your project folder, not the <span class="codefrag">netui-blank</span> folder itself. After you have copied the contents of <span class="codefrag">netui-blank</span> into your project folder, the following directory structure should exist:</p>
+<pre class="code"><Project-Folder>
+ src
+ build.xml</pre>
+<p>The following Ant command will compile the control template. </p>
+<pre class="code"> ant
+ -f <Project-Folder>\build.xml build</pre>
+<p>This will produce a distributable JAR file at: <span class="codefrag"><Project-Folder>/build/mycontrols.jar</span>.</p>
+<p>To use the JAR in your other projects (like a web app project or a web service project), copy <span class="codefrag">mycontrols.jar</span> into the project's <span class="codefrag">WEB-INF/lib</span> directory.</p>
+</div>
<div class="attribution"></div>
</div>
Modified: incubator/beehive/site/build/site/pageflow/sample_netui-blank.html
==============================================================================
--- incubator/beehive/site/build/site/pageflow/sample_netui-blank.html (original)
+++ incubator/beehive/site/build/site/pageflow/sample_netui-blank.html Mon Nov 15 17:34:46 2004
@@ -294,20 +294,60 @@
<li>
<a href="#intro">The Page Flow Application Template</a>
</li>
+<li>
+<a href="#Using+the+Page+Flow+Web+App+Template">Using the Page Flow Web App Template</a>
+</li>
</ul>
<a name="N1000C"></a><a name="intro"></a>
<h3>The Page Flow Application Template</h3>
<div style="margin-left: 0 ; border: 2px">
-<p>Use the "blank" Page Flow sample (located at <span class="codefrag">BEEHIVE_HOME/samples/netui-blank</span>) is a template for building your own Page Flow applications.
-
+<p>Use the "blank" Page Flow sample (located at <span class="codefrag">BEEHIVE_HOME/samples/netui-blank</span>) as a template for building your own Page Flow applications.
+The sample contains everything needed in a basic Page Flow application, except for the runtime and <netui> tag library JAR files.
</p>
-<p>The sample contains everything needed in a basic Page Flow application, except for the runtime JAR files. To use the template, (1) copy its contents into your project folder, and (2) copy the runtime JARs to the WEB-INF/lib directory. The following Ant command will copy the necessary runtime JARs to <span class="codefrag"><Project-Folder>/WEB-INF/lib</span>, where <span class="codefrag"><Project-Folder></span> is the path to your Page Flow project folder: </p>
+</div>
+
+<a name="N10019"></a><a name="Using+the+Page+Flow+Web+App+Template"></a>
+<h3>Using the Page Flow Web App Template</h3>
+<div style="margin-left: 0 ; border: 2px">
+<p>The following instruction assume that you have completed the basic Beehive set up procedure at <a target="_blank" href="../setup.html">Set Up the Dev Environment</a>.</p>
+<p>To use the template, (1) copy its contents into your project folder (refered to as <span class="codefrag"><Project-Folder></span> below), and (2) copy the runtime JARs to the project's WEB-INF/lib directory.
+It is important to copy the <em>contents</em> of <span class="codefrag">netui-blank</span> into your project folder, not the <span class="codefrag">netui-blank</span> folder itself. After you have copied the contents of <span class="codefrag">netui-blank</span> into your project folder, the following directory structure should exist:</p>
+<pre class="code"><Project-Folder>
+ resources
+ WEB-INF
+ Controller.jpf
+ error.jsp
+ index.jsp</pre>
+<p>The following Ant command will copy the necessary runtime and tag library JARs to <span class="codefrag"><Project-Folder>/WEB-INF/lib</span>.</p>
<pre class="code"> ant
-f %BEEHIVE_HOME%\ant\buildWebapp.xml
- -Dwebapp.dir=<Project-Folder>
+ -Dwebapp.dir=<Project-Folder>
deploy.beehive.webapp.runtime</pre>
+<p>To build and run the template web app, run the following Ant command. (Before running ensure that Tomcat is turned on: <span class="codefrag">%CATALINA_HOME%\bin\startup.bat</span>. Or use the Ant command provided in the distribution: <span class="codefrag">ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml start</span>. If you use the provided Ant command, you will have to press <span class="codefrag">Ctrl+C</span> to continue issuing commands in that command window.)</p>
+<pre class="code"> ant
+ -f ant\buildWebapp.xml
+ -Dwebapp.dir=<Project-Folder>
+ -Dcontext.path=WebApp-Blank
+ build.webapp
+ deploy</pre>
+<p>If the WebApp-Blank web app is already deployed, use the following target:</p>
+<pre class="code"> ant
+ -f ant\buildWebapp.xml
+ -Dwebapp.dir=<Project-Folder>
+ -Dcontext.path=WebApp-Blank
+ undeploy
+ build.webapp
+ deploy</pre>
+<p>You can now try out the web app by pointing your browser at the following links.</p>
+<ul>
+
+<li>Run the controller file's begin() method: <a target="_blank" href="http://localhost:8080/WebApp-Blank/">http://localhost:8080/WebApp-Blank/</a>
+</li>
+
+</ul>
</div>
+
<div class="attribution"></div>
</div>
Modified: incubator/beehive/site/build/site/wsm/sample_wsm-blank.html
==============================================================================
--- incubator/beehive/site/build/site/wsm/sample_wsm-blank.html (original)
+++ incubator/beehive/site/build/site/wsm/sample_wsm-blank.html Mon Nov 15 17:34:46 2004
@@ -294,19 +294,59 @@
<li>
<a href="#intro">The Web Service Application Template</a>
</li>
+<li>
+<a href="#Using+the+Web+Service+Template">Using the Web Service Template</a>
+</li>
</ul>
<a name="N1000C"></a><a name="intro"></a>
<h3>The Web Service Application Template</h3>
<div style="margin-left: 0 ; border: 2px">
-<p>Use the "blank" web service sample (located at <span class="codefrag">BEEHIVE_HOME/samples/wsm-blank</span>) is a template for building your own web service applications.
+<p>Use the "blank" web service sample (located at <span class="codefrag">BEEHIVE_HOME/samples/wsm-blank</span>) as a template for building your own web service applications.
</p>
-<p>The sample contains everything needed in a basic web service application, except for the runtime JAR files. To use the template, (1) copy its contents into your project folder, and (2) copy the runtime JARs to the WEB-INF/lib directory. The following Ant command will copy the necessary runtime JARs to <span class="codefrag"><Project-Folder>/WEB-INF/lib</span>, where <span class="codefrag"><Project-Folder></span> is the path to your web service project folder: </p>
+<p>The sample contains everything needed in a basic web service application, except for the runtime JAR files.
+</p>
+</div>
+
+<a name="N1001C"></a><a name="Using+the+Web+Service+Template"></a>
+<h3>Using the Web Service Template</h3>
+<div style="margin-left: 0 ; border: 2px">
+<p>The following instruction assume that you have completed the basic Beehive set up procedure at <a target="_blank" href="../setup.html">Set Up the Dev Environment</a>.</p>
+<p>To use the template, (1) copy its contents into your project folder, and (2) copy the runtime JARs to the project's WEB-INF/lib directory.
+It is important to copy the <em>contents</em> of <span class="codefrag">wsm-blank</span> into your project folder, not the
+ The following Ant command will copy the necessary runtime JARs to <span class="codefrag"><Project-Folder>/WEB-INF/lib</span>, where <span class="codefrag"><Project-Folder></span> is the path to your web service project folder: </p>
<pre class="code"> ant
-f %BEEHIVE_HOME%\ant\buildWebapp.xml
-Dwebapp.dir=<Project-Folder>
deploy.wsm.webapp.runtime</pre>
+<p>To build and run the template, run the following Ant command. (Before running ensure that Tomcat is turned on: <span class="codefrag">%CATALINA_HOME%\bin\startup.bat</span>. Or use the Ant command provided in the distribution: <span class="codefrag">ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml start</span>. If you use the provided Ant command, you will have to press <span class="codefrag">Ctrl+C</span> to continue issuing commands in that command window.)</p>
+<pre class="code"> ant
+ -f ant\buildWebapp.xml
+ -Dwebapp.dir=<Project-Folder>
+ -Dcontext.path=HelloWorldWS
+ build.webapp
+ deploy</pre>
+<p>If the HelloWorldWS web service is already deployed, use the redeploy target:</p>
+<pre class="code"> ant
+ -f ant\buildWebapp.xml
+ -Dwebapp.dir=<Project-Folder>
+ -Dcontext.path=HelloWorldWS
+ build.webapp
+ redeploy</pre>
+<p>You can now try out the HelloWorldWS web service by pointing your browser at the following links.</p>
+<ul>
+
+<li>Start Page: <a target="_blank" href="http://localhost:8080/HelloWorldWS/">http://localhost:8080/HelloWorldWS/</a>
+</li>
+
+<li>WSDL: <a target="_blank" href="http://localhost:8080/HelloWorldWS/template/Blank.jws?wsdl">http://localhost:8080/HelloWorldWS/template/Blank.jws?wsdl</a>
+</li>
+
+<li>Invoke the sayHelloWorld() method in Blank.java: <a target="_blank" href="http://localhost:8080/HelloWorldWS/template/Blank.jws?method=sayHelloWorld">http://localhost:8080/HelloWorldWS/template/Blank.jws?method=sayHelloWorld</a>
+</li>
+
+</ul>
</div>
<div class="attribution"></div>
Modified: incubator/beehive/site/src/documentation/content/xdocs/controls/sample_controls-blank.xml
==============================================================================
--- incubator/beehive/site/src/documentation/content/xdocs/controls/sample_controls-blank.xml (original)
+++ incubator/beehive/site/src/documentation/content/xdocs/controls/sample_controls-blank.xml Mon Nov 15 17:34:46 2004
@@ -12,27 +12,25 @@
</p>
<p>The template contains a basic 'Hello World' control to get you started. Control projects can be archived in a JAR file and then imported into multiple applications. Simply import the JAR archive into the application's WEB-INF/lib directory. </p>
-<!--<source>
-netui-blank
- resources
- beehive
- version
- images
- error-handling.jpg - header image for the error.jsp page
- javascript
- netui-tree.js - JavaScript file to support the <netui:tree> tag
- WEB-INF
- src
- global
- Global.app - a global Page Flow useful for common operations, error handling, etc.
- log4j.xml - the log4j configuration file
- netui-config.xml -
- netui-validator-rules.xml
- web.xml
-</source>-->
- </section>
-
+ </section>
+ <section>
+ <title>Using the Control Project Template</title>
+ <p>The following instruction assume that you have completed the basic Beehive set up procedure at <fork href="../setup.html">Set Up the Dev Environment</fork>.</p>
+ <p>To use the template, (1) copy its contents into your project folder (refered to as <code><Project-Folder></code> below), and (2) copy the runtime JARs to the project's WEB-INF/lib directory.
+It is important to copy the <em>contents</em> of <code>netui-blank</code> into your project folder, not the <code>netui-blank</code> folder itself. After you have copied the contents of <code>netui-blank</code> into your project folder, the following directory structure should exist:</p>
+<source><Project-Folder>
+ src
+ build.xml</source>
+ <p>The following Ant command will compile the control template. </p>
+<source> ant
+ -f <Project-Folder>\build.xml build</source>
+
+
+
+ <p>This will produce a distributable JAR file at: <code><Project-Folder>/build/mycontrols.jar</code>.</p>
+ <p>To use the JAR in your other projects (like a web app project or a web service project), copy <code>mycontrols.jar</code> into the project's <code>WEB-INF/lib</code> directory.</p>
+ </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/>
Modified: incubator/beehive/site/src/documentation/content/xdocs/pageflow/sample_netui-blank.xml
==============================================================================
--- incubator/beehive/site/src/documentation/content/xdocs/pageflow/sample_netui-blank.xml (original)
+++ incubator/beehive/site/src/documentation/content/xdocs/pageflow/sample_netui-blank.xml Mon Nov 15 17:34:46 2004
@@ -7,34 +7,47 @@
<body>
<section id="intro">
<title>The Page Flow Application Template</title>
-<p>Use the "blank" Page Flow sample (located at <code>BEEHIVE_HOME/samples/netui-blank</code>) is a template for building your own Page Flow applications.
-
+<p>Use the "blank" Page Flow sample (located at <code>BEEHIVE_HOME/samples/netui-blank</code>) as a template for building your own Page Flow applications.
+The sample contains everything needed in a basic Page Flow application, except for the runtime and <netui> tag library JAR files.
</p>
-
-<p>The sample contains everything needed in a basic Page Flow application, except for the runtime JAR files. To use the template, (1) copy its contents into your project folder, and (2) copy the runtime JARs to the WEB-INF/lib directory. The following Ant command will copy the necessary runtime JARs to <code><Project-Folder>/WEB-INF/lib</code>, where <code><Project-Folder></code> is the path to your Page Flow project folder: </p>
+ </section>
+ <section>
+ <title>Using the Page Flow Web App Template</title>
+ <p>The following instruction assume that you have completed the basic Beehive set up procedure at <fork href="../setup.html">Set Up the Dev Environment</fork>.</p>
+ <p>To use the template, (1) copy its contents into your project folder (refered to as <code><Project-Folder></code> below), and (2) copy the runtime JARs to the project's WEB-INF/lib directory.
+It is important to copy the <em>contents</em> of <code>netui-blank</code> into your project folder, not the <code>netui-blank</code> folder itself. After you have copied the contents of <code>netui-blank</code> into your project folder, the following directory structure should exist:</p>
+<source><Project-Folder>
+ resources
+ WEB-INF
+ Controller.jpf
+ error.jsp
+ index.jsp</source>
+ <p>The following Ant command will copy the necessary runtime and tag library JARs to <code><Project-Folder>/WEB-INF/lib</code>.</p>
<source> ant
-f %BEEHIVE_HOME%\ant\buildWebapp.xml
- -Dwebapp.dir=<Project-Folder>
+ -Dwebapp.dir=<Project-Folder>
deploy.beehive.webapp.runtime</source>
-<!--<source>
-netui-blank
- resources
- beehive
- version
- images
- error-handling.jpg - header image for the error.jsp page
- javascript
- netui-tree.js - JavaScript file to support the <netui:tree> tag
- WEB-INF
- src
- global
- Global.app - a global Page Flow useful for common operations, error handling, etc.
- log4j.xml - the log4j configuration file
- netui-config.xml -
- netui-validator-rules.xml
- web.xml
-</source>-->
+ <p>To build and run the template web app, run the following Ant command. (Before running ensure that Tomcat is turned on: <code>%CATALINA_HOME%\bin\startup.bat</code>. Or use the Ant command provided in the distribution: <code>ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml start</code>. If you use the provided Ant command, you will have to press <code>Ctrl+C</code> to continue issuing commands in that command window.)</p>
+<source> ant
+ -f ant\buildWebapp.xml
+ -Dwebapp.dir=<Project-Folder>
+ -Dcontext.path=WebApp-Blank
+ build.webapp
+ deploy</source>
+<p>If the WebApp-Blank web app is already deployed, use the following target:</p>
+<source> ant
+ -f ant\buildWebapp.xml
+ -Dwebapp.dir=<Project-Folder>
+ -Dcontext.path=WebApp-Blank
+ undeploy
+ build.webapp
+ deploy</source>
+<p>You can now try out the web app by pointing your browser at the following links.</p>
+ <ul>
+ <li>Run the controller file's begin() method: <fork href="http://localhost:8080/WebApp-Blank/">http://localhost:8080/WebApp-Blank/</fork></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/>
Modified: incubator/beehive/site/src/documentation/content/xdocs/wsm/sample_wsm-blank.xml
==============================================================================
--- incubator/beehive/site/src/documentation/content/xdocs/wsm/sample_wsm-blank.xml (original)
+++ incubator/beehive/site/src/documentation/content/xdocs/wsm/sample_wsm-blank.xml Mon Nov 15 17:34:46 2004
@@ -7,16 +7,44 @@
<body>
<section id="intro">
<title>The Web Service Application Template</title>
-<p>Use the "blank" web service sample (located at <code>BEEHIVE_HOME/samples/wsm-blank</code>) is a template for building your own web service applications.
+<p>Use the "blank" web service sample (located at <code>BEEHIVE_HOME/samples/wsm-blank</code>) as a template for building your own web service applications.
</p>
-<p>The sample contains everything needed in a basic web service application, except for the runtime JAR files. To use the template, (1) copy its contents into your project folder, and (2) copy the runtime JARs to the WEB-INF/lib directory. The following Ant command will copy the necessary runtime JARs to <code><Project-Folder>/WEB-INF/lib</code>, where <code><Project-Folder></code> is the path to your web service project folder: </p>
+<p>The sample contains everything needed in a basic web service application, except for the runtime JAR files.
+</p>
+ </section>
+ <section>
+ <title>Using the Web Service Template</title>
+ <p>The following instruction assume that you have completed the basic Beehive set up procedure at <fork href="../setup.html">Set Up the Dev Environment</fork>.</p>
+ <p>To use the template, (1) copy its contents into your project folder, and (2) copy the runtime JARs to the project's WEB-INF/lib directory.
+It is important to copy the <em>contents</em> of <code>wsm-blank</code> into your project folder, not the
+ The following Ant command will copy the necessary runtime JARs to <code><Project-Folder>/WEB-INF/lib</code>, where <code><Project-Folder></code> is the path to your web service project folder: </p>
<source> ant
-f %BEEHIVE_HOME%\ant\buildWebapp.xml
-Dwebapp.dir=<Project-Folder>
deploy.wsm.webapp.runtime</source>
-<!--<source>
+ <p>To build and run the template, run the following Ant command. (Before running ensure that Tomcat is turned on: <code>%CATALINA_HOME%\bin\startup.bat</code>. Or use the Ant command provided in the distribution: <code>ant -f %BEEHIVE_HOME%\ant\buildWebapp.xml start</code>. If you use the provided Ant command, you will have to press <code>Ctrl+C</code> to continue issuing commands in that command window.)</p>
+<source> ant
+ -f ant\buildWebapp.xml
+ -Dwebapp.dir=<Project-Folder>
+ -Dcontext.path=HelloWorldWS
+ build.webapp
+ deploy</source>
+<p>If the HelloWorldWS web service is already deployed, use the redeploy target:</p>
+<source> ant
+ -f ant\buildWebapp.xml
+ -Dwebapp.dir=<Project-Folder>
+ -Dcontext.path=HelloWorldWS
+ build.webapp
+ redeploy</source>
+<p>You can now try out the HelloWorldWS web service by pointing your browser at the following links.</p>
+ <ul>
+ <li>Start Page: <fork href="http://localhost:8080/HelloWorldWS/">http://localhost:8080/HelloWorldWS/</fork></li>
+ <li>WSDL: <fork href="http://localhost:8080/HelloWorldWS/template/Blank.jws?wsdl">http://localhost:8080/HelloWorldWS/template/Blank.jws?wsdl</fork></li>
+ <li>Invoke the sayHelloWorld() method in Blank.java: <fork href="http://localhost:8080/HelloWorldWS/template/Blank.jws?method=sayHelloWorld">http://localhost:8080/HelloWorldWS/template/Blank.jws?method=sayHelloWorld</fork></li>
+</ul>
+ <!--<source>
netui-blank
resources
beehive