myfaces-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mmarinsc...@apache.org
Subject svn commit: r396608 - /myfaces/site/trunk/src/site/xdoc/gettingstarted.xml
Date Mon, 24 Apr 2006 17:11:49 GMT
Author: mmarinschek
Date: Mon Apr 24 10:11:43 2006
New Revision: 396608

URL: http://svn.apache.org/viewcvs?rev=396608&view=rev
Log:
fixed getting started instructions for new release

Modified:
    myfaces/site/trunk/src/site/xdoc/gettingstarted.xml

Modified: myfaces/site/trunk/src/site/xdoc/gettingstarted.xml
URL: http://svn.apache.org/viewcvs/myfaces/site/trunk/src/site/xdoc/gettingstarted.xml?rev=396608&r1=396607&r2=396608&view=diff
==============================================================================
--- myfaces/site/trunk/src/site/xdoc/gettingstarted.xml (original)
+++ myfaces/site/trunk/src/site/xdoc/gettingstarted.xml Mon Apr 24 10:11:43 2006
@@ -23,7 +23,7 @@
     
     <ul>
 		<li>Tomcat 5.x. Download <a href="http://jakarta.apache.org/tomcat/index.html">here</a>.</li>
-		<li>MyFaces examples. Latest milestone webapp archive (myfaces-X.X.X-app.zip or myfaces-X.X.X-app.tgz)
is <a href="http://myfaces.apache.org/download.html">here</a>.</li>
+		<li>MyFaces examples. Latest milestone webapp archive (myfaces-X.X.X-examples.zip
or myfaces-X.X.X-examples.tgz) is <a href="http://myfaces.apache.org/download.html">here</a>.</li>
     </ul>
 </section>
 
@@ -31,11 +31,11 @@
 <section name="Installing and Running the Examples">
 	
 	<ul>
-		<li>Unpack the MyFaces examples archive myfaces-X.X.X-app.zip (or myfaces-X.X.X-app.tgz)
to a directory of your choice.</li>
+		<li>Unpack the MyFaces examples archive myfaces-X.X.X-examples.zip (or myfaces-X.X.X-examples.tgz)
to a directory of your choice.</li>
 		<li>Remove any previous MyFaces webapps from your Tomcat installation and clean up
your Tomcat work dir. Also make sure that there is no jsf-api.jar or jsf-impl.jar (i.e. Suns
API and implementation) in the classpath or in one of Tomcat's lib directories (common/lib
or shared/lib).</li>
-		<li>Copy the file myfaces-examples.war to the webapps dir of your Tomcat installation
directory - and check once more that there is no old myfaces-examples directory there ;-)</li>
+		<li>Copy the file simple.war (or any of the other example war-files) to the webapps
dir of your Tomcat installation directory - and check once more that there is no old myfaces-examples
directory there ;-)</li>
 		<li>Start Tomcat, if its not already running.</li>
-		<li> Start your browser and enjoy it at <a href="http://localhost:8080/myfaces-examples">http://localhost:8080/myfaces-examples</a></li>
+		<li> Start your browser and enjoy it at <a href="http://localhost:8080/myfaces-examples">http://localhost:8080/simple</a></li>
 	</ul>
 </section>
 
@@ -47,83 +47,49 @@
 </section>
 
 <section name="Using MyFaces in your own web application">
-	
-	<ul>
-		<li>Look at the <a href="compatibility.html">compatibility list</a> to
find out if your servlet container is supported.</li>
-		<li>Download the latest <a href="http://myfaces.apache.org/download.html">MyFaces
binary</a> release.</li>
-		<li>Copy these jar files from the <code>$MYFACES/lib</code> directory
to the <code>WEB-INF/lib</code> dir of your <code>.war</code> file.
-		  <table>
-		    <tr>
-		      <th colspan="1" rowspan="1">Jar File</th><th colspan="1" rowspan="1">Notes</th>
-		    </tr>
-		    <tr>
-		      <td colspan="1" rowspan="1">commons-beanutils-1.6.1.jar</td><td colspan="1"
rowspan="1"/>
-		    </tr>
-		    <tr>
-		      <td colspan="1" rowspan="1">commons-codec-1.2.jar</td><td colspan="1"
rowspan="1"/>
-		    </tr>
-		    <tr>
-		      <td colspan="1" rowspan="1">commons-collections-3.0.jar</td><td colspan="1"
rowspan="1"/>
-		    </tr>
-		    <tr>
-		      <td colspan="1" rowspan="1">commons-digester-1.5.jar</td><td colspan="1"
rowspan="1"/>
-		    </tr>
-		    <tr>
-		      <td colspan="1" rowspan="1">commons-el.jar</td><td colspan="1" rowspan="1"/>
-		    </tr>
-		    <tr>
-		      <td colspan="1" rowspan="1">commons-fileupload-1.0.jar</td><td colspan="1"
rowspan="1">Required only if you are uploading files</td>
-		    </tr>
-		    <tr>
-		      <td colspan="1" rowspan="1">commons-validator.jar</td><td colspan="1"
rowspan="1"/>
-		    </tr>
-		    <tr>
-		      <td colspan="1" rowspan="1">commons-lang-2.1.jar</td><td colspan="1"
rowspan="1"/>
-		    </tr>
-		    <tr>
-		      <td colspan="1" rowspan="1">jakarta-oro.jar</td><td colspan="1" rowspan="1"/>
-		    </tr>
-		    <tr>
-		      <td colspan="1" rowspan="1">jstl.jar</td><td colspan="1" rowspan="1"/>
-		    </tr>
-		    <tr>
-		      <td colspan="1" rowspan="1">log4j-1.2.8.jar</td><td colspan="1" rowspan="1">Required
only if you have commons-logging configured to use log4j</td>
-		    </tr>
-		    <tr>
-		      <td colspan="1" rowspan="1">myfaces-api.jar</td><td colspan="1" rowspan="1"/>
-		    </tr>
-		    <tr>
-  		      <td colspan="1" rowspan="1">myfaces-impl.jar</td><td colspan="1"
rowspan="1"/>
-		    </tr>
-		    <tr>
-		      <td colspan="1" rowspan="1">portlet-api-1.0.jar</td><td colspan="1"
rowspan="1">Required only if you are doing portlets</td>
-		    </tr>
-		    <tr>
-		      <td colspan="1" rowspan="1">struts.jar</td><td colspan="1" rowspan="1">Required
only if you are doing tiles work, will change to the tile.jar file once tiles is pulled from
struts.</td>
-		    </tr>
-		    <tr>
-		      <td colspan="1" rowspan="1">tomahawk.jar</td><td colspan="1" rowspan="1">If
you like to use our extensions.</td>
-		    </tr>
-		    <tr>
-		      <td colspan="1" rowspan="1">myfaces-all.jar</td><td colspan="1" rowspan="1">Contains
the content of myfaces-api, myfaces-impl and tomahawk if you want to use everything this might
be a more convienent option for you</td>
-		    </tr>
-		  </table>
-		</li>
-		<li>If you are using a JSP 1.2 container like Tomcat 4 you must also copy the file
jsp-2.0.jar to your WEB-INF/lib dir, you may not do this for Tomcat 5.5.x. If you get problems
with blank pages on startup, please make sure that neither jsp-2.0.jar nor commons-el.jar
is in your WEB-INF/lib directory.</li>
-		<li>Make sure that there is no jsf-api.jar (i.e. Suns API implementation) in the
classpath or in one of your container's shared lib directories (e.g. common/lib or shared/lib
for Tomcat).</li>
-		<li>Configure your webapp's web.xml file (see conf/web.xml for example and documentation)</li>
-		<li>Add the following lines to your JSPs:</li>
-		<ul>
-			<li><source xml:space="preserve">&lt;%@ taglib uri="http://java.sun.com/jsf/html"
prefix="h"%&gt;</source></li>
-			<li><source xml:space="preserve">&lt;%@ taglib uri="http://java.sun.com/jsf/core"
prefix="f"%&gt;</source></li>
-		</ul>
-    </ul>
+
+    <p>
+        Suggested step:
+        <ul>
+            <li>Look at the <a href="compatibility.html">compatibility list</a>
to find out if your servlet container is supported.</li>
+        </ul>
+    </p>
+    <p>
+        There are two possible ways to start off with MyFaces, one is to start from the example-app:
+        <ul>
+            <li>If you want to have it simple, take the myfaces-X.X.X-examples.zip
you downloaded before for looking at the examples, and extract the blank.war file (<a href="http://myfaces.apache.org/download.html">MyFaces
binary</a>)</li>
+            <li>Rename the blank.war file to blank.zip, and extract this file - you
have a working directory structure for a MyFaces application at hand after this step.</li>
+        </ul>
+    </p>
+    <p>
+        The second possibility is to download the core implementation and/or tomahawk (dependent
on if you want to use the RI and the tomahawk components, or only MyFaces), and start from
there:
+        <ul>
+            <li>Alternatively, download the latest <a href="http://myfaces.apache.org/download.html">MyFaces
binary</a> release. You can download only the implementation (aka core) or the implementation
and tomahawk.</li>
+            <li>Copy all *.jar files into your WEB-INF/lib directory. Some of the jar-files
are optional, you can find more info on: <a
+            href="http://myfaces.apache.org/impl/dependencies.html">http://myfaces.apache.org/impl/dependencies.html</a>
and <a
+            href="http://myfaces.apache.org/tomahawk/dependencies.html">http://myfaces.apache.org/impl/dependencies.html</a></li>
+        </ul>
+    </p>
+
+    <p>
+        After you have downloaded the necessary packages and setup your project hierarchy,
do this:
+
+        <ul>
+            <li>Make sure that there is no jsf-api.jar (i.e. Suns API implementation)
in the classpath or in one of your container's shared lib directories (e.g. common/lib or
shared/lib for Tomcat).</li>
+            <li>Configure your webapp's web.xml file (see conf/web.xml for example
and documentation)</li>
+            <li>Add the following lines to your JSPs:</li>
+            <ul>
+                <li><source xml:space="preserve">&lt;%@ taglib uri="http://java.sun.com/jsf/html"
prefix="h"%&gt;</source></li>
+                <li><source xml:space="preserve">&lt;%@ taglib uri="http://java.sun.com/jsf/core"
prefix="f"%&gt;</source></li>
+            </ul>
+        </ul>
+    </p>
 </section>
 
 <section name="Using the MyFaces extensions (aka Tomahawk) in your own web application">
 
 <ul>
-    <li>If you don't use the MyFaces implementation, you will need to add the file
tomahawk.jar to your web-app directory.</li>
+    <li>If you don't use the MyFaces implementation, you will need to add the file
tomahawk.jar and its dependencies (see above) to your web-app directory.</li>
     <li> To be able to use the MyFaces extensions (aka Tomahawk) add the following
line to your JSPs:</li>
     <ul>
         <li><source xml:space="preserve">&lt;%@ taglib uri="http://myfaces.apache.org/tomahawk"
prefix="t"%&gt;</source></li>



Mime
View raw message