click-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r731099 - in /incubator/click/trunk/click/documentation: docs/building.html docs/extensions.html docs/extras-overview.html docs/velocity/velocity.html toc.html
Date Sat, 03 Jan 2009 22:11:13 GMT
Author: sabob
Date: Sat Jan  3 14:11:13 2009
New Revision: 731099

added extensions doco


Added: incubator/click/trunk/click/documentation/docs/extensions.html
--- incubator/click/trunk/click/documentation/docs/extensions.html (added)
+++ incubator/click/trunk/click/documentation/docs/extensions.html Sat Jan  3 14:11:13 2009
@@ -0,0 +1,60 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+   Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+    <head>
+        <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+        <meta name="Author" content="Malcolm Edgar"/>
+        <meta name="description" lang="en" content="Apache Click Java web application
+        <meta name="keywords" lang="en" content="Apache Click, Click Framework, Java,
JEE, J2EE, web application framework, open source"/>
+        <title>Apache Click</title>
+        <link rel="stylesheet" type="text/css" href="../help.css"/>
+        <style type="text/css">
+            th { text-align: left; }
+            td { vertical-align: top; white-space: nowrap; }
+        </style>
+    </head>
+    <body>
+        <h1>Click Extensions</h1>
+        There are a number of extension projects that provides extra features
+        and components.
+        <p/>
+        Below is a list of third party contributions:
+        <ul>
+            <li>
+                <a class="external" target="_blank" href="">Click
+                provides a DHTML popup Calendar component for Click. The Calendar component
+                based upon the JSCalendar library <a class="external" target="_blank"
+            </li>
+            <li>
+                <a class="external" target="_blank" href="">Click
+                provides common Chart components for Click. The Chart components
+                are based upon the JavaScript library <a class="external" target="_blank"
+            </li>
+        </ul>
+        Any questions regarding these projects should be raised on one of the <a href="click-online.html#mailing-lists">Click
mailing</a> lists.
+    </body>

Modified: incubator/click/trunk/click/documentation/docs/extras-overview.html
--- incubator/click/trunk/click/documentation/docs/extras-overview.html (original)
+++ incubator/click/trunk/click/documentation/docs/extras-overview.html Sat Jan  3 14:11:13
@@ -43,69 +43,14 @@
-Click Extras provides a place for people to contribute their own code to the
-Click project and have it package with the standard distribution. Contributed
-code will be subject to review and may require modifications before it is
-included in the Click distribution.
-One of the overriding design principles with Click is to keep it simple, this
-makes to code easier to understand and more reliable. 
-Another guiding principle is YAGNI (You Ain't Going to Need It), or don't build 
-it until you really really need it. Click is trying to provide an 80/20 rule framework 
-where 80% of peoples needs are meet by a framework which is only 20% in size.
-When developing Click Extras contributions please follow these principles.
-Components and controls should have minimal dependencies. This is to support easy 
-deployment of the click-examples and keeps the click build process simple. 
-See <a href="../building.html#extras-dependencies">Extras Dependencies</a> for

-Please Note the Cayenne and Spring dependencies are only required if you use these particular
-For example if you are using Hibernate for your persistence framework, the 
-<a href="net/sf/click/extras/cayenne/CayenneForm.html">CayenneForm</a> 
+Please Note the Cayenne, Hibernate and Spring dependencies are only required if you use these
particular features.
+For example if you are using Hibernate for your persistence framework, the
+<a href="../extras-api/net/sf/click/extras/cayenne/CayenneForm.html">CayenneForm</a>
 control will not cause any issues as this class would never be loaded by your application.
-<h3>Auto File Deployment</h3>
-The Click framework uses the Velocity Tools <tt>WebappLoader</tt> for loading
-This avoids issues associate with using the Velocity <tt>ClasspathResourceLoader</tt>
-<tt>FileResourceLoader</tt> on JEE application servers.
-To make preconfigured resources (templates, stylesheets, etc.) available to web applications
-Click automatically deploys configured classpath resources to the <tt class="blue">/click</tt>

-directory at startup (existing files will not be overwritten).
-To enable your controls to deploy resources on startup either place the resources
-in the Click Extras JAR folder 'META-INF/web/' or use the Control
-<a href="../click-api/net/sf/click/Control.html#on-deploy">onDeploy()</a> method.
-Click extra controls which use the <tt>onDeploy</tt> method should be registered
-in Click Extras JAR <tt>extras-controls.xml</tt> file. See the section
-<a href="configuration.html#deploying-custom-resources">Deploying Custom Resources</a>
-for more information on resource deployment.
-<h3>Coding Style and Practices</h3>
-Click follows the Sun conversions for Java code style. Other style convertions
-and practices include:
-<ul style="margin-top:0.75em;margin-bottom:0.75em;">
-<li>indents are 4 spaces wide and no tabs are used</li>
-<li>public and protected visibility members require Javadoc</li>
-<li>private and package visiblity members do not require Javadoc</li>
-<li>favour the use of unchecked <tt>RuntimeException</tt> and avoid creating
new Exception classes</li>
-<li>check method parametes and throw <tt>IllegalArguementException</tt>
if parameters are null or invalid</li>
-<li>avoid creating any more classes than you need to get the job done</li>
-<li>localize control messages in the classe's <tt>properties</tt> files</li>
-<li>use the <tt>Context.getLocale()</tt> method to obtain a users locale</li>
-<li>before checking in code run the Ant task: <tt>ant format-java</tt>
+For a detailed list of dependencies please see <a href="building.html#extras-dependencies">Extras

Modified: incubator/click/trunk/click/documentation/docs/velocity/velocity.html
--- incubator/click/trunk/click/documentation/docs/velocity/velocity.html (original)
+++ incubator/click/trunk/click/documentation/docs/velocity/velocity.html Sat Jan  3 14:11:13
@@ -22,7 +22,7 @@
-Velocity is a Java-based template framework which provides the HTML rending engine 
+Velocity is a Java-based template framework which provides the default HTML rending engine
 for Click. Velocity is very easy to learn, simple to use, and is also very capable.
 <a href="">Velocity</a> is an open source 

Modified: incubator/click/trunk/click/documentation/toc.html
--- incubator/click/trunk/click/documentation/toc.html (original)
+++ incubator/click/trunk/click/documentation/toc.html Sat Jan  3 14:11:13 2009
@@ -95,8 +95,13 @@
-<a target='topic' class='navLinkTopic' href='docs/building.html' title=' Building Framework
and Examples'>
+<a target='topic' class='navLinkTopic' href='docs/extensions.html' title=' Extention Projects'>
+Extension Projects</a>
+<a target='topic' class='navLinkTopic' href='docs/developer-guide/developer-guide.html'
title=' Guide for developers and contributors'>
+Developer Guide</a>

View raw message