You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by jl...@apache.org on 2006/04/19 23:17:03 UTC
svn commit: r395398 - in /myfaces/tomahawk/trunk/sandbox/core/src/site:
resources/images/fisheye1.png resources/images/fisheye2.png site.xml
xdoc/fisheye.xml xdoc/schedule.xml
Author: jlust
Date: Wed Apr 19 14:17:01 2006
New Revision: 395398
URL: http://svn.apache.org/viewcvs?rev=395398&view=rev
Log:
added documentation for the fisheyeNavigationMenu, and updated the schedule documentation to the maven xdoc format
Added:
myfaces/tomahawk/trunk/sandbox/core/src/site/resources/images/fisheye1.png (with props)
myfaces/tomahawk/trunk/sandbox/core/src/site/resources/images/fisheye2.png (with props)
myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/fisheye.xml
Modified:
myfaces/tomahawk/trunk/sandbox/core/src/site/site.xml
myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/schedule.xml
Added: myfaces/tomahawk/trunk/sandbox/core/src/site/resources/images/fisheye1.png
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/sandbox/core/src/site/resources/images/fisheye1.png?rev=395398&view=auto
==============================================================================
Binary file - no diff available.
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/site/resources/images/fisheye1.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: myfaces/tomahawk/trunk/sandbox/core/src/site/resources/images/fisheye2.png
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/sandbox/core/src/site/resources/images/fisheye2.png?rev=395398&view=auto
==============================================================================
Binary file - no diff available.
Propchange: myfaces/tomahawk/trunk/sandbox/core/src/site/resources/images/fisheye2.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: myfaces/tomahawk/trunk/sandbox/core/src/site/site.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/sandbox/core/src/site/site.xml?rev=395398&r1=395397&r2=395398&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/site/site.xml (original)
+++ myfaces/tomahawk/trunk/sandbox/core/src/site/site.xml Wed Apr 19 14:17:01 2006
@@ -38,6 +38,7 @@
<item name="Form" href="form.html"/>
<item name="Picklist" href="selectManyPicklist.html"/>
<item name="Dynamic Image" href="graphicImageDynamic.html"/>
+ <item name="FishEye Navigation Menu" href="fisheye.html"/>
</menu>
<menu name="Validators">
Added: myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/fisheye.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/fisheye.xml?rev=395398&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/fisheye.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/fisheye.xml Wed Apr 19 14:17:01 2006
@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+<document>
+ <!-- component name -->
+ <body>
+ <!-- Description -->
+ <section name="Description">
+ <p>
+ A navigation menu/toolbar with a nice mouse-over effect,
+ similar to the Mac OS X Dock. It is actually a JSF
+ implementation of the Fisheye List widget from the
+ <a href="http://dojotoolkit.org/">Dojo Toolkit</a>.
+ </p>
+ <p>
+ The component makes use of the Tomahawk navigation framework,
+ so the menu items can be added using t:navigationMenuItem
+ child components.
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+ <div><img src="images/fisheye1.png" alt="fisheye"/></div>
+ <div><img src="images/fisheye2.png" alt="fisheye"/></div>
+ </section>
+ <!-- API -->
+ <section name="API">
+ <table>
+ <tr>
+ <td>author</td>
+ <td>Jurgen Lust</td>
+ </tr>
+ <tr>
+ <td>component-family</td>
+ <td>javax.faces.Output</td>
+ </tr>
+ <tr>
+ <td>renderer-type</td>
+ <td>org.apache.myfaces.FishEyeList</td>
+ </tr>
+ <tr>
+ <td>component-class</td>
+ <td>org.apache.myfaces.custom.fisheye.HtmlFishEyeNavigationMenu</td>
+ </tr>
+ <tr>
+ <td>renderer-class</td>
+ <td>org.apache.myfaces.custom.fisheye.HtmlFishEyeNavigationMenuRenderer</td>
+ </tr>
+ <tr>
+ <td>tag-class</td>
+ <td>org.apache.myfaces.custom.fisheye.HtmlFishEyeNavigationMenuTag</td>
+ </tr>
+ </table>
+ </section>
+
+ <!-- Usage -->
+ <section name="Usage">
+ <source xml:space="preserve">
+<s:fishEyeNavigationMenu [id="myToolbar"]
+ [rendered="true|false"]
+ [itemWidth="50"]
+ [itemHeight="50"]
+ [itemMaxWidth="200"]
+ [itemMaxHeight="200"]
+ [orientation="horizontal|vertical"]
+ [effectUnits="2"]
+ [itemPadding="10"]
+ [attachEdge="top|bottom"]
+ [labelEdge="top|bottom"]>
+</s:fishEyeNavigationMenu>
+ </source>
+ </section>
+
+ <!-- Additional Information -->
+ <section name="Additional Information">
+ <p>see fisheye.jsp in the Sandbox examples.</p>
+ </section>
+ </body>
+
+</document>
Modified: myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/schedule.xml
URL: http://svn.apache.org/viewcvs/myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/schedule.xml?rev=395398&r1=395397&r2=395398&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/schedule.xml (original)
+++ myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/schedule.xml Wed Apr 19 14:17:01 2006
@@ -1,16 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "document-v12.dtd">
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
<document>
- <!-- component name -->
- <header>
- <title>Schedule</title>
- <subtitle><s:schedule/></subtitle>
- </header>
<body>
<!-- Description -->
- <section>
- <title>Description</title>
+ <section name="Description">
<p>
Renders a schedule component, showing appointments and events
in a day, workweek, week or month view, similar to the schedule
@@ -24,14 +19,13 @@
</p>
</section>
<!-- screen shot -->
- <section>
- <title>Screen Shot</title>
- <figure src="images/schedule.png" alt="schedule"/>
- <figure src="images/schedule.jpg" alt="schedule"/>
+ <section name="Screen Shot">
+
+ <div><img src="images/schedule.png" alt="schedule"/></div>
+ <div><img src="images/schedule.jpg" alt="schedule"/></div>
</section>
<!-- API -->
- <section>
- <title>API</title>
+ <section name="API">
<table>
<tr>
<td>author</td>
@@ -61,9 +55,8 @@
</section>
<!-- Usage -->
- <section>
- <title>Usage</title>
- <source>
+ <section name="Usage">
+ <source xml:space="preserve">
<s:schedule [ UI component attributes ]
[ UI command attributes ]
[value="#{backingBean.scheduleModel}"]
@@ -84,8 +77,8 @@
</section>
<!-- Syntax -->
- <section>
- <title>Syntax</title>
+ <section name="Syntax">
+
<note label="<x:schedule/>">
<code>
value - This must be a value binding expression that points to an instance of ScheduleModel.
@@ -237,10 +230,9 @@
</note>
</section>
- <!-- Instructions -->
- <section>
- <title>Instructions</title>
- <p>see examples/schedule.jsp for an example.</p>
+ <!-- Additional Information -->
+ <section name="Additional Information">
+ <p>see the Sandbox examples.</p>
</section>
</body>