You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by ma...@apache.org on 2005/03/15 10:08:28 UTC
cvs commit: incubator-myfaces/src/documentation/content/xdocs tabs.xml site.xml
matzew 2005/03/15 01:08:28
Modified: src/documentation/content/xdocs tabs.xml site.xml
Added: src/documentation/resources/images tree2.jpeg jscookmenu.png
src/documentation/content/xdocs/components treeTable.xml
overview.xml jscookmenu.xml tree2.xml
component-template.xml
Log:
added forrest stuff from Sean Schofield
Revision Changes Path
1.1 incubator-myfaces/src/documentation/resources/images/tree2.jpeg
<<Binary file>>
1.1 incubator-myfaces/src/documentation/resources/images/jscookmenu.png
<<Binary file>>
1.1 incubator-myfaces/src/documentation/content/xdocs/components/treeTable.xml
Index: treeTable.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>Tree Table</title>
<subtitle><x:treeTable/></subtitle>
</header>
<body>
<!-- Description -->
<section>
<title>Description</title>
<p>
[TO DO]
</p>
</section>
<!-- screen shot -->
<section>
<title>Screen Shot</title>
<p>[TO DO]</p> <!-- replace with either a figure or Not Available -->
<!--
<figure src="jscookmenu.png" alt="jscookmenu"/>
-->
</section>
<!-- API -->
<section>
<title>API</title>
<table>
<tr>
<td>component-family</td>
<td>[TODO]</td>
</tr>
<tr>
<td>renderer-type</td>
<td>[TODO]</td>
</tr>
<tr>
<td>component-class</td>
<td>[TODO]</td>
</tr>
<tr>
<td>renderer-class</td>
<td>[TODO]</td>
</tr>
<tr>
<td>tag-class</td>
<td>[TODO]</td>
</tr>
</table>
</section>
<!-- Syntax -->
<section>
<title>Syntax</title>
<p>[TO DO]</p>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>[TO DO]</p>
</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 - 2005, Apache Software Foundation
</legal>
</footer>
</document>
1.1 incubator-myfaces/src/documentation/content/xdocs/components/overview.xml
Index: overview.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "document-v12.dtd">
<document>
<header>
<title>Overview of the Apache MyFaces Components</title>
</header>
<body>
<section>
<title>Custom Components</title>
<ul>
<li></li>
</ul>
</section>
<section>
<title>Extended Components and Other "Goodies"</title>
<ul>
<li></li>
</ul>
</section>
<section>
<title>Requirements and Setup</title>
</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>
1.1 incubator-myfaces/src/documentation/content/xdocs/components/jscookmenu.xml
Index: jscookmenu.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "document-v12.dtd">
<document>
<!-- component name -->
<header>
<title>JSCook Menu</title>
<subtitle><x:jscookMenu/></subtitle>
</header>
<body>
<!-- Description -->
<section>
<title>Description</title>
<p>
Renders a Javascript Menu based on the excellent
<link href="http://www.cs.ucla.edu/~heng/JSCookMenu">JSCookMenu</link>
by Heng Yuan. Renders the nested NavigationMenuItem(s) as Javascript Menu.
</p>
</section>
<!-- screen shot -->
<section>
<title>Screen Shot</title>
<figure src="images/jscookmenu.png" alt="jscookmenu"/>
</section>
<!-- API -->
<section>
<title>API</title>
<table>
<tr>
<td>component-family</td>
<td>[TODO]</td>
</tr>
<tr>
<td>renderer-type</td>
<td>[TODO]</td>
</tr>
<tr>
<td>component-class</td>
<td>[TODO]</td>
</tr>
<tr>
<td>renderer-class</td>
<td>[TODO]</td>
</tr>
<tr>
<td>tag-class</td>
<td>[TODO]</td>
</tr>
</table>
</section>
<!-- Syntax -->
<section>
<title>Syntax</title>
<p>[TO DO]</p>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>If you want to use jscookMenu in your application, you will have to: </p>
<ul>
<li>
Add jscookmenu directory containing css and scripting code to your web directory
(you can find it in the examples application).
</li>
<li>
Add scripts and stylesheets for the theme you would like to use to html-header
(see also inc/header.inc in the examples application)
</li>
</ul>
<p>
<code><!-- JSCook Menu --></code><br/>
<code><script language="JavaScript" src="jscookmenu/JSCookMenu.js" type="text/javascript"></script></code><br/>
<code><script language="JavaScript" src="jscookmenu/ThemeOffice/theme.js"></script></code> <br/>
<code><link rel="stylesheet" href="jscookmenu/ThemeOffice/theme.css" type="text/css"></code> <br/>
<code><script language="JavaScript" src="jscookmenu/ThemeMiniBlack/theme.js"></script></code> <br/>
<code><link rel="stylesheet" href="jscookmenu/ThemeMiniBlack/theme.css" type="text/css"></code> <br/>
<code><script language="JavaScript" src="jscookmenu/ThemeIE/theme.js"></script></code> <br/>
<code><link rel="stylesheet" href="jscookmenu/ThemeIE/theme.css" type="text/css"></code> <br/>
<code><script language="JavaScript" src="jscookmenu/ThemePanel/theme.js"></script></code> <br/>
<code><link rel="stylesheet" href="jscookmenu/ThemePanel/theme.css" type="text/css"></code> <br/>
</p>
</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 - 2005, Apache Software Foundation
</legal>
</footer>
</document>
1.1 incubator-myfaces/src/documentation/content/xdocs/components/tree2.xml
Index: tree2.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>Tree2</title>
<subtitle><x:tree2/></subtitle>
</header>
<body>
<!-- Description -->
<section>
<title>Description</title>
<p>
A component that provides an HTML-based tree from data supplied by a backing
bean. The tree is highly customizable and allows for fine-grained control
over the appearance of each of the nodes depending on their type. Almost any
type of JSF component (text, image, checkbox, etc.) can be rendered inside the
nodes and there is an option for client-side or server-side toggling of the
expand/collapse state.
</p>
</section>
<!-- screen shot -->
<section>
<title>Screen Shot</title>
<figure src="images/tree2.jpeg" alt="Tree2"/>
</section>
<!-- API -->
<section>
<title>API</title>
<table>
<tr>
<td>component-family</td>
<td>org.apache.myfaces.HtmlTree</td>
</tr>
<tr>
<td>renderer-type</td>
<td>org.apache.myfaces.Tree</td>
</tr>
<tr>
<td>component-class</td>
<td>org.apache.myfaces.custom.tree2.HtmlTree</td>
</tr>
<tr>
<td>renderer-class</td>
<td>org.apache.myfaces.custom.tree2.HtmlTreeRenderer</td>
</tr>
<tr>
<td>tag-class</td>
<td>org.apache.myfaces.custom.tree2.TreeTag</td>
</tr>
</table>
</section>
<!-- Syntax -->
<section>
<title>Syntax</title>
<note label="<x:tree2>">
<code>id</code><br/>
<code>clientSideToggle [true|false] (default=true)</code><br/>
<code>imageLocation</code><br/>
<code>javascriptLocation</code><br/>
<code>showLines [true|false] (default=true)</code><br/>
<code>showNav [true|false] (default=true)</code><br/>
<code>showRootNode [true|false] (default=true)</code><br/>
<code>styleLocation</code><br/>
<code>value [value binding expression] (required)</code><br/>
<code>var</code><br/>
<code>varNodeToggler</code><br/>
</note>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>[TO DO]</p>
</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 - 2005, Apache Software Foundation
</legal>
</footer>
</document>
1.1 incubator-myfaces/src/documentation/content/xdocs/components/component-template.xml
Index: component-template.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>
<!-- ex. JSCook Menu -->
<title>[TO DO]</title>
<!-- ex. <x:jsCookMenu> -->
<subtitle>[TO DO]</subtitle>
</header>
<body>
<!-- Description -->
<section>
<title>Description</title>
<p>
[TO DO]
</p>
</section>
<!-- screen shot -->
<section>
<title>Screen Shot</title>
<p>[TO DO]</p> <!-- replace with either a figure or Not Available -->
<!--
<figure src="jscookmenu.png" alt="jscookmenu"/>
-->
</section>
<!-- API -->
<section>
<title>API</title>
<table>
<tr>
<td>component-family</td>
<td>[TODO]</td>
</tr>
<tr>
<td>renderer-type</td>
<td>[TODO]</td>
</tr>
<tr>
<td>component-class</td>
<td>[TODO]</td>
</tr>
<tr>
<td>renderer-class</td>
<td>[TODO]</td>
</tr>
<tr>
<td>tag-class</td>
<td>[TODO]</td>
</tr>
</table>
</section>
<!-- Syntax -->
<section>
<title>Syntax</title>
<p>[TO DO]</p>
</section>
<!-- Instructions -->
<section>
<title>Instructions</title>
<p>[TO DO]</p>
</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 - 2005, Apache Software Foundation
</legal>
</footer>
</document>
1.5 +1 -0 incubator-myfaces/src/documentation/content/xdocs/tabs.xml
Index: tabs.xml
===================================================================
RCS file: /home/cvs/incubator-myfaces/src/documentation/content/xdocs/tabs.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- tabs.xml 12 Jan 2005 14:53:38 -0000 1.4
+++ tabs.xml 15 Mar 2005 09:08:28 -0000 1.5
@@ -7,6 +7,7 @@
xmlns:xlink="http://www.w3.org/1999/xlink">
<tab label="Project" dir="" id="project" indexfile="index.html"/>
+ <tab label="Components" dir="components/" id="components" indexfile="overview.html"/>
<tab label="Documentation" dir="docs/" id="documentation" indexfile="gettingstarted.html"/>
<tab label="Community" dir="community/" id="community" indexfile="mailinglists.html"/>
1.10 +6 -0 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.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- site.xml 11 Mar 2005 11:20:59 -0000 1.9
+++ site.xml 15 Mar 2005 09:08:28 -0000 1.10
@@ -7,6 +7,12 @@
<downloads label="Downloads" href="downloads.html" />
<livesites label="Web apps using MyFaces" href="livesites.html"/>
</project-information>
+ <components href="components/" label="Components" tab="components">
+ <overview label="Overview" href="overview.html"/>
+ <jscookmenu label="JSCook Menu" href="jscookmenu.html"/>
+ <tree label="Tree2" href="tree2.html"/>
+ <treTable label="Tree Table" href="treeTable.html"/>
+ </components>
<docu href="docs/" label="Documentation" tab="documentation">
<gettingstarted label="Getting Started" href="gettingstarted.html"/>
<ri label="MyFaces and RI" href="risamples.html"/>