You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by sk...@apache.org on 2008/01/03 21:01:48 UTC
svn commit: r608611 - in /myfaces/core/trunk/src/site: fml/ fml/faq.fml
site.xml xdoc/ xdoc/gettingstarted.xml xdoc/javadoc.xml xdoc/risamples.xml
xdoc/tomcat.xml
Author: skitching
Date: Thu Jan 3 12:01:46 2008
New Revision: 608611
URL: http://svn.apache.org/viewvc?rev=608611&view=rev
Log:
Move docs related to core-1.1 into core-1.1 project.
Added:
myfaces/core/trunk/src/site/fml/
myfaces/core/trunk/src/site/fml/faq.fml
myfaces/core/trunk/src/site/xdoc/
myfaces/core/trunk/src/site/xdoc/gettingstarted.xml (with props)
myfaces/core/trunk/src/site/xdoc/javadoc.xml (with props)
myfaces/core/trunk/src/site/xdoc/risamples.xml (with props)
myfaces/core/trunk/src/site/xdoc/tomcat.xml (with props)
Modified:
myfaces/core/trunk/src/site/site.xml
Added: myfaces/core/trunk/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/src/site/fml/faq.fml?rev=608611&view=auto
==============================================================================
--- myfaces/core/trunk/src/site/fml/faq.fml (added)
+++ myfaces/core/trunk/src/site/fml/faq.fml Thu Jan 3 12:01:46 2008
@@ -0,0 +1,38 @@
+<?xml version="1.0"?>
+<faqs id="Frequently Asked Questions">
+ <part id="General">
+ <faq id="1">
+ <question>What is MyFaces?</question>
+ <answer>
+ <p>
+ MyFaces is a Open Source Implementation of the JavaServer Faces Framework.
+ See the <a href="http://jcp.org/en/jsr/detail?id=127">JSR 127</a> and
+ <a href="http://jcp.org/en/jsr/detail?id=252">JSR 252</a>for more info.
+ </p>
+ </answer>
+ </faq>
+ <faq id="2">
+ <question>Does MyFaces work with Tomcat 5.5?</question>
+ <answer>
+ <p>
+ Yes, Apache MyFaces works with Tomcat5.5.
+ If you see a blank page in your browser, try to remove the JAR files
+ <code>jsp-2.0.jar</code> and <code>commons-el.jar</code> of the
+ folder <code>WEB-INF/lib</code>.
+ </p>
+ </answer>
+ </faq>
+ <faq id="3">
+ <question>Can I use MyFaces extensions (aka Tomahawk) with the JSF RI?</question>
+ <answer>
+ <p>
+ Yes, most of the Apache MyFaces extensions work with JSF RI. Follow the
+ instructions in the section "Using the MyFaces extensions (aka Tomahawk)
+ in your own web application" under
+ <a href="http://myfaces.apache.org/gettingstarted.html">http://myfaces.apache.org/gettingstarted.html</a>.
+ If you notice problems please submit a ticket on <a href="issue.html">JIRA</a>.
+ </p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
Modified: myfaces/core/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/src/site/site.xml?rev=608611&r1=608610&r2=608611&view=diff
==============================================================================
--- myfaces/core/trunk/src/site/site.xml (original)
+++ myfaces/core/trunk/src/site/site.xml Thu Jan 3 12:01:46 2008
@@ -73,6 +73,14 @@
<item name="Portlet Bridge" href="http://myfaces.apache.org/portlet-bridge/index.html"/>
</menu>
+ <menu name="Documentation" inherit="top">
+ <item name="Getting Started" href="gettingstarted.html"/>
+ <item name="MyFaces and RI" href="risamples.html"/>
+ <item name="Tomcat Config" href="tomcat.html"/>
+ <item name="Javadocs" href="javadoc.html"/>
+ <item name="FAQ" href="faq.html"/>
+ </menu>
+
<menu ref="reports" inherit="top"/>
<menu name="Foundation" inherit="top">
Added: myfaces/core/trunk/src/site/xdoc/gettingstarted.xml
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/src/site/xdoc/gettingstarted.xml?rev=608611&view=auto
==============================================================================
--- myfaces/core/trunk/src/site/xdoc/gettingstarted.xml (added)
+++ myfaces/core/trunk/src/site/xdoc/gettingstarted.xml Thu Jan 3 12:01:46 2008
@@ -0,0 +1,117 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+-->
+
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+<document>
+ <body>
+ <section name="Examples Application">
+ <p>
+ Your first step with Apache MyFaces should be to have
+ a look at our examples application. You can do that
+ by going to our working distribution on <a href="http://www.irian.at/myfaces.jsf">
+ http://www.irian.at/myfaces.jsf</a>
+ or by deploying the examples application yourself. All
+ you need to do to get up and running is to follow the steps below!
+ </p>
+ </section>
+ <section name="What you need for the Examples Application">
+ <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-examples.zip or myfaces-X.X.X-examples.tgz) is <a href="http://myfaces.apache.org/download.html">here</a>.</li>
+ </ul>
+ </section>
+ <section name="Installing and Running the Examples">
+ <ul>
+ <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 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/simple</a></li>
+ </ul>
+ </section>
+ <section name="Installing and Running Sun JSF-RI Samples with MyFaces">
+ <ul>
+ <li><a href="risamples.html">see detailed description</a></li>
+ </ul>
+ </section>
+ <section name="Using MyFaces in your own web application">
+ <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/tomahawk/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"><%@ taglib uri="http://java.sun.com/jsf/html" prefix="h"%></source></li>
+ <li><source xml:space="preserve"><%@ taglib uri="http://java.sun.com/jsf/core" prefix="f"%></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 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"><%@ taglib uri="http://myfaces.apache.org/tomahawk" prefix="t"%></source></li>
+ <li><source xml:space="preserve"><%@ taglib uri="http://myfaces.apache.org/wap" prefix="wap" %></source></li>
+ </ul>
+
+ For using the Tomahawk components, it's also very important to setup the MyFaces Extensions-Filter. You find the explanations
+ for doing this under: <a href="http://myfaces.apache.org/tomahawk/extensionsFilter.html">http://myfaces.apache.org/tomahawk/extensionsFilter.html</a>
+ </ul>
+ </section>
+ <section name="Tutorials for getting started with JSF">
+ <ul>
+ <li><a href="http://www.coreservlets.com/JSF-Tutorial/"> Core-Servlets JSF Tutorial by Marty Hall</a></li>
+ </ul>
+ </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>
\ No newline at end of file
Propchange: myfaces/core/trunk/src/site/xdoc/gettingstarted.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: myfaces/core/trunk/src/site/xdoc/javadoc.xml
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/src/site/xdoc/javadoc.xml?rev=608611&view=auto
==============================================================================
--- myfaces/core/trunk/src/site/xdoc/javadoc.xml (added)
+++ myfaces/core/trunk/src/site/xdoc/javadoc.xml Thu Jan 3 12:01:46 2008
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+-->
+
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+<document>
+ <body>
+ <section name="Javadoc Links">
+ <ul>
+ <li><a href="myfaces-api/apidocs/index.html">Javadoc (API)</a></li>
+ <li><a href="myfaces-impl/apidocs/index.html">Javadoc (Impl)</a></li>
+ </ul>
+ </section>
+ <section name="TLD Links">
+ <ul>
+ <li><a href="myfaces-impl/tlddoc/index.html">Core: Impl</a></li>
+ </ul>
+ </section>
+ <section name="Links to Sun's RI docu">
+ <ul>
+ <li><a href="http://java.sun.com/j2ee/javaserverfaces/1.1_01/docs/api/index.html">Javadoc (API)</a></li>
+ <li><a href="http://java.sun.com/j2ee/javaserverfaces/1.1_01/docs/tlddocs/index.html">TLD</a></li>
+ </ul>
+ </section>
+ </body>
+</document>
Propchange: myfaces/core/trunk/src/site/xdoc/javadoc.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: myfaces/core/trunk/src/site/xdoc/risamples.xml
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/src/site/xdoc/risamples.xml?rev=608611&view=auto
==============================================================================
--- myfaces/core/trunk/src/site/xdoc/risamples.xml (added)
+++ myfaces/core/trunk/src/site/xdoc/risamples.xml Thu Jan 3 12:01:46 2008
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+-->
+
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+<document>
+ <body>
+ <section name="Steps to get Sun's cardemo sample running">
+ <ol>
+ <li>Download the latest JSF Reference Implementation <a href="http://java.sun.com/j2ee/javaserverfaces/download.html">here</a></li>
+ <li>In samples dir you will find the cardemo web application archive named jsf-cardemo.war</li>
+ <li>Unpack jsf-cardemo.war to a directory of your choice. If you are not familiar with deploying web applications and you are using tomcat, unpack jsf-cardemo.war to CATALINA_HOME/webapps/cardemo directory (where CATALINA_HOME = Tomcat installation directory)</li>
+ <li>Remove all jar files from WEB-INF/lib directory but NOT! demo-components.jar</li>
+ <li>Copy all jar files from simple.war or blank.war (the MyFaces examples, see getting started) to WEB-INF/lib directory</li>
+ <li>Replace WEB-INF/web.xml with <a href="cardemoweb.html">web.xml</a></li>
+ <li>Deploy web application. If you unpacked cardemo.war into CATALINA_HOME/webapps/cardemo start tomcat and see cardemo running at http://localhost:8080/cardemo</li>
+ </ol>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/core/trunk/src/site/xdoc/risamples.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: myfaces/core/trunk/src/site/xdoc/tomcat.xml
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/src/site/xdoc/tomcat.xml?rev=608611&view=auto
==============================================================================
--- myfaces/core/trunk/src/site/xdoc/tomcat.xml (added)
+++ myfaces/core/trunk/src/site/xdoc/tomcat.xml Thu Jan 3 12:01:46 2008
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+-->
+
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+<document>
+ <body>
+ <section name="Tomcat 5.5.x">
+ <p>Some users have reported problems when using MyFaces wtth Tomcat5.5.x. Here is a short guide that will hopefully help you not run into the same problems :-)</p>
+ <ul>
+ <li>If your are using the binary version of MyFaces: MyFaces is packaged so that it works with Tomcat5.0.x so the <code>WEB-INF/lib/jsp-2.0.jar</code> and <code>WEB-INF/lib/commons-el.jar</code> JAR files must be removed from your WAR files (including the examples).</li>
+ <li>If you are building from source: If you want to build MyFaces from scratch to work with Tomcat 5.5.x, you have to set the property <code>tomcat.pre.5.5.version</code> in the <code>$MYFACES_HOME/build/build.default.properties</code> file to the value <code>false</code>.</li>
+ </ul>
+ <p>We hope this helps, if not please contact the user list at <a href="mailto:users@myfaces.apache.org">MyFaces</a>!</p>
+ </section>
+ <section name="Tomcat 4.x">
+ <p>MyFaces has a dependency on some of the classes in the JSP2.0 spec. As a result applications based on MyFaces will not run without the inclusion of the jsp-2.0.jar file in the <code>WEB-INF/lib</code> directory of your <code>.war</code> file.</p>
+ <p>We hope this helps, if not please contact the user list at <a href="mailto:users@myfaces.apache.org">MyFaces</a>.</p>
+ </section>
+ <section name="Configuring MyFaces/Tomahawk to be available for all applications in Tomcat ">
+ <ul>
+ <li>Place the relevant myfaces jars in <code>$TOMCAT_HOME/shared/lib</code>.</li>
+ <li>Place the following supporting jars in <code>$TOMCAT_HOME/shared/lib</code>: commons-beanutils.jar, commons-codec.jar,
+ commons-digester.jar and commons-fileupload.jar.
+ </li>
+ </ul>
+ <p>We hope this helps, if not please contact the user list at <a href="mailto:users@myfaces.apache.org">MyFaces</a>!</p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: myfaces/core/trunk/src/site/xdoc/tomcat.xml
------------------------------------------------------------------------------
svn:eol-style = native