jvanzyl 01/05/17 00:30:11
Modified: xdocs getting-started.xml install.xml
j2ee-integration.xml
turbine-documentation-project.xml
xdocs/howto tdk-howto.xml
Log:
- updating the docs to reflect the removal of all the .sh and .bat scripts.
Revision Changes Path
1.13 +9 -7 jakarta-turbine/xdocs/getting-started.xml
Index: getting-started.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine/xdocs/getting-started.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- getting-started.xml 2001/05/13 17:01:48 1.12
+++ getting-started.xml 2001/05/17 07:29:58 1.13
@@ -4,7 +4,8 @@
<properties>
<title>Turbine Getting Started</title>
- <author email="[EMAIL PROTECTED]">Turbine Documentation Team</author>
+ <author email="[EMAIL PROTECTED]">Jon S. Stevens</author>
+ <author email="[EMAIL PROTECTED]">Jason van Zyl</author>
</properties>
<body>
@@ -133,19 +134,20 @@
<section name="Generating the Turbine Javadocs">
<p>
-To generate the Javadocs for Turbine check out Turbine from CVS. The build scripts
for Turbine are in the /jakarta-turbine/build directory. The Ant Target is javadocs,
cd into the build directory and run build.sh or build.bat depending on whether you are
on *nix or Win32;
+To generate the Javadocs for Turbine check out Turbine from CVS,
+cd to the 'build' directory and execute the <strong>javadocs</strong> target:
+
</p>
<source>
- ./build.sh javadocs
-
- or
+
+ cd jakarta-turbine/build
+ ant javadocs
- build.bat javadocs
</source>
<p>
-The javadocs will build to the /jakarta-turbine/docs/apidocs directory.
+The javadocs will be generated in the ../docs/apidocs directory.
</p>
</section>
1.13 +0 -263 jakarta-turbine/xdocs/install.xml
Index: install.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine/xdocs/install.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- install.xml 2001/05/13 05:31:12 1.12
+++ install.xml 2001/05/17 07:30:00 1.13
@@ -9,267 +9,6 @@
<body>
-<section name="Before you Begin">
-
-<p>
-Before reading the rest of this install document, please take a moment
-to read these disclaimers:
-<ul>
-<li>
-Turbine is still under development. Although many parts of Turbine
-may be production-ready, the project as a whole is not, and there is no
-production-ready release of Turbine. If you check out the latest
-Turbine from CVS at any given point, do not expect that it will compile
-or that all members of the framework will function as expected.</li>
-<li>
-Because Turbine is being constantly improved, much of the documentation
-on the site is out-of-sync with what is in CVS. Please be patient with
-us, or join the <a href="http://jakarta.apache.org/site/mail.html";>mailing list</a>
-to learn how to contribute to the documentation.</li>
-<li>
-Please note, Turbine probably won't build or run on MacOS 9 boxes. You
-should use MacOS X or Linux or *BSD on your Apple hardware
-instead.</li>
-</ul>
-</p>
-
-</section>
-
-<section name="Building the Application Structure">
-
-<p>
- The TDK comes with Ant and Ant build scripts to create the core
- directory structures and enough template files to get most
- applications started quickly. The TDK can build two types of
- applications - "simple" for applications not requiring a database
- schema or Object Relational (OR) model, or "peer" for applications
- using the Peer tool for OR.
-</p>
-
-<p>
- You should first check and modify as necessary the newapp.props file
- in the root of the TDK distribution. The turbine.app.name is the
- name that you want your application to have. A servlet context will
- be created with this name, and (if you're using a Peer application),
- a database by this name will be created. The turbine.app.view is
- the template system that will be used for your application. The
- recommended value here is velocity. The turbine.app.type can be
- either simple or peer. The target.package is the package that all
- of your Java classes (all the OR classes, and modules) will go in,
- and the target.directory is the directory structure they will go
- under. This should PROBABLY match the package structure, except
- use '/' as the delimeter.
-</p>
-
-<p>
- Once the newapp.props file has been built, run the newapp script
- in the root of the TDK distribution directory - either newapp.sh on
- Unix, or newapp.bat on Win32. The Ant script will create the
- necessary directory structure and configuration files to get your
- application started. Be sure to read any directions at the end of
- the script processing - especially if you're creating a peer
- application.
-</p>
-
-</section>
-
-<section name="Starting Catalina/Viewing Your Application">
-
-<p>
- Once your application has been created, you should be able to view
- it by changing directories to the root of the TDK distribution and
- running bin\startup.bat on Win32, or bin/startup.sh on Unix.
- Once Catalina has started, point your browser to
- http://SERVERNAME:8080/APPNAME/servlet/APPNAME where SERVERNAME is
- the hostname of the machine running Catalina, and APPNAME is the
- name of the application you created.
-</p>
-
-</section>
-
-<section name="Servlet Container Specifics">
-
-<p>
-<strong>With Apache JServ</strong>
-</p>
-
-<p>
- #1. Specify the path to the necessary packages
-</p>
-
-<p>
- Place the packages that you will not be changing into the wrapper.classpath
- (in jserv.properties). Please see this FAQ entry (line wrapped) for more
- information on determining what will change and what won't change look
- <a
href="http://java.apache.org/jyve-faq/Turbine/screen/DisplayQuestionAnswer/action/SetAll/project_id/1/faq_id/2/topic_id/69/question_id/322";>here</a>.
-</p>
-
-<p>
-Here is an example:
-</p>
-
-<source><![CDATA[
-
-wrapper.classpath=<path to>/ECS.jar
-wrapper.classpath=<path to>/Village.jar
-wrapper.classpath=<path to>/jndi.jar
-wrapper.classpath=<path to>/mail.jar
-wrapper.classpath=<path to>/activation.jar
-
-]]></source>
-
-<p>
- Place the rest of the classes that you will be using, such as your Turbine
- classes into the repositories path that is defined in your zone.properties
- file.
-</p>
-
-<p>
- #2. Run the appropriate SQL script for your database. If a script for your
- specific database is not present, the SQL can easily be adapted. We
- appreciate your contributions here. If your database is not supported by
- the connection pooling code, please subscribe to the mailing list and ask
- for help there. Include the type of database and the driver information in
- your posting.
-</p>
-
-<source><![CDATA[
-
-mysqladmin create turbine
-mysql turbine < tables.schema
-
-]]></source>
-
-<p>
- Please note that the tables.schema file is not actually a single file. The
- various schema files exist in the src/sql/ directory. You will need to choose
the
- appropriate .sql file for your needs according to what database you are using.
- We currently have .sql files for Oracle, MySQL, DB2, Hypersonic,
- Sybase, InstantDB, and Postgres. The ones that are
- the most tested and reliable are the MySQL files because this is our database of
- choice. Contributions for more databases is most appreciated.
-</p>
-
-
-<p>
- #3. Edit TurbineResources.properties file (in the conf directory), define
- your database types and make sure that the database adaptor for your
- database is uncommented, and place this file in a directory accessible to
- your servlet engine.
-</p>
-
-<p>
- #4. Specify an initial parameter named "properties" (without the quotes)
- with the pathname to the TurbineResources.properties file as its value.
- This can be accomplished by placing the following line in your
- [zone].properties file:
-</p>
-
-
-<source><![CDATA[
-
-servlet.Turbine.initArgs=properties=/path/to/TurbineResources.properties
-
-]]></source>
-
-<p>
-<strong>With Tomcat</strong>
-</p>
-
-<p>
- Note that the TDK includes Catalina, which is Tomcat 4.0. All the
- necessary JAR files for Turbine are included in the target
- application when you use the TDK, and this is the recommended method
- of using Tomcat. If you need to deploy a TDK application to another
- Tomcat installation, you should be able to make a WAR file of the
- application and drop it into the webapps directory on the target
- platform.
-</p>
-
-<p>
- The following instructions assume that you have followed the above
- instructions for either source compilation or release distribution. This
- also assumes that you have working Tomcat installation which can be
- found <a href="http://jakarta.apache.org/tomcat";>here</a>.
-</p>
-
-<p>
-<ul>
- <li>
- TOMCAT_HOME=/path/to/tomcat</li>
-
- <li>
- Put all necessary Turbine-related jars (Turbine, ECS, Village,
- JNDI) into $TOMCAT_HOME/lib.</li>
-
- <li>
- Add the path to the jars to the existing Tomcat CLASSPATH found in
- $TOMCAT_HOME/bin/tomcat.sh</li>
-
- <li>
- Make necessary adjustments to TurbineResources.properties and copy into
- $TOMCAT_HOME/webapps/YOUR_APP_CONTEXT/WEB-INF/conf</li>
-
- <li>
- Add the following xml to
$TOMCAT_HOME/$TOMCAT_HOME/webapps/YOUR_APP_CONTEXT/WEB-INF/web.xml. It
- will be a child of the web-app element.</li>
-</ul>
-</p>
-
-<source><![CDATA[
-
-<servlet>
- <servlet-name>Turbine</servlet-name>
- <servlet-class>org.apache.turbine.Turbine</servlet-class>
- <init-param>
- <param-name>properties</param-name>
- <param-value>WEB-INF/conf/TurbineResources.properties</param-value>
- </init-param>
- </servlet>
-]]>
-</source>
-
-<p>
-<ul>
- <li>
- Restart Tomcat.</li>
-</ul>
-</p>
-
-</section>
-
-
-<section name="Testing Your Installation">
-
-<p>
-The following examples assume your servlet zone is configured at
-http://your.host.com/servlets. If this is not the case, please substitute your
-zone name for /servlets (Tomcat uses /servlet for its default servlet zone).
-</p>
-
-<ul>
-
- <li>
- Point your web browser at http://your.host.com/servlets/Turbine</li>
-
- <li>
- Login using username 'turbine' and password 'turbine'</li>
-
- <li>
- You should see a Welcome screen with basic request information.</li>
-</ul>
-
-<p>
-If you have problems or receive exceptions when following these steps, please
-subscribe to the mailing list and ask for help. Be sure to include the
-specific steps you followed, where the error occurred, and what the exact text
-of the error message is.
-</p>
-
-</section>
-
-
-
<section name="Ant Tasks available in build.xml">
<p>
@@ -309,8 +48,6 @@
</p>
</section>
-
-
</body>
</document>
1.4 +37 -13 jakarta-turbine/xdocs/j2ee-integration.xml
Index: j2ee-integration.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine/xdocs/j2ee-integration.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- j2ee-integration.xml 2001/04/11 01:58:01 1.3
+++ j2ee-integration.xml 2001/05/17 07:30:01 1.4
@@ -24,15 +24,17 @@
isn't that cool?
</p>
-<p><strong>What is J2EE?</strong></p>
+<subsection name="What is J2EE?">
<p>
Many Java technology extensions, including - Servlets, EJB, Swing, JMS,
Transactions, JNDI, XML, JDBC, JSP, Security
</p>
-<p><strong>How does Turbine work with ... Servlets?</strong></p>
+</subsection>
+<subsection name="How does Turbine work with ... Servlets?">
+
<p>
It is a servlet. It is also a set of re-usable components assembled into
a framework. You can choose to work with just the Servlet, you can
@@ -43,8 +45,10 @@
done as well, however we have done it in such a way that it is very
pluggable. Mix and match and use what you want to use. Ignore the rest.
</p>
+
+</subsection>
-<p><strong>How does Turbine work with ... EJB?</strong></p>
+<subsection name="How does Turbine work with ... EJB?">
<p>
Turbine provides a framework for developing web applications -
@@ -52,15 +56,19 @@
n-tier applications - specifically the back ends - thus Turbine and EJB
complement each other well at that level.
</p>
+
+</subsection>
-<p><strong>How does Turbine work with ... Swing?</strong></p>
+<subsection name="How does Turbine work with ... Swing?">
<p>
Turbine is the for the web - Swing is not - not applicable.
</p>
-<p><strong>How does Turbine work with ... JMS?</strong></p>
+</subsection>
+<subsection name="How does Turbine work with ... JMS?">
+
<p>
Turbine provides facilities for plugging in other Services - and thus
JMS could be plugged in as a service to that. Even if it isn't plugged
@@ -68,15 +76,19 @@
related methods into your code. Turbine doesn't prevent you from calling
other Java code.
</p>
+
+</subsection>
-<p><strong>How does Turbine work with ... Transactions?</strong></p>
+<subsection name="How does Turbine work with ... Transactions?">
<p>
There is nothing in Turbine explicitly using the JTS/JTA - but can use
EJB and hence these technologies. That belongs in EJB's anyways. :-)
</p>
+
+</subsection>
-<p><strong>How does Turbine work with ... JNDI?</strong></p>
+<subsection name="How does Turbine work with ... JNDI?">
<p>
Turbine provides access to JNDI via a Service facility. You can always
@@ -85,28 +97,34 @@
from using it).
</p>
-<p><strong>How does Turbine work with ... XML?</strong></p>
+</subsection>
+<subsection name="How does Turbine work with ... XML?">
+
<p>
Turbine provides support for using and working with XML. Again, nothing
preventing you from using XML within Turbine or even sending XML out
of Turbine.
</p>
+
+</subsection>
-<p><strong>How does Turbine work with ... JDBC?</strong></p>
+<subsection name="How does Turbine work with ... JDBC?">
<p>
Turbine provides good support for working with JDBC through the <a
href="http://share.whichever.com/village/";>Village API</a>, the <a
-href="torque.html">Torque Object Relational Tool</a> and its connection
+href="howto/torque-howto.html">Torque Object Relational Tool</a> and its connection
pooling facilities. The connection pool is not yet fully J2EE
"compatible" in that it does not support DataSources. However, at some
point we may choose to implement that. Note, again, Turbine does not
prevent you from using your own Connection pooling mechanism, we simply
created one because at the time, we needed one and ours works just fine.
</p>
+
+</subsection>
-<p><strong>How does Turbine work with ... JSP?</strong></p>
+<subsection name="How does Turbine work with ... JSP?">
<p>
Turbine provides excellent support for using JSP in its model of working
@@ -116,8 +134,10 @@
suggest</a> that you do not use JSP and seek out other alternatives.
</p>
-<p><strong>How does Turbine work with ... Security?</strong></p>
+</subsection>
+<subsection name="How does Turbine work with ... Security?">
+
<p>
Turbine was created long before J2EE was created. Therefore, we needed
to implement our own Security Model. This model is based on Users,
@@ -127,8 +147,10 @@
pattern and you can use Turbine's code as the basis for any additional
security your application requires.
</p>
+
+</subsection>
-<p><strong>How does Turbine work with ... container managed security?</strong></p>
+<subsection name="How does Turbine work with ... container managed security?">
<p>
You can use container managed security if you wish, and Turbine provides you with
@@ -164,6 +186,8 @@
getUserPrincipal</code> and <code>isUserInRole</code> methods.
above.
</p>
+
+</subsection>
</section>
1.7 +6 -45 jakarta-turbine/xdocs/turbine-documentation-project.xml
Index: turbine-documentation-project.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine/xdocs/turbine-documentation-project.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- turbine-documentation-project.xml 2001/05/08 19:47:14 1.6
+++ turbine-documentation-project.xml 2001/05/17 07:30:02 1.7
@@ -26,9 +26,6 @@
</section>
-
-
-
<section name="What Can I do to Contribute?">
<p>
@@ -91,10 +88,6 @@
</section>
-
-
-
-
<section name="Website Documentation">
<p>
@@ -105,9 +98,6 @@
</section>
-
-
-
<section name="Turbine and TDK Feature Documentation">
<p>
@@ -117,9 +107,6 @@
</section>
-
-
-
<section name="Turbine and TDK Internal Workings Documentation">
<p>
@@ -129,9 +116,6 @@
</section>
-
-
-
<section name="Turbine and TDK Tutorials">
<p>
@@ -142,9 +126,6 @@
</section>
-
-
-
<section name="Filtering Mailing Lists">
<p>
@@ -155,10 +136,6 @@
</section>
-
-
-
-
<section name="Javadocing Source Code">
<p>
@@ -169,10 +146,6 @@
</section>
-
-
-
-
<section name="Getting Started">
<p>
@@ -190,10 +163,6 @@
</section>
-
-
-
-
<section name="Building the Docs">
<p>
@@ -202,20 +171,15 @@
<p>
To check that the xml document you have built is validated, run it through the
-build process. To do this cd to the build directory and run for Win32;
+build process. To do this cd to the build directory and execute the
+<strong>docs</strong> target:
</p>
-<p>
-<ul> build docs </ul>
-</p>
-
-<p>
-and for Unix;
-</p>
+<source><![CDATA[
-<p>
-<ul> ./build.sh docs </ul>
-</p>
+ ant docs
+
+]]></source>
<p>
This will transform all the XML files in the /jakarta-turbine/xdocs directory to
@@ -242,9 +206,6 @@
</p>
</section>
-
-
-
</body>
</document>
1.10 +6 -8 jakarta-turbine/xdocs/howto/tdk-howto.xml
Index: tdk-howto.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine/xdocs/howto/tdk-howto.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- tdk-howto.xml 2001/05/17 06:56:37 1.9
+++ tdk-howto.xml 2001/05/17 07:30:08 1.10
@@ -175,18 +175,16 @@
<p>
-3. Run the newapp script located in the root directory of the TDK installation.
-This script should be run with the name of your turbine app appended to it. For
-example:
+3. Run Ant in the root directory of the TDK installation. The sample
+application will be generated with the default name of
+<strong>newapp</strong>. If you wish to change the name of the default
+sample app then you must change the <strong>turbine.app.name</strong>
+property in the <strong>build.properties</strong> file.
</p>
<source><![CDATA[
-./build.sh
-
-or
-
-ant (If you have a correctly configured Ant installation)
+ant
]]></source>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
