This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 6374b2a9 Port site from Doxia 1 to 2
6374b2a9 is described below
commit 6374b2a9cf4f4ca0fadd9ffaf602e1df03a7ef32
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Fri Feb 7 11:03:05 2025 -0500
Port site from Doxia 1 to 2
Fix HTML
---
.../xdoc/userguide_v1.10/howto_basicfeatures.xml | 7 +++-
src/site/xdoc/userguide_v1.10/howto_beans.xml | 15 ++++---
.../howto_combinedconfiguration.xml | 12 +++---
.../howto_compositeconfiguration.xml | 5 ++-
.../userguide_v1.10/howto_configurationbuilder.xml | 11 ++---
src/site/xdoc/userguide_v1.10/howto_events.xml | 9 +++--
src/site/xdoc/userguide_v1.10/howto_filebased.xml | 11 +++--
.../xdoc/userguide_v1.10/howto_filesystems.xml | 7 ++--
.../xdoc/userguide_v1.10/howto_multitenant.xml | 5 ++-
src/site/xdoc/userguide_v1.10/howto_properties.xml | 8 +++-
src/site/xdoc/userguide_v1.10/howto_utilities.xml | 9 +++--
src/site/xdoc/userguide_v1.10/howto_xml.xml | 11 ++---
src/site/xdoc/userguide_v1.10/overview.xml | 11 +++--
src/site/xdoc/userguide_v1.10/user_guide.xml | 47 ++++++++++++++--------
14 files changed, 101 insertions(+), 67 deletions(-)
diff --git a/src/site/xdoc/userguide_v1.10/howto_basicfeatures.xml
b/src/site/xdoc/userguide_v1.10/howto_basicfeatures.xml
index 1248d108..43b4098f 100644
--- a/src/site/xdoc/userguide_v1.10/howto_basicfeatures.xml
+++ b/src/site/xdoc/userguide_v1.10/howto_basicfeatures.xml
@@ -16,8 +16,9 @@
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Basic Features</title>
<author email="ohe...@apache.org">Oliver Heger</author>
@@ -172,6 +173,7 @@ application.title = ${application.name}
${application.version}
the variable is to be evaluated in a certain context. We have already
seen
that the context is the current configuration instance if the prefix is
missing. The following other prefix names are supported by default:
+ </p>
<table border="1">
<tr>
<th>Prefix</th>
@@ -200,6 +202,7 @@ application.title = ${application.name}
${application.version}
This is indicated by the <code>env</code> prefix.</td>
</tr>
</table>
+ <p>
Here are some examples (again using properties syntax):
</p>
<source><![CDATA[
diff --git a/src/site/xdoc/userguide_v1.10/howto_beans.xml
b/src/site/xdoc/userguide_v1.10/howto_beans.xml
index 5b753e69..61a74f28 100644
--- a/src/site/xdoc/userguide_v1.10/howto_beans.xml
+++ b/src/site/xdoc/userguide_v1.10/howto_beans.xml
@@ -16,8 +16,9 @@
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Declaring Beans Howto</title>
<author email="ohe...@apache.org">Oliver Heger</author>
@@ -72,6 +73,7 @@
</p>
<p>
On the Java side three entities are involved in the creation of a bean:
+ </p>
<ul>
<li>A <em>bean factory</em>: This is an object that implements the
<code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/beanutils/BeanFactory.html">BeanFactory</a></code>
@@ -91,6 +93,7 @@
one of the <code>createBean()</code> methods of
<code>BeanHelper</code>.
That's it!</li>
</ul>
+ <p>
For all of the interfaces mentioned above default implementations are
provided, which in many cases can be used out of the box.
</p>
@@ -159,6 +162,7 @@ public class DefaultWindowManager implements WindowManager
This XML document contains a valid bean declaration starting with the
<code>windowManager</code> element and including its sub elements. Note
the following points:
+ </p>
<ul>
<li>The (full qualified) class of the bean is specified using the
<code>config-class</code> attribute. (Attributes starting with the
@@ -173,6 +177,7 @@ public class DefaultWindowManager implements WindowManager
element; indeed it could even have further sub elements defining
bean properties of the <code>WindowStyleDefinition</code> class.</li>
</ul>
+ <p>
The basic structure of a bean declaration should have become clear by
this example.
</p>
@@ -210,11 +215,11 @@ WindowManager wm = (WindowManager)
BeanHelper.createBean(decl);
As was pointed out in the introduction of this chapter support for
creating
beans is focused on the basics. But there are some possibilities of
hooking
in and add custom extensions. This can be done in the following ways:
+ </p>
<ul>
<li>By defining a custom <code>BeanDeclaration</code>
implementation</li>
<li>By providing a custom <code>BeanFactory</code>
implementation</li>
</ul>
- </p>
<p>
A specialized bean declaration is needed when you have to deal with
configuration files that contain bean declarations in a different
format
@@ -223,6 +228,7 @@ WindowManager wm = (WindowManager)
BeanHelper.createBean(decl);
data and extract the required information to create the bean. Basically
your <code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/beanutils/BeanDeclaration.html">BeanDeclaration</a></code>
implementation must be able to provide the following data:
+ </p>
<ul>
<li>The name of the class for which an instance is to be
created.</li>
<li>The name of the bean factory that is used to create the bean.
Here
@@ -242,7 +248,6 @@ WindowManager wm = (WindowManager)
BeanHelper.createBean(decl);
processed bean (the names of these properties are again obtained from
the keys of the map).</li>
</ul>
- </p>
<p>
While creating a custom <code>BeanDeclaration</code> implementation
allows you to adapt the format of bean declarations in configuration
files,
@@ -250,6 +255,7 @@ WindowManager wm = (WindowManager)
BeanHelper.createBean(decl);
specialized implementation of the
<code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/beanutils/BeanFactory.html">BeanFactory</a></code>
interface. For this purpose the following steps are necessary:
+ </p>
<ol>
<li>Create a class implementing the <code>BeanFactory</code>
interface.
This interface is quite simple. It defines one method for creating an
@@ -260,7 +266,6 @@ WindowManager wm = (WindowManager)
BeanHelper.createBean(decl);
<li>In the bean declaration in your configuration file refer to the
factory that should be used for creating the bean.</li>
</ol>
- </p>
<p>
We will provide an example that covers all these steps. This example
deals with a <em>singleton</em> factory, i.e. an implementation of
diff --git a/src/site/xdoc/userguide_v1.10/howto_combinedconfiguration.xml
b/src/site/xdoc/userguide_v1.10/howto_combinedconfiguration.xml
index 89ec558b..c2aaf53e 100644
--- a/src/site/xdoc/userguide_v1.10/howto_combinedconfiguration.xml
+++ b/src/site/xdoc/userguide_v1.10/howto_combinedconfiguration.xml
@@ -16,8 +16,9 @@
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Combined Configurations</title>
<author email="ohe...@apache.com">Oliver Heger</author>
@@ -33,7 +34,6 @@
<a href="howto_compositeconfiguration.html#Composite Configuration
Details">last
section</a>. There are the following differences however:
</p>
- <p>
<ul>
<li>A <code>CombinedConfiguration</code> is a truly
<a href="howto_xml.html#Hierarchical properties">hierarchical
@@ -55,8 +55,6 @@
<li>There is no concept of an <em>in memory configuration</em>. Changes
to a combined configuration are handled in a different way.</li>
</ul>
- </p>
-
<subsection name="How it works">
<p>
A <code>CombinedConfiguration</code> provides a logic view on the
@@ -435,6 +433,7 @@
]]></source></td><td width="60%">
<p>
The features that are significant in this file are:
+ </p>
<ul>
<li>In the gui section each of the child elements only appears once.
The level element
merges the attributes from the two files and uses the element value
of the first file.</li>
@@ -448,7 +447,6 @@
was not merged in this case.</li>
<li>Again, only Channel 3 from the first file was included.</li>
</ul>
- </p>
<p>
How the Channel elements ended up may not at first be obvious. The
<code>OverrideCombiner</code>
simply noticed that the Channels element had three child elements
named Channel and
@@ -662,6 +660,7 @@
]]></source></td><td width="60%">
<p>
The features that are significant in this file are:
+ </p>
<ul>
<li>In the gui section the elements were merged.</li>
<li>In the net section the elements were merged, with the exception
of the urls.</li>
@@ -672,7 +671,6 @@
<li>Channel 1 and Channel 2 were merged</li>
<li>Both Channel 3 elements appear as they were determined to not be
the same.</li>
</ul>
- </p>
<p>
When merging elements attributes play a critical role. If an element
has an attribute that
appears in both sources, the value of that attribute must be the same
for the elements to be
diff --git a/src/site/xdoc/userguide_v1.10/howto_compositeconfiguration.xml
b/src/site/xdoc/userguide_v1.10/howto_compositeconfiguration.xml
index a9417139..94ea22bf 100644
--- a/src/site/xdoc/userguide_v1.10/howto_compositeconfiguration.xml
+++ b/src/site/xdoc/userguide_v1.10/howto_compositeconfiguration.xml
@@ -16,8 +16,9 @@
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Composite Configuration Details</title>
<author email="ep...@opensourceconnections.com">Eric Pugh</author>
diff --git a/src/site/xdoc/userguide_v1.10/howto_configurationbuilder.xml
b/src/site/xdoc/userguide_v1.10/howto_configurationbuilder.xml
index 34567f3b..579d0be4 100644
--- a/src/site/xdoc/userguide_v1.10/howto_configurationbuilder.xml
+++ b/src/site/xdoc/userguide_v1.10/howto_configurationbuilder.xml
@@ -16,8 +16,9 @@
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Configuration Builder Howto</title>
</properties>
@@ -32,6 +33,7 @@
<code>DefaultConfigurationBuilder</code> is the option of choice for
applications that have to deal with multiple configuration sources. It
provides the following features:
+ </p>
<ul>
<li>Various configuration sources can be combined to a single
<a href="howto_combinedconfiguration.html#Combined Configuration">
@@ -46,7 +48,6 @@
<li><code>DefaultConfigurationBuilder</code> is extensible. Custom
configuration sources can be added.</li>
</ul>
- </p>
<p>
This document starts with some explanations of
<code>DefaultConfigurationBuilder</code> basics. Then the
<em>configuration
@@ -418,7 +419,6 @@ Configuration config = builder.getConfiguration(true);
file to be loaded or a reloading strategy). Below is a list of all
tags which can be used out of the box:
</p>
- <p>
<dl>
<dt>properties</dt>
<dd>With this element properties files can be included. The name of
@@ -488,7 +488,6 @@ Configuration config = builder.getConfiguration(true);
This works in the same way as the <code><system></code> tag for
Java system properties.</dd>
</dl>
- </p>
<p>
In the declaration of a configuration source it is possible to set
properties on the corresponding configuration objects. Configuration
@@ -529,7 +528,6 @@ Configuration config = builder.getConfiguration(true);
<code>DefaultConfigurationBuilder</code> when it creates the objects.
These attributes are listed in the following table:
</p>
- <p>
<table border="1">
<tr>
<th>Attribute</th>
@@ -584,7 +582,6 @@ Configuration config = builder.getConfiguration(true);
have any effect).</td>
</tr>
</table>
- </p>
<p>
<em>Note:</em> In older versions of Commons Configuration the attributes
<code>config-at</code> and <code>config-optional</code> were named
diff --git a/src/site/xdoc/userguide_v1.10/howto_events.xml
b/src/site/xdoc/userguide_v1.10/howto_events.xml
index 89125004..1a0de350 100644
--- a/src/site/xdoc/userguide_v1.10/howto_events.xml
+++ b/src/site/xdoc/userguide_v1.10/howto_events.xml
@@ -16,8 +16,9 @@
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Configuration Events Howto</title>
<author email="ohe...@apache.org">Oliver Heger</author>
@@ -43,6 +44,7 @@
<code><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/event/ConfigurationEvent.html">
ConfigurationEvent</a></code> object. The event object contains all
information available about the modification, including:
+ </p>
<ul>
<li>A source object, which is usually the configuration object that was
modified.</li>
@@ -58,6 +60,7 @@
is performed. This allows event listeners to react at the correct point
of time.</li>
</ul>
+ <p>
Depending on the event type not all of this data may be available.
</p>
<p>
@@ -67,7 +70,6 @@
is an incomplete list of available event types with the configuration
classes, in which they are defined:
</p>
- <p>
<dl>
<dt>AbstractConfiguration</dt>
<dd>EVENT_ADD_PROPERTY (a property was added; the name of the affected
@@ -92,7 +94,6 @@
to map the property key as it was received from the subnode
configuration
into the namespace of the parent configuration.)</em></dd>
</dl>
- </p>
</subsection>
<subsection name="An example">
diff --git a/src/site/xdoc/userguide_v1.10/howto_filebased.xml
b/src/site/xdoc/userguide_v1.10/howto_filebased.xml
index e20b33ee..5006ba3d 100644
--- a/src/site/xdoc/userguide_v1.10/howto_filebased.xml
+++ b/src/site/xdoc/userguide_v1.10/howto_filebased.xml
@@ -16,8 +16,9 @@
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>File-based Configurations</title>
<author email="ohe...@apache.org">Oliver Heger</author>
@@ -51,6 +52,7 @@
The <code>FileConfiguration</code> interface contains several
methods for specifying the file to be loaded. The following
variants
are supported:
+ </p>
<ul>
<li>With the <code>setFile()</code> method the data file can be
specified as a <code>java.io.File</code> object.</li>
@@ -60,7 +62,6 @@
allows to specify the path of the data file. The base path is
important if relative paths are to be resolved based on this
file.</li>
</ul>
- </p>
<p>
While a <code>File</code> or a URL uniquely identify a file, the
situation is a bit ambiguous when only a base path and a file name
are
@@ -68,6 +69,7 @@
meaning must be detected when the file is loaded. For this purpose
file-based configurations perform the following checks (in this
order):
+ </p>
<ul>
<li>If the combination from base path and file name is a full URL
that points to an existing file, this URL will be used to load
@@ -81,6 +83,7 @@
<li>Otherwise the file name is interpreted as a resource name,
and
it is checked whether the data file can be loaded from the
classpath.</li>
</ul>
+ <p>
If all these checks fail, a <code>ConfigurationException</code>
will
be thrown.
</p>
@@ -102,6 +105,7 @@
(containing either an absolute or relative path), input stream, or
reader. When using these variants of the <code>load()</code> method
be aware of two things:
+ </p>
<ol>
<li>They do not change the configuration's file name. To do this
you have to explicitly call one of the setter methods.</li>
@@ -113,7 +117,6 @@
<code>clear()</code> method first to ensure that old properties
are
wiped out.</li>
</ol>
- </p>
<p>
File-based configurations typically define a set of constructors
that
correspond to the various setter methods for defining the data
file.
diff --git a/src/site/xdoc/userguide_v1.10/howto_filesystems.xml
b/src/site/xdoc/userguide_v1.10/howto_filesystems.xml
index 7d926e6d..205820f7 100644
--- a/src/site/xdoc/userguide_v1.10/howto_filesystems.xml
+++ b/src/site/xdoc/userguide_v1.10/howto_filesystems.xml
@@ -16,8 +16,9 @@
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>File Systems</title>
<author email="rgo...@apache.org">Ralph Goers</author>
@@ -40,6 +41,7 @@
<subsection name="Configuration">
<p>
The FileSystem used by Commons Configuration can be set in one of
several ways:
+ </p>
<ol>
<li>A system property named
"org.apache.commons.configuration.filesystem" can be defined
with the full class name of the desired <code>FileSystem</code>
implementation to set the
@@ -58,7 +60,6 @@
Both <code>AbstractFileConfiguration</code> and
<code>AbstractHierarchicalFileConfiguration</code>
implement <code>FileSystemBased</code></li>
</ol>
- </p>
<p>
The example that follows shows how to add <code>FileSystem</code>
configuration to
<code>DefaultConfigurationBuilder</code>.
diff --git a/src/site/xdoc/userguide_v1.10/howto_multitenant.xml
b/src/site/xdoc/userguide_v1.10/howto_multitenant.xml
index 3862adfc..a3556ea7 100644
--- a/src/site/xdoc/userguide_v1.10/howto_multitenant.xml
+++ b/src/site/xdoc/userguide_v1.10/howto_multitenant.xml
@@ -16,8 +16,9 @@
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Mutli-tenant Configurations</title>
<author email="rgo...@apache.org">Ralph Goers</author>
diff --git a/src/site/xdoc/userguide_v1.10/howto_properties.xml
b/src/site/xdoc/userguide_v1.10/howto_properties.xml
index 859ff8ce..9dd02fcc 100644
--- a/src/site/xdoc/userguide_v1.10/howto_properties.xml
+++ b/src/site/xdoc/userguide_v1.10/howto_properties.xml
@@ -16,7 +16,9 @@
limitations under the License.
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Properties files</title>
<author email="sma...@lfjr.net">Emmanuel Bourg</author>
@@ -64,12 +66,12 @@ Configuration config = new
PropertiesConfiguration("usergui.properties");
<p>
If you do not specify an absolute path, the file will be searched
automatically
in the following locations:
+ </p>
<ul>
<li>in the current directory</li>
<li>in the user home directory</li>
<li>in the classpath</li>
</ul>
- </p>
<p>
Instead of using a constructor that takes a file name you can also
invoke one of the <code>load()</code> methods. There are several
@@ -271,6 +273,7 @@ config.dirs = \\\\share2
control over the output of properties files is needed. The following
list describes these methods (note that corresponding get methods are
of course also provided):
+ </p>
<ul>
<li><code>setComment()</code><br/>
With this method a comment can be set for a specified property. When
@@ -315,6 +318,7 @@ config.dirs = \\\\share2
platform-specific line separator is used (e.g. <code>\n</code> on
Unix).
</li>
</ul>
+ <p>
The default settings of <code>PropertiesConfigurationLayout</code> are
chosen in a way that most of the original layout of a properties file
is retained. With the methods listed above specific layout restrictions
diff --git a/src/site/xdoc/userguide_v1.10/howto_utilities.xml
b/src/site/xdoc/userguide_v1.10/howto_utilities.xml
index a568592b..97bbd384 100644
--- a/src/site/xdoc/userguide_v1.10/howto_utilities.xml
+++ b/src/site/xdoc/userguide_v1.10/howto_utilities.xml
@@ -16,8 +16,9 @@
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Utility classes and Tips and Tricks Howto</title>
<author email="ohe...@apache.org">Oliver Heger</author>
@@ -41,6 +42,7 @@
AbstractConfiguration</a></code> class (which serves as the base class
for
most of the configuration implementations shipped with this library)
provides two methods implementing a basic copy operation:
+ </p>
<ul>
<li><code>append()</code> takes the configuration to be copied
as argument and adds all of its properties to the current
configuration.</li>
@@ -49,7 +51,6 @@
configuration are replaced by the properties of the source
configuration.
</li>
</ul>
- </p>
<p>
These methods work fine if the target configuration is not a hierarchical
configuration. If a hierarchical configuration is to be copied into
@@ -58,6 +59,7 @@
properties of the source configuration, but the specific parent-child
relations will probably be lost. If a hierarchical configuration needs to
be copied, there are the following options:
+ </p>
<ul>
<li>The <code>clone()</code> method can be used to create a copy of a
hierarchical configuration. This also works for non-hierarchical
@@ -74,7 +76,6 @@
copies the content of the specified configuration into the newly
created
object.</li>
</ul>
- </p>
</subsection>
<subsection name="Converting a flat configuration into a hierarchical one">
diff --git a/src/site/xdoc/userguide_v1.10/howto_xml.xml
b/src/site/xdoc/userguide_v1.10/howto_xml.xml
index 893ae0c1..26dceeda 100644
--- a/src/site/xdoc/userguide_v1.10/howto_xml.xml
+++ b/src/site/xdoc/userguide_v1.10/howto_xml.xml
@@ -16,8 +16,9 @@
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Hierarchical configurations and XML Howto</title>
<author email="ohe...@apache.org">Oliver Heger</author>
@@ -50,6 +51,7 @@
but the information provided here (especially the rules for
accessing
properties) applies to other hierarchical configurations as well.
Examples for other hierarchical configuration classes are
+ </p>
<ul>
<li><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/CombinedConfiguration.html">
<code>CombinedConfiguration</code></a></li>
@@ -58,7 +60,6 @@
<li><a
href="../javadocs/v1.10/apidocs/org/apache/commons/configuration/plist/PropertyListConfiguration.html">
<code>PropertyListConfiguration</code></a></li>
</ul>
- </p>
<subsection name="Accessing properties in hierarchical configurations">
<p>
We will start with a simple XML document to show some basics
@@ -124,6 +125,7 @@ List<Object> buttons = config.getList("buttons.name");
This listing demonstrates some important points
about constructing
keys for accessing properties in hierarchical
configuration sources and about
features of <code>HierarchicalConfiguration</code> in general:
+ </p>
<ul>
<li>
Nested elements are accessed
using a dot notation. In
@@ -164,7 +166,6 @@ List<Object> buttons = config.getList("buttons.name");
element.
</li>
</ul>
- </p>
<p>
In the next section will show how data in a more complex XML
document can be processed.
@@ -304,6 +305,7 @@ if(prop instanceof Collection)
<p>
We will now provide some configuration keys and
show the results
of a <code>getProperty()</code> call with these
keys as arguments.
+ </p>
<dl>
<dt><code>tables.table(0).name</code></dt>
<dd>
@@ -349,7 +351,6 @@ if(prop instanceof Collection)
values [<em>long, long</em>].
</dd>
</dl>
- </p>
<p>
These examples should make the usage of indices
quite clear.
Because each configuration key can contain an
arbitrary number
diff --git a/src/site/xdoc/userguide_v1.10/overview.xml
b/src/site/xdoc/userguide_v1.10/overview.xml
index 513d65b0..e887a64b 100644
--- a/src/site/xdoc/userguide_v1.10/overview.xml
+++ b/src/site/xdoc/userguide_v1.10/overview.xml
@@ -16,7 +16,9 @@
limitations under the License.
-->
-<document>
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Configuration Overview</title>
<author email="ep...@upstate.com">Eric Pugh</author>
@@ -45,6 +47,7 @@
by just using a Configuration object versus a specific type like
XMLConfiguration or
JNDIConfiguration, you are sheltered from the mechanics of actually
retrieving the
configuration values. These various sources include:
+ </p>
<ul>
<li>
<strong>PropertiesConfiguration</strong>
@@ -86,8 +89,6 @@
and converts it to a Configuration object.
</li>
</ul>
-
- </p>
</subsection>
<subsection name="Mixing Configuration Sources">
@@ -155,6 +156,7 @@ Configuration config = factory.getConfiguration();
overloaded variants of all methods that allow to specify a default
value,
which will be returned if the property cannot be found. The following
data types are supported:
+ </p>
<ul>
<li>BigDecimal</li>
<li>BigInteger</li>
@@ -167,6 +169,7 @@ Configuration config = factory.getConfiguration();
<li>short</li>
<li>String</li>
</ul>
+ <p>
The names of these methods start with <code>get</code> followed by
their
data type. The <code>getString()</code> method for instance will return
String values, <code>getInt()</code> will operate on integers.
@@ -179,6 +182,7 @@ Configuration config = factory.getConfiguration();
<p>
For manipulating properties or their values the following methods can
be used:
+ </p>
<dl>
<dt><code>addProperty()</code></dt>
<dd>Adds a new property to the configuration. If this property
already
@@ -193,7 +197,6 @@ Configuration config = factory.getConfiguration();
<dt><code>clear()</code></dt>
<dd>Wipes out the whole configuration</dd>
</dl>
- </p>
</subsection>
<subsection name="Threading issues">
diff --git a/src/site/xdoc/userguide_v1.10/user_guide.xml
b/src/site/xdoc/userguide_v1.10/user_guide.xml
index 83330928..ec8518c6 100644
--- a/src/site/xdoc/userguide_v1.10/user_guide.xml
+++ b/src/site/xdoc/userguide_v1.10/user_guide.xml
@@ -16,8 +16,9 @@
limitations under the License.
-->
-<document>
-
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
https://maven.apache.org/xsd/xdoc-2.0.xsd";>
<properties>
<title>Commons Configuration 1.10 User's Guide</title>
</properties>
@@ -37,21 +38,23 @@
<section name="Table of contents">
<ul>
- <li><a href="overview.html#Using_Configuration">Using
Configuration</a></li>
+ <li><a href="overview.html#Using_Configuration">Using Configuration</a>
<ul>
<li><a href="overview.html#Configuration_Sources">Configuration
Sources</a></li>
<li><a href="overview.html#Mixing_Configuration_Sources">Mixing
Configuration Sources</a></li>
<li><a href="overview.html#The_Configuration_interface">The
Configuration interface</a></li>
<li><a href="overview.html#Threading_issues">Threading issues</a></li>
</ul>
- <li><a
href="howto_basicfeatures.html#Basic_features_and_AbstractConfiguration">Basic
features and AbstractConfiguration</a></li>
+ </li>
+ <li><a
href="howto_basicfeatures.html#Basic_features_and_AbstractConfiguration">Basic
features and AbstractConfiguration</a>
<ul>
<li><a
href="howto_basicfeatures.html#Handling_of_missing_properties">Handling of
missing properties</a></li>
<li><a href="howto_basicfeatures.html#List_handling">List
handling</a></li>
<li><a href="howto_basicfeatures.html#Variable_Interpolation">Variable
Interpolation</a></li>
<li><a
href="howto_basicfeatures.html#Customizing_interpolation">Customizing
interpolation</a></li>
</ul>
- <li><a href="howto_properties.html#Properties_files">Properties
files</a></li>
+ </li>
+ <li><a href="howto_properties.html#Properties_files">Properties files</a>
<ul>
<li><a
href="howto_properties.html#Using_PropertiesConfiguration">Using
PropertiesConfiguration</a></li>
<li><a href="howto_properties.html#Includes">Includes</a></li>
@@ -61,7 +64,8 @@
<li><a href="howto_properties.html#Layout_Objects">Layout
Objects</a></li>
<li><a
href="howto_properties.html#Custom_properties_readers_and_writers">Custom
properties readers and writers</a></li>
</ul>
- <li><a href="howto_filebased.html#File-based_Configurations">File-based
Configurations</a></li>
+ </li>
+ <li><a href="howto_filebased.html#File-based_Configurations">File-based
Configurations</a>
<ul>
<li><a href="howto_filebased.html#Specifying_the_file">Specifying the
file</a></li>
<li><a href="howto_filebased.html#Loading">Loading</a></li>
@@ -69,39 +73,45 @@
<li><a href="howto_filebased.html#Automatic_Saving">Automatic
Saving</a></li>
<li><a href="howto_filebased.html#Automatic_Reloading">Automatic
Reloading</a></li>
</ul>
- <li><a href="howto_xml.html#Hierarchical_properties">Hierarchical
properties</a></li>
+ </li>
+ <li><a href="howto_xml.html#Hierarchical_properties">Hierarchical
properties</a>
<ul>
<li><a
href="howto_xml.html#Accessing_properties_in_hierarchical_configurations">Accessing
properties in hierarchical configurations</a></li>
<li><a href="howto_xml.html#Complex_hierarchical_structures">Complex
hierarchical structures</a></li>
<li><a href="howto_xml.html#Accessing_structured_properties">Accessing
structured properties</a></li>
<li><a href="howto_xml.html#Adding_new_properties">Adding new
properties</a></li>
<li><a href="howto_xml.html#Escaping_special_characters">Escaping dot
characters in property names</a></li>
- <li><a href="howto_xml.html#Expression_engines">Expression
engines</a></li>
+ <li><a href="howto_xml.html#Expression_engines">Expression engines</a>
<ul>
<li><a href="howto_xml.html#The_default_expression_engine">The
default expression engine</a></li>
<li><a href="howto_xml.html#The_XPATH_expression_engine">The XPATH
expression engine</a></li>
</ul>
+ </li>
<li><a
href="howto_xml.html#Validation_of_XML_configuration_files">Validation of XML
configuration files</a></li>
</ul>
- <li><a
href="howto_compositeconfiguration.html#Composite_Configuration_Details">Composite
Configuration Details</a></li>
+ </li>
+ <li><a
href="howto_compositeconfiguration.html#Composite_Configuration_Details">Composite
Configuration Details</a>
<ul>
<li><a
href="howto_compositeconfiguration.html#Setting_Up_Defaults">Setting Up
Defaults</a></li>
<li><a href="howto_compositeconfiguration.html#Saving_Changes">Saving
Changes</a></li>
</ul>
- <li><a
href="howto_combinedconfiguration.html#Combined_Configuration">Combined
Configuration</a></li>
+ </li>
+ <li><a
href="howto_combinedconfiguration.html#Combined_Configuration">Combined
Configuration</a>
<ul>
<li><a href="howto_combinedconfiguration.html#How_it_works">How it
works</a></li>
<li><a href="howto_combinedconfiguration.html#Node_combiners">Node
combiners</a></li>
<li><a
href="howto_combinedconfiguration.html#Constructing_a_CombinedConfiguration">Constructing
a CombinedConfiguration</a></li>
<li><a
href="howto_combinedconfiguration.html#Dealing_with_changes">Dealing with
changes</a></li>
</ul>
- <li><a href="howto_beans.html#Declaring_and_Creating_Beans">Declaring
and Creating Beans</a></li>
+ </li>
+ <li><a href="howto_beans.html#Declaring_and_Creating_Beans">Declaring
and Creating Beans</a>
<ul>
<li><a href="howto_beans.html#Basic_Concepts">Basic Concepts</a></li>
<li><a href="howto_beans.html#An_Example">An Example</a></li>
<li><a href="howto_beans.html#Extending_the_Basic_Mechanism">Extending
the Basic Mechanism</a></li>
</ul>
- <li><a
href="howto_configurationbuilder.html#Using_DefaultConfigurationBuilder">Using
DefaultConfigurationBuilder</a></li>
+ </li>
+ <li><a
href="howto_configurationbuilder.html#Using_DefaultConfigurationBuilder">Using
DefaultConfigurationBuilder</a>
<ul>
<li><a
href="howto_configurationbuilder.html#The_configuration_definition_file">The
configuration definition file</a></li>
<li><a
href="howto_configurationbuilder.html#Setting_up_a_DefaultConfigurationBuilder">Setting
up a ConfigurationFactory</a></li>
@@ -112,20 +122,23 @@
<li><a href="howto_configurationbuilder.html#An_example">An
example</a></li>
<li><a
href="howto_configurationbuilder.html#Extending_the_configuration_definition_file_format">Extending
the configuration definition file format</a></li>
</ul>
- <li><a href="howto_multitenant.html#Multi-tenant
Configurations">Multi-tenant Configurations</a></li>
+ </li>
+ <li><a href="howto_multitenant.html#Multi-tenant
Configurations">Multi-tenant Configurations</a>
<ul>
<li><a
href="howto_multitenant.html#MultiFileHierarchicalConfiguration">MultiFileHierarchicalConfiguration</a></li>
<li><a
href="howto_multitenant.html#DynamicCombinedConfiguration">DynamicCombinedConfiguration</a></li>
<li><a href="howto_multitenant.html#Sample Configuration">Sample
Configuration</a></li>
<li><a
href="howto_multitenant.html#PatternSubtreeConfigurationWrapper">PatternSubtreeConfigurationWrapper</a></li>
</ul>
- <li><a href="howto_events.html#Configuration_Events">Configuration
Events</a></li>
+ </li>
+ <li><a href="howto_events.html#Configuration_Events">Configuration
Events</a>
<ul>
<li><a href="howto_events.html#Configuration_listeners">Configuration
listeners</a></li>
<li><a href="howto_events.html#An_example">An example</a></li>
<li><a href="howto_events.html#Error_listeners">Error
listeners</a></li>
</ul>
- <li><a
href="howto_utilities.html#Utility_classes_and_Tips_and_Tricks">Utility classes
and Tips and Tricks</a></li>
+ </li>
+ <li><a
href="howto_utilities.html#Utility_classes_and_Tips_and_Tricks">Utility classes
and Tips and Tricks</a>
<ul>
<li><a href="howto_utilities.html#Copy_a_configuration">Copy a
configuration</a></li>
<li><a
href="howto_utilities.html#Converting_a_flat_configuration_into_a_hierarchical_one">Converting
a flat configuration into a hierarchical one</a></li>
@@ -133,12 +146,14 @@
<li><a
href="howto_utilities.html#Interpolation_of_all_variables">Interpolation of all
variables</a></li>
<li><a
href="howto_utilities.html#Handling_of_runtime_exceptions">Handling of runtime
exceptions</a></li>
</ul>
- <li><a href="howto_filesystems.html#File_Systems">File Systems</a></li>
+ </li>
+ <li><a href="howto_filesystems.html#File_Systems">File Systems</a>
<ul>
<li><a
href="howto_filesystems.html#File_Systems#Configuration">Configuration</a></li>
<li><a
href="howto_filesystems.html#File_Systems#File_Options_Provider">File Options
Provider</a></li>
<li><a
href="howto_filesystems.html#File_Systems#File_Reloading_Strategy">File
Reloading Strategy</a></li>
</ul>
+ </li>
</ul>
</section>
