This is an automated email from the ASF dual-hosted git repository.
ddekany pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/freemarker-site.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 78202c32 2.3.33 javadocs fix: package-info was missing
78202c32 is described below
commit 78202c32db246d9a6456e92a902f03e8a4e03ca5
Author: ddekany <[email protected]>
AuthorDate: Tue Jun 4 19:06:38 2024 +0200
2.3.33 javadocs fix: package-info was missing
---
docs/api/allpackages-index.html | 83 +++++++++++++++++-----
docs/api/freemarker/cache/package-summary.html | 6 ++
docs/api/freemarker/core/package-summary.html | 4 ++
docs/api/freemarker/debug/package-summary.html | 4 ++
docs/api/freemarker/ext/ant/package-summary.html | 4 ++
docs/api/freemarker/ext/beans/package-summary.html | 10 +++
docs/api/freemarker/ext/dom/package-summary.html | 6 ++
.../ext/jakarta/jsp/package-summary.html | 8 +++
.../ext/jakarta/servlet/package-summary.html | 7 ++
docs/api/freemarker/ext/jdom/package-summary.html | 4 ++
docs/api/freemarker/ext/jsp/package-summary.html | 8 +++
.../api/freemarker/ext/jython/package-summary.html | 10 +++
docs/api/freemarker/ext/rhino/package-summary.html | 3 +
.../freemarker/ext/servlet/package-summary.html | 7 ++
docs/api/freemarker/ext/util/package-summary.html | 3 +
docs/api/freemarker/ext/xml/package-summary.html | 4 ++
docs/api/freemarker/log/package-summary.html | 3 +
docs/api/freemarker/template/package-summary.html | 6 ++
.../template/utility/package-summary.html | 3 +
docs/api/index-all.html | 83 +++++++++++++++++-----
docs/api/index.html | 83 +++++++++++++++++-----
docs/api/jquery-ui.overrides.css | 42 +++++------
docs/api/script.js | 42 +++++------
docs/api/search.js | 34 ++++-----
24 files changed, 354 insertions(+), 113 deletions(-)
diff --git a/docs/api/allpackages-index.html b/docs/api/allpackages-index.html
index 87441eef..78b34a4d 100644
--- a/docs/api/allpackages-index.html
+++ b/docs/api/allpackages-index.html
@@ -58,43 +58,90 @@ loadScripts(document, 'script');</script>
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a
href="freemarker/cache/package-summary.html">freemarker.cache</a></div>
-<div class="col-last even-row-color"> </div>
+<div class="col-last even-row-color">
+<div class="block">Template <em>loading</em> and caching.</div>
+</div>
<div class="col-first odd-row-color"><a
href="freemarker/core/package-summary.html">freemarker.core</a></div>
-<div class="col-last odd-row-color"> </div>
+<div class="col-last odd-row-color">
+<div class="block">The seldom used or advanced parts of the fundamental
FreeMarker API, compared to <a
href="freemarker/template/package-summary.html"><code>freemarker.template</code></a>.</div>
+</div>
<div class="col-first even-row-color"><a
href="freemarker/debug/package-summary.html">freemarker.debug</a></div>
-<div class="col-last even-row-color"> </div>
+<div class="col-last even-row-color">
+<div class="block">Debugging API; experimental status, might change!
+ This is to support debugging in IDE-s.</div>
+</div>
<div class="col-first odd-row-color"><a
href="freemarker/debug/impl/package-summary.html">freemarker.debug.impl</a></div>
<div class="col-last odd-row-color"> </div>
<div class="col-first even-row-color"><a
href="freemarker/ext/ant/package-summary.html">freemarker.ext.ant</a></div>
-<div class="col-last even-row-color"> </div>
+<div class="col-last even-row-color">
+<div class="block"><a href="http://jakarta.apache.org/ant"; target="_blank">Ant
task</a> to transform XML files
+ with a template; a more powerful alternative is <a
href="http://fmpp.sourceforge.net/"; target="_blank">FMPP</a>.</div>
+</div>
<div class="col-first odd-row-color"><a
href="freemarker/ext/beans/package-summary.html">freemarker.ext.beans</a></div>
-<div class="col-last odd-row-color"> </div>
+<div class="col-last odd-row-color">
+<div class="block">The <a href="freemarker/template/DefaultObjectWrapper.html"
title="class in freemarker.template">default object wrapper</a> of FreeMarker
uses
+ this to expose Java Beans and POJO-s to templates.</div>
+</div>
<div class="col-first even-row-color"><a
href="freemarker/ext/dom/package-summary.html">freemarker.ext.dom</a></div>
-<div class="col-last even-row-color"> </div>
+<div class="col-last even-row-color">
+<div class="block">Exposes DOM XML nodes to templates as easily traversable
trees;
+ see <a href="https://freemarker.apache.org/docs/xgui.html"; target="_blank">in
the Manual</a>.</div>
+</div>
<div class="col-first odd-row-color"><a
href="freemarker/ext/jakarta/jsp/package-summary.html">freemarker.ext.jakarta.jsp</a></div>
-<div class="col-last odd-row-color"> </div>
+<div class="col-last odd-row-color">
+<div class="block">Classes for two-way FreeMarker-JSP integration.</div>
+</div>
<div class="col-first even-row-color"><a
href="freemarker/ext/jakarta/servlet/package-summary.html">freemarker.ext.jakarta.servlet</a></div>
-<div class="col-last even-row-color"> </div>
+<div class="col-last even-row-color">
+<div class="block">Servlet for legacy "Model 2" frameworks that allows using
FreeMarker
+ templates instead of JSP as the MVC View (see <a
href="https://freemarker.apache.org/docs/pgui_misc_servlet.html";
target="_blank">in the Manual</a>).</div>
+</div>
<div class="col-first odd-row-color"><a
href="freemarker/ext/jdom/package-summary.html">freemarker.ext.jdom</a></div>
-<div class="col-last odd-row-color"> </div>
+<div class="col-last odd-row-color">
+<div class="block">Deprecated, use W3C DOM (<a
href="freemarker/ext/dom/package-summary.html"><code>freemarker.ext.dom</code></a>)
instead;
+ Exposes <a href="http://www.jdom.org/"; target="_blank">JDOM</a> XML nodes to
templates.</div>
+</div>
<div class="col-first even-row-color"><a
href="freemarker/ext/jsp/package-summary.html">freemarker.ext.jsp</a></div>
-<div class="col-last even-row-color"> </div>
+<div class="col-last even-row-color">
+<div class="block">Classes for two-way FreeMarker-JSP integration.</div>
+</div>
<div class="col-first odd-row-color"><a
href="freemarker/ext/jython/package-summary.html">freemarker.ext.jython</a></div>
-<div class="col-last odd-row-color"> </div>
+<div class="col-last odd-row-color">
+<div class="block">Exposes <a href="http://www.jython.org";
target="_blank">Jython</a> objects to templates.</div>
+</div>
<div class="col-first even-row-color"><a
href="freemarker/ext/rhino/package-summary.html">freemarker.ext.rhino</a></div>
-<div class="col-last even-row-color"> </div>
+<div class="col-last even-row-color">
+<div class="block">Exposes Rhino (ECMAScript) objects to templates.</div>
+</div>
<div class="col-first odd-row-color"><a
href="freemarker/ext/servlet/package-summary.html">freemarker.ext.servlet</a></div>
-<div class="col-last odd-row-color"> </div>
+<div class="col-last odd-row-color">
+<div class="block">Servlet for legacy "Model 2" frameworks that allows using
FreeMarker
+ templates instead of JSP as the MVC View (see <a
href="https://freemarker.apache.org/docs/pgui_misc_servlet.html";
target="_blank">in the Manual</a>).</div>
+</div>
<div class="col-first even-row-color"><a
href="freemarker/ext/util/package-summary.html">freemarker.ext.util</a></div>
-<div class="col-last even-row-color"> </div>
+<div class="col-last even-row-color">
+<div class="block">Various classes used by <code>freemarker.ext</code> but
might be useful outside it too.</div>
+</div>
<div class="col-first odd-row-color"><a
href="freemarker/ext/xml/package-summary.html">freemarker.ext.xml</a></div>
-<div class="col-last odd-row-color"> </div>
+<div class="col-last odd-row-color">
+<div class="block">Deprecated, use W3C DOM with <a
href="freemarker/ext/dom/package-summary.html"><code>freemarker.ext.dom</code></a>
instead;
+ Exposes XML from DOM, dom4j or JDOM nodes, uniformly.</div>
+</div>
<div class="col-first even-row-color"><a
href="freemarker/log/package-summary.html">freemarker.log</a></div>
-<div class="col-last even-row-color"> </div>
+<div class="col-last even-row-color">
+<div class="block">Logging facility; dispatches FreeMarker log messages to the
chosen logger library.</div>
+</div>
<div class="col-first odd-row-color"><a
href="freemarker/template/package-summary.html">freemarker.template</a></div>
-<div class="col-last odd-row-color"> </div>
+<div class="col-last odd-row-color">
+<div class="block"><b>The fundamental, most commonly used API-s of
FreeMarker;</b>
+ start with <a href="freemarker/template/Configuration.html" title="class in
freemarker.template"><code>Configuration</code></a> (see also the
+ <a href="https://freemarker.apache.org/docs/pgui_quickstart.html";
target="_blank">Getting Started</a> in the
+ Manual.)</div>
+</div>
<div class="col-first even-row-color"><a
href="freemarker/template/utility/package-summary.html">freemarker.template.utility</a></div>
-<div class="col-last even-row-color"> </div>
+<div class="col-last even-row-color">
+<div class="block">Various classes used by core FreeMarker code but might be
useful outside of it too.</div>
+</div>
</div>
</main>
</div>
diff --git a/docs/api/freemarker/cache/package-summary.html
b/docs/api/freemarker/cache/package-summary.html
index ed2d55de..bdab30db 100644
--- a/docs/api/freemarker/cache/package-summary.html
+++ b/docs/api/freemarker/cache/package-summary.html
@@ -55,6 +55,12 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.cache</span></div>
+<section class="package-description" id="package.description">
+<div class="block">Template <em>loading</em> 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.</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/core/package-summary.html
b/docs/api/freemarker/core/package-summary.html
index 5d506f22..58ab9d00 100644
--- a/docs/api/freemarker/core/package-summary.html
+++ b/docs/api/freemarker/core/package-summary.html
@@ -55,6 +55,10 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.core</span></div>
+<section class="package-description" id="package.description">
+<div class="block">The seldom used or advanced parts of the fundamental
FreeMarker API, compared to <a
href="../template/package-summary.html"><code>freemarker.template</code></a>.
+ This package also encloses FreeMarker's core parsing/rendering
functionality.</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/debug/package-summary.html
b/docs/api/freemarker/debug/package-summary.html
index f25bf618..fd01d446 100644
--- a/docs/api/freemarker/debug/package-summary.html
+++ b/docs/api/freemarker/debug/package-summary.html
@@ -55,6 +55,10 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.debug</span></div>
+<section class="package-description" id="package.description">
+<div class="block">Debugging API; experimental status, might change!
+ This is to support debugging in IDE-s. If you are working on a client for
this, don't hesitate to contact us!</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/ext/ant/package-summary.html
b/docs/api/freemarker/ext/ant/package-summary.html
index d35af86c..c09ef464 100644
--- a/docs/api/freemarker/ext/ant/package-summary.html
+++ b/docs/api/freemarker/ext/ant/package-summary.html
@@ -55,6 +55,10 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.ext.ant</span></div>
+<section class="package-description" id="package.description">
+<div class="block"><a href="http://jakarta.apache.org/ant"; target="_blank">Ant
task</a> to transform XML files
+ with a template; a more powerful alternative is <a
href="http://fmpp.sourceforge.net/"; target="_blank">FMPP</a>.</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/ext/beans/package-summary.html
b/docs/api/freemarker/ext/beans/package-summary.html
index adc1af7a..62120b67 100644
--- a/docs/api/freemarker/ext/beans/package-summary.html
+++ b/docs/api/freemarker/ext/beans/package-summary.html
@@ -55,6 +55,16 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.ext.beans</span></div>
+<section class="package-description" id="package.description">
+<div class="block">The <a href="../../template/DefaultObjectWrapper.html"
title="class in freemarker.template">default object wrapper</a> of FreeMarker
uses
+ this to expose Java Beans and POJO-s to templates.
+
+ <p>Most of the issues dealing with beans are handled by the <a
href="BeansWrapper.html#wrap(java.lang.Object)"><code>BeansWrapper.wrap(Object)</code></a>
+ and <a
href="BeansWrapper.html#getStaticModels()"><code>BeansWrapper.getStaticModels()</code></a>
methods. In normal cases, these are the only methods
+ you should use to turn an arbitrary Java object into a FreeMarker <a
href="../../template/TemplateModel.html" title="interface in
freemarker.template"><code>TemplateModel</code></a>.
+ 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.</p></div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/ext/dom/package-summary.html
b/docs/api/freemarker/ext/dom/package-summary.html
index cd6d6849..73c35777 100644
--- a/docs/api/freemarker/ext/dom/package-summary.html
+++ b/docs/api/freemarker/ext/dom/package-summary.html
@@ -55,6 +55,12 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.ext.dom</span></div>
+<section class="package-description" id="package.description">
+<div class="block">Exposes DOM XML nodes to templates as easily traversable
trees;
+ see <a href="https://freemarker.apache.org/docs/xgui.html"; target="_blank">in
the Manual</a>. The
+ <a href="../../template/DefaultObjectWrapper.html" title="class in
freemarker.template"><code>default object wrapper</code></a> of FreeMarker
automatically wraps W3C nodes
+ with this.</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/ext/jakarta/jsp/package-summary.html
b/docs/api/freemarker/ext/jakarta/jsp/package-summary.html
index 2437b48e..657cd1b9 100644
--- a/docs/api/freemarker/ext/jakarta/jsp/package-summary.html
+++ b/docs/api/freemarker/ext/jakarta/jsp/package-summary.html
@@ -55,6 +55,14 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.ext.jakarta.jsp</span></div>
+<section class="package-description" id="package.description">
+<div class="block">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.
+
+ Note that this is for the legacy "javax" Servlet/JSP API; for Jakarta (that
is, in modern Servlet containers),
+ use the <code>freemarker.ext.jakarta.jsp</code> package instead (since
2.3.33).</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/ext/jakarta/servlet/package-summary.html
b/docs/api/freemarker/ext/jakarta/servlet/package-summary.html
index 96697c5e..bd886fd3 100644
--- a/docs/api/freemarker/ext/jakarta/servlet/package-summary.html
+++ b/docs/api/freemarker/ext/jakarta/servlet/package-summary.html
@@ -55,6 +55,13 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.ext.jakarta.servlet</span></div>
+<section class="package-description" id="package.description">
+<div class="block">Servlet for legacy "Model 2" frameworks that allows using
FreeMarker
+ templates instead of JSP as the MVC View (see <a
href="https://freemarker.apache.org/docs/pgui_misc_servlet.html";
target="_blank">in the Manual</a>).</p>
+
+ <p>Note that this is for the legacy "javax" Servlet/JSP API; for Jakarta
(that is, in modern Servlet containers),
+ use the <code>freemarker.ext.jakarta.servlet</code> package instead (since
2.3.33).</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/ext/jdom/package-summary.html
b/docs/api/freemarker/ext/jdom/package-summary.html
index d0e6a07d..8aada1e6 100644
--- a/docs/api/freemarker/ext/jdom/package-summary.html
+++ b/docs/api/freemarker/ext/jdom/package-summary.html
@@ -55,6 +55,10 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.ext.jdom</span></div>
+<section class="package-description" id="package.description">
+<div class="block">Deprecated, use W3C DOM (<a
href="../dom/package-summary.html"><code>freemarker.ext.dom</code></a>) instead;
+ Exposes <a href="http://www.jdom.org/"; target="_blank">JDOM</a> XML nodes to
templates.</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/ext/jsp/package-summary.html
b/docs/api/freemarker/ext/jsp/package-summary.html
index 4ec318a6..5b22c4ba 100644
--- a/docs/api/freemarker/ext/jsp/package-summary.html
+++ b/docs/api/freemarker/ext/jsp/package-summary.html
@@ -55,6 +55,14 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.ext.jsp</span></div>
+<section class="package-description" id="package.description">
+<div class="block">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.
+
+ Note that this is for the legacy "javax" Servlet/JSP API; for Jakarta (that
is, in modern Servlet containers),
+ use the <code>freemarker.ext.jakarta.jsp</code> package instead (since
2.3.33).</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/ext/jython/package-summary.html
b/docs/api/freemarker/ext/jython/package-summary.html
index a94e8652..f1379892 100644
--- a/docs/api/freemarker/ext/jython/package-summary.html
+++ b/docs/api/freemarker/ext/jython/package-summary.html
@@ -55,6 +55,16 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.ext.jython</span></div>
+<section class="package-description" id="package.description">
+<div class="block">Exposes <a href="http://www.jython.org";
target="_blank">Jython</a> objects to templates.
+ The <a href="../../template/DefaultObjectWrapper.html" title="class in
freemarker.template"><code>default object wrapper</code></a> of FreeMarker
automatically wraps Jython
+ nodes with this.
+
+ <p>Most of the issues dealing with Jython objects are handled by the
+ <a
href="JythonWrapper.html#wrap(java.lang.Object)"><code>JythonWrapper.wrap(Object)</code></a>
method. In normal cases, this is the only method you should
+ use to turn an arbitrary Jython object into a FreeMarker <a
href="../../template/TemplateModel.html" title="interface in
freemarker.template"><code>TemplateModel</code></a>. Additionally, you
+ can manually create instances of any wrapper class using its
constructors.</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/ext/rhino/package-summary.html
b/docs/api/freemarker/ext/rhino/package-summary.html
index 75ac973b..c103d940 100644
--- a/docs/api/freemarker/ext/rhino/package-summary.html
+++ b/docs/api/freemarker/ext/rhino/package-summary.html
@@ -55,6 +55,9 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.ext.rhino</span></div>
+<section class="package-description" id="package.description">
+<div class="block">Exposes Rhino (ECMAScript) objects to templates.</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/ext/servlet/package-summary.html
b/docs/api/freemarker/ext/servlet/package-summary.html
index d64a88fe..dae3c263 100644
--- a/docs/api/freemarker/ext/servlet/package-summary.html
+++ b/docs/api/freemarker/ext/servlet/package-summary.html
@@ -55,6 +55,13 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.ext.servlet</span></div>
+<section class="package-description" id="package.description">
+<div class="block">Servlet for legacy "Model 2" frameworks that allows using
FreeMarker
+ templates instead of JSP as the MVC View (see <a
href="https://freemarker.apache.org/docs/pgui_misc_servlet.html";
target="_blank">in the Manual</a>).</p>
+
+ <p>Note that this is for the legacy "javax" Servlet/JSP API; for Jakarta
(that is, in modern Servlet containers),
+ use the <code>freemarker.ext.jakarta.servlet</code> package instead (since
2.3.33).</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/ext/util/package-summary.html
b/docs/api/freemarker/ext/util/package-summary.html
index cc3f81c2..10bac212 100644
--- a/docs/api/freemarker/ext/util/package-summary.html
+++ b/docs/api/freemarker/ext/util/package-summary.html
@@ -55,6 +55,9 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.ext.util</span></div>
+<section class="package-description" id="package.description">
+<div class="block">Various classes used by <code>freemarker.ext</code> but
might be useful outside it too.</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/ext/xml/package-summary.html
b/docs/api/freemarker/ext/xml/package-summary.html
index f6d3e488..c31175c6 100644
--- a/docs/api/freemarker/ext/xml/package-summary.html
+++ b/docs/api/freemarker/ext/xml/package-summary.html
@@ -55,6 +55,10 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.ext.xml</span></div>
+<section class="package-description" id="package.description">
+<div class="block">Deprecated, use W3C DOM with <a
href="../dom/package-summary.html"><code>freemarker.ext.dom</code></a> instead;
+ Exposes XML from DOM, dom4j or JDOM nodes, uniformly.</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/log/package-summary.html
b/docs/api/freemarker/log/package-summary.html
index 8faf1d50..7425e856 100644
--- a/docs/api/freemarker/log/package-summary.html
+++ b/docs/api/freemarker/log/package-summary.html
@@ -55,6 +55,9 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.log</span></div>
+<section class="package-description" id="package.description">
+<div class="block">Logging facility; dispatches FreeMarker log messages to the
chosen logger library.</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/template/package-summary.html
b/docs/api/freemarker/template/package-summary.html
index b0cd6a4b..3ee1c4d5 100644
--- a/docs/api/freemarker/template/package-summary.html
+++ b/docs/api/freemarker/template/package-summary.html
@@ -55,6 +55,12 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.template</span></div>
+<section class="package-description" id="package.description">
+<div class="block"><b>The fundamental, most commonly used API-s of
FreeMarker;</b>
+ start with <a href="Configuration.html" title="class in
freemarker.template"><code>Configuration</code></a> (see also the
+ <a href="https://freemarker.apache.org/docs/pgui_quickstart.html";
target="_blank">Getting Started</a> in the
+ Manual.)</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/freemarker/template/utility/package-summary.html
b/docs/api/freemarker/template/utility/package-summary.html
index 1448b39b..4098138e 100644
--- a/docs/api/freemarker/template/utility/package-summary.html
+++ b/docs/api/freemarker/template/utility/package-summary.html
@@ -55,6 +55,9 @@ loadScripts(document, 'script');</script>
</div>
<hr>
<div class="package-signature">package <span
class="element-name">freemarker.template.utility</span></div>
+<section class="package-description" id="package.description">
+<div class="block">Various classes used by core FreeMarker code but might be
useful outside of it too.</div>
+</section>
<section class="summary">
<ul class="summary-list">
<li>
diff --git a/docs/api/index-all.html b/docs/api/index-all.html
index 216925cf..0cd8306a 100644
--- a/docs/api/index-all.html
+++ b/docs/api/index-all.html
@@ -2191,43 +2191,90 @@ loadScripts(document, 'script');</script>
through the thread context class loader.</div>
</dd>
<dt><a href="freemarker/cache/package-summary.html">freemarker.cache</a> -
package freemarker.cache</dt>
-<dd> </dd>
+<dd>
+<div class="block">Template <em>loading</em> and caching.</div>
+</dd>
<dt><a href="freemarker/core/package-summary.html">freemarker.core</a> -
package freemarker.core</dt>
-<dd> </dd>
+<dd>
+<div class="block">The seldom used or advanced parts of the fundamental
FreeMarker API, compared to <a
href="freemarker/template/package-summary.html"><code>freemarker.template</code></a>.</div>
+</dd>
<dt><a href="freemarker/debug/package-summary.html">freemarker.debug</a> -
package freemarker.debug</dt>
-<dd> </dd>
+<dd>
+<div class="block">Debugging API; experimental status, might change!
+ This is to support debugging in IDE-s.</div>
+</dd>
<dt><a
href="freemarker/debug/impl/package-summary.html">freemarker.debug.impl</a> -
package freemarker.debug.impl</dt>
<dd> </dd>
<dt><a href="freemarker/ext/ant/package-summary.html">freemarker.ext.ant</a> -
package freemarker.ext.ant</dt>
-<dd> </dd>
+<dd>
+<div class="block"><a href="http://jakarta.apache.org/ant"; target="_blank">Ant
task</a> to transform XML files
+ with a template; a more powerful alternative is <a
href="http://fmpp.sourceforge.net/"; target="_blank">FMPP</a>.</div>
+</dd>
<dt><a
href="freemarker/ext/beans/package-summary.html">freemarker.ext.beans</a> -
package freemarker.ext.beans</dt>
-<dd> </dd>
+<dd>
+<div class="block">The <a href="freemarker/template/DefaultObjectWrapper.html"
title="class in freemarker.template">default object wrapper</a> of FreeMarker
uses
+ this to expose Java Beans and POJO-s to templates.</div>
+</dd>
<dt><a href="freemarker/ext/dom/package-summary.html">freemarker.ext.dom</a> -
package freemarker.ext.dom</dt>
-<dd> </dd>
+<dd>
+<div class="block">Exposes DOM XML nodes to templates as easily traversable
trees;
+ see <a href="https://freemarker.apache.org/docs/xgui.html"; target="_blank">in
the Manual</a>.</div>
+</dd>
<dt><a
href="freemarker/ext/jakarta/jsp/package-summary.html">freemarker.ext.jakarta.jsp</a>
- package freemarker.ext.jakarta.jsp</dt>
-<dd> </dd>
+<dd>
+<div class="block">Classes for two-way FreeMarker-JSP integration.</div>
+</dd>
<dt><a
href="freemarker/ext/jakarta/servlet/package-summary.html">freemarker.ext.jakarta.servlet</a>
- package freemarker.ext.jakarta.servlet</dt>
-<dd> </dd>
+<dd>
+<div class="block">Servlet for legacy "Model 2" frameworks that allows using
FreeMarker
+ templates instead of JSP as the MVC View (see <a
href="https://freemarker.apache.org/docs/pgui_misc_servlet.html";
target="_blank">in the Manual</a>).</div>
+</dd>
<dt><a href="freemarker/ext/jdom/package-summary.html">freemarker.ext.jdom</a>
- package freemarker.ext.jdom</dt>
-<dd> </dd>
+<dd>
+<div class="block">Deprecated, use W3C DOM (<a
href="freemarker/ext/dom/package-summary.html"><code>freemarker.ext.dom</code></a>)
instead;
+ Exposes <a href="http://www.jdom.org/"; target="_blank">JDOM</a> XML nodes to
templates.</div>
+</dd>
<dt><a href="freemarker/ext/jsp/package-summary.html">freemarker.ext.jsp</a> -
package freemarker.ext.jsp</dt>
-<dd> </dd>
+<dd>
+<div class="block">Classes for two-way FreeMarker-JSP integration.</div>
+</dd>
<dt><a
href="freemarker/ext/jython/package-summary.html">freemarker.ext.jython</a> -
package freemarker.ext.jython</dt>
-<dd> </dd>
+<dd>
+<div class="block">Exposes <a href="http://www.jython.org";
target="_blank">Jython</a> objects to templates.</div>
+</dd>
<dt><a
href="freemarker/ext/rhino/package-summary.html">freemarker.ext.rhino</a> -
package freemarker.ext.rhino</dt>
-<dd> </dd>
+<dd>
+<div class="block">Exposes Rhino (ECMAScript) objects to templates.</div>
+</dd>
<dt><a
href="freemarker/ext/servlet/package-summary.html">freemarker.ext.servlet</a> -
package freemarker.ext.servlet</dt>
-<dd> </dd>
+<dd>
+<div class="block">Servlet for legacy "Model 2" frameworks that allows using
FreeMarker
+ templates instead of JSP as the MVC View (see <a
href="https://freemarker.apache.org/docs/pgui_misc_servlet.html";
target="_blank">in the Manual</a>).</div>
+</dd>
<dt><a href="freemarker/ext/util/package-summary.html">freemarker.ext.util</a>
- package freemarker.ext.util</dt>
-<dd> </dd>
+<dd>
+<div class="block">Various classes used by <code>freemarker.ext</code> but
might be useful outside it too.</div>
+</dd>
<dt><a href="freemarker/ext/xml/package-summary.html">freemarker.ext.xml</a> -
package freemarker.ext.xml</dt>
-<dd> </dd>
+<dd>
+<div class="block">Deprecated, use W3C DOM with <a
href="freemarker/ext/dom/package-summary.html"><code>freemarker.ext.dom</code></a>
instead;
+ Exposes XML from DOM, dom4j or JDOM nodes, uniformly.</div>
+</dd>
<dt><a href="freemarker/log/package-summary.html">freemarker.log</a> - package
freemarker.log</dt>
-<dd> </dd>
+<dd>
+<div class="block">Logging facility; dispatches FreeMarker log messages to the
chosen logger library.</div>
+</dd>
<dt><a href="freemarker/template/package-summary.html">freemarker.template</a>
- package freemarker.template</dt>
-<dd> </dd>
+<dd>
+<div class="block"><b>The fundamental, most commonly used API-s of
FreeMarker;</b>
+ start with <a href="freemarker/template/Configuration.html" title="class in
freemarker.template"><code>Configuration</code></a> (see also the
+ <a href="https://freemarker.apache.org/docs/pgui_quickstart.html";
target="_blank">Getting Started</a> in the
+ Manual.)</div>
+</dd>
<dt><a
href="freemarker/template/utility/package-summary.html">freemarker.template.utility</a>
- package freemarker.template.utility</dt>
-<dd> </dd>
+<dd>
+<div class="block">Various classes used by core FreeMarker code but might be
useful outside of it too.</div>
+</dd>
<dt><a href="freemarker/ext/jakarta/servlet/FreemarkerServlet.html"
title="class in freemarker.ext.jakarta.servlet"><span
class="type-name-link">FreemarkerServlet</span></a> - Class in <a
href="freemarker/ext/jakarta/servlet/package-summary.html">freemarker.ext.jakarta.servlet</a></dt>
<dd>
<div class="block">FreeMarker MVC View servlet that can be used similarly to
JSP views.</div>
diff --git a/docs/api/index.html b/docs/api/index.html
index 3ff4d576..92a97e60 100644
--- a/docs/api/index.html
+++ b/docs/api/index.html
@@ -59,43 +59,90 @@ loadScripts(document, 'script');</script>
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/cache/package-summary.html">freemarker.cache</a></div>
-<div class="col-last even-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last even-row-color all-packages-table-tab1
all-packages-table">
+<div class="block">Template <em>loading</em> and caching.</div>
+</div>
<div class="col-first odd-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/core/package-summary.html">freemarker.core</a></div>
-<div class="col-last odd-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last odd-row-color all-packages-table-tab1 all-packages-table">
+<div class="block">The seldom used or advanced parts of the fundamental
FreeMarker API, compared to <a
href="freemarker/template/package-summary.html"><code>freemarker.template</code></a>.</div>
+</div>
<div class="col-first even-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/debug/package-summary.html">freemarker.debug</a></div>
-<div class="col-last even-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last even-row-color all-packages-table-tab1
all-packages-table">
+<div class="block">Debugging API; experimental status, might change!
+ This is to support debugging in IDE-s.</div>
+</div>
<div class="col-first odd-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/debug/impl/package-summary.html">freemarker.debug.impl</a></div>
<div class="col-last odd-row-color all-packages-table-tab1
all-packages-table"> </div>
<div class="col-first even-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/ext/ant/package-summary.html">freemarker.ext.ant</a></div>
-<div class="col-last even-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last even-row-color all-packages-table-tab1
all-packages-table">
+<div class="block"><a href="http://jakarta.apache.org/ant"; target="_blank">Ant
task</a> to transform XML files
+ with a template; a more powerful alternative is <a
href="http://fmpp.sourceforge.net/"; target="_blank">FMPP</a>.</div>
+</div>
<div class="col-first odd-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/ext/beans/package-summary.html">freemarker.ext.beans</a></div>
-<div class="col-last odd-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last odd-row-color all-packages-table-tab1 all-packages-table">
+<div class="block">The <a href="freemarker/template/DefaultObjectWrapper.html"
title="class in freemarker.template">default object wrapper</a> of FreeMarker
uses
+ this to expose Java Beans and POJO-s to templates.</div>
+</div>
<div class="col-first even-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/ext/dom/package-summary.html">freemarker.ext.dom</a></div>
-<div class="col-last even-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last even-row-color all-packages-table-tab1
all-packages-table">
+<div class="block">Exposes DOM XML nodes to templates as easily traversable
trees;
+ see <a href="https://freemarker.apache.org/docs/xgui.html"; target="_blank">in
the Manual</a>.</div>
+</div>
<div class="col-first odd-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/ext/jakarta/jsp/package-summary.html">freemarker.ext.jakarta.jsp</a></div>
-<div class="col-last odd-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last odd-row-color all-packages-table-tab1 all-packages-table">
+<div class="block">Classes for two-way FreeMarker-JSP integration.</div>
+</div>
<div class="col-first even-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/ext/jakarta/servlet/package-summary.html">freemarker.ext.jakarta.servlet</a></div>
-<div class="col-last even-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last even-row-color all-packages-table-tab1
all-packages-table">
+<div class="block">Servlet for legacy "Model 2" frameworks that allows using
FreeMarker
+ templates instead of JSP as the MVC View (see <a
href="https://freemarker.apache.org/docs/pgui_misc_servlet.html";
target="_blank">in the Manual</a>).</div>
+</div>
<div class="col-first odd-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/ext/jdom/package-summary.html">freemarker.ext.jdom</a></div>
-<div class="col-last odd-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last odd-row-color all-packages-table-tab1 all-packages-table">
+<div class="block">Deprecated, use W3C DOM (<a
href="freemarker/ext/dom/package-summary.html"><code>freemarker.ext.dom</code></a>)
instead;
+ Exposes <a href="http://www.jdom.org/"; target="_blank">JDOM</a> XML nodes to
templates.</div>
+</div>
<div class="col-first even-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/ext/jsp/package-summary.html">freemarker.ext.jsp</a></div>
-<div class="col-last even-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last even-row-color all-packages-table-tab1
all-packages-table">
+<div class="block">Classes for two-way FreeMarker-JSP integration.</div>
+</div>
<div class="col-first odd-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/ext/jython/package-summary.html">freemarker.ext.jython</a></div>
-<div class="col-last odd-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last odd-row-color all-packages-table-tab1 all-packages-table">
+<div class="block">Exposes <a href="http://www.jython.org";
target="_blank">Jython</a> objects to templates.</div>
+</div>
<div class="col-first even-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/ext/rhino/package-summary.html">freemarker.ext.rhino</a></div>
-<div class="col-last even-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last even-row-color all-packages-table-tab1
all-packages-table">
+<div class="block">Exposes Rhino (ECMAScript) objects to templates.</div>
+</div>
<div class="col-first odd-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/ext/servlet/package-summary.html">freemarker.ext.servlet</a></div>
-<div class="col-last odd-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last odd-row-color all-packages-table-tab1 all-packages-table">
+<div class="block">Servlet for legacy "Model 2" frameworks that allows using
FreeMarker
+ templates instead of JSP as the MVC View (see <a
href="https://freemarker.apache.org/docs/pgui_misc_servlet.html";
target="_blank">in the Manual</a>).</div>
+</div>
<div class="col-first even-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/ext/util/package-summary.html">freemarker.ext.util</a></div>
-<div class="col-last even-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last even-row-color all-packages-table-tab1
all-packages-table">
+<div class="block">Various classes used by <code>freemarker.ext</code> but
might be useful outside it too.</div>
+</div>
<div class="col-first odd-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/ext/xml/package-summary.html">freemarker.ext.xml</a></div>
-<div class="col-last odd-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last odd-row-color all-packages-table-tab1 all-packages-table">
+<div class="block">Deprecated, use W3C DOM with <a
href="freemarker/ext/dom/package-summary.html"><code>freemarker.ext.dom</code></a>
instead;
+ Exposes XML from DOM, dom4j or JDOM nodes, uniformly.</div>
+</div>
<div class="col-first even-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/log/package-summary.html">freemarker.log</a></div>
-<div class="col-last even-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last even-row-color all-packages-table-tab1
all-packages-table">
+<div class="block">Logging facility; dispatches FreeMarker log messages to the
chosen logger library.</div>
+</div>
<div class="col-first odd-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/template/package-summary.html">freemarker.template</a></div>
-<div class="col-last odd-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last odd-row-color all-packages-table-tab1 all-packages-table">
+<div class="block"><b>The fundamental, most commonly used API-s of
FreeMarker;</b>
+ start with <a href="freemarker/template/Configuration.html" title="class in
freemarker.template"><code>Configuration</code></a> (see also the
+ <a href="https://freemarker.apache.org/docs/pgui_quickstart.html";
target="_blank">Getting Started</a> in the
+ Manual.)</div>
+</div>
<div class="col-first even-row-color all-packages-table-tab1
all-packages-table"><a
href="freemarker/template/utility/package-summary.html">freemarker.template.utility</a></div>
-<div class="col-last even-row-color all-packages-table-tab1
all-packages-table"> </div>
+<div class="col-last even-row-color all-packages-table-tab1
all-packages-table">
+<div class="block">Various classes used by core FreeMarker code but might be
useful outside of it too.</div>
+</div>
</div>
</div>
</main>
diff --git a/docs/api/jquery-ui.overrides.css b/docs/api/jquery-ui.overrides.css
index 1abff952..f89acb63 100644
--- a/docs/api/jquery-ui.overrides.css
+++ b/docs/api/jquery-ui.overrides.css
@@ -1,26 +1,26 @@
/*
* Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
- * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
*/
.ui-state-active,
diff --git a/docs/api/script.js b/docs/api/script.js
index 0765364e..864989cf 100644
--- a/docs/api/script.js
+++ b/docs/api/script.js
@@ -1,26 +1,26 @@
/*
* Copyright (c) 2013, 2020, Oracle and/or its affiliates. All rights reserved.
- * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
*/
var moduleSearchIndex;
diff --git a/docs/api/search.js b/docs/api/search.js
index cd5080c6..2c2ced05 100644
--- a/docs/api/search.js
+++ b/docs/api/search.js
@@ -1,26 +1,26 @@
/*
* Copyright (c) 2015, 2020, Oracle and/or its affiliates. All rights reserved.
- * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
*
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
*
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
*/
var noResult = {l: "No results found"};
