Browse Source

#7424, #7435 Reworked license and release-notes files

svn changeset:20562/svn branch:6.7
tags/6.7.0.beta1
Artur Signell 12 years ago
parent
commit
6373b86b8c
5 changed files with 1132 additions and 287 deletions
  1. 0
    0
      WebContent/css/ie.css
  2. 441
    0
      WebContent/css/styles.css
  3. BIN
      WebContent/img/vaadin-logo.png
  4. 232
    0
      WebContent/license.html
  5. 459
    287
      WebContent/release-notes.html

+ 0
- 0
WebContent/css/ie.css View File


+ 441
- 0
WebContent/css/styles.css View File

@@ -0,0 +1,441 @@
html {
margin: 0;
padding: 0;
text-align: center;
}

body {
background-color: #fff;
font: normal 14px/20px Helvetica, "Lucida Grande", Arial, Verdana, sans-serif;
color: #464440;
padding: 0;
min-width: 980px;
text-align: left;
margin: 0 auto;
}

.clearer {
height: 0;
overflow: hidden;
clear: both;
}

h1,h2,h3,h4,h5,h6 {
color: #000;
font-weight: normal;
line-height: normal;
}

h1 {
font-size: 48px;
font-weight: bold;
}

h2 {
font-size: 36px;
font-weight: bold;
}

h3 {
font-size: 30px;
font-weight: bold;
margin-bottom: 23px;
}

h4 {
font-size: 18px;
margin-bottom: .8em;
}

h5 {
font-size: 16px;
margin-bottom: .5em;
}

h6 {
font-size: 14px;
margin: .6em 0 .1em;
}

p {
margin: 0 0 1em;
}

a {
text-decoration: none;
padding: 0 3px;
margin: 0 -3px;
-moz-border-radius: 2px;
-webkit-border-radius: 2px;
border-radius: 2px;
}

a:link {
color: #00a2d8;
}

a:visited {
color: #003648;
}

a:hover {
background: #e4e3da;
color: #505048;
}

a:active {
color: #000;
background: #a09f91;
}

ul {
list-style-type: square;
}

.codeblock {
background: #f0efea;
padding: 1em;
margin: 1em 0;
-webkit-border-radius: 8px;
-moz-border-radius: 8px;
}

.codeblock h4 {
margin-top: 0;
}


/***************************************************
* Furniture
***************************************************/

#header {
height: 93px;
position: relative;
}

#header h1 {
width: 393px;
height: 46px;
background: transparent url(../img/vaadin-logo.png) no-repeat;
position: absolute;
top: 23px;
left: 50%;
margin: 0;
margin-left: -484px;
text-indent: -9999px;
}

#version {
position: absolute;
left: 50%;
top: 38px;
color: #000;
text-align: right;
width: 484px;
}

#version a {
color: #78776d;
display: inline-block;
zoom: 1;
padding: 1px 12px;
font-size: 12px;
background: #e4e3da;
-moz-border-radius: 9px;
-webkit-border-radius: 9px;
border-radius: 9px;
}

#version a:hover {
border: none;
background: #a09f91;
color: #fff;
}

#version .release-notes {
margin-left: 10px;
}

#subheader {
position: relative;
height: 38px;
line-height: 38px;
background: #000;
}

#menu,
#links {
list-style: none;
padding: 0;
margin: 0;
}

#subheader li {
display: inline;
float: left;
padding: 0;
}

#menu {
position: absolute;
left: 50%;
width: 650px;
margin-left: -483px;
font-weight: bold;
white-space: nowrap;
z-index: 2;
}

#menu li {
margin: 0 .3em;
}

#menu li,
#menu a {
color: #d9d8cb;
}

#links {
width: 484px;
position: absolute;
top: 2px;
left: 50%;
z-index: 1;
}

#links li {
float: right;
}

#links a {
font-size: 12px;
line-height: 34px;
color: #a09f91;
margin-left: 14px;
white-space: nowrap;
}

#subheader a:hover {
background: transparent;
color: #fff;
}

ul {
padding-left: 1.3em;
}

#footer {
margin: 0 auto;
width: 968px;
height: 60px;
color: #000;
font-size: 11px;
}

#footer a {
float: right;
}

#footer strong {
font-size: 13px;
}

#footer strong em {
color: #00b4f0;
font-style: normal;
margin: 0 0.2em 0 -0.15em;
}

/***************************************************
* Content wrapper
***************************************************/

#content {
position: relative;
margin: 0 0 56px -484px;
left: 50%;
width: 968px;
overflow: hidden;
}



/***************************************************
* Vertical tabs
***************************************************/
#tabs {
float: left;
width: 196px;
}

#tabs .tab {
font-size: 18px;
cursor: pointer;
padding: 8px 14px;
background: #fff;
color: #a09f91;
-webkit-transition: linear .2s color;
}

#tabs .tab * {
vertical-align: middle;
}

#tabs .tab a {
margin: 0;
padding: 0;
color: #00a2d8;
-webkit-transition: linear .2s color;
}

#tabs .tab:hover a,
#tabs .tab a:focus {
background: transparent;
margin: 0;
padding: 0;
color: #464440;
}

#tabs .tab:hover {
color: #464440;
}

#tabs .tab span {
font-size: 9px;
margin-left: .7em;
}

#tabs .selected,
#tabs .selected:hover,
#tabs .selected:hover a,
#tabs .selected a,
#tabs .selected a:hover,
#tabs .selected a:focus {
color: #000;
cursor: default;
-webkit-transition: linear .2s color;
font-weight: bold;
}

#tabs .first {
margin-top: 0;
}

h3.reasons {
color: #78776d;
margin: 0 0 40px;
height: 30px;
}
#reasons {
list-style: none;
margin: 0;
padding: 0;
}

#reasons.js {
float: left;
width: 769px;
}

#reasons .tab {
display: block;
margin: 0 0 1em;
padding: 20px 40px;
background: #efeee9;
-webkit-border-radius: 9px;
-moz-border-radius: 9px;
border-radius: 9px;
clear: left;
overflow: hidden;
}

#reasons.js .tab {
width: 689px;
}

#reasons .tab h4 {
font-weight: bold;
font-size: 24px;
margin: 14px 0 24px;
}

#reasons .tab .col {
width: 22.8%;
margin-right: 2%;
float: left;
margin-bottom: 2em;
}

#reasons .tab .col2 {
width: 47.8%;
margin-right: 2%;
float: left;
margin-bottom: 2em;
}

#reasons .tab .col3 {
width: 72.8%;
margin-right: 2%;
float: left;
margin-bottom: 2em;
}

#reasons .tab .col4 {
clear: left;
margin-bottom: 2em;
}

#reasons .tab .newline {
clear: left;
}

#reasons .tab p:last-child {
margin: 0;
}

#reasons .tab h5 {
margin-top: 0;
}


/***************************************************
* Section specific styles
***************************************************/
img {
border: none;
}

.book {
overflow: hidden;
}

.book h5 {
font-weight: bold;
font-size: 18px;
}

.book h6 {
margin: -0.7em 0 .7em;
color: #464440;
font-size: 13px;
font-style: italic;
color: #736f5e;
}

.book img {
float: left;
margin-right: 1.2em;
}

.dzone img,
.tutorial img {
float: left;
margin: 0 1em 2em 0;
}

.tools img {
margin: 0em 2em .8em 2em;
float: right;
}

BIN
WebContent/img/vaadin-logo.png View File


+ 232
- 0
WebContent/license.html View File

@@ -0,0 +1,232 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Vaadin</title>
<link rel="stylesheet" type="text/css" href="css/styles.css" />
<!--[if IE]>
<link rel="stylesheet" type="text/css" href="css/ie.css" />
<![endif]-->
</head>
<body>

<div id="header">
<h1>Vaadin &ndash; thinking of U and I</h1>
<div id="version"></div>
</div>
<!-- /header -->

<div id="content">

<h1>Licensing Summary</h1>

<p>
<strong><i>Vaadin Framework</i> is intended to be freely
used and extended by anyone without any fees</strong>. In order to guarantee
these freedoms, <i>Vaadin Framework</i> is licensed under the Apache
License, Version 2.0.
</p>
<p>The Vaadin software and sample code developed by Vaadin Ltd. is
licensed under the Apache License, v. 2.0.</p>
<p>
Vaadin uses, but does not include, Google Web Toolkit. Google Web
Toolkit is also licensed under the Apache License, v 2.0. See <a
href="http://code.google.com/webtoolkit/terms.html">http://code.google.com/webtoolkit/terms.html</a>
for more details.
</p>
<p>
Trademarks for "Vaadin" and "}>" are owned by <a
href="http://vaadin.com/company">Vaadin Ltd</a>. You may not market
your products using Vaadin -brand name without written permission
from <a href="http://vaadin.com/company">Vaadin Ltd</a>.
</p>
<p>
Copyright to <i>Vaadin Framework</i> is owned by <a
href="http://vaadin.com/company">Vaadin Ltd</a>.
</p>

<p>
If you have any questions on licensing terms, please <a
href="http://vaadin.com/contact">contact us</a>.
</p>

<h1>
<a name="apachelicense">Apache License</a>
</h1>
<h2>Terms and Conditions for Use, Reproduction and Distribution</h2>
<pre>
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction, and
distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the
copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other
entities that control, are controlled by, or are under common control with
that entity. For the purposes of this definition, "control" means (i) the
power, direct or indirect, to cause the direction or management of such
entity, whether by contract or otherwise, or (ii) ownership of fifty percent
(50%) or more of the outstanding shares, or (iii) beneficial ownership of
such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising
permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation source, and
configuration files.

"Object" form shall mean any form resulting from mechanical transformation
or translation of a Source form, including but not limited to compiled
object code, generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form,
made available under the License, as indicated by a copyright notice that is
included in or attached to the work (an example is provided in the Appendix
below).

"Derivative Works" shall mean any work, whether in Source or Object form,
that is based on (or derived from) the Work and for which the editorial
revisions, annotations, elaborations, or other modifications represent, as a
whole, an original work of authorship. For the purposes of this License,
Derivative Works shall not include works that remain separable from, or
merely link (or bind by name) to the interfaces of, the Work and Derivative
Works thereof.

"Contribution" shall mean any work of authorship, including the original
version of the Work and any modifications or additions to that Work or
Derivative Works thereof, that is intentionally submitted to Licensor for
inclusion in the Work by the copyright owner or by an individual or Legal
Entity authorized to submit on behalf of the copyright owner. For the
purposes of this definition, "submitted" means any form of electronic,
verbal, or written communication sent to the Licensor or its
representatives, including but not limited to communication on electronic
mailing lists, source code control systems, and issue tracking systems that
are managed by, or on behalf of, the Licensor for the purpose of discussing
and improving the Work, but excluding communication that is conspicuously
marked or otherwise designated in writing by the copyright owner as "Not a
Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on
behalf of whom a Contribution has been received by Licensor and subsequently
incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of this
License, each Contributor hereby grants to You a perpetual, worldwide,
non-exclusive, no-charge, royalty-free, irrevocable copyright license to
reproduce, prepare Derivative Works of, publicly display, publicly perform,
sublicense, and distribute the Work and such Derivative Works in Source or
Object form.

3. Grant of Patent License. Subject to the terms and conditions of this
License, each Contributor hereby grants to You a perpetual, worldwide,
non-exclusive, no-charge, royalty-free, irrevocable (except as stated in
this section) patent license to make, have made, use, offer to sell, sell,
import, and otherwise transfer the Work, where such license applies only to
those patent claims licensable by such Contributor that are necessarily
infringed by their Contribution(s) alone or by combination of their
Contribution(s) with the Work to which such Contribution(s) was submitted.
If You institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work or a
Contribution incorporated within the Work constitutes direct or contributory
patent infringement, then any patent licenses granted to You under this
License for that Work shall terminate as of the date such litigation is
filed.

4. Redistribution. You may reproduce and distribute copies of the Work or
Derivative Works thereof in any medium, with or without modifications, and
in Source or Object form, provided that You meet the following conditions:

a. You must give any other recipients of the Work or Derivative Works a copy
of this License; and

b. You must cause any modified files to carry prominent notices stating that
You changed the files; and

c. You must retain, in the Source form of any Derivative Works that You
distribute, all copyright, patent, trademark, and attribution notices from
the Source form of the Work, excluding those notices that do not pertain to
any part of the Derivative Works; and

d. If the Work includes a "NOTICE" text file as part of its distribution,
then any Derivative Works that You distribute must include a readable copy
of the attribution notices contained within such NOTICE file, excluding
those notices that do not pertain to any part of the Derivative Works, in at
least one of the following places: within a NOTICE text file distributed as
part of the Derivative Works; within the Source form or documentation, if
provided along with the Derivative Works; or, within a display generated by
the Derivative Works, if and wherever such third-party notices normally
appear. The contents of the NOTICE file are for informational purposes only
and do not modify the License. You may add Your own attribution notices
within Derivative Works that You distribute, alongside or as an addendum to
the NOTICE text from the Work, provided that such additional attribution
notices cannot be construed as modifying the License.

You may add Your own copyright statement to Your modifications and may
provide additional or different license terms and conditions for use,
reproduction, or distribution of Your modifications, or for any such
Derivative Works as a whole, provided Your use, reproduction, and
distribution of the Work otherwise complies with the conditions stated in
this License.

5. Submission of Contributions. Unless You explicitly state otherwise, any
Contribution intentionally submitted for inclusion in the Work by You to the
Licensor shall be under the terms and conditions of this License, without
any additional terms or conditions. Notwithstanding the above, nothing
herein shall supersede or modify the terms of any separate license agreement
you may have executed with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor, except
as required for reasonable and customary use in describing the origin of the
Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
writing, Licensor provides the Work (and each Contributor provides its
Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied, including, without limitation, any
warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or
FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining
the appropriateness of using or redistributing the Work and assume any risks
associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory, whether
in tort (including negligence), contract, or otherwise, unless required by
applicable law (such as deliberate and grossly negligent acts) or agreed to
in writing, shall any Contributor be liable to You for damages, including
any direct, indirect, special, incidental, or consequential damages of any
character arising as a result of this License or out of the use or inability
to use the Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all other
commercial damages or losses), even if such Contributor has been advised of
the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing the Work
or Derivative Works thereof, You may choose to offer, and charge a fee for,
acceptance of support, warranty, indemnity, or other liability obligations
and/or rights consistent with this License. However, in accepting such
obligations, You may act only on Your own behalf and on Your sole
responsibility, not on behalf of any other Contributor, and only if You
agree to indemnify, defend, and hold each Contributor harmless for any
liability incurred by, or claims asserted against, such Contributor by
reason of your accepting any such warranty or additional liability.

</pre>

</div>
<!-- /content-->


<div id="footer">
<span class="slogan">Vaadin &ndash; thinking of U and I<span>
</div>
<!-- /footer -->

</body>
</html>

+ 459
- 287
WebContent/release-notes.html View File

@@ -1,294 +1,466 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Vaadin @version@</title>
<link rel="stylesheet" type="text/css" href="demo/css/styles.css" />
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Vaadin Framework @version@</title>
<link rel="stylesheet" type="text/css" href="css/styles.css" />

<!--[if lte IE 6]>
<link rel="stylesheet" type="text/css" href="demo/css/ie.css" />
<!--[if lte IE 6]>
<link rel="stylesheet" type="text/css" href="css/ie.css" />
<![endif]-->
<style type="text/css">
.nested-list ol { counter-reset: item }
.nested-list li { display: block }
.nested-list li:before { content: counters(item, ".") ". "; counter-increment: item }
</style>
</head> <!-- /head -->
<body>

<div id="header">
<h1>Vaadin &ndash; thinking of U and I</h1>
<div id="version">
<strong>Version @version@</strong>
<a href="javascript:history.go(-1);" title="Back to index page">&laquo; Back</a>
</div>
</div> <!-- /header -->

<div id="content">

<p>Version @version@ built on @builddate@.</p>

<h2 id="overview">Release Notes for Vaadin Framework @version@</h2>

<ul>
<li><a href="#overview">Overview</a></li>
<li><a href="#upgrading">General Upgrade Instructions</a></li>
<li><a href="#known-problems">Important known problems in Vaadin @version@</a></li>
<li><a href="#requirements">Requirements</a></li>
</ul>

<p>Vaadin @version@ is an update release for Vaadin Framework 6. In addition to various fixes, it
contains a number of significant enhancements.</p>

<h3>Enhancements in Vaadin Framework 6.7</h3>

<p>General enhancements:</p>

<ul>

</ul>

<p>In the server-side API:</p>

<ul>
<li>Support for specifying whether the content of MenuItems, OptionGroup items and Notifications should be used as html or plain text using setHtmlContentAllowed (<a href="http://dev.vaadin.com/ticket/7187">#7187</a>), (<a href="http://dev.vaadin.com/ticket/5402">#5402</a>), (<a href="http://dev.vaadin.com/ticket/6097">#6097</a>)</li>
<li>Support for selecting a time zone for DateField and InlineDateField added (<a href="http://dev.vaadin.com/ticket/6066">#6066</a>)</li>
</ul>

<p>In the client-side API:</p>

<ul>
</ul>

<h3>Backward-Incompatible Changes</h3>

<ul>
</ul>

<!-- ====================================================================== -->
<!-- For minor releases, this should be after the enhancement highlights, for maintenance releases in the beginning. -->
<h3>Change Log, Future Releases, and Upgrading</h3>

<p>See this <a href="http://dev.vaadin.com/query?status=closed&group=resolution&order=priority&col=id&col=summary&col=owner&col=type&col=priority&col=component&col=version&milestone=Vaadin+@version@">list of closed tickets</a> for a
full list of tickets fixed in this release.</p>

<p>Problem fixes and enhancements planned for upcoming releases can be found in the <a
href="http://dev.vaadin.com/roadmap">Vaadin Roadmap</a> in Vaadin Trac.</p>

<p>As always, when upgrading from an earlier version, you should recompile any custom
widget sets and refresh your project in Eclipse. If you are upgrading from
6.5.x or earlier, notice that Vaadin 6.6 uses GWT 2.3 (included in the installation
package). See <a href="#upgrading">General Upgrade Instructions</a> for more details on upgrading.</p>
<!-- ====================================================================== -->

<h2 id="widgetupgrade">Upgrading from Vaadin 6.0 or 6.1</h2>

<p>The way how widget sets are defined was simplified in Vaadin 6.2.
Existing projects, where custom widgets (a custom widget set) are used,
must be migrated when upgrading to Vaadin 6.2 or later. Projects where
the default widget set is used do not need migration. For most projects
this should be a quite painless upgrade.</p>

<p>
For applications where custom widgets are used (also applicable to widget projects):
<ul>
<li>Remove the <i>getTag()</i> method from all components and replace it with a <tt>@ClientWidget(VClientSideWidget.class)</tt> annotation. Tag names are no longer used to map the server-side and client-side part of the component. This is done automatically using the <tt>@ClientWidget</tt> annotation.</li>
<li>Remove the <tt>WidgetSet.java</tt> file. This file is no longer needed as the mapping between the server- and the client-side is done automatically using <tt>@ClientWidget</tt>.</li>
</ul>
</p>
<p>
If you are using widgets from another project (typically in a separate JAR file):
<ul>
<li>Acquire a new JAR which is compatible with Vaadin 6.3 and add it to <tt>WEB-INF/lib</tt>. The widget set compilation will automatically include the JAR in your <tt>.gwt.xml</tt> during compilation if you use the Eclipse <b>Compile Widget Set</b> button. For Ant/Maven you need to specify the location of the widget set JARs that you want to include in the application widget set.</li>
</ul>
</p>
<p>
If you package a widget set as a JAR for use in other projects:
<ul>
<li>Replace <tt>getTag()</tt> with <tt>@ClientWidget</tt> and remove the <tt>-WidgetSet.java</tt> as described above.</li>
<li>Add a &quot;Vaadin-Widgetsets: &lt;fully qualified name of widgetset&gt;&quot; (e.g. &quot;Vaadin-Widgetsets: com.example.widgetset.mywidgetset&quot;) row to the META-INF/MANIFEST.MF of the JAR file. This enables the widget set builder to automatically detect and include the widget set in other projects.</li>
</ul>
</p>

<h2 id="upgrading">General Upgrade Instructions</h2>

<p>When upgrading from an earlier version of the Vaadin library, you should always do the following.</p>

<h3>All Users</h3>

<ul>
<li>If you have extracted any built-in themes or widget sets from the Vaadin Jar to a
<tt>VAADIN</tt> folder that is served statically by the application server,
you need to delete the old themes and widget sets and re-extract them from the new Vaadin Jar.</li>
</ul>

<h3>Eclipse Users</h3>

<ol>
<li>Upgrade the <a href="http://vaadin.com/eclipse">Vaadin Integration Plugin for Eclipse</a> to the latest version</li>
<ul>
<li>Use the <tt>http://vaadin.com/eclipse</tt> software site to upgrade or install the stable version of the Vaadin Integration Plugin in Eclipse. If you have installed an unstable version of the plugin (see below), you need to remove it first.</li>
<li>For using pre-release versions of Vaadin and nightly builds, it is either recommended or often necessary to use the unstable "experimental" Vaadin Plugin for Eclipse.
In such case, add <tt>http://vaadin.com/eclipse/experimental</tt> as a Software Site in Eclipse and upgrade the Vaadin Plugin.</li>
</ul>
<li>Set your project to use the new Vaadin version</li>
<ol style="list-style-type: lower-alpha;">
<li>Select the new version in the <b>Vaadin</b> section in project preferences<sup>1</sup></li>
<li>The Eclipse plugin will automatically download the required GWT libraries and update launch configurations and the project build path</li>
</ol>
<li>If you have installed Vaadin add-ons containing custom widget sets, recompile them by selecting the project or the widget set and clicking the <b>Compile Vaadin widgets</b> button in Eclipse toolbar</li>
<li>Stop the development server, clean up the working directories, and restart the server.</li>
</ol>

<p><sup>1</sup> The Vaadin section is enabled only if the Vaadin Facet is configured for the project</p>

<h3>NetBeans and Build Script Users</h3>

<p>If you build the Vaadin application or the widget sets using an Ant script, such as in NetBeans, follow the following instructions:</p>

<ol>
<li>Copy the <TT>vaadin-@version@.jar</TT> library to the <tt>WEB-INF/lib</tt> directory in the project and remove the old version</li>
<li>Refresh the project (in NetBeans or Eclipse)</li>
<li>If using any add-ons containing custom widget sets:</li>
<ol style="list-style-type: lower-alpha;">
<li>If the GWT version has changed, copy the GWT libraries to the compilation-time library directory of the project. The GWT libraries should not be located in the <tt>WEB-INF/lib</tt> directory, as they are not deployed together with the web application.</li>
<ul>
<li><tt>gwt-user.jar</tt></li>
<li><tt>gwt-dev.jar</tt></li>
<li><tt>validation-api-1.0.0.GA.jar</tt> (a GWT dependency)</li>
<li><tt>validation-api-1.0.0.GA-sources.jar</tt> (a GWT dependency)</li>
</ul>
<li>The build script must include all the mentioned libraries in its class path</li>
<li>Recompile the widget set using the build script</li>
</ol>
</ol>

<p>You can use the <tt>WebContent/docs/example-source/build-widgetset.xml</tt> Ant script in the Vaadin
installation package as a template for a script for compiling the widget sets.</p>

<h3>Maven Users</h3>

<ul>
<li>If the Vaadin version is defined as <tt>LATEST</tt> in the <tt>pom.xml</tt>, the new version is automatically used and you simply need to recompile the project.</li>
<li>If the Vaadin version is defined explicitly in the <tt>pom.xml</tt>, edit the file to change the version.</li>
</ul>

<p>Maven downloads the defined Vaadin version and required GWT libraries automatically.</p>

<p>Notice that there can sometimes be a delay between the official release
of Vaadin to when it is submitted to the central repository. Once in the central repository, the
replication to other repositories can take several hours.</p>

<h3>Liferay Users</h3>

<ol>
<li>You may need to install a new version of the <a href="http://vaadin.com/directory#addon/vaadin-control-panel-for-liferay">Vaadin Control Panel for Liferay</a></li>
<li>Install the new Vaadin Jar to the <tt>ROOT/WEB-INF/lib</tt> directory in the portal</li>
<li>Extract the contents of the <tt>VAADIN</tt> folder from the Jar to the static <tt>ROOT/html/VAADIN</tt> directory in Liferay. Only the <b>PortalDefaultWidgetSet</b> widget set is needed.</li>
<li>If using any add-on components or custom widget sets, use the Vaadin Control Panel to recompile the combining widget set</li>
</ol>

<p>Similar instructions apply for other portals, except that you need to recompile the widget sets for example using the <tt>build-widgetset.xml</tt> script included in the Vaadin installation package.</p>

<h2 id="gae">Notes and Limitations for Google App Engine</h2>

<p>The following instructions and limitations apply when you run a Vaadin application
under the Google App Engine.</p>

<ul>
<li><p>Applications must use <b>GAEApplicationServlet</b> instead of
<b>ApplicationServlet</b> in <tt>web.xml</tt>.</p></li>

<li><p>Session support must be enabled in <tt>appengine-web.xml</tt>:</p>

<pre> &lt;sessions-enabled&gt;true&lt;/sessions-enabled&gt;</pre>
</li>

<li><p>Avoid using the session for storage, usual App Engine limitations apply (no
synchronization, i.e, unreliable).</p></li>

<li><p>Vaadin uses memcache for mutex, the key is of the form
<tt>_vmutex&lt;sessionid&gt;</tt>.</p></li>
<li><p>The Vaadin <b>WebApplicationContext</b> class is serialized separately into memcache
and datastore; the memcache key is <tt>_vac&lt;sessionid&gt;</tt> and the datastore
entity kind is <tt>_vac</tt> with identifiers of the type <tt>_vac&lt;sessionid&gt;</tt>.</p></li>
<li><p>DO NOT update application state when serving an <b>ApplicationResource</b> (e.g <b>ClassResource</b>.<i>getStream()</i>).</p></li>

<li><p>AVOID (or be very careful when) updating application state in a
<b>TransactionListener</b> or a <b>HttpServletRequestListener</b> - they are called even when the
application is not locked and won't be serialized (e.g <b>ApplicationResource</b>), and
changes can thus go missing (it should be safe to update things that can be safely discarded
later - i.e valid only for the current request)</p></li>

<li><p>The application remains locked during uploads - a progress bar is not possible</p></li>
</ul>

<h2 id="known-problems">Important known problems in Vaadin @version@</h2>

<ul>
<li><p><a href="http://dev.vaadin.com/ticket/1155">#1155</a>:
Uncompressing the installation package fails in Windows if using the
default Zip uncompression. Uncompression gives (in Windows Vista) an
error message about too long filenames, and a more obscure message in
other versions of Windows. Workaround: use <a
href="http://www.7-zip.org/">7-Zip</a> or some other good unzip
program for Windows.</p></li>
</ul>

<p>For other known problems, see open tickets at developer site <a
href="http://dev.vaadin.com/">dev.vaadin.com</a>.</p>

<h2 id="requirements">Requirements</h2>

<p>Vaadin is available for the following operating systems:</p>

<ul>
<li>Windows (see the Zip installation notice above)</li>

<li>Linux</li>

<li>Mac OS X Tiger (mac) or Leopard (leopard)</li>

<li>Other UNIX operating systems, such as Sun Solaris</li>
</ul>

<p>Vaadin supports Java Servlet API 2.3 and later versions and should work with
any Java application server that conforms to the standard. It supports the following
application servers:</p>

<ul>
<li>Apache Tomcat, version 4.1 or later</li>
<li>BEA WebLogic&reg; Server, version 9.2 or later</li>
<li>IBM WebSphere&reg; Application Server, version 6.1 or later</li>
<li>JBoss Application Server, version 3.2.8 or later</li>
<li>Jetty, version 5 or later</li>
<li>Glassfish, version 2 or later</li>
</ul>

<p>Vaadin supports the following browsers for using the applications made with
it:</p>

<ul>
<li>Mozilla Firefox 3, 4, and 5</li>
<li>Internet Explorer releases 6, 7, 8 and 9</li>
<li>Safari 4 and 5</li>
<li>Opera 10 and 11</li>
<li>Google Chrome (latest version)</li>
</ul>

<p>The support for browsers follows the support by GWT. The browsers are supported on both
Windows and Mac, if available. Firefox is supported also on Linux. There may be differences between the
exact versions of the supported browsers that may cause incompatibility with applications
made with Vaadin.</p>

</div> <!-- /content-->


<div id="footer">
<span class="slogan"><strong>vaadin <em>}></em></strong> thinking of U and I<span> <a href="#top">&uarr; Back to top</a>
</div> <!-- /footer -->
<style type="text/css">
.nested-list ol {
counter-reset: item
}

.nested-list li {
display: block
}

.nested-list li:before {
content: counters(item, ".") ". ";
counter-increment: item
}
</style>
</head>
<!-- /head -->
<body>

<div id="header">
<h1>Vaadin &ndash; thinking of U and I</h1>
<div id="version">
<strong>Version @version@</strong>
</div>
</div>
<!-- /header -->

<div id="content">

<p>Version @version@ built on @builddate@.</p>

<h2 id="tableofcontents">Release Notes for Vaadin Framework
@version@</h2>
<ul>
<li><a href="#overview">Package contents</a></li>
<li><a href="#enhancements">Enhancements in Vaadin @version@</a>
</li>
<li><a href="#fixes">Fixes in Vaadin @version@</a></li>
<li><a href="#dependencies">Vaadin @version@ dependencies</a></li>
<li><a href="#upgrading">Upgrading to Vaadin @version-minor@</a>
</li>
<li><a href="#knownissues">Known problems and limitations in
Vaadin @version@</a></li>
<li><a href="#supportedversions">Supported technologies</a></li>
</li>
<li><a href="#vaadinontheweb">Vaadin on the Web</a></li>
</ul>
<h2 id="overview">Package Contents</h2>
<p>
<b>Vaadin</b> is a Java framework for building modern web
applications that look great, perform well and make you and your
users happy. <b>Vaadin</b> is available under the Apache 2 license
(see license.html).
</p>
<p>
<b>Vaadin</b> is distributed as a single JAR file. Inside the JAR you
will find:
<ul>
<li>Vaadin server and client side classes (/com)</li>
<li>Vaadin server and client side sources (/com)</li>
<li>The default widget set (/VAADIN/widgetsets)</li>
<li>Themes: Runo, Reindeer and Chameleon (/VAADIN/themes)</li>
<li>Release notes (/release-notes.html)</li>
<li>Licensing information (/license.html)</li>
</ul>
</p>


<h2 id="enhancements">Enhancements in Vaadin @version@</h2>
<p>
<b>SQLContainer</b>
</p>
<p>SQLContainer connects your application to an SQL database using
JDBC. SQLContainer allows you to easily bind data stored in a SQL
database to Table and Select components, as well as edit the data
using Forms. Compared to many object-relational tools this provides
you with fast, low-level database access.</p>
<p>SQLContainer was previously distributed as an add-on and has
now been integrated into the framework.</p>
<p>
<b>TreeTable</b>
</p>
<p>TreeTable is an extended Table component that can show
hierarchical structures in its first column. Users can show or hide
children from a small icon before the actual column value in the
first column.</p>
<p>TreeTable is, similarly to Table, designed to scale well with
large number of rows by only sending the needed rows to the browser.
With the Collapsible Container extension, a developer can build the
data provider so that it does not consume too much memory on the
server side either.</p>
<p>
<b>Chameleon Theme</b>
</p>
<p>Chameleon Theme provides a completely new look and feel for
your application.</p>
<p>
The theme is built on top of the Vaadin Base theme and tries to keep
out of the way where appropriate, so small modifications are easy to
do with CSS.
<p>
The theme contains several different useful styles for many of the
basic components like <i>big</i> and <i>warning</i> for a Label. You
can even combine many styles together, like <i>big warning</i>
</p>
If the default color scheme does not suit your taste, feel free to
use the online color scheme editor at <a
href="http://demo.vaadin.com/">http://demo.vaadin.com</a> to build a
customized theme.You can also change the base font size for the whole
theme with the same editor.
<p>
<i>Note that the theme is intentionally simplified for some
browsers, most notably old Internet Explorer versions.</i>
</p>
</p>
<p>
<b>WebApplicationContext</b> now provides a way to switch the session
id to prevent session fixation attacks
</p>
<p>
<b>Notification</b> now supports plain text its contents
</p>
<p>
<b>OptionGroup</b> now supports HTML for the items
</p>
<p>
<b>MenuBar</b> now supports HTML for the items
</p>
<p>
<b>ComboBox</b> now supports scrolling using the mouse wheel
</p>
<p>
<b>Table ColumnGenerator</b> can now generate plain text in addition
to Components
</p>
<p>
<b>TabSheet</b> tabs can be styled individually
</p>
<p>
<b>Button</b> can be automatically disabled when clicked
</p>
<p>
<b>Tree, Table</b>and <b>TreeTable</b> supports tooltips for
individual items or cells
</p>
<p>
<b>Table</b>and <b>TreeTable</b> now supports GeneratedRows that can
be used for grouping or summary rows
</p>
<p>
<b>TreeTable</b> supports animation for expand and collapse
operations
</p>
<p>
<b>TreeTable</b> supports expand and collapse listeners
</p>
<p>
<b>PopupDateField</b>and<b>InlineDateField</b> now supports Timezones
</p>
<p>
<b>Sampler</b> is no longer distributed as part of Vaadin @version@.
It will be available as a separate download
</p>
<p>
<b>Book of Vaadin</b> is no longer distributed with Vaadin @version@.
It is available as a separate download from <a
href="http://vaadin.com/book">http://vaadin.com/book</a>
</p>
<p>
The <a
href="http://dev.vaadin.com/query?type=enhancement&group=component&milestone=Vaadin+@vaadin-version@.beta1&milestone=Vaadin+@vaadin-version@.rc1&milestone=Vaadin+@vaadin-version@">full
details of the enhancements</a> can be found at dev.vaadin.com.</a>
</p>
<h2 id="fixes">Fixes in Vaadin @version@</h2>
<p>#7179 PortalDefaultWidgetset no longer automatically tries to
load Google Analytics scripts</p>
<p>#5924 Browser context menu is no longer prevented in Table if
there is no click handler or no actions enabled</p>
<p>#7292 TreeTable now renders correctly when pagelength is set to
zero</p>
<p>#6499 AbstractApplicationServlet.handleDownload now closes
streams properly in case of exceptions</p>
<p>#7369 It is now possible to use Vaadin components as
SessionScoped beans</p>
<p>#5738 TabSheet's first visible tab is now always rendered with
the correct style name</p>
<p>
The <a
href="http://dev.vaadin.com/query?type=defect&group=component&milestone=Vaadin+@vaadin-version@.beta1&milestone=Vaadin+@vaadin-version@.rc1&milestone=Vaadin+@vaadin-version@">full
details of the defects</a> can be found at dev.vaadin.com.
</p>

<h2 id="dependencies">Vaadin @version@ dependencies</h2>
Vaadin uses GWT @gwt-version@ for widget set compilation. GWT can be
downloaded from <a href="http://code.google.com/webtoolkit/">http://code.google.com/webtoolkit/</a>.
GWT can also be automatically downloaded by the Vaadin Plug-in for
Eclipse. Please note that GWT @gwt-version@ requires the <i>validation-api-1.0.0.GA.jar</i>
and <i>validation-api-1.0.0.GA-sources.jar</i> files in addition to <i>gwt-dev.jar</i>
and <i>gwt-user.jar</i> for widget set compilation.

<h2 id="upgrading">Upgrading to Vaadin @version-minor@</h2>
<p>
When upgrading from an earlier Vaadin version, you must
<ul>
<li>Recompile your classes using the new Vaadin @version@ jar.
Binary compatibility is not guaranteed for new minor versions like
Vaadin @version-minor@.</li>
<li>Recompile any add-ons you have created using the new Vaadin
@version@ jar.</li>
<li>Recompile your widget set using the new Vaadin @version@
jar and the newly compiled add-ons.</li>
<li>If you have extracted a theme from the Vaadin jar, you need
to update it with the theme provided in the Vaadin @version@ jar.</li>
</ul>
</p>
<p>Remember also to refresh the project in your IDE to ensure that
the new version of everything is in use.</p>
<p>Using the "?debug" URL parameter you can verify that the
version of the servlet (JAR), the theme and the widgetset all match.</p>
<p>
<b>Eclipse</b> users should always check if there is a new version of
the Eclipse Plug-in available. The Eclipse Plug-in can be used to
update the Vaadin version in the project (Project properties &raquo;
Vaadin).
</p>

<p>
<b>Maven</b> users should update the Vaadin dependency version in the
<tt>pom.xml</tt>
unless it is defined as
<tt>LATEST</tt>
. You must also ensure that the GWT dependency uses the correct
version and recompile your project and your widget set.

</p>

<b>Liferay and other portal</b> users must install the new
vaadin-@version@.jar to the
<tt>ROOT/WEB-INF/lib</tt>
directory in the portal
</li>. Additionally the contents of the
<tt>VAADIN</tt>
folder from the jar must be extracted to the
<tt>ROOT/html/VAADIN</tt>
directory in the Liferay installation. If your portal uses custom
widgets, install the latest version of <a
href="http://vaadin.com/directory#addon/vaadin-control-panel-for-liferay">Vaadin
Control Panel for Liferay</a> for easy widget set compilation.

<h3>Upgrading from Vaadin 6.5 or earlier</h3>
If you are upgrading from 6.5.x or earlier, notice that Vaadin
@version@ uses GWT @gwt-version@. Upgrade your dependencies as
necessary. See <a href="#dependencies">the dependencies</a> section
for more information.
</p>

<h3 id="widgetupgrade">Upgrading from Vaadin 6.1 or earlier</h3>

<p>
The way widget sets are created was completely changed in Vaadin 6.2.
Existing projects, where custom widgets (a custom widget set) are
used, must be migrated when upgrading to Vaadin 6.2 or later.
Projects where the default widget set is used do not need migration.
See <a
href="http://vaadin.com/download/release/6.2/6.2.0/release-notes.html">Vaadin
6.2.0 release notes</a> for more details.
</p>





<h3 id="knownissues">Known problems and limitations in Vaadin
@version@</h3>

<ul>
<li><p id="zipissue">
<a href="http://dev.vaadin.com/ticket/1155">#1155</a>:
Uncompressing the installation package fails in Windows if using
the default Zip uncompression. Uncompression gives (in Windows
Vista) an error message about too long filenames, and a more
obscure message in other versions of Windows. Workaround: use <a
href="http://www.7-zip.org/">7-Zip</a> or some other good unzip
program for Windows.
</p></li>
</ul>
<h4 id="gae">Notes and Limitations for Google App Engine</h4>

<p>The following instructions and limitations apply when you run a
Vaadin application under the Google App Engine.</p>

<ul>
<li><p>
Applications must use <b>GAEApplicationServlet</b> instead of <b>ApplicationServlet</b>
in
<tt>web.xml</tt>
.
</p></li>

<li><p>
Session support must be enabled in
<tt>appengine-web.xml</tt>
:
</p> <pre> &lt;sessions-enabled&gt;true&lt;/sessions-enabled&gt;</pre>
</li>

<li><p>Avoid using the session for storage, usual App Engine
limitations apply (no synchronization, i.e, unreliable).</p></li>

<li><p>
Vaadin uses memcache for mutex, the key is of the form
<tt>_vmutex&lt;sessionid&gt;</tt>
.
</p></li>

<li><p>
The Vaadin <b>WebApplicationContext</b> class is serialized
separately into memcache and datastore; the memcache key is
<tt>_vac&lt;sessionid&gt;</tt>
and the datastore entity kind is
<tt>_vac</tt>
with identifiers of the type
<tt>_vac&lt;sessionid&gt;</tt>
.
</p></li>

<li><p>
DO NOT update application state when serving an <b>ApplicationResource</b>
(e.g <b>ClassResource</b>.<i>getStream()</i>).
</p></li>

<li><p>
AVOID (or be very careful when) updating application state in a <b>TransactionListener</b>
or a <b>HttpServletRequestListener</b> - they are called even when
the application is not locked and won't be serialized (e.g <b>ApplicationResource</b>),
and changes can thus go missing (it should be safe to update things
that can be safely discarded later - i.e valid only for the current
request)
</p></li>

<li><p>The application remains locked during uploads - a
progress bar is not possible</p></li>
</ul>


<p>
For other known problems, see open tickets at developer site <a
href="http://dev.vaadin.com/">dev.vaadin.com</a>.
</p>

<h2 id="supportedversions">Supported technologies</h2>

<p>
Vaadin is based on <b>Java 5</b> and it is also compatible with most
other operating system supporting Java 5 or newer. Vaadin is
supported on the following <b>operating systems</b>:
</p>

<ul>
<li>Windows (see the <a href="#knownissues">Zip installation
notice above</a>)</li>
<li>Linux</li>
<li>Mac OS X</li>
</ul>

<p>
Vaadin requires <b>Java Servlet API 2.3</b> but also supports later
versions and should work with any Java application server that
conforms to the standard. The following <b>application servers</b>
are supported:
</p>

<ul>
<li>Apache Tomcat, version 4.1 and later</li>
<li>Oracle WebLogic&reg; Server, version 9.2 or later</li>
<li>IBM WebSphere&reg; Application Server, version 6.1 or later</li>
<li>JBoss Application Server, version 3.2.8 or later</li>
<li>Jetty, version 5 or later</li>
<li>Glassfish, version 2 or later</li>
</ul>
<p>
Vaadin supports JSR-168 and JSR-286 Portlet specifications. All
portals that implementated either of the portlet specifications
should work. The following <b>portals</b> are supported:
</p>
<ul>
<li>Liferay Portal 5.2 or later</li>
<li>GateIn Portal 3.1 or later</li>
<li>eXo Platform 3 or later</li>
</ul>
<p>
Vaadin also supports <b>Google App Engine</b>.
</p>
<p>
Vaadin supports the following <b>browsers</b>:
</p>

<ul>
<li>Mozilla Firefox 3, 4, 5 and 6</li>
<li>Internet Explorer 6, 7, 8 and 9</li>
<li>Safari 4 and 5</li>
<li>Opera 10 and 11</li>
<li>Google Chrome 13</li>
</ul>

<h2 id="vaadinontheweb">Vaadin on the Web</h2>
<p>
<ul>
<li><a href="http://vaadin.com">vaadin.com - The developer
portal containing everything you need to know about Vaadin</a></li>

<li><a href="http://vaadin.com/learn">vaadin.com/learn -
Getting started with Vaadin</a>
</li>
<li><a href="http://vaadin.com/forum">vaadin.com/forum -
Forums for Vaadin related discussions
</li>
<li><a href="http://vaadin.com/book">vaadin.com/book - Book
of Vaadin - everything you need to know about Vaadin
</li>
<li><a href="http://vaadin.com/api">vaadin.com/api - Online
javadocs
</li>
<li><a href="http://vaadin.com/directory">vaadin.com/directory
- Add-ons for Vaadin
</li>
<li><a href="http://dev.vaadin.com">dev.vaadin.com - Bug
tracker
</li>
<li><a href="http://dev.vaadin.com/svn">dev.vaadin.com/svn
- Source code repository
</li>
<li><a href="http://vaadin.com/pro-account">vaadin.com/pro-account
- Commercial support and tools for Vaadin development
</li>
<li><a href="http://vaadin.com/services">vaadin.com/services
- Expert services for Vaadin
</li>
<li><a href="http://vaadin.com/company">vaadin.com/company
- Information about the company behind Vaadin
</li>
</ul>
</p>

</div>
<!-- /content-->


<div id="footer">
<span class="slogan"><strong>vaadin <em>}></em> </strong>
thinking of U and I<span> <a href="#top">&uarr; Back to
top</a>
</div>
<!-- /footer -->

</body>
</html>

Loading…
Cancel
Save