myfaces-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sc...@apache.org
Subject cvs commit: incubator-myfaces/src/documentation/content/xdocs index.xml site.xml
Date Fri, 01 Apr 2005 05:12:56 GMT
schof       2005/03/31 21:12:56

  Modified:    src/documentation/content/xdocs/components overview.xml
               src/documentation/content/xdocs index.xml site.xml
  Added:       src/documentation/content/xdocs/components tiles.xml
  Removed:     src/documentation/content/xdocs/components treeTable.xml
  Log:
  finished component overview doc; added doc for tiles; removed doc for treeTable (since no
longer contemplating treeTable2)
  
  Revision  Changes    Path
  1.2       +51 -5     incubator-myfaces/src/documentation/content/xdocs/components/overview.xml
  
  Index: overview.xml
  ===================================================================
  RCS file: /home/cvs/incubator-myfaces/src/documentation/content/xdocs/components/overview.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- overview.xml	15 Mar 2005 09:08:28 -0000	1.1
  +++ overview.xml	1 Apr 2005 05:12:56 -0000	1.2
  @@ -11,20 +11,66 @@
   
       <section>
           <title>Custom Components</title>
  -        <ul>
  -            <li></li>
  -        </ul>
  +        <p>
  +            MyFaces provides a series of JSF components that go beyond the JSF specification.
 These components are 100% compatible
  +            with the Sun JSF 1.1 Reference Implementation (RI) or any other JSF 1.1 compatible
implementation.  Of course the custom
  +            components can also be used with the Apache MyFaces JSF implementation.
  +        </p>
       </section>
  -
       <section>
           <title>Extended Components and Other "Goodies"</title>
  +        <p>
  +            In addition to custom components not found in the JSF specification, the MyFaces
components bundle also includes an
  +            "extended" version of some of the default components.  These are basically
components that exist in either the core or
  +            html tag libraries but additional functionality has been addded that goes beyond
the specification.
  +        </p>
  +        <ul>
  +            <li>Example: &lt;x:inputText> - This is similar to the &lt;h:inputText>
component but it provides additional attributes
  +                such as <code>forceId</code>.  When this attribute is <code>true</code>
the HTML generated will used the id
  +                specified by the <code>id</code> attribute instead of the one
normally generated by following the JSF specification.
  +            </li>
  +        </ul>
  +        <ul>
  +            <li>Converters - MyFaces components project contains several custom objects
that do not implement <code>UIComponent</code>.
  +                Some of these include objects that implement the <code>Converter</code>
interface.
  +            </li>
  +        </ul>
           <ul>
  -            <li></li>
  +            <li>Tiles Support - MyFaces provides a custom solution to allow use to
use Tiles together with JSF.
  +            </li>
           </ul>
  +        <warning label="Warning">
  +            The MyFaces version of Tiles Support requires the MyFaces JSF implementation.
 It will not work with the Sun RI or
  +            any other JSF implementation. This is the only MyFaces "goody" that does not
work with all implementations.  It
  +            should be emphasized that Tiles can theoretically work with any JSF implementation
(even though it is tricky due to
  +            the nature of the JSF specification.)
  +        </warning>
       </section>
   
       <section>
           <title>Requirements and Setup</title>
  +        <ul>
  +            <li>
  +                Put the <code>myfaces-extensions.jar</code> in your <code>WEB-INF/lib</code>
directory (or in the classpath of your
  +                application server.)
  +            </li>
  +        </ul>
  +        <note label="Note">
  +            If you are using the MyFaces implementation you can choose to use the <code>myfaces.jar</code>
instead.  It is basically
  +            a single jar file containing the JSF 1.1 API, JSF 1.1 Implementation and the
MyFaces custom components.
  +        </note>
  +        <ul>
  +            <li>
  +                Add the following to your JSP page in order to use one of the MyFaces custom
components: <br/><br/>
  +                <code>&lt;%@ taglib uri="http://myfaces.apache.org/extensions"
prefix="x"%></code>
  +            </li>
  +        </ul>
  +        <ul>
  +            <li>
  +                That's it! You're good to go.  Please see additional documentation for
specific issues regarding the MyFaces API and
  +                implementation packages.
  +            </li>
  +        </ul>
       </section>
   
   </body>
  
  
  
  1.1                  incubator-myfaces/src/documentation/content/xdocs/components/tiles.xml
  
  Index: tiles.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "document-v12.dtd">
  
  <!--
  This is a standard template meant to be used for the documentation of all custom
  components.
  -->
  <document>
      <!-- component name -->
      <header>
          <title>Tiles Support</title>
      </header>
      <body>
          <!-- Description -->
          <section>
              <title>Description</title>
              <p>
                  For better <link href="http://struts.apache.org">struts/tiles</link>
support, MyFaces has an integrated JspTilesViewHandler
                  (since release 1.0.6 beta). The main advantage of the ViewHandler is, that
tiles-definitions can be sourced out into xml files
                  (up to now using tiles and myfaces you had to definie the layout within
jsp-pages).
              </p>
              <p>
                  Take a look at the <code>myfaces-tiles-example</code> web application.
              </p>
          </section>
          <!-- screen shot -->
          <section>
              <title>Screen Shot</title>
              <p>Not Available</p>
          </section>
          <!-- API -->
          <section>
              <title>API</title>
              <p>Not Applicable</p>
          </section>
          <!-- Syntax -->
          <section>
              <title>Syntax</title>
              <p>Not Applicable</p>
          </section>
          <!-- Instructions -->
          <section>
              <title>Instructions</title>
              <ul>
                  <li>Configure the JspTilesViewHandler in your faces-config: </li>
              </ul>
              <source>
              &lt;application>
                  &lt;view-handler>net.sourceforge.myfaces.application.jsp.JspTilesViewHandlerImpl&lt;view-handler>
              &lt;/application>
              </source>
              <ul>
                  <li>Add the following lines to your web.xml: </li>
              </ul>
              <source>
              &lt;context-param>
                  &lt;param-name>tiles-definitions&lt;/param-name>
                  &lt;param-value>/WEB-INF/tiles.xml&lt;/param-value>
              &lt;/context-param>
              </source>
              <ul>
                  <li>Define your layout in a tiles-definition file</li>
              </ul>
              <ul>
                  <li>When rendering the view, the JspTilesViewHandlerImpl will take
the given viewId and compute a tileId by:</li>
                  <ul>
                      <li>Substituting any extension by ".tiles"</li>
                  </ul>
                  <ul>
                      <li>Appending ".tiles" if path-mapping is used</li>
                  </ul>
              </ul>
              <ul>
                  <li>
                      Next the ViewHanlder looks up in the tile-definitions for the corresponding
definition.
                      (eg. for viewId = /page1.jsp the lookup would be /page1.tiles)
                  </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 />
  	&copy; 2004 - 2005, Apache Software Foundation
  	</legal>
      </footer>
  
  </document>
  
  
  
  1.6       +25 -25    incubator-myfaces/src/documentation/content/xdocs/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvs/incubator-myfaces/src/documentation/content/xdocs/index.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- index.xml	1 Apr 2005 00:07:47 -0000	1.5
  +++ index.xml	1 Apr 2005 05:12:56 -0000	1.6
  @@ -1,10 +1,10 @@
   <?xml version="1.0" encoding="UTF-8"?>
   <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://apache.org/forrest/dtd/document-v12.dtd">
  -<document> 
  -  <header> 
  -    <title>Apache MyFaces</title> 
  -  </header> 
  -  <body> 
  +<document>
  +  <header>
  +    <title>Apache MyFaces</title>
  +  </header>
  +  <body>
       <section>
         <title>Welcome to The MyFaces Project</title>
         <p>This is the official homepage of the first free open source JavaServer(tm)
Faces implementation called "MyFaces".</p>
  @@ -15,49 +15,49 @@
         	JavaServer(tm) Faces is a new and upcoming web application framework that accomplishes
the MVC paradigm.
         	 It is comparable to the well-known <link href="http://struts.apache.org/">Struts
Framework</link> but has features and concepts that are beyond those of Struts.
   Look at <link href="http://java.sun.com/j2ee/javaserverfaces/">Sun's JavaServer(tm)
Page</link> to learn more about the <link href="http://www.jcp.org/en/jsr/detail?id=127">Java
Specification Request 127</link> and to download the specification. They also provide
a useful Tutorial there.
  - 	
  +
         </p>
       </section>
  -	
  +
       <section>
  -        <title>April 2, 2005 - Nightly builds are now available</title>
  +        <title>April 1, 2005 - Nightly builds are now available</title>
           <p>
  -            Nightly builds are now available <link href="http://cvs.apache.org/builds/myfaces/nightly">here</link>.
 Go ahead and download  
  +            Nightly builds are now available <link href="http://cvs.apache.org/builds/myfaces/nightly">here</link>.
 Go ahead and download
               them if you wish to use the latest and greatest source code before the next
official release.
           </p>
       </section>
       <section>
           <title>March 29, 2005 - MyFaces 1.0.9 RC2 now available</title>
           <p>
  -            My Faces 1.0.9 RC2 is now available <link href="http://cvs.apache.org/dist/myfaces/builds/1.0.9/rc2/">here</link>.

  -            Please help us prepare for the official release by testing and providing feedback.
 If you think you have found a 
  +            My Faces 1.0.9 RC2 is now available <link href="http://cvs.apache.org/dist/myfaces/builds/1.0.9/rc2/">here</link>.
  +            Please help us prepare for the official release by testing and providing feedback.
 If you think you have found a
               bug, please report it <link href="http://issues.apache.org/jira/secure/BrowseProject.jspa?id=10600">here</link>.
           </p>
  -    </section>	
  +    </section>
       <section>
           <title>February 24, 2005 - MyFaces is Hot</title>
           <note label="David Geary (JSF Author and Creator of Tiles) Blogs on MyFaces">
               MyFaces is Hot<br/><br/>
               Disclaimer: From now on, we're going to have nothing but fun here!<br/><br/>
  -            I like to keep my finger on the pulse as much as I can so that I can track
Big Things and Next Big Things. 
  -            One of the best ways to do that is to join mailing lists and watch how much
traffic appears in your inbox. 
  -            Lately, I've taken notice of the traffic on the MyFaces mailing list, which
seems to be running neck and 
  +            I like to keep my finger on the pulse as much as I can so that I can track
Big Things and Next Big Things.
  +            One of the best ways to do that is to join mailing lists and watch how much
traffic appears in your inbox.
  +            Lately, I've taken notice of the traffic on the MyFaces mailing list, which
seems to be running neck and
               neck with the Struts developer's mailing list, which means that MyFaces is
generating a lot of attention.
               <br/><br/>
               What? Oh no, I haven't joined the Ruby on Rails mailing list yet. 8-)
               <br/><br/>
  -            In the early days of JSF (last year), there was very little JSF traction. I
think people were suspicious 
  -            of anything of that complexity that came out of a JSR, which in general is
probably wise, but in this case, 
  +            In the early days of JSF (last year), there was very little JSF traction. I
think people were suspicious
  +            of anything of that complexity that came out of a JSR, which in general is
probably wise, but in this case,
               of course, totally unfounded.
               <br/><br/>
  -            But lately, I'm seeing quite a surge in interest in JSF. And now that MyFaces
is under the Apache umbrella, 
  -            I expect big things for it. Kudos to all the folks who have put in so much
time and effort for MyFaces, such 
  -            as Heath Borders, Matthias Wessendorf, and Sean Schofield (Sean: how the heck
can you be in so many places 
  -            at once?). Apologies to those I didn't mention; this list is off the top of
my head.       
  -            <br/><br/>            
  +            But lately, I'm seeing quite a surge in interest in JSF. And now that MyFaces
is under the Apache umbrella,
  +            I expect big things for it. Kudos to all the folks who have put in so much
time and effort for MyFaces, such
  +            as Heath Borders, Matthias Wessendorf, and Sean Schofield (Sean: how the heck
can you be in so many places
  +            at once?). Apologies to those I didn't mention; this list is off the top of
my head.
  +            <br/><br/>
           </note>
           <p>Click <link href="http://www.jroller.com/page/dgeary/20050224#myfaces_is_hot">here</link>
to read David Geary's blog.</p>
  -    </section>	        
  +    </section>
       <section>
           <title>February 23, 2005 - MyFaces is Now a Top Level Apache Project</title>
           <note label="Email to myfaces-dev from ASF Board">
  @@ -75,7 +75,7 @@
               <br/><br/>
               Anton
           </note>
  -    </section>	    
  +    </section>
       <section>
           <title>Resources</title>
           <p>If you are new to JavaServer Faces Technology look at the following resources
to become familar with JSF:</p>
  @@ -84,6 +84,6 @@
               <li><link href="http://www.jamesholmes.com/JavaServerFaces/">James
Holmes' JSF Resources</link></li>
           </ul>
       </section>
  -    
  +
     </body>
   </document>
  
  
  
  1.14      +1 -1      incubator-myfaces/src/documentation/content/xdocs/site.xml
  
  Index: site.xml
  ===================================================================
  RCS file: /home/cvs/incubator-myfaces/src/documentation/content/xdocs/site.xml,v
  retrieving revision 1.13
  retrieving revision 1.14
  diff -u -r1.13 -r1.14
  --- site.xml	1 Apr 2005 00:07:47 -0000	1.13
  +++ site.xml	1 Apr 2005 05:12:56 -0000	1.14
  @@ -13,8 +13,8 @@
   	<components href="components/" label="Components" tab="components">
   		<overview label="Overview" href="overview.html"/>
   		<jscookmenu label="JSCook Menu" href="jscookmenu.html"/>
  +                <tree label="Tiles Support" href="tiles.html"/>
   		<tree label="Tree2" href="tree2.html"/>
  -		<treTable label="Tree Table" href="treeTable.html"/>
   		<validateCreditCard label="validateCreditCard" href="validateCreditCard.html"/>
   		<validateISBN label="validateISBN" href="validateISBN.html"/>
   		<validateRegExpr label="validateRegExpr" href="validateRegExpr.html"/>
  
  
  

Mime
View raw message