Maven"

From Documentation
m
Line 19: Line 19:
 
</blockquote>
 
</blockquote>
  
==Sample of pom.xml==
+
=Dependencies=
 +
==ZK Spreadsheet==
 +
<source lang="xml">
 +
<dependency>
 +
<groupId>org.zkoss.poi</groupId>
 +
<artifactId>zpoi</artifactId>
 +
<version>3.8.1</version>
 +
</dependency>
 +
<dependency>
 +
<groupId>org.zkoss.zss</groupId>
 +
<artifactId>zss</artifactId>
 +
<version>2.5.0</version>
 +
</dependency>
 +
</source>
 +
 
 +
==ZK Spreadsheet EE==
 +
<source lang="xml">
 +
<dependency>
 +
<groupId>org.zkoss.poi</groupId>
 +
<artifactId>zpoiex</artifactId>
 +
<version>3.8.1</version>
 +
</dependency>
 +
<dependency>
 +
<groupId>org.zkoss.zss</groupId>
 +
<artifactId>zssex</artifactId>
 +
<version>2.5.0</version>
 +
</dependency>
 +
<!-- Export to PDF -->
 +
<dependency>
 +
<groupId>org.zkoss.zss</groupId>
 +
<artifactId>zsspdf</artifactId>
 +
<version>2.5.0</version>
 +
</dependency>
 +
<!-- Export to HTML -->
 +
<dependency>
 +
<groupId>org.zkoss.zss</groupId>
 +
<artifactId>zsshtml</artifactId>
 +
<version>2.5.0</version>
 +
</dependency>
 +
<!-- ZK Spreadsheet JSP Tag -->
 +
<dependency>
 +
<groupId>org.zkoss.zss</groupId>
 +
<artifactId>zssjsp</artifactId>
 +
<version>2.5.0</version>
 +
</dependency>
 +
<!-- ZK Spreadsheet As JSF Component -->
 +
<dependency>
 +
<groupId>org.zkoss.zss</groupId>
 +
<artifactId>zssjsf</artifactId>
 +
<version>2.5.0</version>
 +
</dependency>
 +
</source>
 +
 
 +
=Repository=
 +
==Evaluating users (ZK Spreadsheet EE-eval)==
 +
 
 +
For evaluation
 +
*http://mavensync.zkoss.org/eval/
 +
*Sample Config
 +
<source lang="xml">
 +
<repositories>
 +
    <repository>
 +
      <id>ZK Spreadsheet EE Evaluation</id>
 +
      <url>http://mavensync.zkoss.org/eval/</url>
 +
    </repository>
 +
  </repositories>
 +
</source>
 +
 
 +
===Sample of pom.xml for evaluation===
 
Here is sample pom.xml for a simple Java project that uses the ZK Spreadsheet.
 
Here is sample pom.xml for a simple Java project that uses the ZK Spreadsheet.
  
Line 99: Line 167:
 
</project>
 
</project>
 
</source>
 
</source>
 +
==Premium users only==
 +
 +
* <span style="color:red">'''Notice'''</span>: Need [[ZK_Spreadsheet_Essentials/Getting_Started_with_ZK_Spreadsheet/Maven#Login_authentication|Login authentication]]
 +
 +
* http://maven.zkoss.org/repo/zk/ee
  
=Sample of Dependencies=
 
==ZK Spreadsheet==
 
 
<source lang="xml">
 
<source lang="xml">
<dependency>
+
<repositories>
<groupId>org.zkoss.poi</groupId>
+
<repository>
<artifactId>zpoi</artifactId>
+
<id>ZK EE Repository</id>
<version>3.8.1</version>
+
<url>https://maven.zkoss.org/repo/zk/ee</url>
</dependency>
+
</repository>
<dependency>
+
</repositories>
<groupId>org.zkoss.zss</groupId>
 
<artifactId>zss</artifactId>
 
<version>2.5.0</version>
 
</dependency>
 
 
</source>
 
</source>
  
==ZK Spreadsheet EE==
+
==== Login authentication ====
 +
 
 +
Please refer to the [http://maven.apache.org/settings.html#Servers official documentation] of Apache Maven project for storing login authentication credential in the global settings file.
 +
 
 +
* Location (if not already existed, you can create it manually)
 +
** Maven installation root:  <u>$M2_HOME/conf/settings.xml</u> - OR -
 +
** User's Maven root: <u>${user.home}/.m2/settings.xml</u>
 +
 
 
<source lang="xml">
 
<source lang="xml">
<dependency>
+
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
<groupId>org.zkoss.poi</groupId>
+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
<artifactId>zpoiex</artifactId>
+
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
<version>3.8.1</version>
+
http://maven.apache.org/xsd/settings-1.0.0.xsd">
</dependency>
+
<servers>
<dependency>
+
<server>
<groupId>org.zkoss.zss</groupId>
+
<id>ZK EE Repository</id><!-- Same as the repository name used in your pom.xml -->
<artifactId>zssex</artifactId>
+
<!-- Please replace the following with your premium username and password -->
<version>2.5.0</version>
+
<username>premium</username>
</dependency>
+
<password>2k0553cr3t</password>
<!-- Export to PDF -->
+
</server>
<dependency>
+
</servers>
<groupId>org.zkoss.zss</groupId>
+
</settings>
<artifactId>zsspdf</artifactId>
 
<version>2.5.0</version>
 
</dependency>
 
<!-- Export to HTML -->
 
<dependency>
 
<groupId>org.zkoss.zss</groupId>
 
<artifactId>zsshtml</artifactId>
 
<version>2.5.0</version>
 
</dependency>
 
<!-- ZK Spreadsheet JSP Tag -->
 
<dependency>
 
<groupId>org.zkoss.zss</groupId>
 
<artifactId>zssjsp</artifactId>
 
<version>2.5.0</version>
 
</dependency>
 
<!-- ZK Spreadsheet As JSF Component -->
 
<dependency>
 
<groupId>org.zkoss.zss</groupId>
 
<artifactId>zssjsf</artifactId>
 
<version>2.5.0</version>
 
</dependency>
 
 
</source>
 
</source>
  
=ZK Spreadsheet EE-eval=
+
==== Troubleshooting ====
For evaluation
 
*http://mavensync.zkoss.org/eval/
 
*Sample Config
 
<source lang="xml">
 
<repositories>
 
    <repository>
 
      <id>ZK Spreadsheet EE Evaluation</id>
 
      <url>http://mavensync.zkoss.org/eval/</url>
 
    </repository>
 
  </repositories>
 
</source>
 
<blockquote>
 
----
 
For premium users, please refer to [http://books.zkoss.org/wiki/ZK_Installation_Guide/Setting_up_IDE/Maven/Use_ZK_Maven_Artifacts/Resolving_ZK_Framework_Artifacts_via_Maven#2._PE-eval_.2F_EE-_eval_.2860-days_free_evaluation.29 here]
 
</blockquote>
 
  
 
{{ZKSpreadsheetEssentialsPageFooter}}
 
{{ZKSpreadsheetEssentialsPageFooter}}

Revision as of 09:13, 2 August 2013



If your project is managed by Maven already, you can adopt easily by simply adding a dependency[1]

<dependency>
	<groupId>org.zkoss.zss</groupId>
	<artifactId>zss</artifactId>
	<version>2.5.0</version>
</dependency>

  1. If you didn't setup zk maven repository yet, you have to setup zk maven repository too.

Dependencies

ZK Spreadsheet

<dependency>
	<groupId>org.zkoss.poi</groupId>
	<artifactId>zpoi</artifactId>
	<version>3.8.1</version>
</dependency>
<dependency>
	<groupId>org.zkoss.zss</groupId>
	<artifactId>zss</artifactId>
	<version>2.5.0</version>
</dependency>

ZK Spreadsheet EE

<dependency>
	<groupId>org.zkoss.poi</groupId>
	<artifactId>zpoiex</artifactId>
	<version>3.8.1</version>
</dependency>
<dependency>
	<groupId>org.zkoss.zss</groupId>
	<artifactId>zssex</artifactId>
	<version>2.5.0</version>
</dependency>
<!-- Export to PDF -->
<dependency>
	<groupId>org.zkoss.zss</groupId>
	<artifactId>zsspdf</artifactId>
	<version>2.5.0</version>
</dependency>
<!-- Export to HTML -->
<dependency>
	<groupId>org.zkoss.zss</groupId>
	<artifactId>zsshtml</artifactId>
	<version>2.5.0</version>
</dependency>
<!-- ZK Spreadsheet JSP Tag -->
<dependency>
	<groupId>org.zkoss.zss</groupId>
	<artifactId>zssjsp</artifactId>
	<version>2.5.0</version>
</dependency>
<!-- ZK Spreadsheet As JSF Component -->
<dependency>
	<groupId>org.zkoss.zss</groupId>
	<artifactId>zssjsf</artifactId>
	<version>2.5.0</version>
</dependency>

Repository

Evaluating users (ZK Spreadsheet EE-eval)

For evaluation

 <repositories>
    <repository>
      <id>ZK Spreadsheet EE Evaluation</id>
      <url>http://mavensync.zkoss.org/eval/</url>
    </repository>
  </repositories>

Sample of pom.xml for evaluation

Here is sample pom.xml for a simple Java project that uses the ZK Spreadsheet.

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>sample</groupId>
	<artifactId>zss.maven</artifactId>
	<properties>
		<zpoi.version>3.8.1</zpoi.version>
		<zss.version>2.5.0</zss.version>
		<zk.version>6.5.0</zk.version>
	</properties>
	<packaging>war</packaging>
	<version>0.0.1-SNAPSHOT</version>
	<name>eval Maven Webapp</name>
	<url>http://maven.apache.org</url>
	<repositories>
		<repository>
			<id>ZSS eval</id>
			<url>http://mavensync.zkoss.org/eval/</url>
		</repository>
	</repositories>
	<dependencies>
		<!-- ZSS -->
		<dependency>
			<groupId>org.zkoss.poi</groupId>
			<artifactId>zpoi</artifactId>
			<version>${zpoi.version}</version>
		</dependency>
		<dependency>
			<groupId>org.zkoss.poi</groupId>
			<artifactId>zpoiex</artifactId>
			<version>${zpoi.version}</version>
		</dependency>
		<dependency>
			<groupId>org.zkoss.zss</groupId>
			<artifactId>zss</artifactId>
			<version>${zss.version}</version>
		</dependency>
		<dependency>
			<groupId>org.zkoss.zss</groupId>
			<artifactId>zssex</artifactId>
			<version>${zss.version}</version>
		</dependency>
		<dependency>
			<groupId>org.zkoss.zss</groupId>
			<artifactId>zsspdf</artifactId>
			<version>${zss.version}</version>
		</dependency>
		<dependency>
			<groupId>org.zkoss.zss</groupId>
			<artifactId>zsshtml</artifactId>
			<version>${zss.version}</version>
		</dependency>		
		<dependency>
			<groupId>org.zkoss.zss</groupId>
			<artifactId>zssjsp</artifactId>
			<version>${zss.version}</version>
		</dependency>
		<dependency>
			<groupId>org.zkoss.zss</groupId>
			<artifactId>zssjsf</artifactId>
			<version>${zss.version}</version>
		</dependency>
		<!-- ZK -->
		<dependency>
			<groupId>org.zkoss.zk</groupId>
			<artifactId>zul</artifactId>
			<version>${zk.version}</version>
		</dependency>
		<dependency>
			<groupId>org.zkoss.zk</groupId>
			<artifactId>zkex</artifactId>
			<version>${zk.version}</version>
		</dependency>
	</dependencies>
</project>

Premium users only

<repositories>
	<repository>
		<id>ZK EE Repository</id>
		<url>https://maven.zkoss.org/repo/zk/ee</url>
	</repository>
</repositories>

Login authentication

Please refer to the official documentation of Apache Maven project for storing login authentication credential in the global settings file.

  • Location (if not already existed, you can create it manually)
    • Maven installation root: $M2_HOME/conf/settings.xml - OR -
    • User's Maven root: ${user.home}/.m2/settings.xml
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
		http://maven.apache.org/xsd/settings-1.0.0.xsd">
	<servers>
		<server>
			<id>ZK EE Repository</id><!-- Same as the repository name used in your pom.xml -->
			<!-- Please replace the following with your premium username and password -->
			<username>premium</username>
			<password>2k0553cr3t</password>
		</server>
	</servers>
</settings>

Troubleshooting

All source code listed in this book is at Github.


Last Update : 2013/08/02

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