This is part of QuipuKit library for JSF distribution.

  I. Contents of This Distribution
 II. Runtime Files
III. Installation Instructions
 IV. Installing License File
  V. Support
 VI. Third-Party Libraries


I. Contents of This Distribution

The distribution contains:
readme.txt - this file.
quipukit.jar - the QuipuKit library.
license\ - the License Agreement for the QuipuKit library and third-party product licenses.
lib\ - the third-party libraries required for the QuipuKit library.
doc\ - the QuipuKit library documentation. See index.html as a starting point.


II. Runtime Files

The quipukit.jar file, the libraries residing in the lib\ folder and the individual runtime license key file are redistributable (runtime) files.


III. Installation Instructions

Provided that you already have a JSF application, the following steps allow you to use the QuipuKit library in your Web application:

1. Add quipukit.jar to the application libraries.

2. Add the following libraries found in the distribution under the lib\ folder to the application:
jdom.jar - Unmodified library, version 1.0. You can skip adding it if it's already available for the application.
ss_css2.jar - Unmodified library, version 0.9.4. You can skip adding it if it's already available for the application.
jcommon.jar - Unmodified library, version 1.0.0. You can skip adding it if it's already available for the application.
jfreechart.jar - Specifically modified version for the QuipuKit components library.

3. Register the QuipuKit filter in your WEB-INF/web.xml file by adding the following lines:

<!-- FILTER FOR PROCESSING INTERNAL QUIPUKIT COMPONENTS RESOURCES -->
  <filter>
    <filter-name>ResourceFilter</filter-name>
    <filter-class>teamdev.jsf.util.ResourceFilter</filter-class>
  </filter>

<!-- MAPPING FOR QUIPUKIT COMPONENTS FILTER -->
  <filter-mapping>
    <filter-name>ResourceFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

  For more details see http://www.teamdev.com/quipukit/documentation/developersGuide/installation-and-configuration.html#InstallationandConfiguration-ResourceFilterOptimization
  
4. (Optional) If you want to turn on automatic client-side validation for all pages, add the following lines to the WEB-INF/web.xml file (see Validation Framework documentation for more information):

  <context-param>
    <param-name>teamdev.jsf.validation.clientValidation</param-name>
    <param-value>onSubmit</param-value>
  </context-param>


IV. Installing License File

The QuipuKit library requires a valid license file for operation.
You can request a fully-functional 30-day evaluation license (http://www.teamdev.com/quipukit/evaluate.jsf) or purchase a commercial license of QuipuKit (http://www.teamdev.com/quipukit/purchase.jsf).
To install the license, place the quipukit-license.jar file with the QuipuKit license to the application classpath (next to quipukit.jar).


V. Support

Visit support forums for the QuipuKit library at http://support.teamdev.com/quipukit
Or contact us by e-mail: quipukit-support@teamdev.com


VI. Third-Party Libraries

The QuipuKit library uses:
* Software developed by the JDOM Project ([http://www.jdom.org/])
* The JFreeChart library ([http://www.jfree.org/jfreechart/]) that is covered by the LGPL.
* The JCommon class library ([http://www.jfree.org/jcommon/]) that is covered by the LGPL.
* The CSS Parser library ([http://cssparser.sourceforge.net/]) that is covered by the LGPL.
* Parts of code from Apache MyFaces Project ([http://myfaces.apache.org/]) that is licensed under the Apache License, Version 2.0
* Parts of code from JSON software ([http://www.json.org/])
* Parts of code from Apache Commons codec ([http://jakarta.apache.org/commons/codec/]) that is licensed under the Apache License, Version 2.0.
