freemarker 2.3.10

Contains classes and interfaces that deal with template loading and caching. Beside the actual template cache, it contains loaders that can load template files from the file system, from the classpath, or from a web application context. If you have specific needs, you can plug custom template loaders into the system by implementing the template loader interface.

This package contains FreeMarker's core parsing/rendering functionality; most casual users do not need to be aware of the classes in this package, and can restrict their attention to the {@link freemarker.template} package.

An ant task that can be used to invoke the FreeMarker engine to generate documentation.

Provides model implementations that allow access to arbitrary Java objects.

Most of the issues dealing with beans are handled by the {@link freemarker.ext.beans.BeansWrapper#wrap(Object)}and {@link freemarker.ext.beans.BeansWrapper#getStaticModels()} methods. In normal cases, these are the only methods you should use to turn an arbitrary Java object into a FreeMarker {@link freemarker.template.TemplateModel}. Additionally, you can manually create instance of any wrapper class using its constructors. Note, however that in such cases you bypass the eventual model caching of the wrapper.

Provides adapter for JDOM including support for writing XML fragments, listing nodes, traversal, copying, and filtering, and a full XPath support.

Classes for two-way FreeMarker-JSP integration. It contains both a JSP custom tag that allows embedding of FreeMarker templates inside JSP pages, as well as the infrastructure that allows JSP custom tags to be used inside FreeMarker templates.

Provides model implementations that allow access to arbitrary Jython objects.

Most of the issues dealing with Jython objects are handled by the {@link freemarker.ext.jython.JythonWrapper#wrap(Object)} method. In normal cases, this is the only method you should use to turn an arbitrary Jython object into a FreeMarker {@link freemarker.template.TemplateModel}. Additionally, you can manually create instances of any wrapper class using its constructors.

Rhino (ECMAScript) support; Experimental: no backward compatibility guarantees; any feedback is highly welcome!

Provides a generic purpose servlet that generates dynamic response using FreeMarker.

Provides data model adapter for DOM, dom4j and JDOM; three widely used XML document object models. Supports outputting of transformed XML documents, various node traversals, as well as full XPath support.

Provides the FreeMarker logging facility.

This package contains the core API's that most users will use.

The typical usage pattern is to be vended {@link freemarker.template.Template} objects by the {@link freemarker.template.Configuration} object. The Template class represents a template file compiled into an efficient data structure for later use. Processing of compiled templates is very fast.

For complete instructions on how to use this package, please see the manual.

Utility classes that may be used to customize aspects of FreeMarker. These implement the pluggable interfaces found in FreeMarker, including TemplateTransformModel and TemplateExceptionListener.

Test cases for various aspects of the FreeMarker implementation. These use the JUnit testing framework to carry out and report on tests.

To run the tests:

• Get a copy of JUnit from the JUnit web site
• Modify testcase.properties to point to the FreeMarker testcase directory on your local machine
• Run one of the TestRunners in JUnit, such as junit.swingui.TestRunner
• Point the TestRunner at freemarker.testcase.FreeMarkerTestSuite
• Look for green...

Any errors will result in the text of the failed test case(s) appearing in your current working directory. From there it should be possible to diagnose the cause of the failure.