Version Upgrade"

From Documentation
m
m (Undo revision 51031 by Jeanher (talk))
Line 1: Line 1:
 
{{ZKDevelopersReferencePageHeader}}
 
{{ZKDevelopersReferencePageHeader}}
  
−
=Feature comparison=
+
=Versioning=
−
ZK Framework is offered in 3 editions, CE, PE and EE. To see what  features are included in each edition, visit the Feature Page.
+
ZK products follow semantic versioning, where the three digits refer to MAJOR.MINOR.PATCH respectively. In the case where a hotfix is required, a fourth digit is introduced. 
 +
Except for major (first digit) upgrades, compatibility is generally maintained, or a fall-back mechanism is available.
 +
 +
=Upgrade References=
 +
An introductory smalltalk is published for every MAJOR and MINOR release. For example New Features of ZK 9.5. The smalltalk highlights the most important changes as well as provides upgrade tips for upgrading to that specific version. View all New Features articles.
  
−
=Upgrade the Library=
+
A detailed release note containing a list of fixed issues is available for every new release, including hotfixes. For example, ZK 9.0.0 release notes. The full release history can be found here.
−
To upgrade from CE to ZK PE or EE, download the corresponding PE/EE binary files from the Download Page, or specify the evaluation repository and include required PE/EE dependencies if you use maven. Maven instructions here.
 
  
−
In addition to the core ZK features, PE/EE users are given access to use certain add-ons and tools according to the package they are on. For example a EE user can use ZATS Mimic, ZK Spring, ThemePack themes and ZK Calendar - they are not packaged in the core ZK. To use these add-ons, you will have to either download the corresponding jar files from their download pages, or, include the dependency in your maven POM file.  
+
An “upgrade notes” section will be included at the end of a release note when needed. The “upgrade notes” section points out API changes or changes that developers will most likely need to take actions accordingly.
  
−
Reference the Feature Page to see what features are covered in PE/EE and reference  the content (jar) of binary distributions to see what comes in the core package.
+
You can follow the same naming conventions as the examples provided above to search for the upgrade references you are looking for.
  
−
=Use PE/EE specific components and features=
+
=Important/breaking changes=
−
After upgrading to PE/EE, you have more components, features and Java classes to use.
 
  
−
==Features enabled by default==
+
table
−
After upgrading to PE/EE, some of the features are enabled by default. For example, the client render on demand feature will be enabled by default to improve the client-side performance.
 
−
Also, with EE, the tablet UI will be enabled by default, when a tablet/mobile device connects to your application the tablet-supported components will switch themselves to the tablet theme.
 
−
You can manually disable them in zk.xml if you are not ready.
 
  
−
==Change of default behavior==
+
=Upgrade Process=
−
Some of the default behavior changes after you upgraded ZK edition. For example in the case of server push, with CE, it uses client polling. Once you upgrade to PE, the default push becomes comet push, and with EE it uses servlet 3 comet. Read more here.
+
Specify the version you wish to upgrade to in your maven POM file, or, download corresponding binary files manually and put them into your project. It is important to make sure all ZK jar files are in the same version.  
  
−
==Require configuration==
+
Then, fix any compilation errors by referencing the Upgrade References.
−
Some PE/EE features are now available for you to use, but you will have to enable them by yourself. For example if you have a big grid or listbox, you can turn on render on demand to boost its performance.
 
−
 
 
−
Please reference corresponding documentation for the relevant configurations or contact info@zkoss.org if you have any questions.
 
  
  

Revision as of 10:37, 26 January 2021


DocumentationZK Developer's ReferenceUpgrade TipsVersion Upgrade
Version Upgrade


Versioning

ZK products follow semantic versioning, where the three digits refer to MAJOR.MINOR.PATCH respectively. In the case where a hotfix is required, a fourth digit is introduced. Except for major (first digit) upgrades, compatibility is generally maintained, or a fall-back mechanism is available.

Upgrade References

An introductory smalltalk is published for every MAJOR and MINOR release. For example New Features of ZK 9.5. The smalltalk highlights the most important changes as well as provides upgrade tips for upgrading to that specific version. View all New Features articles.

A detailed release note containing a list of fixed issues is available for every new release, including hotfixes. For example, ZK 9.0.0 release notes. The full release history can be found here.

An “upgrade notes” section will be included at the end of a release note when needed. The “upgrade notes” section points out API changes or changes that developers will most likely need to take actions accordingly.

You can follow the same naming conventions as the examples provided above to search for the upgrade references you are looking for.

Important/breaking changes

table

Upgrade Process

Specify the version you wish to upgrade to in your maven POM file, or, download corresponding binary files manually and put them into your project. It is important to make sure all ZK jar files are in the same version.

Then, fix any compilation errors by referencing the Upgrade References.




Last Update : 2021/01/26

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.


Retrieved from "https://www.zkoss.org/_w/index.php?title=ZK_Developer%27s_Reference/Upgrade_Tips/Version_Upgrade&oldid=51032"