From bbcfa6649deeeb5d221133d3c69e54fc8111f76a Mon Sep 17 00:00:00 2001
From: Marko Grönroos <magi@iki.fi>
Date: Mon, 10 Jan 2011 11:08:01 +0000
Subject: Some fixes to Release Notes.

svn changeset:16833/svn branch:6.5
---
 WebContent/release-notes.html | 132 ++++++++++--------------------------------
 1 file changed, 30 insertions(+), 102 deletions(-)

(limited to 'WebContent')

diff --git a/WebContent/release-notes.html b/WebContent/release-notes.html
index 66af0410cb..2922c0bc98 100644
--- a/WebContent/release-notes.html
+++ b/WebContent/release-notes.html
@@ -28,7 +28,6 @@
 <ul>
   <li><a href="#overview">Overview</a></li>
   <li><a href="#upgrading">General Upgrade Notes</a></li>
-  <li><a href="#upgrading-tk5">Instructions for Upgrading from IT Mill Toolkit 5</a></li>
   <li><a href="#known-problems">Important known problems in Vaadin @version@</a></li>
   <li><a href="#requirements">Requirements</a></li>
 </ul>
@@ -39,16 +38,18 @@ contains a number of significant enhancements.</p>
 <h3>Enhancements</h3>
 
 <ul>
-  <li>Implemented server-side logging using java.util.logging, allowing you to specify loglevels and get
+  <li>Implemented server-side logging using <tt>java.util.logging</tt>, allowing you to specify log levels and get
       rid of unnecessary messages. See <a href="http://dev.vaadin.com/ticket/5715">#5715</a> for more info.
   </li>
-  <li>GWT has been updated to version 2.1.0</li>
-  <li>Widgetset builder has been optimized to only look for paintables in Vaadin add-on jars (containing an add-on manifest). If you are packaging your own widgets into jar file, ensure they also contain the <a href="http://dev.vaadin.com/wiki/VaadinAddon">Vaadin add-on manifest</a>.</li>
-  <li>TwinColSelect supports separate captions for the right and left selects (<a href="http://dev.vaadin.com/ticket/2942">#2942</a>)</li>
-  <li>TextField supports sending of TextChangeEvents as the user types. (<a href="http://dev.vaadin.com/ticket/2387">#2387</a>)</li>
-  <li>Localization of LoginForm. (<a href="http://dev.vaadin.com/ticket/5226">#5226</a>)</li>
-  <li>Tooltip support for MenuBar items. (<a href="http://dev.vaadin.com/ticket/5919">#5919</a>)</li>
-  <li>All component containers support getComponentCount().</li>
+  <li>GWT has been updated to version 2.1.1</li>
+  <li>Widget set builder has been optimized to only look for paintables in Vaadin add-on jars (containing an add-on manifest).
+      If you are packaging your own widgets into a JAR file, ensure they also contain the
+      <a href="http://dev.vaadin.com/wiki/VaadinAddon">Vaadin add-on manifest</a>.</li>
+  <li><b>TwinColSelect</b> supports separate captions for the right and left selects (<a href="http://dev.vaadin.com/ticket/2942">#2942</a>)</li>
+  <li><b>TextField</b> supports sending of <b>TextChangeEvent</b>s as the user types. (<a href="http://dev.vaadin.com/ticket/2387">#2387</a>)</li>
+  <li>Localization of <b>LoginForm</b>. (<a href="http://dev.vaadin.com/ticket/5226">#5226</a>)</li>
+  <li>Tooltip support for <b>MenuBar</b> items. (<a href="http://dev.vaadin.com/ticket/5919">#5919</a>)</li>
+  <li>All component containers support <tt>getComponentCount()</tt>.</li>
   <li>Sub windows now support focus and blur events. (<a href="http://dev.vaadin.com/ticket/5039">#5039</a>)</li>
   <li>Sub windows now support server side re-ordering. (<a href="http://dev.vaadin.com/ticket/5037">#5037</a>)</li>
 </ul>
@@ -58,16 +59,16 @@ contains a number of significant enhancements.</p>
 <p>The following changes can break backward compatibility in applications using an earlier version of Vaadin:</p>
 
 <ul>
-  <li>Table.setColumnCollapsed throws IllegalStateException instead of IllegalAccessException if collapsing is not allowed.</li>
-  <li>Window.removeWindow(Window) now triggers window close listeners also when called explicitly.
+  <li>The <tt>setColumnCollapsed()</tt> method in <b>Table</b> throws <b>IllegalStateException</b> instead of <b>IllegalAccessException</b> if collapsing is not allowed.</li>
+  <li>The <tt>removeWindow(Window)</tt> method in <b>Window</b> now triggers window close listeners also when called explicitly.
       See <a href="http://dev.vaadin.com/ticket/3865">#3865</a> for more info.
   </li>
-  <li>RichTextArea no longer extends TextField as it cannot implement (and never has) a large part of the TextField API.</li>
+  <li><b>RichTextArea</b> no longer extends <b>TextField</b> as it cannot implement (and never has) a large part of the <b>TextField</b> API.</li>
   <li>The client side window implementation has changed because of <a href="http://dev.vaadin.com/ticket/5039">#5039</a> and therefore TestBench scripts may not be 100% compatible. 
-  		Replaces locators like "VWindow[0]/ScrollPanel[0]..." with "VWindow[0]/FocusableScrollPanel[0]...". An example regular 
-  		expression for replacement: Search "VWindow\[(\d)\]/ScrollPanel\[0\]" and replace with "VWindow[$1]/FocusableScrollPanel[0]".</li>
-  <li>AbstractStringValidator and now converts non-String values using toString() prior to validation (#5785).
-  This also affects most built-in validators such as IntegerValidator.</li>
+  		Replaces locators like "<tt>VWindow[0]/ScrollPanel[0]...</tt>" with "<tt>VWindow[0]/FocusableScrollPanel[0]...</tt>". An example regular 
+  		expression for replacement: Search "<tt>VWindow\[(\d)\]/ScrollPanel\[0\]</tt>" and replace with "<tt>VWindow[$1]/FocusableScrollPanel[0]</tt>".</li>
+  <li><tt>AbstractStringValidator</tt> and now converts non-String values using <tt>toString()</tt> prior to validation (<a href="http://dev.vaadin.com/ticket/5785">#5785</a>).
+  This also affects most built-in validators such as <b>IntegerValidator</b>.</li>
 </ul>
 
 <h3>Backwards compatible API Changes</h3>
@@ -75,11 +76,11 @@ contains a number of significant enhancements.</p>
 <p>The following backwards compatible class/method changes have been made:</p>
 
 <ul>
-  <li>SplitPanel has been deprecated in favor of VerticalSplitPanel and HorizontalSplitPanel.</li>
-  <li>TextArea has been split from TextField to a separate component. As a result TextField.setRows has been deprecated.</li>
-  <li>PasswordField has been split from TextField to a separate component. As a result TextField.setSecret has been deprecated.</li>
-  <li>Button.setSwitchMode has been deprecated in favor of CheckBox. Remember to set CheckBox in immediate mode.</li>
-  <li>ItemClickSource has been renamed to ItemClickNotifier for consistency with other classes.</li>
+  <li><b>SplitPanel</b> has been deprecated in favor of <b>VerticalSplitPanel</b> and <b>HorizontalSplitPanel</b>.</li>
+  <li><b>TextArea</b> has been split from <b>TextField</b> to a separate component. As a result, the <tt>setRows()</tt> method in TextField has been deprecated.</li>
+  <li><b>PasswordField</b> has been split from <b>TextField</b> to a separate component. As a result, the <tt>setSecret()</tt> method in <b>TextField</b> has been deprecated.</li>
+  <li>The <tt>setSwitchMode()</tt> method in <b>Button</b> has been deprecated in favor of the separate <b>CheckBox</b> component. Remember to set <b>CheckBox</b> in immediate mode.</li>
+  <li><b>ItemClickSource</b> has been renamed to <b>ItemClickNotifier</b> for consistency with other classes.</li>
 </ul>
 
 <h3>Theme changes</h3>
@@ -88,22 +89,22 @@ contains a number of significant enhancements.</p>
 
 <ul>
 	<li>Due to the fixes for tickets <a href="http://dev.vaadin.com/ticket/5066">#5066</a> and <a href="http://dev.vaadin.com/ticket/2681">#2681</a>,
-		the Table component has a slightly changed DOM structure in it's header.</li>
+		the <b>Table</b> component has a slightly changed DOM structure in it's header.</li>
 	<ul>
 		<li>The sort indicator (arrow icon) has been moved from being the background of the "caption container" DIV, to it's very own DIV. This DIV
-			can be styled by the .v-table-sort-indicator selector. Sort indicator images can thus no longer be placed in the
-			.v-table-caption-container DIV.</li>
+			can be styled by the <tt>.v-table-sort-indicator</tt> selector. Sort indicator images can thus no longer be placed in the
+			<tt>.v-table-caption-container</tt> DIV.</li>
 	</ul>
-	<li>TwinColSelect DOM structure has changed slightly to support captions for the left and right column.</li>
-	<li>TwinColSelect now supports .v-select-twincol-caption-left and .v-select-twincol-caption-right for the left and right captions.</li>
+	<li><b>TwinColSelect</b> DOM structure has changed slightly to support captions for the left and right column.</li>
+	<li><b>TwinColSelect</b> now supports <tt>.v-select-twincol-caption-left</tt> and <tt>.v-select-twincol-caption-right</tt> for the left and right captions.</li>
 </ul>
 
 <p>New themeing possibilities:</p>
 <ul>
-	<li>Table</li>
+	<li><b>Table</b></li>
 	<ul>
-		<li>All cells in a sorted column now get the .v-table-cell-content-sorted CSS class, allowing styling of the sorted items.</li>
-		<li>The alignment of the column captions can now be changed in CSS by styling the .v-table-caption-container-align-[left|center|right]
+		<li>All cells in a sorted column now get the <tt>.v-table-cell-content-sorted</tt> CSS class, allowing styling of the sorted items.</li>
+		<li>The alignment of the column captions can now be changed in CSS by styling the <tt>.v-table-caption-container-align-[left|center|right]</tt>
 			CSS classes. This makes it possible to align all captions left, for instance.</li>
 	</ul>
 </ul>
@@ -174,79 +175,6 @@ If you package a widget set as a JAR for use in other projects:
 
 <p>Using the Vaadin project facet in the Eclipse IDE does the steps 1 and 2 automatically.</p>
 
-<h2 id="upgrading-tk5">Instructions for Upgrading from IT Mill Toolkit 5</h2>
-
-<p>While the Vaadin 6 API is otherwise mostly backward-compatible with IT Mill Toolkit 5.4, the
-change of the product name has made it necessary to reflect it in the Java package names,
-some name prefixes, and some other details.</p>
-
-<h3>Server-side Upgrade Instructions</h3>
-
-<ul>
-  <li>Java Package names have changed:</li>
-  <ul>
-    <li>In all Java files using IT Mill Toolkit, rename package prefix <tt>com.itmill.toolkit</tt> &#x2192; <tt>com.vaadin</tt></li>
-    <li>You also need to update the <tt>web.xml</tt> deployment descriptor:</li>
-    <ul>
-      <li>The servlet class is now <strong>com.vaadin.terminal.gwt.server.ApplicationServlet</strong>.</li>
-    </ul>
-  </ul>
-
-  <li>Changes in themes:
-  <ul>
-    <li>Rename <tt>WebContent/ITMILL</tt> &#x2192; <tt>WebContent/VAADIN</tt></li>
-    <ul>
-      <li>If you have extracted the built-in themes and widgetsets in IT Mill Toolkit JAR to the folder to have them served statically by the server, remove the old content and re-extract from Vaadin JAR.</li>
-      <li>This may require changes to build scripts for custom widgetsets, as well as to any code that relies on the old naming (it is discouraged but possible).</li>
-    </ul>
-    <li>The new "<tt>reindeer</tt>" theme is the default theme in Vaadin; the old
-    "<tt>default</tt>" theme in IT Mill Toolkit 5 has been renamed as "<tt>runo</tt>"</li>
-    <ul>
-      <li>There is no longer a theme with name "<tt>default</tt>"</li>
-      <li>In your custom theme, replace:
-         <table><tr><td></td><td><tt>@import "../default/styles.css";</tt></td></tr>
-         <tr><td align="right">&#x2192;</td><td><tt>@import "../reindeer/styles.css";</tt></td><td>if you wish to use the new default theme,</td></tr>
-         <tr><td align="right">or &#x2192;</td><td><tt>@import "../runo/styles.css";</tt></td><td>if you wish to use the old default theme.</td></tr></table></li>
-      <li>Use the new default theme with <tt>setTheme("reindeer")</tt> and the old one with <tt>setTheme("runo")</tt>.</li>
-    </ul>
-    <li>CSS class names now start with "<tt>v-</tt>" prefix instead of "<tt>i-</tt>"</li>
-    <ul>
-      <li>Search and replace "<tt>.i-</tt>" &#x2192; "<tt>.v-</tt>" in custom themes </li>
-    </ul>
-  </ul>
-
-  <li>Embedding Vaadin applications in web pages:</li>
-  <ul>
-    <li>The name of the JavaScript variable used for launching applications has changed from "<tt>itmill.toolkitConfigurations</tt>" &#x2192; "<tt>vaadin.vaadinConfigurations</tt>"</li>
-  </ul>
-
-  <li>Other changes in naming:</li>
-  <ul>
-    <li>Rename references to <tt>translateToolkitUri()</tt> &#x2192; <tt>translateVaadinUri()</tt> method in <strong>ApplicationConnection</strong> class.
-  </ul>
-
-</ul>
-
-<h3>Client-side Upgrade Instructions</h3>
-
-<p>The following changes are relevant only if you have developed or integrated custom
-client-side widgets with Google Web Toolkit (GWT).</p>
-
-<ul>
-  <li>GWT 2.0 is required for compiling custom widgets (optional)</li>
-  <ul>
-    <li>You need to upgrade GWT</li>
-    <li>The GWT Compiler class name has changed:</li>
-    <ul>
-      <li>Replace <tt>com.google.gwt.dev.GWTCompiler</tt> &#x2192; <tt>com.google.gwt.dev.Compiler</tt> in your widget set build script (Ant) or launch configuration (Eclipse).</li>
-      <li>Replace the output directory argument for the compiler with the new WAR output argument: <tt>-out</tt> &#x2192; <tt>-war</tt>. The directory parameter for the argument remains unchanged.</li>
-    </ul>
-  </ul>
-
-  <li>The "<strong>I</strong>" (IT Mill) prefix in client-side widget classes has been changed to "<strong>V</strong>" (Vaadin), for example: <strong>IButton</strong> &#x2192; <strong>VButton</strong>.</li>
-  <li>Rename <strong>IToolkitOverlay</strong> &#x2192; <strong>VOverlay</strong>
-</ul>
-
 <h2 id="gae">Notes and Limitations for Google App Engine</h2>
 
 <p>The following instructions and limitations apply when you run a Vaadin application
-- 
cgit v1.2.3