You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by da...@apache.org on 2011/09/01 00:13:04 UTC
svn commit: r1163841 - /wicket/trunk/README
Author: dashorst
Date: Wed Aug 31 22:13:04 2011
New Revision: 1163841
URL: http://svn.apache.org/viewvc?rev=1163841&view=rev
Log:
Updated README
Modified:
wicket/trunk/README
Modified: wicket/trunk/README
URL: http://svn.apache.org/viewvc/wicket/trunk/README?rev=1163841&r1=1163840&r2=1163841&view=diff
==============================================================================
--- wicket/trunk/README (original)
+++ wicket/trunk/README Wed Aug 31 22:13:04 2011
@@ -78,23 +78,25 @@ Here is a list of projects in this distr
- 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-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;
+ configuration and markup cache;
- wicket-objectssizeof-agent: utility for making better estimates of object
- sizes in the JVM - most people probably never need this;
+ sizes in the JVM - most people probably never need this;
- wicket-ioc: base project for IoC (aka DI) implementations such as
- Spring and Guice;
+ Spring and Guice;
- wicket-spring: support project for using Spring with Wicket and including
- Spring managed dependencies through using @SpringBean annotations;
+ Spring managed dependencies through using @SpringBean annotations;
- 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-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.
- - wicket-devutils: provides small utilities which can help in development phase
+ how to use Wicket and Wicket components, including examples for sub
+ projects such as wicket-spring, wicket-velocity and wicket-auth-roles.
+ - wicket-devutils: provides small utilities which can help in development
+ phase
Getting started
---------------
@@ -105,24 +107,15 @@ started quickly:
- wicket-examples:
shows all components in short usage examples, also available live on:
- http://www.wicketstuff.org/wicket14
+ http://www.wicketstuff.org/wicket
- - wicket-quickstart:
+ - wicket-quickstart archetype:
provides a skeleton project for use in NetBeans, Eclipse, IntelliJ IDEA
and other major IDE's, without having to configure anything yourself. You
can copy'n'paste the examples from the website into your pages and see
them running on your own box.
- - qwicket (http://www.antwerkz.com/qwicket):
-
- Qwicket is a quickstart application for the wicket framework. Its intent
- is to provide a rapid method for creating a new wicket project with the
- basic infrastructure in place so that you can quickly get to the meat of
- your application rather than mucking with the plumbing of a wicket
- application. Currently, the system only supports spring and hibernate
- built with ant.
-
- AppFuse light - Wicket edition (https://appfuse-light.dev.java.net/)
AppFuse Light is a can all do it all quickstart setup for almost all
@@ -134,51 +127,54 @@ started quickly:
Dependencies
------------
-The easiest way of getting the dependencies of your Wicket based projects right
-is to use Apache Maven (http://maven.apache.org) with your projects and include
-the wicket dependencies you want is outlined in the wicket-quickstart.
+The easiest way of getting the dependencies of your Wicket based projects
+right is to use Apache Maven (http://maven.apache.org) with your projects and
+include the wicket dependencies you want is outlined in the wicket-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.
+If you do not want to use maven, here is a break down of the dependencies you
+need. For the complete and precise reference see the wicket-parent pom.xml in
+the src/ folder.
- 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.
+ You only need to include the Servlet API (2.5, just for compiling), SLF4J
+ API 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.
+ As the following projects all depend on wicket, they inherit these
+ dependencies.
- wicket-datetime:
- Joda-Time 1.4 (http://joda-time.sourceforge.net/)
+ Joda-Time 1.6 (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)
+
+ Apache Velocity 1.7 (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/)
+ 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-ioc and Spring (http://www.springframework.org/) and it's
+ dependencies
- wicket-guice:
- Google Guice (http://code.google.com/p/google-guice/).
+ Google Guice (http://code.google.com/p/google-guice/)
- wicket-examples:
- All of the above.
+ All of the above.
Building Wicket from source
---------------------------
@@ -189,7 +185,8 @@ and JavaDoc jars as well as the final ja
the Maven build tool. So there is actually no specific need to build Wicket
yourself from the distribution.
-Building using maven 2, change the working directory to src and either do:
+Building using Maven 2 or 3, change the working directory to src and either
+do:
- mvn package
@@ -200,12 +197,12 @@ Building using maven 2, change the worki
creates wicket-x.y.z.jar in target/ subdirectory and installs the file
into your local Maven repository for use in other projects.
-Migrating from 1.3
+Migrating from 1.4
------------------
This file is a copy of the migration guide from available on our Wiki:
- http://cwiki.apache.org/WICKET/migrate-14.html
+ http://cwiki.apache.org/WICKET/migrate-15.html
Getting help
------------
@@ -213,7 +210,7 @@ Getting help
- Read the online documentation available on our website
(http://wicket.apache.org)
- - Read the migration guide (migrate-14.html)
+ - Read the migration guide (migrate-15.html)
- Read the mailing archives available on Nabble, GMane and Apache
@@ -226,21 +223,26 @@ Getting help
Cryptographic Software Notice
-----------------------------
-This distribution includes cryptographic software. The country in which you currently reside may
-have restrictions on the import, possession, use, and/or re-export to another country, of encryption
-software. BEFORE using any encryption software, please check your country's laws, regulations and
-policies concerning the import, possession, or use, and re-export of encryption software, to
-see if this is permitted. See http://www.wassenaar.org for more information.
-
-The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified
-this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security
-software using or performing cryptographic functions with asymmetric algorithms. The form and manner
-of this Apache Software Foundation distribution makes it eligible for export under the License Exception
-ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations,
-Section 740.13) for both object code and source code.
+This distribution includes cryptographic software. The country in which you
+currently reside may have restrictions on the import, possession, use, and/or
+re-export to another country, of encryption software. BEFORE using any
+encryption software, please check your country's laws, regulations and
+policies concerning the import, possession, or use, and re-export of
+encryption software, to see if this is permitted. See http://www.wassenaar.org
+for more information.
+
+The U.S. Government Department of Commerce, Bureau of Industry and Security
+(BIS), has classified this software as Export Commodity Control Number (ECCN)
+5D002.C.1, which includes information security software using or performing
+cryptographic functions with asymmetric algorithms. The form and manner of
+this Apache Software Foundation distribution makes it eligible for export
+under the License Exception ENC Technology Software Unrestricted (TSU)
+exception (see the BIS Export Administration Regulations, Section 740.13) for
+both object code and source code.
The following provides more details on the included cryptographic software:
-For encoding HTTP URL data (see org.apache.wicket.request.mapper.CryptoMapper)
-Wicket requires the Java Cryptography extensions (http://java.sun.com/javase/technologies/security/). Wicket
-does not include these libraries itself, but is designed to use them.
+For encoding HTTP URL data (see org.apache.wicket.request.mapper.CryptoMapper)
+Wicket requires the Java Cryptography extensions
+(http://java.sun.com/javase/technologies/security/). Wicket does not include
+these libraries itself, but is designed to use them.