I wanted to add some info to the beggining of the getting_started.html
doc about the javadocs parameter for build-turbine. The opening
paragraph would read like so:
######################################
The purpose of this document is to define simple documentation on
getting started with Turbine. For information about the overall
structure of Turbine, please refer to the Functional Specification
Document (FSD) as well as the other documentation that is available.The
composition of this document will be written from the perspective of
what you should do in order to start a newly functional system.
The first thing that you should do is download and install Turbine into
your servlet engine. This step is documented in the INSTALL document, so
I will not cover that here. If you would like to view the detailed API
documentation run "build-turbine.bat javadoc" (for Win32 users) or the
"build-turbine.sh javadoc" (for Unix users) from the "build" directory.
This will create a full set of Turbine API docs in the "doc/apidocs"
directory.
###############################################
Anyone have any problems with the following patch?
*************** Begin Patch *****************
Index: turbine/docs/getting_started.html
===================================================================
RCS file: /products/cvs/turbine/turbine/docs/getting_started.html,v
retrieving revision 1.12
diff -u -r1.12 getting_started.html
--- turbine/docs/getting_started.html 2000/06/28 21:00:52 1.12
+++ turbine/docs/getting_started.html 2000/07/06 20:11:52
@@ -21,10 +21,14 @@
please refer to the <a href="fsd.html">Functional Specification
Document
(FSD)</a> as well as the other <a href="index.html">documentation</a>
that
is available.The composition of this document will be written from the
-perspective of what I would do in order to start a newly functional
system.
-<p>The first thing that I would do is I would download and install
Turbine
-into my servlet engine. This step is documented in the <a
href="install.txt">INSTALL</a>
-document, so I will not cover that here.
+perspective of what you should do in order to start a newly functional
system.
+<p>The first thing that you should do is download and install Turbine
+into your servlet engine. This step is documented in the <a
href="install.txt">INSTALL</a>
+document, so I will not cover that here. If you would like to view the
detailed API documentation
+run "build-turbine.bat javadocs" (for Win32 users) or the
"build-turbine.sh javadocs" (for Unix users)
+from the "build" directory. This will create a full set of Turbine API
docs in the
+"doc/apidocs" directory.
+
<p><b><font size=+1>Package Structure</font></b>
<p>Once you have Turbine installed, you should then setup a package
structure
for your project that is independent of the Turbine package
structure.
*************** End Patch ********************
--
********************************
** John Thorhauer
** [EMAIL PROTECTED]
********************************
------------------------------------------------------------
To subscribe: [EMAIL PROTECTED]
To unsubscribe: [EMAIL PROTECTED]
Search: <http://www.mail-archive.com/turbine%40list.working-dogs.com/>
Problems?: [EMAIL PROTECTED]
