ZK Studio Installation Guide

Charles Pao, Engineer, Potix Corporation
Last Update: November 04, 2008

Prerequisites

Eclipse 3.3.2 Europa with WTP plugin installed

The update site URL:

http://studioupdate.zkoss.org/studio/update

• Install
  • Online Installation
  • Offline Installation
• Uninstall
  • Update Manager
  • Manually Remove

Install

The ZK Studio can be installed by either using Online Installation via update site url, or download the offline installation zip file provided here and follow the Offline Installation to install.

Online Installation

1. Open Eclipse, click [Help] menu, select [Software Updates]/[Find and Install...]
   
   


2. Select "Search for new features to install", click  Next > .
   
   


3. Click "New Remote Site..." button on the right top corner. Type "ZK Studio" in Name Field, enter the ZK Studio Update Site URL: http://studioupdate.zkoss.org/studio/update in URL field, click OK.
   
   
   Make sure the ZK Studio update site is selected then click  Finish  .
   
   


4. There will be some features listed in Search Result Window after Eclipse search the update site, select the feature then click  Next >  .
   
   


5. On the next window, select "I select the terms in the license agreement" then click  Next > .
   
   


6. Click  Finish  on the confirm window.
   
   
   
   The installation will proceed.
   
   
   
   If it popup the Verification Window, click  Install All .
   
   


7. Restart the eclipse as prompted when installation complete.
   
   

Offline Installation

1. Download the off-line installation zip file here.
2. Open Eclipse, click [Help] menu, select [Software Updates]/[Find and Install...].
3. Select "Search for new features to install", click  Next > .
4. Select  New Archived Site... .
   
   
   
   
5. Select the offline install zip file, then press  Open .
   
   
   
   Press  OK .
   
   
   
   
6. Make sure the newly added site is selected, then press  Finish .
   
   
7. The rest procedures is like the Online Installation section started from step 4.

Uninstall

If you install ZK Studio by copying those jar files to Eclipse's plugin folder (By Eclipse Official Suggestion, We strongly not recommend to install like this.), please follow the Manually Remove section, If installation is by Eclipse's Update Manager, please follow the Update Manager section.

Update Manager

1. Be sure to close all the open zul files in editors in Eclipse IDE.
2. Click [Help] menu, select [Software Updates]/[Manage Configuration].
3. On the Opened "Product Configuration" Window, select the ZK Studio entry on the left tree node. Right click the entry and select "Uninstall", then click    OK   .
   
4. It should prompt a confirmation dialog to you to restart Eclipse, follow that instruction.
5. Use the normal way to run Eclipse. To make sure the plugin has already uninstalled, click [Help] menu, select [About Eclipse Platform], click "Plug-in Details", on the "About Eclipse Plug-ins" window, there should be no plugins whose name is started with "ZK Studio".
6. If the ZKStudio plugin still existed, use the steps in Manually Remove section to uninstall.

Manually Remove:

1. Be sure to close all the open zul files in editors in Eclipse IDE.
2. Close Eclipse completely.
3. Remove all files whose names are "org.zkoss.eclipse.*.jar" in Eclipse's plugin folder, it is usually a "plugins" folder under the Eclipse's install directory.
4. Start Eclipse with -clean -initialize startup parameters (about how to specify startup parameters, please refer this), then use the normal way to run Eclipse. To make sure the plugin has already uninstalled, click [Help] menu, select [About Eclipse Platform], click "Plug-in Details", on the popuped "About Eclipse Plug-ins", there should be no plugins whose name is started with "ZK Studio".