Environment setup"

From Documentation
m (Created page with '{{DevelopersGuidePageHeader}} __TOC__ ==Development Tools== To develop a ZK application, we suggest following working environment. *'''Eclipse''': :It's an open source IDE. Cu…')
 
m (correct highlight (via JWB))
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{DevelopersGuidePageHeader}}
+
{{ZKDevelopersGuidePageHeader}}
  
 
__TOC__
 
__TOC__
−
==Development Tools==
+
==Installation Guide==
−
To develop a ZK application, we suggest following working environment.
 
  
−
*'''Eclipse''':
+
[[ZK Installation Guide]] provides the detailed information to install ZK on different servers, and development environments (IDE).
−
:It's an open source IDE. Currently, ZKoss provides Visual Editor plugin for Eclipse.
 
−
*'''WTP''':
 
−
:Web Tools Platform, it includes tools for developing Web and Java EE applications.
 
−
*'''FireFox''':
 
−
:A browser that implements open web specifications, and many powerful plugin can help debugging on it.
 
−
*'''[https://addons.mozilla.org/en-US/firefox/addon/1843 Firebug]''':
 
−
:A plugin for FireFox. It's a must have tool for debug web applications.
 
−
*'''ZK jars''':
 
−
:You can use ZK by simply copy all needed jar files into certain directory. Please refer to quick start guide.
 
−
*'''[http://www.zkoss.org/download/zkstudio.dsp ZK Studio]''':
 
−
:A visual editor plugin provides by ZKoss. It's helpful to debug zscript in ZUML, and it provides many useful functionality like content assistance.
 
  
−
 
+
It is recommended to use an IDE you preferred to try the code by yourself. If you are not familiar with any IDE, you might follow the instructions described in [[ZK_Installation_Guide/Setting_up_IDE/Eclipse_with_ZK_Studio|ZK Installation Guide's Eclipse with ZK Studio]].
−
Please refer to our [http://www.zkoss.org/doc/quickstart/ quick start guide] for step by step installation tutorial.
 
  
 
==Configuration files you should know==
 
==Configuration files you should know==
−
ZKoss has provided Configuration files for most common use cases. In most case, you '''simply copy and paste''' it.
+
ZK provides configuration files for most common use cases. In most case, you '''simply copy and paste''' it. You could find them in the <code>MyApp</code> folder after you uncompress the binary distribution.
  
 
'''web.xml''':  
 
'''web.xml''':  
−
:To develop a Web application with ZK, you have to configure servlets, listeners and an optional filter to web.xml. It is also know as [http://en.wikipedia.org/wiki/Deployment_Descriptor Deployment Descriptor].
+
:To develop a Web application with ZK, we have to configure two Servlets and one listeners to <code>web.xml</code><ref>It is also known as [http://en.wikipedia.org/wiki/Deployment_Descriptor Deployment Descriptor]</ref> under the <code>WEB-INF</code> directory.
  
 
'''zk.xml''':   
 
'''zk.xml''':   
−
:zk.xml is the configuration descriptor of ZK. This file is optional. If you need to configure ZK differently from the default, you could provide a file called zk.xml under the WEB-INF directory.  
+
:zk.xml is the configuration descriptor of ZK. This file is optional. If you need to configure ZK differently from the default, you could provide a file called <code>zk.xml</code> under the <code>WEB-INF</code> directory.  
−
 
+
:For more information, please refer to the [http://books.zkoss.org/wiki/ZK_Configuration_Reference ZK Configuration Reference].
−
For detail explanation of web.xml, zk.xml, please refer to [http://www.zkoss.org/doc/devref-single/index.html#id537010 Appendix A, B of ZK developer's reference]
 
−
 
 
−
When you use other back-end frameworks like hibernate, you have to modify zk.xml as well. Also, ZKoss has provided reference zk.xml. You can simply copy and paste it.
 
−
 
 
−
== See Also ==
 
−
From ZK Forum:
 
  
−
[http://www.zkoss.org/forum/index.zul#path%3DlistComment%3BdiscussionId%3D5409%3BcategoryId%3D14%3B Eclipse 3.4 and zul.xsd]
+
<blockquote>
 +
----
 +
<references/>
 +
</blockquote>
  
 
== Quiz ==
 
== Quiz ==
−
#A plugin for FireFox is a must have debug tool. What is it?
 
−
#What's the visual editor plugin provides by ZKoss?
 
 
#What's the two configuration files you should know?
 
#What's the two configuration files you should know?
  
  
−
{{DevelopersGuidePageFooter}}
+
{{ZKDevelopersGuidePageFooter}}

Latest revision as of 10:39, 19 January 2022

DocumentationZK Developer's GuideIntroductionEnvironment setup
Environment setup


Stop.png This documentation is for an older version of ZK. For the latest one, please click here.


Installation Guide

ZK Installation Guide provides the detailed information to install ZK on different servers, and development environments (IDE).

It is recommended to use an IDE you preferred to try the code by yourself. If you are not familiar with any IDE, you might follow the instructions described in ZK Installation Guide's Eclipse with ZK Studio.

Configuration files you should know

ZK provides configuration files for most common use cases. In most case, you simply copy and paste it. You could find them in the MyApp folder after you uncompress the binary distribution.

web.xml:

To develop a Web application with ZK, we have to configure two Servlets and one listeners to web.xml[1] under the WEB-INF directory.

zk.xml:

zk.xml is the configuration descriptor of ZK. This file is optional. If you need to configure ZK differently from the default, you could provide a file called zk.xml under the WEB-INF directory.
For more information, please refer to the ZK Configuration Reference.
  1. ↑ It is also known as Deployment Descriptor

Quiz

  1. What's the two configuration files you should know?



Last Update : 2022/01/19

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_Guide/Introduction/Environment_setup&oldid=53410"