From c44985e0e933f42641d44f9f66568d4dbf15b5af Mon Sep 17 00:00:00 2001 From: =?utf8?q?Marko=20Gr=C3=B6nroos?= Date: Mon, 1 Dec 2008 02:56:36 +0000 Subject: [PATCH] Cleaned up the Release Notes for Toolkit 5.3.0. svn changeset:6047/svn branch:trunk --- WebContent/release-notes.html | 238 ++++++++++++++++++++-------------- 1 file changed, 141 insertions(+), 97 deletions(-) diff --git a/WebContent/release-notes.html b/WebContent/release-notes.html index 281dd46506..e237726fe6 100644 --- a/WebContent/release-notes.html +++ b/WebContent/release-notes.html @@ -24,118 +24,163 @@
-

Release notes version (beta)

+

Release Notes for IT Mill Toolkit Version

- Version of IT Mill Toolkit Release 5 is still in beta - phase, meaning that the library should be considered unstable and is recommended for - evaluation and early adoption. Also, any changes are possible, including API changes, - before the stable release. + Version 5.3.0 is the first stable release of IT Mill Toolkit 5, meaning that there are no + known major problems and the API will be kept backward compatible.

-

Client side is compiled with GWT 1.5

-

-GWT is upgraded to 1.5. In case you have built your own client side components, you need to upgrade your GWT library. Lot's of things have changed in GWT 1.5, but upgrading to is rather straightforward and as a bonus you'll get nice features from Java 1.5. See more details from GWT web site -

-

Java 5 is required

+ +

Google Web Toolkit Upgraded to Version 1.5

+

-Since GWT now needs java 5, support for java 1.4 is now dropped. +The GWT used in IT Mill Toolkit is upgraded to version 1.5. If you have made your own +client side components, you will need to upgrade your GWT library. Many things have +changed in GWT 1.5, but upgrading is rather straightforward and, as a bonus, you will get +the nice features from Java 1.5. For more details on GWT 1.5, see the GWT web site.

-

Layout changes

+ +

Java 5 Now Required

+ +

As GWT now requires Java 5, support for Java 1.4 is discontinued also in IT Mill +Toolkit.

+ +

Layout Changes

+ +

The stable IT Mill Toolkit version 5.3 introduces a major rework of layout components +since the beta versions 5.2.x and before.

+

Use debug mode during development / debugging

-

-Layouts are now more strict than before. Some components may even be invisible when using relative sizes in wrong way. During debugging/development always add the following parameter to your web.xml file: -

+ +

Layouts are now more strict than before and some components may even be invisible if +you use relative sizes in a wrong way. You should always have the following parameter in +your web.xml file during development:

+ 
  <context-param>
   	<param-name>Debug</param-name>
   	<param-value>true</param-value>
   	<description>IT Mill Toolkit debug mode</description>
   </context-param>
-

-This will make Toolkit run some sanity checks for relatively sized components. Informative error messages are printed to server console, invalid components are painted without their relative size and colored red. -

-

-Since 5.3 this parameter is also needed to show the client side logging window ( enabled by adding the request parameter "?debug=true" to uri). -

-

Handling of relative sizes have changed, ExpandLayout? deprecated

-

-See wiki:DevDocs/RFC/RelativeSizes for details -

+ + +

This will make Toolkit run some sanity checks for relatively sized components and print +informative error messages to the server console. Invalid components are painted without +their relative size and colored red.

+ +

From version 5.3 this parameter is also needed to show the client-side logging window, +which you can enable by adding the request parameter "?debug=true" to application +URI.

+ +

Handling of relative sizes has changed, ExpandLayout deprecated

+ +

See the article on Relative sizes in IT Mill +Toolkit for details.

+

Some components now have default sizes

-

-Previously almost all components had undefined size by default. Now some containers have 100% width by default. These are: -

-

Custom tailored client side components

-

-Due to the layout changes, all child component size changes (outside updateFromUIDL function) must be announced. Most commonly this kind of change happens when an image gets loaded inside a component. There is a helper method in the Util class for doing the announcement: -

+ +

Previously, almost all components had undefined size by default. Now some containers +have 100% width by default. These components are:

+ + + +

Custom Tailored Client-Side Components

+ +

Due to the layout changes, all child component size changes (outside the +updateFromUIDL() function) must be announced. Most commonly, this kind of change +occurs when an image gets loaded inside a component. There is a helper method +componentSizeUpdated() in the Util class for making the +announcement:

+ 
            Set<Widget> w = new HashSet<Widget>();
             w.add(this);
             Util.componentSizeUpdated(w);
-

Themes

-

-Many component have changed quite a lot due to layout refactoring. DOM structures have been changed etc. This may break old themes. -

-

-Theme building for Toolkit is not the most straightforward process as there is quite a lot of javascript magic done e.g. dimension measuring etc. If using unsupported CSS a component might be rendered in an unexpected way. "Theme builders handbook" is at the top of our TODO list. In the mean time it is often safest to override values defined in the default theme. -

-

-Especially if you encounter problems with margins or spacings, check the manual. Some CSS class names and conventions have changed. -

-

-If you have or get "broken" component on your screen, the first thing to do is to comment out all custom theme. If it works you may have the rework your css for that particular component. Things to check: -

-
  • Don't use custom margins outside component. In Toolkit no component should have a margin defined. Width/height on server side means offset width/height on client side, so using custom margins for components using css may break some features in the layouts. -
  • The same goes for borders and paddings for the main element unless they are used for the main element in the default theme. It is often safer to use borders in the same elements that have borders in the default theme or in inner elements. -

-Often the easiest path for your custom theme is to override values from the default theme. -

+ + +

Themes

+ +

Many components have changed significantly due to layout refactoring. Especially the +DOM structures of the components have changed, which may break old themes.

+ +

Building themes for Toolkit is not the most straightforward process as there is quite a +lot of JavaScript magic done while rendering the components, e.g., dimension measuring, +etc. If you use unsupported CSS, a component may be rendered in an unexpected way in a +browser. A "Theme builder's Handbook" is at the top of our TODO list. In the mean time, it +is often safest to override the values defined in the default theme.

+ +

Especially, if you encounter problems with margins or spacings, check the manual. Some +CSS class names and conventions have changed as well. (Many of the changes are not yet +included in the manual.)

+ +

If you have or get "broken" component on your screen, the first thing to do is to +comment out all your custom theme. If it works, you may have the rework your CSS for that +particular component. Below are a few things to check:

+ +
    + +
  • Do not use custom margins outside a component. In IT Mill Toolkit, no component + should have a margin defined. Settings width/height on the server-side would mean offset + width/height on client-side, so using custom margins for components using CSS may break + some features in the layouts.
    • + +
  • The same goes for borders and paddings for the main element unless they are used for + the main element in the default theme. It is often safer to use borders in the same + elements that have borders in the default theme or in inner elements.
    • + +
+ +

The easiest and safest way to build a custom theme is, often, to override the values +from the default theme.

+

Browser support changes since 5.2.x

-

-Safari 2 and Firefox 1.5 and Operas prior to version 9.6 are no longer supported. Users of these browsers are strongly encouraged to move to newer versions. -

-

-Google Chrome is not yet supported, but it is known to work rather well as it is a close relative to Safari. -

-

-GWT Hosted mode on Linux uses same Gecko version as FF 1.5 and is currently partly broken. Some layout's don't render properly. We hope to resolve these issues soon with next generation Hosted Mode Browser aka OOPHM or with minor hacks to the client side code. -

-

Minor Changes

-

-Version 5.3 contains lots of small changes also (more than 200), which might not be worth mentioning in the release notes, but here are some of them. -

-

-- New sub-window theme
-- Tabsheet HTML-structure has changed
-- Better shadow support for overlay elements
-- Row and column icons for Table
-- New component: PopupPanel/PopupView
-- Theme changing on-the-fly
-- Table cellstyle and rowstyle generators
-- New component: MenuBar (is this in the release?)
-- Security: double-cookie submission pattern
-- Low level bookmarking and history support
-- Sub-windows can be centered on screen. Modal windows are centered automatically
-- Link component now behaves like a normal "weblink"
-

+ +

Safari 2, Firefox 1.5, and versions of Opera prior to version 9.6 are no longer +supported. Users of these browsers are strongly encouraged to upgrade to a newer +version.

+ +

Google Chrome is not yet supported, but it is known to work rather well as it is a +close relative to Safari.

+ +

The GWT Hosted Mode Browser on Linux uses same Gecko version as FF 1.5 and is currently +partially broken. Some layouts do not render properly. We hope to resolve these issues +soon with next generation Hosted Mode Browser aka OOPHM or with minor hacks to the client +side code.

+ +

Miscellaneous Changes and Enhancements

+ +

Version 5.3 also contains a large number (more than 200) of small changes, which might +not be worth mentioning in the release notes, but below are some of them.

+ +
    +
  • A new sub-window theme
    • +
  • The HTML structure of TabSheet has changed
    • +
  • Better shadow support for overlay elements
    • +
  • Row and column icons for Table
    • +
  • New component: PopupPanel/PopupView
    • +
  • Theme changing on-the-fly
    • +
  • Table cellstyle and rowstyle generators
    • +
  • New component: MenuBar
    • +
  • Security: double-cookie submission pattern
    • +
  • Low-level support for bookmarking and history
    • +
  • Sub-windows can be centered on screen. Modal windows are centered automatically
    • +
  • The Link component now behaves like a normal "weblink"
    • +
- - - - ====== - -

The release if IT Mill Toolkit includes new features and a number - of fixed problems compared to the older 5.2.x version. Major changes and dozens of bug - fixes have been done. Only major issues handled below.

+

The release of IT Mill Toolkit includes new features and a large +number of fixes to problems compared to the older 5.2.x version. Major enhancements and +dozens of bug fixes have been implemented. Only the most significant issues are mentioned +here.

- -

For up-to-date status of known problems, see the developer website dev.itmill.com.

+

For up-to-date status of known problems, see the developer website dev.itmill.com.

Important known problems in

@@ -153,7 +198,6 @@ Version 5.3 contains lots of small changes also (more than 200), which might not not possible. This is due to the new client-side loader code. For a workaround for loading multiple applications per page, use a static HTML loader page, see for example the multiapp.html demo page. -

For other known problems, see open tickets at developer site dev.itmill.com.

@@ -194,10 +238,10 @@ Version 5.3 contains lots of small changes also (more than 200), which might not

Nokia E-series phones with at least 128MB of memory have been known to work with - older versions, but not with IT Mill Toolkit 5.2.0. Konqueror, the default browser in + older versions, but not with IT Mill Toolkit 5.2.x. Konqueror, the default browser in many Linux distributions, is known to have limited usability.

-

ChangeLog Between IT Mill Toolkit 5.1.2 and 5.2.0

+
-- 2.39.5