5 files changed, 134 insertions, 0 deletions
diff --git a/ACE/ACEXML/docs/TODO.txt b/ACE/ACEXML/docs/TODO.txt
new file mode 100644
index 00000000000..e7e48ca67c4
--- /dev/null
+++ b/ACE/ACEXML/docs/TODO.txt
@@ -0,0 +1,17 @@
+/**
+@page acexml_todo ACEXML TO-DO List
+
+<ul>
+
+  <li>Add Schema parsing ability.
+
+  <li>Add support for resolving external entities, such as a
+      schema/namespace definition located on the web.
+
+  <li>Add parameterized entity management class.  See above.
+
+  <li>Define validator building/calling interfaces.
+
+</ul>
+
+*/
diff --git a/ACE/ACEXML/docs/bugs.txt b/ACE/ACEXML/docs/bugs.txt
new file mode 100644
index 00000000000..136e0cd7117
--- /dev/null
+++ b/ACE/ACEXML/docs/bugs.txt
@@ -0,0 +1,17 @@
+/**
+@page acexml_bugs ACEXML Known Bugs
+
+<ul>
+  <li>ACEXML currently do not validate an XML files.  The validator
+      hooks have not fully integrated into the parser yet.
+
+  <li>Need to verify predefined entities are working correctly.  Check
+      out the SAXPrint example.
+
+  <li>Currently, replacement of parameterized reference (PEReference) is
+      not working.
+
+</ul>
+
+
+*/
diff --git a/ACE/ACEXML/docs/guidelines.txt b/ACE/ACEXML/docs/guidelines.txt
new file mode 100644
index 00000000000..9d084924c2c
--- /dev/null
+++ b/ACE/ACEXML/docs/guidelines.txt
@@ -0,0 +1,39 @@
+// -*- HTML-Helper -*- $Id$
+
+/**
+@page acexml_guides ACEXML Programming Guidelines
+
+<ul>
+  <li>A lot of class names under @c $(ACE_ROOT)/ACEXML/common do not
+      follow the naming convention suggested in ACE-guidelines.html.
+      The reason for that is because those classes were derived from
+      the SAX2 API and we would like to keep them as similar as
+      possible.
+  <li>Character encoding:  The default character encoding for ACEXML
+      can be set at compile time.   ACEXML uses UTF-8 encoding in most
+      platforms where <code>ACEXML_Char</code> maps to
+      <code>char</code> in this case.  When ACE is configured to use
+      <CODE>wchar</CODE> and <CODE>UNICODE</CODE>,  ACEXML uses UTF-16
+      encoding and <code>ACEXML_Char</code> maps to
+      <code>wchar_t</code>.  Notice that ACEXML assume
+      <code>sizeof (wchar_t)</code> is of 2-byte long.  For platforms
+      using 4-byte <code>wchar_t</code>, ACEXML will not work
+      correctly, but it should be trivial to fix.<p>
+
+  <li>Currently, there's only an example showing how to use the parser
+      under @c $(ACE_ROOT)/ACEXML/examples/SAXPrint/.
+
+  <li><b>(Not supported yet)</b> To develop a new validator, one must
+      create a DLL implementing
+      @c ACEXML_Attributes_Def_Builder, @c
+      ACEXML_Attribute_Def_Builder, @c ACEXML_Element_Def_Builder,
+      @c ACEXML_Validator, and @c ACEXML_DTD_Manager.  The DLL should
+      also export a traditional C function called @c
+      create_dtd_manager.  The XML parser itself should also be
+      modified to support and dynamically link with the new validator.
+      See @c $(ACE_ROOT)/ACEXML/parser/debug_validator/ for an example.
+
+</ul>
+
+
+*/
diff --git a/ACE/ACEXML/docs/parser_features.txt b/ACE/ACEXML/docs/parser_features.txt
new file mode 100644
index 00000000000..c65930e32a2
--- /dev/null
+++ b/ACE/ACEXML/docs/parser_features.txt
@@ -0,0 +1,25 @@
+/**  -*- HTML-Helper -*- $Id$
+@defgroup acexml_parser_features Configurable Special Features of ACEXML Parser
+@{
+
+There are special features in ACEXML Parser that can be
+activated/deactivated thru @c setFeature.  Likewise, whether a feature
+has been activated or not can be queried using @c getFeature.
+
+@sa ACEXML_XMLReader::setFeature
+@sa ACEXML_XMLReader::getFeature
+
+Here is a list of supported features:
+
+<OL>
+  <li> namespaces - When this feature is enabled, ACEXML parser allows
+  access by namespace qualified names.
+
+  <li> namespace_prefixes - Normally the list of attributes returned by the
+  parser will not contain attributes used as namespace declarations
+  (xmlns:foo="bar"). When this feature is enabled, the list of attributes
+  contains the namespace declarations also.
+</OL>
+
+@}
+*/
diff --git a/ACE/ACEXML/docs/readme.txt b/ACE/ACEXML/docs/readme.txt
new file mode 100644
index 00000000000..f0de833b526
--- /dev/null
+++ b/ACE/ACEXML/docs/readme.txt
@@ -0,0 +1,36 @@
+/**  -*- HTML-Helper -*- $Id$
+@mainpage ACEXML - A Small and Portable XML Parser
+
+@section acexml_synopsis Synopsis
+ACEXML is a small footprint and portable framework for integrating XML
+parsing ability into user applications.  The framework is based on the
+ <a href="http://www.saxproject.org/"> Simple API for XML
+(SAX 2.0) </A> by David Megginson.  A simple non-conformant XML parser
+is also included in the framework.  Since our original motivation was
+to use the parser for specifying software composition and
+configuration descriptors, at the current stage, the parser does not
+fully support all the features specified in the XML specification.
+
+We do, however, plan to add more features to the parser and will
+either release a more versatile parser or allow the current parser to
+dynamically load in the extra features in the future.
+
+@section acexml_features Features of ACEXML
+<ul>
+  <li> ACEXML only recognize UNICODE documents, although they can be
+  in various different encoding, such as UTF-8, UTF-16, or UCS-4.
+  Therefore, it might be a problem to handle document containing
+  multi-byte charatersets.  They can, however, be translated into
+  UNICODE before being parsed by ACEXML parser.
+</ul>
+
+
+@section acexml_others  Other Topics
+<ol>
+  <li>@ref acexml_parser_features
+  <li>@ref acexml_guides
+  <li>@ref acexml_bugs
+  <li>@ref acexml_todo
+</ol>
+
+*/