User: tobias
Date: 01/03/11 17:57:30
Modified: business doco.html
Log:
Now reflects the (new) various flavors of documentation available.
Revision Changes Path
1.13 +43 -122 newsite/business/doco.html
Index: doco.html
===================================================================
RCS file: /products/cvs/ejboss/newsite/business/doco.html,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- doco.html 2001/02/16 00:38:09 1.12
+++ doco.html 2001/03/12 01:57:30 1.13
@@ -15,131 +15,52 @@
<td
class="pageheader"><b>Documentation</b></td>
</tr>
<tr>
- <td class="newsheader"><b>The
new documentation format</b></td>
+ <td class="newsheader"><b>The
manual</b></td>
</tr>
<tr>
- <td class="newsbody"><font
face="Myriad Web,Arial">All the documentation is going to be restructured and moved to
a new XML base format: DocBook. We are still in the process of getting everything
done, but you already can start using the documentation in the new format (thanks to
Vladimir) with the
-<center><b><a href="../documentation/HTML/index.html"> new JBoss
manual</a></b>.</center> We would be happy to get feedback from you.</font></td>
- </tr>
- <tr><td><b>
-<hr><font face="Myriad Web,Arial">The following content is already included in the
new JBoss manual mentioned above. For the time of the ongoing converting process these
documents will stay online.</font><hr>
-</td></tr>
- <tr>
- <td
class="newsheader"><b>Getting Started</b></td>
- </tr>
- <tr>
- <td class="newsbody"><font
face="Myriad Web,Arial">These manuals are intended to help you get started to jboss.
They cover the installation the basic configuration and all you need to know in order
to get quickly going with our product suite.</font>
- <p><a
href="../documentation/jboss_linux_trail_index.html"><font face="Myriad
Web,Arial">Beginning EJB programming using JBoss (Linux)</font></a></p>
- <p><a
href="../documentation/jboss_win32_trail_index.html"><font face="Myriad
Web,Arial">Beginning EJB programming using JBoss (Windows)</font></a></td>
- </tr>
- <tr>
- <td class="newsheader"><b>User
Manual (preliminary)</b></td>
- </tr>
- <tr>
- <td class="newsbody"><font
face="Myriad Web,Arial">The jboss "User Manual" tries to manage all the
flow of information surrounding jboss. It is a collection of all the information
covered above. It is a collaborative effort started by Aaron Mulder, if you can help
please do so. </font>
- <p><a
href="../manual/index.html"><font face="Myriad Web,Arial">JBoss 2.0 Manual
(<b>PRELIMINARY</b>)</font></a></p>
- <p><font face="Myriad
Web,Arial">If you plan on helping with any of the documentation please read the
following</font></p>
- <p><font face="Myriad
Web,Arial"><a href="../documentation/DOCUMENTATION_STANDARDS.html">Guidelines for
Documentation writing</a></font></td>
- </tr>
- <tr>
- <td
class="newsheader"><b>Advanced Topics</b></td>
- </tr>
- <tr>
- <td class="newsbody"><font
face="Myriad Web,Arial">These manuals are intended to cover advanced jboss topics.
These are to used only if you already are familiar with the basic operation of the
jboss suite of products. Here you will find details on the advanced usages of
jboss.</font>
- <p><a
href="../documentation/jbossxml_howto.html"><font face="Myriad Web,Arial">Using
jboss.xml for advanced configurations (JNDI override, ejb-ref, Container
conf)</font></a></p>
- <p><a
href="../documentation/jboss_cmp_trail_index.html"><font face="Myriad Web,Arial">Using
container-managed persistence with JBoss</font></a></p>
- <p><a
href="../documentation/jawsxml_howto.html"><font face="Myriad Web,Arial">Customizing
JAWS</font></a></p>
+ <td class="newsbody"><font
face="Myriad Web,Arial">
+<p>The manual contains all the documentation a user needs to install,
+configure and run JBoss. It also includes a quick start section and
+helps you to make your first steps with JBoss. We offer it in
+different flavors, make your choice please:</p>
+<ul>
+<li><a href="../documentation/HTML/index.html">
+Manual - online HTML version</a> :
+Nice layout, chunked into small, fast loading pages.</li>
+<li><a href="../documentation/compressed/JBoss-Manual-HTML.zip">
+Manual - HTML version ZIP file</a> :
+the online version zipped into one archive for download and local install.</li>
+<li><a href="../documentation/HTML/jbossdocs.html">
+Manual - all in one HTML page</a> :
+very simple layout for download or print-out. Just one, very long HTML page.</li>
+<li><a href="../business/cvs.html">
+Manual - CVS module for contributors</a> :
+Our environment for developing new documentation can be obtained from the
+CVS. You need to checkout the module "manual".</li>
+</ul>
+Last updated: 2001/03/12, for JBoss versions: 2.0 FINAL (partly PRE2.1 included)
+</font></td>
+ </tr>
+ <tr>
+ <td class="newsheader"><b>The
files</b></td>
+ </tr>
+ <tr>
+ <td class="newsbody"><font
face="Myriad Web,Arial"><p>From time to time the manual mentions that you can download
a file which may contain some source code, preconfigured packages or examples. Get the
name of the file you want to download from the manual and select it from the following
link:</p>
+<p><a href="../documentation/files/">Download files mentioned in the manual.</a></p>
+</font></td>
+ </tr>
+ <tr>
+ <td
class="newsheader"><b>Todo: Documents to include</b></td>
+ </tr>
+ <tr>
+ <td class="newsbody"><font
face="Myriad Web,Arial">The following files have not yet been included into the
manual. If you want to help to include them, join the jboss-docs mailinglist and get
further directions there.
+</font>
+<font face="Myriad Web,Arial"><ul>
+<li><a href="../documentation/HowTo-JAWS-UseCustomFinders.html">custom finders with
JAWS CMP for EJB 1.1</a></li>
+<li><a href="../documentation/HowTo-JAWS-JoinQueries.html">join queries with JAWS
CMP for EJB 1.1</a></li>
+<li><a href="../documentation/petstore-1.1.1-01.html">Deploying Pet Store
1.1.1</a></li>
+</ul></font>
</td>
- </tr>
- <tr>
- <td
class="newsheader"><b>How-To</b></td>
- </tr>
- <tr>
- <td class="newsbody">
- <table>
- <tr>
- <th width="70%">Name</th>
- <th width="10%">Version</th>
- <th width="20%">Last Upd.</th>
- </tr>
- <tr>
- <td><a href="../documentation/tomcat.htm"><font
face="Myriad Web,Arial">Tomcat + JBoss (EJB,JSP, & Servlet) Howto</font></a></td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td><a
href="../documentation/oraclecmp.htm"><font face="Myriad Web,Arial">CMP with ORACLE
Howto</font></a></td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td><a
href="../documentation/mssql.htm"><font face="Myriad Web,Arial">MS SQL Server
(includes JDBC-ODBC) Howto</font></a></td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td><a
href="../documentation/jbuilder.htm"><font face="Myriad Web,Arial">Run JBoss and debug
EJBs in JBuilder's Debugger Howto</font></a> (<a
href="../documentation/jbuilder4.htm"><font face="Myriad Web,Arial">JBuilder 4
Update</font></a>)</td>
- <td>1.0</td>
- <td>12/15/2000</td>
- </tr>
- <tr>
- <td><a
href="../documentation/postgres.htm"><font face="Myriad Web,Arial">CMP with PostgreSQL
Howto</font></a></td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td><a
href="../documentation/rmh_howto.html"><font face="Myriad Web,Arial">RMH (run the
examples) Howto</font></a></td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td><a
href="../documentation/JMX.Connector.Howto.html"><font face="Myriad Web,Arial">JMX
Connector Howto</font></a></td>
- <td></td>
- <td></td>
- </tr>
- <tr>
- <td><a
href="../documentation/JMX.Timer.HowTo.html"><font face="Myriad Web,Arial">JMX Timer
HowTo</font></td>
- <td>1.0</td>
- <td>12/7/2000</td>
- </tr>
- <tr>
- <td><a
href="../documentation/JMX.ExternalContext.HowTo.html"><font face="Myriad
Web,Arial">JMX External JNDI Context and JNDIView HowTo</font></td>
- <td>1.0</td>
- <td>1/13/2001</td>
- </tr>
- <tr>
- <td><a
href="../documentation/EJX.HowTo.Index.html"><font face="Myriad Web,Arial">EJX HowTo
Index</font></a></td>
- <td>1.0</td>
- <td>12/1/2000</td>
- </tr>
- <tr>
- <td><a
href="../documentation/J2eeDeployment_howto.html"><font face="Myriad
Web,Arial">J2eeDeployment HowTo: Introduction</font></td>
- <td></td>
- <td></td>
- </tr>
- <tr><td><b>For version PRE2.1 or later only (get
sources from cvs or snapshot):</b></td></tr>
- <tr>
- <td><a
href="../documentation/HowTo.Security.html"><font face="Myriad Web,Arial">JAAS Based
Security in JBoss</font></td>
- <td></td>
- <td>1/21/2001</td>
- </tr>
- <tr>
- <td><a
href="../documentation/HowTo-JavaMail.html"><font face="Myriad Web,Arial">Using
JavaMail in JBoss</font></td>
- <td></td>
- <td>1/21/2001</td>
- </tr>
- <tr>
- <td><a
href="../documentation/jca_config.html"><font face="Myriad Web,Arial">JBossCX
Configuration</font></td>
- <td></td>
- <td>2/06/2001</td>
- </tr>
- <tr>
- <td><a
href="../documentation/petstore-1.1.1-01.html"><font face="Myriad Web,Arial">Deploying
Pet Store 1.1.1</font></td>
- <td></td>
- <td>2/15/2001</td>
- </tr>
- </table>
- </td>
</tr>
<tr>
<td
class="newsheader"><b>Container developer documentation</b></td>