Compile LESS

From Documentation


Install Node.js

Node.js is now required is now required for our ZK-Less Engine since 7.0.3.

If you don't have Node.js installed yet, please follow the steps given by the official-website to install Node.js.

Compile LESS to DSP

If you are using DSP pages, here we introduce how to compile LESS to DSP files by Ant and Maven.

Compile LESS by Ant

  • Have Node.js installed in your environment.
  • Follow the online document to install Apache Ant.
  • Download the following necessary jars in your project/lib folder from zk repository (right click -> save as).
    • yuicompressor.jar
    • zkjszips.jar
    • commons-io.jar
    • CssCompressor.jar
    • zul.jar (extract zk-bin-7.0.X.zip file from sourceforge)
  • Execute the following command under your project folder to install ZK-Less' node package.
cd root_of_your_project
npm install zkless-engine
  • Write an ant script build.xml file like the following sample under project folder, and change the input folder and output folder as needed.
<?xml version="1.0"?>
<project name="less.compile" default="lessc" basedir=".">
	<target name="lessc">
		<exec executable="node">
			<arg value="${basedir}/node_modules/zkless-engine/lib/CpLess.js" /> 	<!-- location of the engine's core file -->
			<arg value="${basedir}/src/main/webapp"/> 	  <!-- input folder that contains less files-->
            <arg value="${basedir}/src/main/webapp"/>	  <!-- output folder -->
            <arg value="${basedir}/lib/zul.jar"/>    <!-- path of zul.jar -->
		</exec>
                <!-- compress the result using zk's Css Compressor -->
		<java classname="CompressCss" fork="true">
			<arg value="${basedir}/src/main/webapp"/>    <!-- input folder (same as above) -->
			<arg value="${basedir}/src/main/webapp"/>    <!-- output folder (same as above) -->
			<classpath>
			    <!-- required jars -->
			    <pathelement location="${basedir}/lib/zkjszips.jar"/>
			    <pathelement location="${basedir}/lib/yuicompressor.jar"/>
			    <pathelement location="${basedir}/lib/commons-io.jar"/>
			    <pathelement location="${basedir}/lib/CssCompressor.jar"/>
			</classpath>
		</java>
	</target>
</project>
  • Execute ant command in command line tool, i.e:
cd root_of_your_project
ant lessc

Compile LESS by Maven

  • Have Node.js installed in your environment.
  • Execute the following command to install the native less engine by Less.js
npm install -g less
  • Modify pom.xml in maven project
<!-- Add Plugin Repository -->
<pluginRepositories>
	<pluginRepository>
		<id>zkmaven</id>
		<name>ZK Maven Plugin Repository</name>
		<url>http://mavensync.zkoss.org/maven2/</url>
	</pluginRepository>
</pluginRepositories>
<dependencies>
	<!-- only needed if using _zkmixins.less provided by ZK -->
	<dependency>
		<groupId>org.zkoss.zk</groupId>
		<artifactId>zul</artifactId>
		<version>7.0.3</version>
	</dependency>
</dependencies>
<build>
	<plugins>
		<!-- Add zkless-engine-maven-plugin -->
		<plugin>
			<groupId>org.zkoss.maven</groupId>
			<artifactId>zkless-engine-maven-plugin</artifactId>
			<version>0.9.2</version>
			<executions>
				<execution>
					<id>compile-less</id>
					<goals>
						<goal>lessc</goal>
					</goals>
					<configuration>
						<!-- LESS source folder -->
						<sourceDirectory>${project.basedir}/src/main/resources</sourceDirectory>
						<!-- *.CSS.DSP output folder -->
						<outputDirectory>${project.basedir}/src/main/resources</outputDirectory>
					</configuration>
				</execution>
			</executions>
		</plugin>
	</plugins>
</build>
  • Execute mvn install command to trigger LESS compilation.

Compile LESS to DSP during Development phase

It is not friendly to debug LESS during development by running Ant or Maven each time you modify LESS files. Therefore, we provide a servlet named ZKLessServlet that can be used in web project to develop LESS by simply refreshing the browser page.

Note: This is only recommended in development environment.

Steps to use ZKLessServlet within a Maven Project:

  • Have Node.js installed in your environment.
  • Install the native less engine by the following command:
npm install -g less
  • Add maven dependency if you are using maven.
<repositories>
    <repository>
        <id>ZK CE</id>
        <name>ZK CE Repository</name>
        <url>http://mavensync.zkoss.org/maven2</url>
    </repository>
    <!-- omitted other repository -->
</repositories>
<dependencies>
    <dependency>
        <groupId>org.zkoss.maven</groupId>
        <artifactId>zkless-servlet</artifactId>
        <version>0.9.2</version>
    </dependency>
    <!-- omitted other dependency -->
</dependencies>
  • Add servlet settings in web.xml
<web-app>
    <!-- omitted other servlets -->
    <servlet>
        <servlet-name>zkLess</servlet-name>
        <servlet-class>org.zkoss.less.ZKLessServlet</servlet-class>
        <init-param>
            <param-name>org.zkoss.less.LessResource</param-name>
            <param-value>/less</param-value><!-- specify to the folder that contains *.less -->
        </init-param>
        <init-param>
            <param-name>org.zkoss.less.OutputFormat</param-name>
            <param-value>.css.dsp</param-value><!-- specify output file suffix, default .css.dsp -->
        </init-param>
        <init-param>
            <param-name>org.zkoss.less.CompressOutput</param-name>
            <param-value>true</param-value><!-- compress output, default true -->
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>zkLess</servlet-name>
        <url-pattern>/less/*</url-pattern><!-- specify to folder that contains *.less -->
    </servlet-mapping>
</web-app>
  • Project structure and use LESS directly in zul page.
Project structure should look like the following:
zkMavenWebProject - src/main/webapp
    WEB-INF
        web.xml
        zk.xml
    less
        test.less
    pages
        test.zul
Use test.less inside test.zul as follows
<!-- test.zul -->
<?link rel="stylesheet" href="../less/test.less"?>
<zk>
    <button label="test" />
</zk>
  • Now you can modify LESS and see the result by refreshing your browser page.

Version History

Last Update : 2014/08/29


Version Date Content
     


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