You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by eh...@apache.org on 2007/09/20 08:35:01 UTC
svn commit: r577576 - /wicket/trunk/README
Author: ehillenius
Date: Wed Sep 19 23:35:01 2007
New Revision: 577576
URL: http://svn.apache.org/viewvc?rev=577576&view=rev
Log:
added description of projects and dependencies to the README file
Modified:
wicket/trunk/README
Modified: wicket/trunk/README
URL: http://svn.apache.org/viewvc/wicket/trunk/README?rev=577576&r1=577575&r2=577576&view=diff
==============================================================================
--- wicket/trunk/README (original)
+++ wicket/trunk/README Wed Sep 19 23:35:01 2007
@@ -16,7 +16,9 @@
--------
- License
- Java/Application server requirements
+ - What is in this package
- Getting started
+ - Dependencies
- Building Wicket from source
- Migrating from 1.2
- Getting help
@@ -34,6 +36,38 @@
Wicket requires at least Java 1.4. The application server for running your web
application should adhere to the servlet specification version 2.3 or newer.
+What is in this package
+-----------------------
+
+The archive you just downloaded and unpacked contains the jars of the core
+projects of Wicket. If you are just starting out, you probably only need to
+include wicket-x.jar, where x stands for the version. As a rule, use just
+the jars you need.
+
+Here is a list of projects in this distribution and what they do.
+
+ - wicket: the core project, includes the framework and basic components;
+ - wicket-extensions: contains utilities and more specialized components;
+ - wicket-auth-roles: a basic authorization package based on roles;
+ - wicket-datetime: contains date/ time specific components such as a date picker;
+ - wicket-jmx: registers JMX beans for managing things like your Wicket
+ configuration and markup cache;
+ - wicket-objectssizeof-agent: utility for making better estimates of object
+ sizes in the JVM - most people probably never need this;
+ - wicket-ioc: base project for IoC (aka DI) implementations such as
+ Spring and Guice;
+ - wicket-spring: support project for using Spring with Wicket;
+ - wicket-spring-annot: supports including Spring managed dependencies
+ through using @SpringBean annotations - recommended for most users
+ who use Spring and can use JDK 5 and up;
+ - wicket-guice: support project for using Google Guice with Wicket;
+ - wicket-velocity: contains special components for rendering Velocity templates
+ using Wicket components - most people probably don't need this, but it
+ can be neat when you want to do CMS-like things;
+ - wicket-examples: contains a basic component reference and many examples of
+ how to use Wicket and Wicket components, including examples for sub
+ projects such as wicket-spring, wicket-velocity and wicket-auth-roles.
+
Getting started
---------------
@@ -68,6 +102,61 @@
technologies. It features over 60 downloads and combines each available
web application framework with Hibernate, iBatis, JDO (JPOX), OJB and
Spring JDBC.
+
+Dependencies
+------------
+
+The easiest way of getting the dependencies of your Wicket based projects right is to use Maven with your projects and include the wicket dependencies you want like is outlined in the quickstart. Maven will then take care of including the appropriate dependencies.
+
+If you do not want to use maven, here is a break down of the dependencies you need.
+
+ - wicket and wicket-extensions:
+
+ You only need to include the Servlet API (2.3, just for compiling) and
+ the SLF4J logging implementation you want. You cannot use Wicket without
+ adding a SLF4J logging implementation to your classpath. Most people use
+ log4j. If you do, just include slf4j-log4j12.jar on your classpath to get
+ Wicket to use log4j too. If you want to use commons-logging or JDK14
+ logging or something else, please see the SLF4J site (http://www.slf4j.org/)
+ for more information.
+
+ As the following projects all depend on wicket, they inherit these dependencies.
+
+ - wicket-auth-roles, wicket-jmx and wicket-objectssize-agent:
+
+ JDK 5 or up (though JMX can be run on 1.4 with an
+ extension package if you really need to).
+
+ - wicket-datetime:
+
+ Joda-Time 1.4 (http://joda-time.sourceforge.net/)
+
+ - wicket-velocity:
+
+ Apache Velocity 1.4 (http://velocity.apache.org/) and it's
+ dependencies (it ships a velocity-deps jar for convenience)
+
+ - wicket-ioc:
+
+ gclib nodep 2.1.3 (http://cglib.sourceforge.net/) and
+ asm 1.5.3 (http://asm.objectweb.org/)
+
+ - wicket-spring:
+
+ wicket-ioc and Spring (http://www.springframework.org/) and
+ it's dependencies
+
+ - wicket-spring-annots:
+
+ wicket-spring and needs to run on JDK 5 or up
+
+ - wicket-guice:
+
+ Google Guice (http://code.google.com/p/google-guice/) and runs on JDK 5 or up.
+
+ - wicket-examples:
+
+ All of the above.
Building Wicket from source
---------------------------
Re: svn commit: r577576 - /wicket/trunk/README
Posted by Eelco Hillenius <ee...@gmail.com>.
On 9/20/07, Martijn Dashorst <ma...@gmail.com> wrote:
> I appreciate the effort but we are very much better off if we could
> include the generated dependencies reports of maven. This readme
> document will get stale and out of date. And when building a release
> you really don't have the time to parse and verify the readme document
> for libraries.
On the really long term maybe. For now I solved an immediate problem.
> maven does have a couple of interesting reports, and the dependency
> report is one of them. It is a shame we can't get maven to do a good
> multi-module website that retains intersite links.
Go for it. I didn't want to spend too much time on it annoyed as I was
with that maven thing coming up again.
Also note that stating those dependencies is only half of it. The
other part is a short project description. Which could be pulled from
maven too I guess, but it's probably the difference between spending
hours of getting those reports right and a quick fix (one hour) that I
commited here.
Eelco
Re: svn commit: r577576 - /wicket/trunk/README
Posted by Gerolf Seitz <ge...@gmail.com>.
On 9/20/07, Martijn Dashorst <ma...@gmail.com> wrote:
>
> maven does have a couple of interesting reports, and the dependency
> report is one of them. It is a shame we can't get maven to do a good
> multi-module website that retains intersite links.
did you take a look/try on WICKET-952?
Gerolf
Martijn
>
> --
> Buy Wicket in Action: http://manning.com/dashorst
> Apache Wicket 1.3.0-beta3 is released
> Get it now: http://www.apache.org/dyn/closer.cgi/wicket/1.3.0-beta3/
>
Re: svn commit: r577576 - /wicket/trunk/README
Posted by Martijn Dashorst <ma...@gmail.com>.
I appreciate the effort but we are very much better off if we could
include the generated dependencies reports of maven. This readme
document will get stale and out of date. And when building a release
you really don't have the time to parse and verify the readme document
for libraries.
maven does have a couple of interesting reports, and the dependency
report is one of them. It is a shame we can't get maven to do a good
multi-module website that retains intersite links.
Martijn
--
Buy Wicket in Action: http://manning.com/dashorst
Apache Wicket 1.3.0-beta3 is released
Get it now: http://www.apache.org/dyn/closer.cgi/wicket/1.3.0-beta3/