From Documentation

Jump to: navigation, search






Contents

Directory Structure

The content of the ZK binary distribution is as follows.

/doc

This directory holds the documents including release notes and license.

/dist

/dist/lib

This directory holds the ZK libraries
Filename Description License Shipped
zcommon.jar ZK's common library that ZK depends on (org.zkoss.*) LGPL All
zweb.jar ZK's Web library that ZK depends on (org.zkoss.web.* LGPL All
zk.jar ZK core functions, such as ZK Loader and Update Engine. (org.zkoss.zk.*) LGPL All
zul.jar ZUL components (org.zkoss.zul.*) LGPL All
zhtml.jar ZK HTML (ZHTML) components (org.zkoss.zhtml.*) LGPL All
zkbind.jar ZK Bind, including data binding and MVVM. LGPL All
zkplus.jar ZK extra utilities integrated easily with other frameworks. (org.zkoss.zkplus.*) LGPL All
zel.jar ZK's implementation of EL 2.2. It is based on Apache Tomcat 7's EL 2.2 implementation. Apache All
zkex.jar ZK professional ZUL components and utilities (org.zkoss.zkex.*) Commercial ZK PE and EE only
zml.jar ZK XML components for generating XML output (org.zkoss.zml.*) Commercial ZK PE and EE only
zkmax.jar ZK enterprise components and utilities (org.zkoss.*) Commercial ZK EE only

/dist/lib/zkforge

This directory holds the additional components and libraries. It is optional depending on whether you need them.
There are three kinds of binary distributions: CE, PE and EE. If not stated explicitly, it is shipped in all distributions.
Filename Description License Version Shipped
sapphire.jar Required if you want to use the sapphire theme. LGPL 6.5.0 All
silvertail.jar Required if you want to use the silvertail theme. LGPL 6.5.0 All
timelinez.jar Required if you want to use ZK Timeline component. GPL 2.3.1_50 ZK PE and EE only
timeplotz.jar Required if you want to use ZK Timeplot component. GPL 1.1_50 ZK EE only
gmapsz.jar Required if you want to use ZK Google Maps component. GPL 3.0.1 ZK EE only
zuljsp.jar Required if you want to use ZK JSP Tags. GPL 2.2 ZK EE only
  • ckez.jar not shipped with the binary distribution since ZK 6.5.1. You could get it from its google code repository

/dist/lib/ext

This directory holds the external libraries required to run ZK. Since these libraries are common, you might have already installed them in your Servlet container. These jar files are optional. You can choose whether to copy depending on your requirements.

Filename Description License Version Shipped
  • commons-fileupload.jar
  • commons-io.jar
Required if you want to upload files with them. Apache
  • Commons Fileupload 1.2.2
  • Commons IO 2.1
All
  • jcommon.jar
  • jfreechar.jar
Required if you want to use ZUL's chart component. LGPL
  • JFreeChart 1.0.14
  • JCommon 1.0.17
ZK PE and EE only
  • jasperreports.jar
  • itext.jar
  • jxl.jar
  • poi.jar
  • commons-collections.jar
  • commons-logging.jar
  • commons-digester.jar
Required if you want to use the jasperreport component. LGPL (jasperreports)
  • Jasper Reports 4.5.1 (itext: 2.1.7, commons-collections: 3.2.1, commons-logging: 1.1.1, commons-digester: 2.1, jxl: 2.6.12, poi: 3.7)
  • Note: poi.jar is required if you want to use Apache POI to generate Microsoft Excel format. And, jxl.jar is required only if you want to use JExcelApi to generate the Microsoft Excel format.
ZK PE and EE only
  • bsh.jar
Required if you want scripting in Java interpreter (BeanShell). LGPL BeanShell 2.0b4 All
  • Filters.jar
Required if you want to use the captcha component. Apache JH Labs Java Image Filters ZK PE and EE only
  • The interpreters for Groovy (groovy.jar), Ruby (jruby.jar), Python (jython.jar), JavaScript (js.jar), MVEL (mvel.jar) and OGNL (ognl.jar) are not shipped with the binary distribution since ZK 6. You could get them from their websites, or from ZK's Git repository.

/dist/src

This directory holds the source codes in JAR format. These JAR files are used for debugging in IDE, such as Eclipse and NetBeans. You cannot build the binary libraries from these. Rather, download and uncompress zk-src-6.0.0.tar.gz.

/dist/xsd

This directory holds the XSD files that might be useful to develop ZK applications.

/dist/WEB-INF

This directory holds the sample configuration file (web.xml and portlet.xml) and the TLD files. These TLD files are part of JAR files so they are loaded automatically. We put them here mainly for your reference only.

Version History

Last Update : 2013/11/27


Version Date Content
     




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