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 2005/09/11 15:48:08 UTC
svn commit: r280136 -
/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/sample_netui-blank.xml
Author: ekoneil
Date: Sun Sep 11 06:48:06 2005
New Revision: 280136
URL: http://svn.apache.org/viewcvs?rev=280136&view=rev
Log:
Reformat the netui-blank documentation.
BB: self
Test: build.release pass
Modified:
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/sample_netui-blank.xml
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/sample_netui-blank.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/sample_netui-blank.xml?rev=280136&r1=280135&r2=280136&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/sample_netui-blank.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/netui/sample_netui-blank.xml Sun Sep 11 06:48:06 2005
@@ -1,112 +1,113 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
- "http://forrest.apache.org/dtd/document-v20.dtd">
+ "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
- <header>
- <title>NetUI Project Template</title>
- </header>
- <body>
- <section id="intro">
- <title>Introduction</title>
- <p>Use the NetUI application template (located at
- <code><BeehiveRoot>/samples/netui-blank</code>) as a
- starting point for building your own NetUI applications.</p>
-
- <note><BeehiveRoot> refers to the top-level directory of your Beehive installation.
- A typical value for <BeehiveRoot> would be <code>/apache/apache-beehive-1.0</code>. </note>
- <p>
- The template contains everything needed in a basic NetUI
- application, except for the runtime and <netui> tag library
- JAR files. This topic explains how to add those JAR files and
- get the template up and running.
- </p>
- </section>
- <section id="using">
- <title>Using the NetUI Web App Template</title>
- <p>The following instruction assume that you have completed all of
- required and optional steps in the Beehive set up procedure at
- <a href="site:../setup">Installation and Setup</a>.</p>
- <p>To use the template, follow these steps:</p>
- <section id="copy_rename">
- <title>Copy and Rename the Template Folder</title>
- <p>Copy the folder
- <code><BeehiveRoot>/samples/netui-blank</code> to your
- development directory. </p>
-
- <p>Below we assume that you have copied <code>netui-blank</code> into the
- folder <strong><code>/myDevelopmentDirectory</code></strong>.</p>
- <source>/myDevelopmentDirectory/netui-blank</source>
- <p>Rename <code>netui-blank</code> to something more
- appropriate to your application. Below we assume that <code>netui-blank</code> has been
- renamed as <strong><code>myWebApplication</code></strong>. </p>
- <source>/myDevelopmentDirectory/myWebApplication</source>
- </section>
- <section id="edit_properties_file"><title>Edit the <code>build.properties</code> File</title>
- <p>In this section you will edit the <code>build.properties</code> file--the file
- that sets the build-related properties for your web application.</p>
- <p>Open the file <code>/myDevelopmentDirectory/myWebApplication/WEB-INF/src/build.properties</code>
- in a text editor.</p>
- <p>Edit the <code>beehive.home</code> property so that it points to the
- top-level folder of your beehive installation.
- </p>
- <p>Edit the <code>context.path</code> property to some value that is appropriate to your
- web application.</p>
- <p> For example, if you beehive installation
- resides at <code>/apache/apache-beehive-1.0</code>, then your <code>build.properties</code> file
- would appear as follows.</p>
- <p><strong>Note:</strong> the value of <code><SomeContext></code> will determine the
- app's URL address.</p>
- <source>beehive.home=<strong>/apache/apache-beehive-1.0</strong>
+ <header>
+ <title>NetUI Project Template</title>
+ </header>
+ <body>
+ <section id="intro">
+ <title>Introduction</title>
+ <p>
+ Use the NetUI application template (located at <code><BeehiveRoot>/samples/netui-blank</code>) as a
+ starting point for building your own NetUI applications.
+ </p>
+ <note>
+ <BeehiveRoot> refers to the top-level directory of your Beehive installation. A typical value for <BeehiveRoot>
+ would be <code>/apache/apache-beehive-1.0</code>.
+ </note>
+ <p>
+ The template contains everything needed in a basic NetUI application, except for the runtime and <netui> tag library
+ JAR files. This topic explains how to add those JAR files and get the template up and running.
+ </p>
+ </section>
+ <section id="using">
+ <title>Using the NetUI Webapp Template</title>
+ <p>
+ The following instruction assume that you have completed all of required and optional steps in the Beehive set up procedure at
+ <a href="site:../setup">Installation and Setup</a>.
+ </p>
+ <p>
+ To use the template, follow these steps:
+ </p>
+ <section id="copy_rename">
+ <title>Copy and Rename the Template Folder</title>
+ <p>
+ Copy the folder <code><BeehiveRoot>/samples/netui-blank</code> to your development directory.
+ </p>
+ <p>
+ Below we assume that you have copied <code>netui-blank</code> into the folder <strong><code>/myDevelopmentDirectory</code></strong>.
+ </p>
+ <source>/myDevelopmentDirectory/netui-blank</source>
+ <p>
+ Rename <code>netui-blank</code> to something more appropriate to your application. Below we assume that <code>netui-blank</code> has been
+ renamed as <strong><code>myWebApplication</code></strong>.
+ </p>
+ <source>/myDevelopmentDirectory/myWebApplication</source>
+ </section>
+ <section id="edit_properties_file"><title>Edit the <code>build.properties</code> File</title>
+ <p>
+ In this section you will edit the <code>build.properties</code> file -- the file that sets the build-related
+ properties for your web application.
+ </p>
+ <p>
+ Open the file <code>/myDevelopmentDirectory/myWebApplication/WEB-INF/src/build.properties</code> in a text editor.
+ </p>
+ <p>
+ Edit the <code>beehive.home</code> property so that it points to the top-level folder of your beehive installation.
+ </p>
+ <p>
+ Edit the <code>context.path</code> property to some value that is appropriate to your web application.
+ </p>
+ <p>
+ For example, if you beehive installation resides at <code>/apache/apache-beehive-1.0</code>, then your
+ <code>build.properties</code> file would appear as follows.
+ </p>
+ <p>
+ <strong>Note:</strong> the value of <code><SomeContext></code> will determine the web application's URL address.
+ </p>
+<source>beehive.home=<strong>/apache/apache-beehive-1.0</strong>
servlet-api.jar=${os.CATALINA_HOME}/common/lib/servlet-api.jar
jsp-api.jar=${os.CATALINA_HOME}/common/lib/jsp-api.jar
context.path=<strong><SomeContext></strong></source>
-<note>Windows users must use forwardslashes (/) not backslashes (\) in the
- <code>build.properties</code> file.</note>
-
- </section>
- <section id="build"><title>Build the Template Web App</title>
- <p>To build the web app, run the following Ant command. This Ant command will delete
- any build artifacts in the <code>classes</code> directory, compile the web application
- source, and archive the result as a WAR file. The WAR file will be saved at
- <code>/myDevelopmentmentDirectory/</code>. The name of the WAR file will
- be <code><SomeContext>.war</code>.</p>
-<source>ant
- -f /myDevelopmentDirectory/myWebApplication/WEB-INF/src/build.xml
- clean
- build
- war
-
-<strong>Copy and Paste version:</strong>
-ant -f /myDevelopmentDirectory/myWebApplication/WEB-INF/src/build.xml clean build war</source>
-</section>
- <section id="deploy_run">
- <title>To Deploy and Run the Template Web App</title>
- <p>Before deploying the application, ensure that Tomcat is turned on.</p>
- <p>On Windows:</p>
- <source>%CATALINA_HOME%\bin\startup.bat</source>
- <p>Everywhere else:</p>
- <source>$CATALINA_HOME/bin/startup.sh</source>
-
- <p>To deploy the web application copy the application WAR file to Tomcat's <code>webapps</code> dir.</p>
- <p>On Windows:</p>
- <source>copy C:\webDevelopementDirectory\<SomeContext>.war %CATALINA_HOME%\webapps</source>
- <p>Everywhere else:</p>
- <source>cp /webDevelopementDirectory/<SomeContext>.war $CATALINA_HOME/webapps</source>
-
- <p>You can now try out the web app by pointing your browser at
- the following link.</p>
- <ul>
- <li>Run the controller class's begin() method:
- http://localhost:8080/<strong><SomeContext></strong>/</li>
- </ul>
- </section>
- </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>
+ <note>
+ Properties files should use the '/' character to separate drive, directory, and file names.
+ </note>
+ </section>
+ <section id="build">
+ <title>Build the Template Web App</title>
+ <p>
+ To build the web app, run the following Ant command. This Ant command will delete any build artifacts in
+ the <code>WEB-INF/classes</code> directory, compile the web application source, and archive the result as a WAR
+ file. The WAR file will be saved at <code>/myDevelopmentmentDirectory/</code>. The name of the WAR file
+ will be <code><SomeContext>.war</code>. The following command should be exuecuted from the web project's
+ WEB-INF/src directory where the Ant build files are stored:
+ </p>
+<source>ant clean build war</source>
+ </section>
+ <section id="deploy_run">
+ <title>To Deploy and Run the Template Web App</title>
+ <p>
+ If you are using Tomcat, the web application can be deployed by copying the built <code>.war</code> file
+ from <code>webDevelopmentDirectory/<SomeContext>.war</code> to Tomcat's <code>webapps</code> directory.
+ </p>
+ <p>
+ If you are using a different Servlet container, follow your container's deployment instructions for deploying
+ a <code>.war</code> web projct arcive.
+ </p>
+ <p>
+ Once the web application is deployed, you can run your web application by accessing the following URL from
+ a browser: http://localhost:8080/<strong><SomeContext></strong>/
+ </p>
+ </section>
+ </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>