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/03/23 23:30:47 UTC
svn commit: r640265 - in /myfaces/tomahawk/trunk/core/src/site:
apt/extendedDocs.apt apt/index.apt site.xml
Author: skitching
Date: Sun Mar 23 15:30:45 2008
New Revision: 640265
URL: http://svn.apache.org/viewvc?rev=640265&view=rev
Log:
Move component docs into a page instead of left nav pane.
Minor doc/site tidyups.
Added:
myfaces/tomahawk/trunk/core/src/site/apt/extendedDocs.apt
Modified:
myfaces/tomahawk/trunk/core/src/site/apt/index.apt
myfaces/tomahawk/trunk/core/src/site/site.xml
Added: myfaces/tomahawk/trunk/core/src/site/apt/extendedDocs.apt
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/site/apt/extendedDocs.apt?rev=640265&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/core/src/site/apt/extendedDocs.apt (added)
+++ myfaces/tomahawk/trunk/core/src/site/apt/extendedDocs.apt Sun Mar 23 15:30:45 2008
@@ -0,0 +1,89 @@
+ ------
+ Apache MyFaces Tomahawk Extended Documentation
+ ------
+
+Introduction
+
+ The full list of components available in the Tomahawk library can be found on the
+ tld (tag library description) report. That documentation includes an overview of each
+ JSP tag, and a table of all the attributes available for that tag. This information
+ should also be useful for users of other templating systems (eg Facelets).
+
+ However there are limitations to the documentation that can be provided in that report
+ format. For *some* components, extended documentation is available below.
+
+ See also the component section of our {{{http://wiki.apache.org/myfaces/MyFacesComponents}WIKI}},
+ which includes the latest information from both Tomahawk developers and the Tomahawk user
+ community.
+
+Components
+
+ * {{{jscookmenu.html}JSCook Menu}}
+
+ * {{{newspaperTable.html}Newspaper Table}}
+
+ * {{{aliasBean.html}Alias Bean}}
+
+ * {{{buffer.html}Buffer}}
+
+ * {{{fileUpload.html}File Upload}}
+
+ * {{{tabbedPane.html}TabbedPane}}
+
+ * {{{calendar.html}Calendar}}
+
+ * {{{popup.html}Popup}}
+
+ * {{{javascriptListener.html}Javascript Listener}}
+
+ * {{{inputDate.html}Date}}
+
+ * {{{htmlEditor.html}Html Editor}}
+
+ * {{{htmlTag.html}Html Tag}}
+
+ * {{{dataList.html}Data List}}
+
+ * {{{tree.html}Tree}}
+
+ * {{{tree2.html}Tree2}}
+
+ * {{{treeTable.html}Tree Table}}
+
+ * {{{panelStack.html}Panel Stack}}
+
+ * {{{stylesheet.html}Style Sheet}}
+
+ * {{{commandSortHeader.html}Sort Header}}
+
+ * {{{dataScroller.html}Data Scroller}}
+
+ * {{{extDataTable.html}Extended Data Table}}
+
+ * {{{panelNavigation.html}Panel Navigation}}
+
+ * {{{panelNavigation2.html}Panel Navigation 2}}
+
+ * {{{uiSaveState.html}UI Save State}}
+
+ * {{{columns.html}Columns}}
+
+ * {{{column.html}Column}}
+
+ * {{{schedule.html}Schedule}}
+
+ * {{{dojoInitializer.html}Dojo Initializer}}
+
+ * {{{selectItems.html}SelectItems}}
+
+Validators
+
+ * {{{validateCreditCard.html}validateCreditCard}}
+
+ * {{{validateUrl.html}validateUrl}}
+
+ * {{{validateEmail.html}validateEmail}}
+
+ * {{{validateEqual.html}validateEqual}}
+
+ * {{{validateRegExpr.html}validateRegExpr}}
\ No newline at end of file
Modified: myfaces/tomahawk/trunk/core/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/site/apt/index.apt?rev=640265&r1=640264&r2=640265&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/site/apt/index.apt (original)
+++ myfaces/tomahawk/trunk/core/src/site/apt/index.apt Sun Mar 23 15:30:45 2008
@@ -4,15 +4,16 @@
MyFaces Tomahawk
- See also the component section of our {{{http://wiki.apache.org/myfaces/MyFacesComponents}WIKI}}
- (might be more complete than the information here).
-
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.
- See also the {{{http://wiki.apache.org/myfaces/CompatibilityMatrix}compatibility matrix}}.
-
+ Although we try to make Tomahawk as "portable" as possible, not all Tomahawk releases are compatible with all
+ MyFaces or Sun Mojarra (formerly RI) releases. A Tomahawk release is always compatible with the latest MyFaces
+ Core release available at the time that Tomahawk version was released. For further information on compatibility
+ between Tomahawk and other frameworks/libraries, please see the
+ {{{http://wiki.apache.org/myfaces/CompatibilityMatrix}relevant wiki page}}.
+
Extended Components and Other "Goodies"
In addition to custom components not found in the JSF specification, the MyFaces components bundle also includes an
@@ -39,23 +40,12 @@
* Put the <<<tomahawk.jar>>> in your <<<WEB-INF/lib>>> directory (or in the classpath of your
application server.)
- []
-
-* Note
-
- If you are using the MyFaces implementation you can choose to use the <<<myfaces-all.jar>>> instead. It is basically
- a single jar file containing the JSF 1.1 API, JSF 1.1 Implementation and the MyFaces custom components.
-
- * Install the {{{extensionsFilter.html}MyFaces Extensions filter}}
-
- []
+ * Configure the {{{extensionsFilter.html}MyFaces Extensions filter}} in your <<<WEB-INF/web.xml>>> file.
* Add the following to your JSP page in order to use one of the MyFaces custom components:\
<<<\<%@ taglib uri="http://myfaces.apache.org/tomahawk" prefix="t" %\>>>>
+ * That's it! You're good to go.
+
[]
-
- * That's it! You're good to go. Please see additional documentation for specific issues regarding the MyFaces API and
- implementation packages.
-
- []
\ No newline at end of file
+
\ No newline at end of file
Modified: myfaces/tomahawk/trunk/core/src/site/site.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/site/site.xml?rev=640265&r1=640264&r2=640265&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/site/site.xml (original)
+++ myfaces/tomahawk/trunk/core/src/site/site.xml Sun Mar 23 15:30:45 2008
@@ -59,50 +59,12 @@
<item name="Tobago" href="http://myfaces.apache.org/tobago/index.html"/>
<item name="Trinidad" href="http://myfaces.apache.org/trinidad/index.html"/>
<item name="Orchestra" href="http://myfaces.apache.org/orchestra/index.html"/>
+ <item name="Portlet Bridge" href="http://myfaces.apache.org/portlet-bridge/index.html"/>
</menu>
- <menu name="Components">
- <item name="JSCook Menu" href="jscookmenu.html"/>
- <item name="Tree2" href="tree2.html"/>
- <item name="Newspaper Table" href="newspaperTable.html"/>
- <item name="Alias Bean" href="aliasBean.html"/>
- <item name="Buffer" href="buffer.html"/>
- <item name="File Upload" href="fileUpload.html"/>
- <item name="TabbedPane" href="tabbedPane.html"/>
- <item name="Calendar" href="calendar.html"/>
- <item name="Popup" href="popup.html"/>
- <item name="Javascript Listener" href="javascriptListener.html"/>
- <item name="Date" href="inputDate.html"/>
- <item name="Html Editor" href="htmlEditor.html"/>
- <item name="Html Tag" href="htmlTag.html"/>
- <item name="Data List" href="dataList.html"/>
- <item name="Tree" href="tree.html"/>
- <item name="Tree2" href="tree2.html"/>
- <item name="Tree Table" href="treeTable.html"/>
- <item name="Panel Stack" href="panelStack.html"/>
- <item name="Style Sheet" href="stylesheet.html"/>
- <item name="Sort Header" href="commandSortHeader.html"/>
- <item name="Data Scroller" href="dataScroller.html"/>
- <item name="Extended Data Table" href="extDataTable.html"/>
- <item name="Panel Navigation" href="panelNavigation.html"/>
- <item name="Panel Navigation 2" href="panelNavigation2"/>
- <item name="UI Save State" href="uiSaveState.html"/>
- <item name="Columns" href="columns.html"/>
- <item name="Column" href="column.html"/>
- <item name="Schedule" href="schedule.html"/>
- <item name="Dojo Initializer" href="dojoInitializer.html"/>
- <item name="SelectItems" href="selectItems.html"/>
- </menu>
-
- <menu name="Validators">
- <item name="validateCreditCard" href="validateCreditCard.html"/>
- <item name="validateUrl" href="validateUrl.html"/>
- <item name="validateEmail" href="validateEmail.html"/>
- <item name="validateEqual" href="validateEqual.html"/>
- <item name="validateRegExpr" href="validateRegExpr.html"/>
- </menu>
-
- <menu name="Other Goodies">
+ <menu name="Documentation">
+ <item name="Tag Library" href="tlddoc/index.html"/>
+ <item name="Extended Docs" href="extendedDocs.html"/>
<item name="Extensions filter" href="extensionsFilter.html"/>
<item name="forceId" href="forceId.html"/>
<item name="Tiles Support" href="tiles.html"/>
@@ -113,7 +75,7 @@
<item name="Autoriginate HostedQA" href="/testing/hostedqa.html"/>
</menu>
- ${reports}
+ <menu ref="reports" inherit="top"/>
<menu name="Foundation">
<item name="ASF" href="http://apache.org/" />