ACE/ACEXML/docs/guidelines.txt

   1 // -*- HTML-Helper -*-
   2
   3 /**
   4 @page acexml_guides ACEXML Programming Guidelines
   5
   6 <ul>
   7   <li>A lot of class names under @c $(ACE_ROOT)/ACEXML/common do not
   8       follow the naming convention suggested in ACE-guidelines.html.
   9       The reason for that is because those classes were derived from
  10       the SAX2 API and we would like to keep them as similar as
  11       possible.
  12   <li>Character encoding:  The default character encoding for ACEXML
  13       can be set at compile time.   ACEXML uses UTF-8 encoding in most
  14       platforms where <code>ACEXML_Char</code> maps to
  15       <code>char</code> in this case.  When ACE is configured to use
  16       <CODE>wchar</CODE> and <CODE>UNICODE</CODE>,  ACEXML uses UTF-16
  17       encoding and <code>ACEXML_Char</code> maps to
  18       <code>wchar_t</code>.  Notice that ACEXML assume
  19       <code>sizeof (wchar_t)</code> is of 2-byte long.  For platforms
  20       using 4-byte <code>wchar_t</code>, ACEXML will not work
  21       correctly, but it should be trivial to fix.<p>
  22
  23   <li>Currently, there's only an example showing how to use the parser
  24       under @c $(ACE_ROOT)/ACEXML/examples/SAXPrint/.
  25
  26   <li><b>(Not supported yet)</b> To develop a new validator, one must
  27       create a DLL implementing
  28       @c ACEXML_Attributes_Def_Builder, @c
  29       ACEXML_Attribute_Def_Builder, @c ACEXML_Element_Def_Builder,
  30       @c ACEXML_Validator, and @c ACEXML_DTD_Manager.  The DLL should
  31       also export a traditional C function called @c
  32       create_dtd_manager.  The XML parser itself should also be
  33       modified to support and dynamically link with the new validator.
  34       See @c $(ACE_ROOT)/ACEXML/parser/debug_validator/ for an example.
  35
  36 </ul>
  37
  38
  39 */