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:36:52 UTC
svn commit: r608625 - in /myfaces/core/trunk_1.2.x/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:36:50 2008
New Revision: 608625
URL: http://svn.apache.org/viewvc?rev=608625&view=rev
Log:
Set up docs for Core JSF1.2 site.
Added:
myfaces/core/trunk_1.2.x/src/site/fml/
myfaces/core/trunk_1.2.x/src/site/fml/faq.fml
myfaces/core/trunk_1.2.x/src/site/xdoc/
myfaces/core/trunk_1.2.x/src/site/xdoc/gettingstarted.xml (with props)
myfaces/core/trunk_1.2.x/src/site/xdoc/javadoc.xml (with props)
myfaces/core/trunk_1.2.x/src/site/xdoc/risamples.xml (with props)
myfaces/core/trunk_1.2.x/src/site/xdoc/tomcat.xml (with props)
Modified:
myfaces/core/trunk_1.2.x/src/site/site.xml
Added: myfaces/core/trunk_1.2.x/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/myfaces/core/trunk_1.2.x/src/site/fml/faq.fml?rev=608625&view=auto
==============================================================================
--- myfaces/core/trunk_1.2.x/src/site/fml/faq.fml (added)
+++ myfaces/core/trunk_1.2.x/src/site/fml/faq.fml Thu Jan 3 12:36:50 2008
@@ -0,0 +1,22 @@
+<?xml version="1.0"?>
+<faqs id="Frequently Asked Questions">
+ <part id="General">
+ <faq id="1">
+ <question>What is MyFaces?</question>
+ <answer>
+ <p>
+ MyFaces Core 1.2 is a Open Source Implementation of the JavaServer Faces 1.2 specification.
+ See <a href="http://jcp.org/en/jsr/detail?id=252">JSR 252</a>.
+ </p>
+ </answer>
+ </faq>
+ <faq id="2">
+ <question>Does MyFaces Core 1.2 work with Tomcat 5.5?</question>
+ <answer>
+ <p>
+ No, JSF1.2 requires Tomcat 6.0 or later.
+ </p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
Modified: myfaces/core/trunk_1.2.x/src/site/site.xml
URL: http://svn.apache.org/viewvc/myfaces/core/trunk_1.2.x/src/site/site.xml?rev=608625&r1=608624&r2=608625&view=diff
==============================================================================
--- myfaces/core/trunk_1.2.x/src/site/site.xml (original)
+++ myfaces/core/trunk_1.2.x/src/site/site.xml Thu Jan 3 12:36:50 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_1.2.x/src/site/xdoc/gettingstarted.xml
URL: http://svn.apache.org/viewvc/myfaces/core/trunk_1.2.x/src/site/xdoc/gettingstarted.xml?rev=608625&view=auto
==============================================================================
--- myfaces/core/trunk_1.2.x/src/site/xdoc/gettingstarted.xml (added)
+++ myfaces/core/trunk_1.2.x/src/site/xdoc/gettingstarted.xml Thu Jan 3 12:36:50 2008
@@ -0,0 +1,123 @@
+<?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="Viewing Examples Application">
+ <p>
+ Your first step with Apache MyFaces Core 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 to run the Examples Application locally">
+ <ul>
+ <li>
+ A suitable servlet engine, eg Tomcat 6.x. Download Tomcat
+ <a href="http://jakarta.apache.org/tomcat/index.html">here</a>.
+ </li>
+ <li>
+ A precompiled copy of the 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 Core">
+ <p>
+ Because MyFaces Core is an implementation of the JSF standard, and Sun's examples
+ use only standard JSF features, the examples provided with the Sun RI can also
+ run on MyFaces Core.
+ </p>
+ <p>
+ See <a href="risamples.html">the detailed instructions</a>.
+ </p>
+ </section>
+ <section name="Using MyFaces Core JSF 1.2 for your own web application">
+ <p>
+ First, check the <a href="../compatibility.html">compatibility list</a>
+ to find out if your servlet container is supported.
+ </p>
+ <p>
+ To create a new webapp, one easy way is to take the myfaces-X.X.X-examples.zip
+ (see instructions above), and extract the blank.war file. This contains all the
+ necessary libraries already, plus the necessary directory structure for a
+ basic JSF webapp.
+ </p>
+ <p>
+ Alternatively, download the latest Myfaces Core tarfile. This will contain all
+ the necessary dependencies.
+ </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="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>
Propchange: myfaces/core/trunk_1.2.x/src/site/xdoc/gettingstarted.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: myfaces/core/trunk_1.2.x/src/site/xdoc/javadoc.xml
URL: http://svn.apache.org/viewvc/myfaces/core/trunk_1.2.x/src/site/xdoc/javadoc.xml?rev=608625&view=auto
==============================================================================
--- myfaces/core/trunk_1.2.x/src/site/xdoc/javadoc.xml (added)
+++ myfaces/core/trunk_1.2.x/src/site/xdoc/javadoc.xml Thu Jan 3 12:36:50 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.2/docs/api/index.html">Javadoc (API)</a></li>
+ <li><a href="http://java.sun.com/j2ee/javaserverfaces/1.2/docs/tlddocs/index.html">TLD</a></li>
+ </ul>
+ </section>
+ </body>
+</document>
Propchange: myfaces/core/trunk_1.2.x/src/site/xdoc/javadoc.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: myfaces/core/trunk_1.2.x/src/site/xdoc/risamples.xml
URL: http://svn.apache.org/viewvc/myfaces/core/trunk_1.2.x/src/site/xdoc/risamples.xml?rev=608625&view=auto
==============================================================================
--- myfaces/core/trunk_1.2.x/src/site/xdoc/risamples.xml (added)
+++ myfaces/core/trunk_1.2.x/src/site/xdoc/risamples.xml Thu Jan 3 12:36:50 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_1.2.x/src/site/xdoc/risamples.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: myfaces/core/trunk_1.2.x/src/site/xdoc/tomcat.xml
URL: http://svn.apache.org/viewvc/myfaces/core/trunk_1.2.x/src/site/xdoc/tomcat.xml?rev=608625&view=auto
==============================================================================
--- myfaces/core/trunk_1.2.x/src/site/xdoc/tomcat.xml (added)
+++ myfaces/core/trunk_1.2.x/src/site/xdoc/tomcat.xml Thu Jan 3 12:36:50 2008
@@ -0,0 +1,27 @@
+<?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 6.x">
+ <p>TODO: write this page</p>
+ </section>
+ </body>
+</document>
Propchange: myfaces/core/trunk_1.2.x/src/site/xdoc/tomcat.xml
------------------------------------------------------------------------------
svn:eol-style = native