Table of Contents
This sections discusses flood configuration file.
Flood XML parsing is built around apr-util XML capabilities, which in turn are based on tweaked version of James Clark's marvelous expat library. Because of that flood understands XML v1.0, so you schould start your configuration file with following processing instruction (PI for short):
<?xml version="1.0"?>
It is not required by flood, but it's good practice and may be useful if you decide to use other XML tools for additional processing. Please note, that expat support for different encodings is rather limited. In particular it understands only UTF-8 and ISO-8859-1 encodings, so processing of your configuration may fail if you specify different encoding in your configuration file, like this:
<?xml version="1.0" encoding="iso-8859-2"?>
Please note, that you can get around that limitation, by converting you national characters to UTF-8. Flood itself only checks XML file for well-formdess, which means checking if it is formed after basic XML rules. If you want to do full validation of flood configuration file, you may want to include following line right next to XML processing instruction:
<!DOCTYPE configuration SYSTEM "flood.dtd">
With this declaration you can use software with validating XML
parser (like ASF's Xalan) and validate your configuration before
actually processing it with flood. That way you can ensure, that
flood.xml file is valid and obeys flood configuration rules. You
can find flood.dtd
in
examples/
directory relative
to package root directory.
Please note that all configure elements in flood aren't using their own dedicated XML namespace, so if you (for some reason) intend to mix flood configuration file with other XML, you may experience tag name collision.