You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by sc...@apache.org on 2006/02/17 00:54:13 UTC
svn commit: r378399 - in /myfaces/tomahawk/trunk:
core/src/site/apt/aliasBean.apt core/src/site/apt/buffer.apt
core/src/site/xdoc/aliasBean.xml core/src/site/xdoc/buffer.xml
sandbox/core/src/site/apt/index.apt sandbox/core/src/site/xdoc/index.xml
Author: schof
Date: Thu Feb 16 15:54:11 2006
New Revision: 378399
URL: http://svn.apache.org/viewcvs?rev=378399&view=rev
Log:
Tomahawk Documentation (MYFACES-1129) by James Holmes
Added:
myfaces/tomahawk/trunk/core/src/site/apt/aliasBean.apt
myfaces/tomahawk/trunk/core/src/site/apt/buffer.apt
myfaces/tomahawk/trunk/sandbox/core/src/site/apt/index.apt
Removed:
myfaces/tomahawk/trunk/core/src/site/xdoc/aliasBean.xml
myfaces/tomahawk/trunk/core/src/site/xdoc/buffer.xml
myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/index.xml
Added: myfaces/tomahawk/trunk/core/src/site/apt/aliasBean.apt
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/core/src/site/apt/aliasBean.apt?rev=378399&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/core/src/site/apt/aliasBean.apt (added)
+++ myfaces/tomahawk/trunk/core/src/site/apt/aliasBean.apt Thu Feb 16 15:54:11 2006
@@ -0,0 +1,61 @@
+ ------
+ Apache MyFaces - Tomahawk - Alias Bean
+ ------
+
+Description
+
+ A tag that defines a new bean (alias) with a given value.
+
+ This allows you to design a subform with a generic (fictive) beans
+ and to include it in all the pages where you use it. You just need
+ to make an alias to the real bean named after the generic bean
+ before including the subform.
+
+ When used within an aliasBeansScope tag, this tag adds the alias
+ to the aliasBeansScope. This makes configuration with multiple
+ aliasBeans easier to write.
+
+Screen Shot
+
+ Not available at this time.
+~~<!-- replace with either a figure or Not Available -->
+~~<figure src="jscookmenu.png" alt="jscookmenu"/>
+
+API
+
+*----------------+-----------------------------------------------------+
+|component-family|javax.faces.Data |
+*----------------+-----------------------------------------------------+
+|renderer-type |org.apache.myfaces.AliasBean |
+*----------------+-----------------------------------------------------+
+|component-class |org.apache.myfaces.custom.aliasbean.AliasBean |
+*----------------+-----------------------------------------------------+
+|renderer-class |org.apache.myfaces.custom.aliasbean.AliasBeanRenderer|
+*----------------+-----------------------------------------------------+
+|tag-class |org.apache.myfaces.custom.aliasbean.AliasBeanTag |
+*----------------+-----------------------------------------------------+
+
+Usage
+
++---
+<t:aliasBean alias="#{holder}" value="#{aliasTest1}">
+ <f:subview id="simulatedIncludedSubform1">
+ <h:outputLabel for="name" value="Name:"/>
+ <h:inputText id="name" value="#{holder.name}"/>
+ </f:subview>
+</t:aliasBean>
++---
+
+Syntax
+
+* \<t:aliasBean\>
+
+ <<<alias>>> - The bean that will be set to the given value (Example: #{holder}).
+
+ <<<value>>> - The value that the alias can be set to.
+ This can be a string (like "toto") or a reference to an existing
+ bean (like "#{myBean.member1}").
+
+Instructions
+
+ See examples/aliasBean.jsp for an example!
Added: myfaces/tomahawk/trunk/core/src/site/apt/buffer.apt
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/core/src/site/apt/buffer.apt?rev=378399&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/core/src/site/apt/buffer.apt (added)
+++ myfaces/tomahawk/trunk/core/src/site/apt/buffer.apt Thu Feb 16 15:54:11 2006
@@ -0,0 +1,50 @@
+ ------
+ Apache MyFaces - Tomahawk - Buffer
+ ------
+
+Description
+
+ This component allows you to render a part of the
+ page to a buffer, and then use the buffer later.
+
+Screen Shot
+
+ Not available at this time.
+~~<!-- replace with either a figure or Not Available -->
+~~<figure src="jscookmenu.png" alt="jscookmenu"/>
+
+API
+
+*----------------+-----------------------------------------------+
+|component-family|javax.faces.Data |
+*----------------+-----------------------------------------------+
+|renderer-type |org.apache.myfaces.Buffer |
+*----------------+-----------------------------------------------+
+|component-class |org.apache.myfaces.custom.buffer.Buffer |
+*----------------+-----------------------------------------------+
+|renderer-class |org.apache.myfaces.custom.buffer.BufferRenderer|
+*----------------+-----------------------------------------------+
+|tag-class |org.apache.myfaces.custom.buffer.BufferTag |
+*----------------+-----------------------------------------------+
+
+Usage
+
++---
+<t:buffer into="Bean">
+ <t:div>
+ <h:outputText value="String"/>
+ </t:div>
+</t:buffer>
++---
+
+Syntax
+
+* \<t:buffer\>
+
+ <<<into>>> - The JSP variable that will store the buffered content.
+
+Instructions
+
+ Just nest elements to buffer into a \<t:buffer\> element.
+
+ See examples/buffer.jsp for an example!
Added: myfaces/tomahawk/trunk/sandbox/core/src/site/apt/index.apt
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/sandbox/core/src/site/apt/index.apt?rev=378399&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/site/apt/index.apt (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/site/apt/index.apt Thu Feb 16 15:54:11 2006
@@ -0,0 +1,16 @@
+ ------
+ Apache MyFaces - Sandbox
+ ------
+
+Summary
+
+ See also the component section of our {{{http://wiki.apache.org/myfaces/MyFacesComponents}WIKI}}
+ (might be more complete than the information here).
+
+ The sandbox is a MyFaces subproject that is a testing ground for potential new additions to the Tomahawk project. It
+ primarily consists of components, but like the Tomahawk project, it can also contain validators and other useful JSF
+ "goodies."
+
+ These components are a work in progress. In many cases they are checked in without being 100% feature complete. Testing
+ is generally minimal and there is no guarantee that something you use in sandbox will ever be promoted to an official
+ release in Tomahawk.