Getting Started with ZK Calendar"
(7 intermediate revisions by 2 users not shown) | |||
Line 4: | Line 4: | ||
Here we introduce the required setup for a web application to use ZK Calendar. | Here we introduce the required setup for a web application to use ZK Calendar. | ||
+ | |||
+ | = License = | ||
+ | ZK Calendar is GPL/Commercial dual-licensed. | ||
= Setup by Maven = | = Setup by Maven = | ||
− | We recommend managing your project with Maven. First, you check the available version in [https://mavensync.zkoss.org/maven2/org/zkoss/calendar/calendar/ ZK Maven CE repository]. Then, you can adopt ZK Calendar easily by simply adding a dependency like the following example. | + | We recommend managing your project with Maven. First, you check the available version in [https://mavensync.zkoss.org/maven2/org/zkoss/calendar/calendar/ ZK Maven CE repository]. Then, you can adopt ZK Calendar easily by simply adding a dependency like the following example. (If you didn't setup zk maven repository yet, you have to [[ZK_Installation_Guide/Setting_up_IDE/Maven/Use_ZK_Maven_Artifacts/Resolving_ZK_Framework_Artifacts_via_Maven#How_to_Use_ZK_Maven_Repository | setup zk maven repository]].) |
Line 17: | Line 20: | ||
</dependency> | </dependency> | ||
</source> | </source> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
= Manually Installing the ZK Calendar JAR= | = Manually Installing the ZK Calendar JAR= | ||
Line 29: | Line 26: | ||
# [http://www.zkoss.org/download/zk.dsp Downloaded ZK CE 7.0.3 or above] | # [http://www.zkoss.org/download/zk.dsp Downloaded ZK CE 7.0.3 or above] | ||
# [http://www.zkoss.org/download/zkcalendar.dsp Downloaded ZK Calendar Binary] | # [http://www.zkoss.org/download/zkcalendar.dsp Downloaded ZK Calendar Binary] | ||
− | # Extract those 2 zip files, include all JAR files by putting them into your project's < | + | # Extract those 2 zip files, include all JAR files by putting them into your project's <code>/WEB-INF/lib</code> |
Depending on your IDE the steps will differ, however, the most important part is both ZK Calendar and ZK’s JAR files are included in your project's classpath. The easiest way to create a compatible project is to use [http://www.zkoss.org/download/zkstudio.dsp ZK Studio] and then include calendar.jar as a library. | Depending on your IDE the steps will differ, however, the most important part is both ZK Calendar and ZK’s JAR files are included in your project's classpath. The easiest way to create a compatible project is to use [http://www.zkoss.org/download/zkstudio.dsp ZK Studio] and then include calendar.jar as a library. | ||
Line 35: | Line 32: | ||
=A Very Basic Application= | =A Very Basic Application= | ||
− | After setup, we can create an < | + | After setup, we can create an <code>index.zul</code> with the content below to verify the setup works or not. |
<source lang="xml"> | <source lang="xml"> | ||
Line 51: | Line 48: | ||
Congratulations! That is all it takes to embed ZK Calendar within your ZK application. | Congratulations! That is all it takes to embed ZK Calendar within your ZK application. | ||
− | = | + | = Example Project= |
− | You can | + | You can find all example codes mentioned in this book at [https://github.com/zkoss/zkcalendar/tree/master/essentials the example project]. |
{{ZKCalendarEssentialsPageFooter}} | {{ZKCalendarEssentialsPageFooter}} |
Latest revision as of 06:47, 24 June 2022
Here we introduce the required setup for a web application to use ZK Calendar.
License
ZK Calendar is GPL/Commercial dual-licensed.
Setup by Maven
We recommend managing your project with Maven. First, you check the available version in ZK Maven CE repository. Then, you can adopt ZK Calendar easily by simply adding a dependency like the following example. (If you didn't setup zk maven repository yet, you have to setup zk maven repository.)
<dependency>
<groupId>org.zkoss.calendar</groupId>
<artifactId>calendar</artifactId>
<version>${calendar.version}</version>
</dependency>
Manually Installing the ZK Calendar JAR
- Downloaded ZK CE 7.0.3 or above
- Downloaded ZK Calendar Binary
- Extract those 2 zip files, include all JAR files by putting them into your project's
/WEB-INF/lib
Depending on your IDE the steps will differ, however, the most important part is both ZK Calendar and ZK’s JAR files are included in your project's classpath. The easiest way to create a compatible project is to use ZK Studio and then include calendar.jar as a library.
A Very Basic Application
After setup, we can create an index.zul
with the content below to verify the setup works or not.
<zk>
<calendars/>
</zk>
This gives you the very first ZK Calendar application. When a server starts, navigate to index.zul and the following page should be displayed.
Congratulations! That is all it takes to embed ZK Calendar within your ZK application.
Example Project
You can find all example codes mentioned in this book at the example project.
The example project is at Github