You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by bo...@apache.org on 2008/09/22 11:50:50 UTC
svn commit: r697763 [1/3] - in /xerces/c/trunk/doc: ./ style/dtd/
Author: borisk
Date: Mon Sep 22 02:50:49 2008
New Revision: 697763
URL: http://svn.apache.org/viewvc?rev=697763&view=rev
Log:
Clean up and change the documentation to correspond to the state of the source code/build system.
Removed:
xerces/c/trunk/doc/build-misc.xml
xerces/c/trunk/doc/build-other.xml
xerces/c/trunk/doc/build-winunix.xml
Modified:
xerces/c/trunk/doc/apidocs.xml
xerces/c/trunk/doc/build.xml
xerces/c/trunk/doc/createdoc.xml
xerces/c/trunk/doc/domcount.xml
xerces/c/trunk/doc/domprint.xml
xerces/c/trunk/doc/enumval.xml
xerces/c/trunk/doc/faq-build.xml
xerces/c/trunk/doc/faq-contributing.xml
xerces/c/trunk/doc/faq-distrib.xml
xerces/c/trunk/doc/faq-other.xml
xerces/c/trunk/doc/faq-parse.xml
xerces/c/trunk/doc/install.xml
xerces/c/trunk/doc/memparse.xml
xerces/c/trunk/doc/migration.xml
xerces/c/trunk/doc/migration_archive.xml
xerces/c/trunk/doc/pparse.xml
xerces/c/trunk/doc/program-dom.xml
xerces/c/trunk/doc/program-others.xml
xerces/c/trunk/doc/program-sax.xml
xerces/c/trunk/doc/program-sax2.xml
xerces/c/trunk/doc/program.xml
xerces/c/trunk/doc/psviwriter.xml
xerces/c/trunk/doc/redirect.xml
xerces/c/trunk/doc/samples.xml
xerces/c/trunk/doc/sax2count.xml
xerces/c/trunk/doc/sax2print.xml
xerces/c/trunk/doc/saxcount.xml
xerces/c/trunk/doc/saxprint.xml
xerces/c/trunk/doc/schema.xml
xerces/c/trunk/doc/scmprint.xml
xerces/c/trunk/doc/senumval.xml
xerces/c/trunk/doc/stdinparse.xml
xerces/c/trunk/doc/style/dtd/entities.ent
xerces/c/trunk/doc/xerces-c_book.xml
xerces/c/trunk/doc/xinclude.xml
Modified: xerces/c/trunk/doc/apidocs.xml
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/apidocs.xml?rev=697763&r1=697762&r2=697763&view=diff
==============================================================================
--- xerces/c/trunk/doc/apidocs.xml (original)
+++ xerces/c/trunk/doc/apidocs.xml Mon Sep 22 02:50:49 2008
@@ -28,7 +28,7 @@
<p>&XercesCName; SAX is an implementation of the
<jump href="http://sax.sourceforge.net/">SAX 1.0/2.0</jump> specification.</p>
- <p>&XercesCName; DOM is an implementation of the</p>
+ <p>&XercesCName; DOM is an implementation of the following specifications:</p>
<ul>
<li><jump href="http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/">
DOM Level 1 Specification</jump>, a W3C Recommendation of October 1, 1998</li>
@@ -44,11 +44,12 @@
</ul>
<p>For a complete understanding of how the &XercesCName; APIs work,
- we recommend you to read these documents.</p>
+ we recommend that you read these specifications.</p>
- <p>See the <em><jump href="apiDocs-&XercesC3Series;/index.html">&XercesCName; API documentation</jump></em> for more details.</p>
+ <p>See the <em><jump href="apiDocs-&XercesC3Series;/index.html">&XercesCName; API Reference</jump></em>
+ for the detailed documentation of &XercesCName; interfaces.</p>
- <note>The API documentation is automatically generated using
+ <note>The API Reference is automatically generated using
<jump href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</jump>.</note>
</s2>
Modified: xerces/c/trunk/doc/build.xml
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/build.xml?rev=697763&r1=697762&r2=697763&view=diff
==============================================================================
--- xerces/c/trunk/doc/build.xml (original)
+++ xerces/c/trunk/doc/build.xml Mon Sep 22 02:50:49 2008
@@ -19,42 +19,342 @@
<!DOCTYPE s1 SYSTEM "sbk:/style/dtd/document.dtd">
<s1 title="Build Instructions">
+ <s2 title="Build Instructions">
- <s2 title="Building on Windows and UNIX">
- <p>Read the <jump href="build-winunix-&XercesC3Series;.html">Building on Windows and UNIX</jump> document
- or jump directly to:</p>
- <ul>
- <li><jump href="build-winunix-&XercesC3Series;.html#WinNT">Building on Windows using Microsoft Visual C++</jump></li>
- <li><jump href="build-winunix-&XercesC3Series;.html#UNIX">Building on UNIX/Linux/Mac OS X platforms</jump></li>
- <li><jump href="build-winunix-&XercesC3Series;.html#CygWin">Building on Windows using Cygwin</jump></li>
- <li><jump href="build-winunix-&XercesC3Series;.html#MinGW">Building on Windows using MinGW-MSYS</jump></li>
- <li><jump href="build-winunix-&XercesC3Series;.html#WinBorlandCC">Building on Windows using Borland C++</jump></li>
- <li><jump href="build-winunix-&XercesC3Series;.html#WinBorlandBuilder">Building on Windows using Borland C++ Builder</jump></li>
- <li><jump href="build-winunix-&XercesC3Series;.html#WinIntel">Building 64 bit libraries on Windows using Intel C++</jump></li>
- </ul>
- </s2>
+ <p>Build instructions are provided for the following platforms and
+ compilers:</p>
- <s2 title="Building on Other Platforms">
- <p>Read the <jump href="build-other-&XercesC3Series;.html">Building on Other Platforms</jump> document
- or jump directly to:</p>
<ul>
- <li><jump href="build-other-&XercesC3Series;.html#iSeries">Building &XercesCName; on iSeries (AS/400)</jump></li>
- <li><jump href="build-other-&XercesC3Series;.html#Mac">Building &XercesCName; on Macintosh</jump></li>
+ <li><link anchor="UNIX">UNIX/Linux/Mac OS X/Cygwin/MinGW</link></li>
+ <li><link anchor="Windows">Windows using Microsoft Visual C++</link></li>
+ <li><link anchor="BorlandCC">Windows using Borland C++</link></li>
+ <li><link anchor="BorlandBuilder">Windows using Borland C++ Builder</link></li>
</ul>
- </s2>
- <s2 title="Other Build Instructions">
- <p>Read the <jump href="build-misc-&XercesC3Series;.html">Other Build Instructions</jump> document
- or jump directly to:</p>
- <ul>
- <li><jump href="build-misc-&XercesC3Series;.html#ICUPerl">Building &XercesCName; with ICU</jump></li>
- <li><jump href="build-misc-&XercesC3Series;.html#RPMLinux">Building &XercesCName; using RPM on Linux</jump></li>
- <li><jump href="build-misc-&XercesC3Series;.html#WinCOM">Building &XercesCName; COM Wrapper on Windows</jump></li>
- <li><jump href="build-misc-&XercesC3Series;.html#UserDoc">Building User Documentation</jump></li>
- <li><jump href="build-misc-&XercesC3Series;.html#PortInfo">I wish to port &XercesCProjectName; to my favourite platform. Do you have any suggestions?</jump></li>
- <li><jump href="build-misc-&XercesC3Series;.html#XMLChInfo">What should I define XMLCh to be?</jump></li>
- <li><jump href="build-misc-&XercesC3Series;.html#HelpInfo">Where can I look for more help?</jump></li>
- </ul>
- </s2>
+ <anchor name="UNIX"/>
+ <s3 title="Building on UNIX/Linux/Mac OS X/Cygwin/MinGW platforms">
+
+ <p>For building on UNIX and UNIX-like (GNU/Linux, Max OS X,
+ Cygwin, MinGW-MSYS) platforms &XercesCName; uses the
+ GNU automake-based build systems and requires that you
+ have <jump href="http://www.gnu.org/software/make/make.html">GNU
+ make</jump> installed. On some platforms GNU make is called gmake
+ instead of make.</p>
+
+ <p>As with all automake-based projects the build process is divided
+ into two parts: configuration and building. The configuration
+ part is performed using the <code>configure</code> script that
+ can be found in the <code>&XercesC3SrcInstallDir;</code> directory.
+ The build part is performed by invoking <code>make</code>.</p>
+
+ <p>Besides the standard <code>configure</code> options which
+ you can view by running <code>configure --help</code>,
+ &XercesCName; provides a number of project-specific options
+ that are worth mentioning. You can specify one option for
+ each category outlined below. If you do not specify anything
+ for a particular category then <code>configure</code> will
+ select the most appropriate default. At the end of its
+ execution <code>configure</code> prints the selected
+ values for each category.</p>
+
+
+ <p>Net Accessor (used to access network resources):</p>
+
+ <table>
+ <tr>
+ <th>Option</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><code>--enable-netaccessor-curl</code></td>
+ <td>use the libcurl library</td>
+ </tr>
+ <tr>
+ <td><code>--enable-netaccessor-socket</code></td>
+ <td>use plain sockets</td>
+ </tr>
+ <tr>
+ <td><code>--enable-netaccessor-cfurl</code></td>
+ <td>use the CFURL API (only on Mac OS X)</td>
+ </tr>
+ <tr>
+ <td><code>--enable-netaccessor-winsock</code></td>
+ <td>use WinSock (only on Windows, Cygwin, MinGW)</td>
+ </tr>
+ <tr>
+ <td><code>--disable-network</code></td>
+ <td>disable network support</td>
+ </tr>
+ </table>
+
+ <p>Transcoder (used to convert between internal UTF-16 and other encodings):</p>
+
+ <table>
+ <tr>
+ <th>Option</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><code>--enable-transcoder-gnuiconv</code></td>
+ <td>use the GNU iconv library</td>
+ </tr>
+ <tr>
+ <td><code>--enable-transcoder-iconv</code></td>
+ <td>use the iconv library</td>
+ </tr>
+ <tr>
+ <td><code>--enable-transcoder-icu</code></td>
+ <td>use the ICU library</td>
+ </tr>
+ <tr>
+ <td><code>--enable-transcoder-macosunicodeconverter</code></td>
+ <td>use Mac OS X APIs (only on Mac OS X)</td>
+ </tr>
+ <tr>
+ <td><code>--enable-transcoder-windows</code></td>
+ <td>use Windows APIs (only on Windows, Cygwin, MinGW)</td>
+ </tr>
+ </table>
+
+ <p>Message Loader (used to access diagnostics messages):</p>
+
+ <table>
+ <tr>
+ <th>Option</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td><code>--enable-msgloader-inmemory</code></td>
+ <td>store the messages in memory</td>
+ </tr>
+ <tr>
+ <td><code>--enable-msgloader-icu</code></td>
+ <td>store the messages using the ICU resource bundles</td>
+ </tr>
+ <tr>
+ <td><code>--enable-msgloader-iconv</code></td>
+ <td>store the messages in the iconv message catalog</td>
+ </tr>
+ </table>
+
+ <p>Thread support is enabled by default and can be disabled with the
+ <code>--disable-threads</code> option.</p>
+
+ <p>By default <code>configure</code> selects both shared and static
+ libraries. You can use the <code>--disable-shared</code> and
+ <code>--disable-static</code> options to avoid building the
+ version you don't need.</p>
+
+ <p>Finally, to make the build process cleaner the &XercesCName;
+ build system hides actual compiler commands being executed
+ by <code>make</code>. If you would like to see those then you
+ can specify the <code>--disable-pretty-make</code> option.</p>
+ <p>If you need to specify compiler executables that should be
+ used to build &XercesCName;, you can set the CC and CXX
+ variables when invoking <code>configure</code>. Similarly,
+ if you need to specify additional compiler or linker options,
+ you can set the CFLAGS, CXXFLAGS, and LDFLAGS variables.
+ For example:</p>
+
+ <source>./configure --disable-static CC=gcc-4.3 CXX=g++-4.3 CFLAGS=-O3 CXXFLAGS=-O3</source>
+
+ <p>Once the configuration part is complete you can run
+ <code>make</code> (or <code>gmake</code>). Running
+ <code>make</code> from the <code>&XercesC3SrcInstallDir;</code>
+ directory builds &XercesCName; library and examples. If
+ you like to build only the library, you can run make from
+ <code>&XercesC3SrcInstallDir;/src</code>.</p>
+
+ <p>If you would like to build the tests and run the
+ automated test suite, run <code>make check</code>
+ from the <code>&XercesC3SrcInstallDir;</code>
+ directory. The automated test suite required
+ Perl and the <code>diff</code> command.</p>
+
+ <p>Some platforms and configurations require extra
+ <code>configure</code> and <code>make</code> options
+ which are shown in the following table.</p>
+
+ <table>
+ <tr>
+ <th>Platform</th>
+ <th>Compiler</th>
+ <th>Options</th>
+ </tr>
+ <tr>
+ <td>Solaris x86</td>
+ <td>Sun CC</td>
+ <td><code>./configure CXX=CC CC=cc</code></td>
+ </tr>
+ <tr>
+ <td>Solaris x86-64</td>
+ <td>Sun CC</td>
+ <td><code>./configure CXX=CC CC=cc CFLAGS=-xarch=amd64 CXXFLAGS=-xarch=amd64</code></td>
+ </tr>
+ <tr>
+ <td>Solaris SPARC</td>
+ <td>Sun CC</td>
+ <td><code>/configure CXX=CC CC=cc</code></td>
+ </tr>
+ <tr>
+ <td>Solaris SPARCv9</td>
+ <td>Sun CC</td>
+ <td><code>./configure CXX=CC CC=cc CFLAGS=-xarch=v9 CXXFLAGS=-xarch=v9</code></td>
+ </tr>
+ <tr>
+ <td>AIX PowerPC</td>
+ <td>IBM XL C++</td>
+ <td><code>./configure CXX=xlC_r CC=xlc_r</code><br/>
+ <code>gmake libxerces_c_la_LDFLAGS=-qmkshrobj</code></td>
+ </tr>
+ <tr>
+ <td>AIX PowerPC-64</td>
+ <td>IBM XL C++</td>
+ <td><code>export OBJECT_MODE=64</code><br/>
+ <code>./configure CXX=xlC_r CC=xlc_r CXXFLAGS=-q64 CFLAGS=-q64</code><br/>
+ <code>gmake libxerces_c_la_LDFLAGS=-qmkshrobj</code></td>
+ </tr>
+ <tr>
+ <td>HP-UX IA-64-32</td>
+ <td>HP aCC</td>
+ <td><code>./configure CXX=aCC CC=aCC CFLAGS=-mt CXXFLAGS=-mt LDFLAGS=-mt</code></td>
+ </tr>
+ <tr>
+ <td>HP-UX IA-64</td>
+ <td>HP aCC</td>
+ <td><code>./configure CXX=aCC CC=aCC CFLAGS="-mt +DD64" CXXFLAGS="-mt +DD64" LDFLAGS="-mt +DD64"</code></td>
+ </tr>
+ <tr>
+ <td>Mac OS X x86-64</td>
+ <td>GCC</td>
+ <td><code>/configure CFLAGS="-arch x86_64" CXXFLAGS="-arch x86_64" </code></td>
+ </tr>
+ <tr>
+ <td>Mac OS X PowerPC-64</td>
+ <td>GCC</td>
+ <td><code>./configure CFLAGS="-arch ppc64" CXXFLAGS="-arch ppc64"</code></td>
+ </tr>
+ <tr>
+ <td>Mac OS X x86/PowerPC</td>
+ <td>GCC</td>
+ <td><code>./configure --disable-dependency-tracking CFLAGS="-arch i386 -arch ppc" CXXFLAGS="-arch i386 -arch ppc"</code></td>
+ </tr>
+ <tr>
+ <td>Mingw x86</td>
+ <td>GCC</td>
+ <td><code>./configure LDFLAGS=-no-undefined</code></td>
+ </tr>
+ <tr>
+ <td>Cygwin x86</td>
+ <td>GCC</td>
+ <td><code>./configure LDFLAGS=-no-undefined</code></td>
+ </tr>
+ </table>
+ <p/>
+
+ <note>
+ Note that different UNIX platforms use different system
+ environment variable for finding libraries. On Linux
+ and Solaris, the environment variable name is
+ <code>LD_LIBRARY_PATH</code>, on AIX it is
+ <code>LIBPATH</code>, on Mac OS X it is
+ <code>DYLD_LIBRARY_PATH</code>, and on HP-UX
+ it is <code>SHLIB_PATH</code>.
+ </note>
+
+ <note>
+ Note that Cygwin and MinGW are different from the UNIX platforms
+ in the way they find libraries at run time. While UNIX platforms
+ may use the <code>LD_LIBRARY_PATH</code> environment variable,
+ Cygwin and MinGW use the <code>PATH</code> environment variable.
+ </note>
+
+ <note>
+ On the MinGW platform when linking against the static
+ &XercesCName; library, make sure you compile your application
+ with the <code>-DXML_LIBRARY</code> preprocessor flag. Otherwise
+ the functions in the header files will be marked as to be
+ imported from a DLL and the linker will be unable to resolve
+ the &XercesCName; symbols.
+ </note>
+ </s3>
+
+ <anchor name="Windows"/>
+ <s3 title="Building on Windows using Microsoft Visual C++">
+ <p>&XercesCName; source distribution comes with Microsoft Visual C++ projects and solutions.
+ The following describes the steps you need to build with this compiler.</p>
+
+ <p>To build &XercesCName; from the source distribution you will
+ need to open the solution containing the project. The solutions
+ containing the &XercesCName; project files are in the following
+ sub-directories in the <code>&XercesC3SrcInstallDir;</code>
+ directory:</p>
+
+<source>
+(For VC6) projects\Win32\VC6\xerces-all\xerces-all.dsw
+(For VC7.1) projects\Win32\VC7.1\xerces-all\xerces-all.sln
+(For VC8) projects\Win32\VC8\xerces-all\xerces-all.sln
+(For VC9) projects\Win32\VC9\xerces-all\xerces-all.sln
+</source>
+
+ <p>Once you have the solution open, you need to build the
+ project named <code>XercesLib</code>. You can select
+ Debug/Release, Static/DLL, and, for VC8 and VC9, 32/64 bit
+ builds using the Configuration Manager dialog. You
+ can also select whether the &XercesCName; library
+ should use ICU for transcoding.</p>
+
+ <p>When building your own applications you need to make sure
+ that you are linking your application with the
+ &XercesC3WindowsLib;.lib library (or Debug/Static version of it)
+ and also that the associated DLL is somewhere in the
+ executable/DLL search path (<code>PATH</code>).</p>
+
+ <note>If you are linking your application to a static library,
+ then you will need to compile your application with the
+ XML_LIBRARY preprocessor define in order
+ to turn off the DLL import/export mechanism. This is
+ also the case for the MinGW platform.</note>
+
+ <p>If you would also like to build tests and/or samples, inside
+ the solution files mentioned above (<code>xerces-all.dsw</code>
+ or <code>xerces-all.sln</code>), you'll find several other
+ projects which are for the tests and samples. Select all
+ the tests/samples that you would like to build and then
+ right click on the selection. Choose "Build (selection
+ only)" to build all the selected projects in one shot.</p>
+ </s3>
+
+ <anchor name="BorlandBuilder"/>
+ <s3 title="Building on Windows using Borland C++ Builder">
+ <p>&XercesCName; source distribution comes with the
+ Borland C++ Builder 6 projects. The following describes the steps you
+ need to build with this compiler.</p>
+
+ <p>The library and example projects are all contained in the
+ Xerces-all project group:
+ <code>&XercesC3SrcInstallDir;\projects\Win32\BCB6\Xerces-all\Xerces-all.bpg</code>.
+ Each project in the group refers a directory below <code>Xerces-all\</code>.
+ For example, the XercesLib project files are contained in the directory
+ <code>&XercesC3SrcInstallDir;\projects\Win32\BCB6\Xerces-all\XercesLib</code>.</p>
+
+ <p>To build a project, open the project manager, double click on the project
+ name, and select "Project -> Build" from the menu. For example, double click
+ on XercesLib.dll in the manager then select "Project -> Build XercesLib" from
+ the menu.
+ </p>
+ </s3>
+
+ <anchor name="BorlandCC"/>
+ <s3 title="Building on Windows using Borland C++">
+ <p>&XercesCName; source distribution comes with the Borland C++ makefiles. The
+ following describes the steps you need to build &XercesCName; with this compiler.</p>
+ <ol>
+ <li>Change to the <code>&XercesC3SrcInstallDir;\projects\Win32\BCC.551\Xerces-all</code> directory</li>
+ <li>Run <code>MakeBuildDirs.bat</code></li>
+ <li><code>make -f Xerces-all.mak</code> to build the library, examples, and tests.</li>
+ </ol>
+ </s3>
+ </s2>
</s1>
Modified: xerces/c/trunk/doc/createdoc.xml
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/createdoc.xml?rev=697763&r1=697762&r2=697763&view=diff
==============================================================================
--- xerces/c/trunk/doc/createdoc.xml (original)
+++ xerces/c/trunk/doc/createdoc.xml Mon Sep 22 02:50:49 2008
@@ -21,8 +21,8 @@
<s1 title="Sample: CreateDOMDocument">
<s2 title="CreateDOMDocument">
- <p> CreateDOMDocument, illustrates how you can create a DOM tree in
- memory from scratch. It then reports the elements in the tree that
+ <p>The CreateDOMDocument example illustrates how you can create a DOM tree in
+ memory from scratch. It then reports the number of elements in the tree that
was just created.</p>
<s3 title="Running CreateDOMDocument">
Modified: xerces/c/trunk/doc/domcount.xml
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/domcount.xml?rev=697763&r1=697762&r2=697763&view=diff
==============================================================================
--- xerces/c/trunk/doc/domcount.xml (original)
+++ xerces/c/trunk/doc/domcount.xml Mon Sep 22 02:50:49 2008
@@ -22,12 +22,12 @@
<s2 title="DOMCount">
<p>DOMCount uses the provided DOM API to parse an XML file,
- constructs the DOM tree and walks through the tree counting
+ construct the DOM tree and walk through the tree counting
the elements (using just one API call).</p>
<s3 title="Running DOMCount">
- <p>The DOMCount sample parses an XML file and prints out a count of the number of
+ <p>The DOMCount sample parses an XML file and prints out the number of
elements in the file. To run DOMCount, enter the following </p>
<source>DOMCount <XML file></source>
<p>The following parameters may be set from the command line </p>
@@ -45,7 +45,7 @@
-n Enable namespace processing. Defaults to off.
-s Enable schema processing. Defaults to off.
-f Enable full schema constraint checking. Defaults to off.
- -locale=ll_CC specify the locale, default: en_US
+ -locale=ll_CC specify the locale, default: en_US
-p Print out names of elements and attributes encountered.
-? Show this help.
@@ -55,12 +55,12 @@
<em>-v=never</em> will not use any validation<br/>
<em>-v=auto</em> will validate if a DOCTYPE declaration or a schema declaration is present in the XML document</p>
<p>Here is a sample output from DOMCount</p>
-<source>cd &XercesC3InstallDir;-linux/samples/data
+<source>cd &XercesC3InstallDir;/samples/data
DOMCount -v=always personal.xml
personal.xml: 20 ms (37 elems)</source>
<note>The time reported by the system may be different, depending on your
- processor type.</note>
+ processor speed.</note>
</s3>
</s2>
</s1>
Modified: xerces/c/trunk/doc/domprint.xml
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/domprint.xml?rev=697763&r1=697762&r2=697763&view=diff
==============================================================================
--- xerces/c/trunk/doc/domprint.xml (original)
+++ xerces/c/trunk/doc/domprint.xml Mon Sep 22 02:50:49 2008
@@ -22,7 +22,7 @@
<s2 title="DOMPrint">
<p>DOMPrint parses an XML file, constructs the DOM tree, and
- invokes DOMLSSerializer::write() to serialize the resultant
+ invokes DOMLSSerializer::write() to serialize the resultant
DOM tree back to XML stream.
</p>
@@ -50,10 +50,10 @@
-wenc=XXX Use a particular encoding for output. Default is
the same encoding as the input XML file. UTF-8 if
input XML file has not XML declaration.
- -wfile=xxx Write to a file instead of stdout.
- -wscs=xxx Enable/Disable split-cdata-sections. Default on.
- -wddc=xxx Enable/Disable discard-default-content. Default on.
- -wflt=xxx Enable/Disable filtering. Default off.
+ -wfile=xxx Write to a file instead of stdout.
+ -wscs=xxx Enable/Disable split-cdata-sections. Default on.
+ -wddc=xxx Enable/Disable discard-default-content. Default on.
+ -wflt=xxx Enable/Disable filtering. Default off.
-wfpp=xxx Enable/Disable format-pretty-print. Default off.
-wbom=xxx Enable/Disable write Byte-Order-Mark Default off.
-? Show this help
@@ -67,7 +67,7 @@
<em>-v=never</em> will not use any validation<br/>
<em>-v=auto</em> will validate if a DOCTYPE declaration or a schema declaration is present in the XML document</p>
<p>Here is a sample output from DOMPrint</p>
-<source>cd &XercesC3InstallDir;-linux/samples/data
+<source>cd &XercesC3InstallDir;/samples/data
DOMPrint -v=always personal.xml
<?xml version="1.0" encoding="iso-8859-1"?>
@@ -118,38 +118,38 @@
SAXPrint produce different results because of the way the two APIs store data
and capture events.</p>
- <p>Application needs to provide its own implementation of
- DOMErrorHandler (in this sample, the DOMPrintErrorHandler),
- if it would like to receive notification from the serializer
+ <p>Application needs to provide its own implementation of
+ DOMErrorHandler (in this sample, the DOMPrintErrorHandler),
+ if it would like to receive notification from the serializer
in the case any error occurs during the serialization.
</p>
- <p>Application needs to provide its own implementation of
- DOMLSSerializerFilter (in this sample, the DOMPrintFilter),
- if it would like to filter out certain part of the DOM
- representation, but must be aware that thus may render the
+ <p>Application needs to provide its own implementation of
+ DOMLSSerializerFilter (in this sample, the DOMPrintFilter),
+ if it would like to filter out certain part of the DOM
+ representation, but must be aware that thus may render the
resultant XML stream invalid.
</p>
- <p>Application may choose any combination of characters as the
- end of line sequence to be used in the resultant XML stream,
- but must be aware that thus may render the resultant XML
+ <p>Application may choose any combination of characters as the
+ end of line sequence to be used in the resultant XML stream,
+ but must be aware that this may render the resultant XML
stream ill formed.
</p>
- <p>Application may choose a particular encoding name in which
- the output XML stream would be, but must be aware that if
- characters, unrepresentable in the encoding specified, appearing
- in markups, may force the serializer to terminate serialization
+ <p>Application may choose a particular encoding name in which
+ the output XML stream should be, but must be aware that if
+ unrepresentable in the encoding specified characters appear
+ in the markup, it may force the serializer to terminate serialization
prematurely, and thus no complete serialization would be done.
</p>
- <p>Application shall query the serializer first, before set any
+ <p>Application shall query the serializer first, before set any
feature/mode(true, false), or be ready to catch exception if this
feature/mode is not supported by the serializer.
</p>
- <p>Application needs to clean up the filter, error handler and
+ <p>Application needs to release the filter, error handler and
format target objects created for the serialization.
</p>
Modified: xerces/c/trunk/doc/enumval.xml
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/enumval.xml?rev=697763&r1=697762&r2=697763&view=diff
==============================================================================
--- xerces/c/trunk/doc/enumval.xml (original)
+++ xerces/c/trunk/doc/enumval.xml Mon Sep 22 02:50:49 2008
@@ -21,7 +21,7 @@
<s1 title="Sample: EnumVal">
<s2 title="EnumVal">
- <p>EnumVal shows how to enumerate the markup decls in a DTD Grammar.</p>
+ <p>EnumVal shows how to enumerate the markup declarations in a DTD Grammar.</p>
<s3 title="Running EnumVal">
<p>This program parses the specified XML file, then shows how to
@@ -36,7 +36,7 @@
data structures.
</source>
<p>Here is a sample output from EnumVal</p>
-<source>cd &XercesC3InstallDir;-linux/samples/data
+<source>cd &XercesC3InstallDir;/samples/data
EnumVal personal.xml
ELEMENTS:
Modified: xerces/c/trunk/doc/faq-build.xml
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/faq-build.xml?rev=697763&r1=697762&r2=697763&view=diff
==============================================================================
--- xerces/c/trunk/doc/faq-build.xml (original)
+++ xerces/c/trunk/doc/faq-build.xml Mon Sep 22 02:50:49 2008
@@ -18,36 +18,13 @@
<!DOCTYPE faqs SYSTEM "sbk:/style/dtd/faqs.dtd">
-<faqs title="Building / Running FAQs">
-
- <faq title="Why do I get compilation error saying undeclared identifier or class undefined?">
-
- <q>Why do I get compilation error saying undeclared identifier or class undefined?</q>
-
- <a>
-
- <p>&XercesCName; &XercesC3Version; now supports C++ Namespace.</p>
-
- <p>If C++ Namespace is ENABLED, users' applications must
- namespace qualify all the &XercesCName; classes, data, and
- variables with <code>XERCES_CPP_NAMESPACE_QUALIFIER </code>
- or add the <code>XERCES_CPP_NAMESPACE_USE</code> clause.
- Users also need to ensure all forward declarations are
- properly qualified or scoped.
- </p>
-
- <p>See the Programming Guide <jump href="program-others-&XercesC3Series;.html#CPPNamespace">
- Using C++ Namespace</jump> for details.
- </p>
-
- </a>
- </faq>
+<faqs title="Building / Running &XercesCName;">
<faq title="Why do I get compilation error saying DOMDocument was declared twice using
- Microsoft Visual C++.Net?">
+ Microsoft Visual C++?">
<q>Why do I get compilation error saying DOMDocument was declared twice using
- Microsoft Visual C++.Net?</q>
+ Microsoft Visual C++?</q>
<a>
@@ -56,39 +33,16 @@
with the &XercesCName; &XercesC3Version; <code>&XercesC3Namespace;::DOMDocument</code>
and thus lead to the compilation errors.</p>
- <p> Qualifier the use of DOMDocument in your application explicitly e.g.
- <br/><br/><code>XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument * fDoc;</code><br/><br/>
- will eliminate these compilation problems.
+ <p>Qualifier the use of DOMDocument in your application explicitly e.g.,
+ <br/><br/><code>xercesc::DOMDocument* doc;</code><br/><br/>
+ will eliminate these compilation problems. Alternatively, you
+ may want to get rid of the <code>Msxml.h</code> header inclusion.
</p>
</a>
</faq>
- <faq title="Why do I get Internal Compiler Error when compiling &XercesCName; for a 64bit target with gcc?">
- <q>Why do I get Internal Compiler Error when compiling &XercesCName; for a 64bit target with gcc?</q>
- <a>
- <p>This is a compiler problem. Try turning off optimization to bypass the problem.</p>
- </a>
- </faq>
-
-
- <faq title="Building &XercesCName; with compiler GCC 2.7.x or 2.8.x gives problem, what's wrong?">
-
- <q>Building &XercesCName; with compiler GCC 2.7.x or 2.8.x gives problem, what's wrong?</q>
-
- <a>
- <p>Users using GCC 2.7.x or 2.8.x may have unsuccessful compile/link/run experience with
- &XercesCName;. There were issues related to templates and multi threaded exception
- handling with this old version GCC compiler.
- </p>
-
- <p>Please upgrade to at least GCC 2.95.2.
- </p>
-
- </a>
- </faq>
-
- <faq title="Why does my application give unresolved linking errors?">
+ <faq title="Why does my application have unresolved linking errors?">
<q>Why does my application give unresolved linking errors?</q>
@@ -98,59 +52,22 @@
<ol>
<li>Verify that you have specified the appropriate option and library path in the linker
command line</li>
- <li>If you're using the binary build of &XercesCName;, make sure that the OS and compiler are
- the same version as the ones used to build the binary. Different OS and
+ <li>If you're using the binary build of &XercesCName;, make sure that the CPU architecture, OS,
+ and compiler are
+ the same as the ones used to build the application. Different OS and
compiler versions might cause unresolved linking problems or compilation
errors. If the versions are different, rebuild the &XercesCName; library on
- your system before building your application. If you're using ICU (which is
- packaged with XML4C) you need to rebuild the compatible version of ICU
- first.</li>
- <li>Check that the library path is set properly and that the correct
- versions of <code>gmake</code> and <code>autoconf</code> are on your system.</li>
- <li>If C++ Namespace support is ENABLED (all the binary distributions of &XercesCName;
- &XercesC3Version; are built with C++ Namespace enabled), users' applications
- must namespace qualify all the &XercesCName; classes, data and variables.
- See the Programming Guide <jump href="program-others-&XercesC3Series;.html#CPPNamespace">
- Using C++ Namespace</jump> for details.</li>
- <li>If you are using Microsoft Visual Studio .NET 2003, 2005, or 2008, check that the
- option "Treat wchar_t as a built-in type" has been set to the same value
- used to build Xerces.</li>
+ your system before building your application.</li>
+ <li>If you are using Microsoft Visual Studio 2003 (7.1), 2005 (8.0), or 2008 (9.0),
+ check that the
+ "Treat wchar_t as a built-in type" option has been set to the same value as
+ used to build &XercesCName;. The binary distribution for Visual Studio 7.1 is
+ built with this option turned off. The binary distributions for Visual Studio 8.0
+ and 9.0 are built with this option turned on.</li>
</ol>
</a>
</faq>
- <faq title="Why do I get link error saying icudata library not found when building with ICU?">
-
- <q>Why do I get link error saying icudata library not found when building with ICU?</q>
-
- <a>
- <p>There is a bug in the Makefile of ICU 1.7, 1.8 and 1.8.1. The link created during
- ICU installation in $ICUROOT is, for example,
- </p>
-
- <p>icudata.so@ -> icudt17l.so
- </p>
-
- <p>instead of
- </p>
-
- <p>libicudata.so@ -> libicudt17l.so <br/>
- </p>
-
- <p>Therefore the -licudata doesn't work. To bypass the problem, please manually create the
- following link:
- </p>
-
- <p>libicudata.so@ -> libicudt17l.so
- </p>
-
- <p>This problem has been fixed in ICU 2.0.
- </p>
-
-
- </a>
- </faq>
-
<faq title="I cannot run the sample applications. What is wrong?">
<q>I cannot run the sample applications. What is wrong?</q>
@@ -158,209 +75,13 @@
<a>
<p>In order to run an application built using &XercesCProjectName; you must
- set up your path and library search path properly. In the stand-alone version
- from Apache, you must have the &XercesCName; runtime library available from
- your path settings.
- </p>
- <p>On Windows this library is called <code>&XercesC3WindowsDLL;.dll</code>
- which must be available from your <code>PATH</code> settings. (Note that there are
- separate debug and release dlls for Windows. The release dll is named
- <code>&XercesC3WindowsDLL;.dll</code>, and the debug dll
- is named <code>&XercesC3WindowsDLL;d.dll)</code>.
- </p>
- <p>On UNIX platforms the library is called &XercesC3UnixLib;.so.&XercesC3UnixSoName; (or
- &XercesC3UnixLib;&XercesC3UnixSoName;.so or &XercesC3UnixLib;.sl.&XercesC3UnixSoName;)
- which must be available from your <code>LD_LIBRARY_PATH</code>
- (or <code>LIBPATH</code> or <code>SHLIB_PATH</code>) environment variable.</p>
-
- <p>Thus, if you installed your binaries under <code>$HOME/fastxmlparser</code>, you need to point your library path to that directory.</p>
-
-<source>export LIBPATH=$LIBPATH:$HOME/fastxmlparser/lib # (AIX)
-export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$HOME/fastxmlparser/lib # (Solaris, Linux)
-export SHLIB_PATH=$SHLIB_PATH:$HOME/fastxmlparser/lib # (HP-UX)</source>
-
- <p>If you are using the XML4C parser from IBM, you will
- need to put in two additional DLLs. In the Windows build these are <code>icuuc*.dll</code> and <code>icudt*.dll</code> which must be available from your PATH settings. On UNIX, these
- libraries are called <code>libicuuc*.so</code> and <code>libicudt*.so</code> (or <code>.sl</code> for HP-UX or <code>.a</code> for AIX) which must be available from your library search path.</p>
-
- <p>If the parser is built with icu message loader (as mentioned above), or message
- catalog loader, you need an environment variable, XERCESC_NLS_HOME to point to
- the directory, &XercesC3SrcInstallDir;/msg, where the message files reside.
+ set up your path and library search path properly. For more information
+ refer to the <link idref="install-&XercesC3Series;">Installation instructions</link>.
</p>
</a>
</faq>
- <faq title="Why does my application crash on AIX when I run it under a
- multi-threaded environment?">
-
- <q>Why does my application crash on AIX when I run it under a
- multi-threaded environment?</q>
-
- <a>
-
- <p>AIX maintains two kinds of libraries on the system, thread-safe and
- non-thread safe. Multi-threaded libraries on AIX follow a different naming
- convention, Usually the multi-threaded library names are followed with "_r".
- For example, libc.a is single threaded whereas libc_r.a is multi-threaded.</p>
-
- <p>To make your multi-threaded application run on AIX, you <em>must</em>
- ensure that you do not have a "system library path" in your <code>LIBPATH</code>
- environment variable when you run the application. The appropriate
- libraries (threaded or non-threaded) are automatically picked up at runtime. An
- application usually crashes when you build your application for multi-threaded
- operation but don't point to the thread-safe version of the system libraries.
- For example, LIBPATH can be simply set as:</p>
-
-<source>LIBPATH=$HOME/<&XercesCProjectName;>/lib</source>
-
- <p>Where <&XercesCProjectName;> points to the directory where the
- &XercesCProjectName; application resides.</p>
-
- <p>If, for any reason unrelated to &XercesCProjectName;, you need to keep a
- "system library path" in your LIBPATH environment variable, you must make sure
- that you have placed the thread-safe path before you specify the normal system
- path. For example, you must place <ref>/lib/threads</ref> before
- <ref>/lib</ref> in your LIBPATH variable. That is to say your LIBPATH may look
- like this:</p>
-
-<source>export LIBPATH=$HOME/<&XercesCProjectName;>/lib:/usr/lib/threads:/usr/lib</source>
-
- <p>Where /usr/lib is where your system libraries are.</p>
-
- </a>
- </faq>
-
- <faq title="Why does my multi-threaded application crash on Solaris 2.6?">
-
- <q>Why does my multi-threaded application crash on Solaris 2.6?</q>
-
- <a>
-
- <p>The problem appears because the throw call on Solaris 2.6 is not
- multi-thread safe. Sun Microsystems provides a patch to solve this problem. To
- get the latest patch for solving this problem, go to
- <jump href="http://sunsolve.sun.com">SunSolve.sun.com</jump> and get the
- appropriate patch for your operating system. For Intel machines running
- Solaris, you need to get Patch ID 104678. For SPARC machines you need to get
- Patch ID #105591.</p>
-
- </a>
- </faq>
-
- <faq title="I just built my own application using the &XercesCName; parser. Why does it crash?">
-
- <q>I just built my own application using the &XercesCName; parser. Why does
- it crash?</q>
-
- <a>
-
- <p>In order to work with the &XercesCName; parser, you have to first
- initialize the XML subsystem. The most common mistake is to forget this
- initialization. Before you make any calls to &XercesCName; APIs, you must
- call XMLPlatformUtils::Initialize(): </p>
-
-<source>
-try {
- XMLPlatformUtils::Initialize();
-}
-catch (const XMLException& toCatch) {
- // Do your failure processing here
-}</source>
-
- <p>This initializes the &XercesCProjectName; system and sets its internal
- variables. Note that you must the include <code>xercesc/util/PlatformUtils.hpp</code> file for this to work.</p>
-
- </a>
- </faq>
-
- <faq title="Why does deleting a transcoded string result in assertion on windows?">
- <q>Why does deleting a transcoded string result in assertion on windows?</q>
- <a>
- <p>Both your application program and the &XercesCName; DLL must use the same *DLL* version of the
- runtime library. If either statically links to the runtime library, the
- problem will still occur.</p>
-
- <p>For example, for a Win32/VC6 build, the runtime library build setting MUST
- be "Multithreaded DLL" for release builds and "Debug Multithreaded DLL" for
- debug builds.</p>
-
- <p>Or for example for a Win32/BCB6 build, application need to switch to Multithreaded
- runtime to avoid such memory access violation.</p>
-
- <p>To bypass such problem, instead of calling operator delete[] directly, you can use the
- provided function XMLString::release to delete any string that was allocated by the parser.
- This will ensure the string is allocated and deleted by the same DLL and such assertion
- problem should be resolved.</p>
- </a>
- </faq>
-
- <faq title="Can't debug into the &XercesCName; DLL with the MSVC debugger">
-
- <q> The libs/dll's I downloaded keep me from using the debugger in VC6.0. I
- am using the 'D', debug versions of them. "no symbolic information found" is
- what it says. Do I have to compile everything from source to make it work?</q>
-
- <a>
-
- <p>Unless you have the .pdb files, all you are getting with the debug
- library is that it uses the debug heap manager, so that you can compile your
- stuff in debug mode and not be dangerous. If you want full symbolic info for
- the &XercesCName; library, you'll need the .pdb files, and to get those, you'll
- need to rebuild the &XercesCName; library.</p>
-
- </a>
- </faq>
-
- <faq title="First-chance exception in Microsoft debugger">
-
- <q>First-chance exception in DOMPrint.exe (KERNEL32.DLL): 0xE06D7363:
- Microsoft C++ Exception. I am always getting this message when I am using the
- parser. My programs are terminating abnormally. Even the samples are giving
- this exception. I am using Visual C++ 6.0 with latest service pack
- installed.</q>
-
- <a>
-
- <p>&XercesCName; uses C++ exceptions internally, as part of its normal
- operation. By default, the MSVC debugger will stop on each of these with the
- "First-chance exception ..." message.</p>
-
- <p>To stop this from happening do this:</p>
-
- <ul>
- <li>start debugging (so the debug menu appears)</li>
- <li>from the debug menu select "Exceptions"</li>
- <li>from the box that opens select "Microsoft C++ Exception" and set it
- to "Stop if not handled" instead of "stop always".</li>
- </ul>
-
- <p>You'll still land in the debugger if your program is terminating
- abnormally, but it will be at your problem, not from the internal &XercesCName;
- exceptions.</p>
-
- </a>
- </faq>
-
- <faq title="Cannot load message domain, Xerces Panic Error">
- <q>Cannot load message domain, Xerces Panic Error?</q>
- <a>
- <p>If the parser is built with icu message loader (like IBM XML4C binaries),
- you need to make sure that the message library (for the exact name see
- <jump href="faq-distrib-&XercesC3Series;.html#faq-2">FAQ: Which DLLs do I need to distribute
- with my application?</jump>) is located in a directory which is on the library search path.
- Or the message resource file, XercesMessages_en_US.res, is in the directory given at the call to
- XMLPlatformUtils::Initialize(), or is located in the directory pointed to by the environment variable
- XERCESC_NLS_HOME, or at &XercesC3SrcInstallDir;/msg.
- </p>
- <p>If the parser is built with iconv message loader, you need to make sure that the message
- catalog file, XercesMessages_en_US.cat, is in the directory given at the call to XMLPlatformUtils::Initialize(),
- or is located in the directory pointed to by the environment variable XERCESC_NLS_HOME, or
- at &XercesC3SrcInstallDir;/msg.
- </p>
-
- </a>
- </faq>
<faq title="Why my document is valid on some platforms while invalid on others">
<q>Why my document is valid on some platform while invalid on others?</q>
@@ -372,12 +93,12 @@
zero to the said data if underflow is found.
</p>
<p>The threshold, where the strtod() decides if an underflow occurs, varies on
- platforms. On windows, it is roughly the order of e-308, on Linux, e-325, and
- on AIX, HP and Solaris, e-324.
+ platforms. On Windows, it is roughly the order of e-308, on Linux, e-325, and
+ on AIX, HP-UX and Solaris, e-324.
</p>
<p>So in an instance document, a data of value 1.0e-310 from a type with minExclusive 0,
is considered invalid on windows (since it is converted to 0 and therefore violates
- the minExclusive constraint), but valid on other unix platforms (since it remains
+ the minExclusive constraint), but valid on other Unix platforms (since it remains
the original value).
</p>
<p>The discussion above applies to data in xsd file as well.
@@ -385,39 +106,4 @@
</a>
</faq>
- <faq title="How do I regenerate the documentation?">
- <q>How do I regenerate the documentation?</q>
- <a>
- <p>To use the internal XML based application that creates the
- documentation, you must have a Java Virtual machine installed
- on your system. The application itself, written in Java, is
- provided in the &XercesC3ToolsInstallDir; distribution. You
- should copy its contents into your <code>&XercesC3SrcInstallDir;</code>
- directory.</p>
-
- <p>To regenerate the documentation, go to the &XercesC3SrcInstallDir;/tools
- directory and start <code>createdocs.sh</code> (for Unix) or
- <code>createdocs.bat</code> (for Windows). The result can be
- found in directory <code>&XercesC3SrcInstallDir;/doc/html</code>.</p>
-
- <p>
- To regenerate the API documentation, you need to have at least
- <jump href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</jump>
- installed on your system.</p>
-
- <p>If you want the API documentation to
- contain dependency graphs, you also need to have <jump
- href="http://www.research.att.com/sw/tools/graphviz/">GraphViz</jump> installed on
- your system.</p>
-
- <p>If you do not have GraphViz, or do not want to use it, you
- have to edit file <code>&XercesC3SrcInstallDir;/doc/Doxyfile</code> and
- change <code>HAVE_DOT = YES</code> into <code>HAVE_DOT = NO</code>.</p>
-
- <p>To actually regenerate the API documentation, go to directory
- <code>&XercesC3SrcInstallDir;/doc/</code> and start Doxygen. The result can be
- found in directory <code>&XercesC3SrcInstallDir;/doc/html/apiDocs</code>.</p>
- </a>
- </faq>
-
</faqs>
Modified: xerces/c/trunk/doc/faq-contributing.xml
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/faq-contributing.xml?rev=697763&r1=697762&r2=697763&view=diff
==============================================================================
--- xerces/c/trunk/doc/faq-contributing.xml (original)
+++ xerces/c/trunk/doc/faq-contributing.xml Mon Sep 22 02:50:49 2008
@@ -18,20 +18,20 @@
<!DOCTYPE faqs SYSTEM "sbk:/style/dtd/faqs.dtd">
-<faqs title='FAQs for Contributors'>
+<faqs title='Contributing to &XercesCName;'>
<faq title="Submitting Patches">
<q>I have a problem and I think I know how to fix it. How can I
- communicate my ideas to the Xerces team?
+ communicate my ideas to the &XercesCName; team?
</q>
<a>
<p>To maximize the probability that your ideas will grab the
- attention of one of the Xerces developers who knows about the
+ attention of one of the &XercesCName; developers who knows about the
area of the parser you're concerned with, you should follow
these steps:
</p>
<ol>
- <li>Check out and build the most recent Xerces code. For
- instructions on how to do this, see <jump href="&RepURI;">Xerces-C++
+ <li>Check out and build the most recent &XercesCName; code. For
+ instructions on how to do this, see <jump href="&RepURI;">&XercesCName;
Repository Information</jump>. If you do this, you can confirm that your
bug still exists and has not been fixed since the last
release.
@@ -44,10 +44,10 @@
Describe why your solution works.
</li>
<li>
- Prepare a patch to fix Xerces code. To do this, when you
+ Prepare a patch to fix &XercesCName; code. To do this, when you
have applied your changes to a local copy of the most
- recent xerces source code, do <code>svn diff file</code>
- for each file you've changed.
+ recent &XercesCName; source code, do <code>svn diff file</code>
+ for each file you have changed.
Keep in mind the coding guidelines for &XercesCName; as
described below.
</li>
@@ -57,9 +57,9 @@
apply.
</li>
<li>
- Submit a bug report to the Xerces-C++ bug database as
+ Submit a bug report to the &XercesCName; bug database as
described on the <jump href="&BugURI;">Bug-Reporting</jump> page.
- Pick the product "Xerces-C++" (remembering to attach your patches
+ Pick the product "&XercesCName;" (remembering to attach your patches
and test code) or, if you think your patch might need some discussion,
post it to the <jump href="&MailURI;">developer mailing list</jump>.
</li>
@@ -80,11 +80,9 @@
<ul>
<li>We don't try to enforce binary compatibility between new versions and releases.</li>
<li>New versions and releases will be delivered when a certain number of bug fixes/new features have been added
- (as decided by the committers) or when a dependent product, such as XALAN, wants to ship a new release that uses new Xerces features.</li>
+ (as decided by the committers).</li>
<li>New modification levels will almost never be issued, the only exception is a showstopper bug encountered within
- a release. if no commit has been made on the trunk which would result in binary incompatibility, and no commit has been made that is not thought to
- be release-quality, then the modification release can be created by tagging the trunk; otherwise, a branch (new release) will need to be created and the show stopper
- fixed there.</li>
+ a release.</li>
<li>Any normal bug is fixed only in the HEAD branch (latest development code).</li>
</ul>
@@ -108,14 +106,14 @@
<li>Change the order of data members in the class declaration (other than STATIC members).</li>
<li>Change the class hierarchy (other than adding new classes).</li>
</ul>
- <li>Methods that are deprecated should be marked with the JavaDoc tag @deprecated in the header file.</li>
+ <li>Methods that are deprecated should be marked with the Doxygen tag @deprecated in the header file.</li>
</ul>
<li>x.x.x to x.y.z: the API is source code compatible but not binary compatible (a recompilation of an application that uses the public headers of &XercesCName; should work).</li>
<ul>
<li>This means that to maintain release to release source code compatibility the signature of public methods can only be
changed by adding default parameters.</li>
<li>Signatures of private and protected methods can be changed and/or removed.</li>
- <li>Methods that are deprecated should be marked with the JavaDoc tag @deprecated in the header file.</li>
+ <li>Methods that are deprecated should be marked with the Doxygen tag @deprecated in the header file.</li>
</ul>
<li>x.x.x to a.b.c: the API may not be source code compatible and is not binary compatible (a recompilation of an application using &XercesCName; may fail).</li>
<ul>
@@ -161,15 +159,15 @@
<li>Use a tab size of 4 and insert them as spaces instead of keeping tabs.</li>
<li>The code is written to be platform independent. Platform specific code should only be in the
- util/Platforms, util/Transcoders, util/MsgLoaders, and util/NetAccessors directories.</li>
+ util/FileManagers, util/MutexManagers, util/Transcoders, util/MsgLoaders, and util/NetAccessors directories.</li>
<li>The header file name and the source file name should both be named corresponding to the primary
class they contain. For example class StringPool should be in the header file StringPool.hpp and in
the source file StringPool.cpp.</li>
- <li>In general, code should be documented with comments. Use JavaDoc tags to describe methods.</li>
+ <li>In general, code should be documented with comments. Use Doxygen tags to describe methods.</li>
- <li>The naming convention for ENUMS should be choosen to be unique and descriptive
+ <li>The naming convention for enumerations should be chosen to be unique and descriptive
(i.e. INVALID or UNKNOWN) to avoid colliding with predefined macros in other
products. The current style of using ALL CAP enums should be phased out with
Mixed Case instead, except for names specified in standards (for example, TEXT_NODE
@@ -178,159 +176,4 @@
</ol>
</a>
</faq>
-
- <faq title="Release Preparation">
- <q>How does one do a Xerces-C release?
- </q>
- <a>
- <p>Just follow these steps:
- </p>
- <ol>
- <li>Update the release information in the following files:<br/>
-
- <code>projects/Win32/VC6/xerces-all/XercesLib/XercesLib.dsp</code>
- <code>projects/Win32/VC6/xerces-all/XercesLib/XercesLib.mak</code>
- <code>projects/Win32/VC7.1/xerces-all/XercesLib/XercesLib.vcproj</code>
- <code>projects/Win32/VC8/xerces-all/XercesLib/XercesLib.vcproj</code>
- <br/>
- <code>projects/MacOS/Xcode/XercesLib/Info-XercesLib.plist</code>
- <code>scripts/packageBinaries.pl</code>
- <br/>
- <code>src/xercesc/configure.in</code>
- <br/>
- <code>src/xercesc/com/xml4com.idl</code>
- <code>src/xercesc/util/Platforms/Win32/Version.rc</code>
- <code>src/xercesc/util/XercesVersion.hpp</code>
- <code>src/xercesc/util/MsgLoaders/ICU/ICUMsgLoader.cpp</code>
- <code>src/xercesc/util/MsgLoaders/ICU/resources/res-file-list-unix.txt</code>
- <code>src/xercesc/util/MsgLoaders/ICU/resources/res-file-list-wins.txt</code>
- <code>src/xercesc/util/MsgLoaders/ICU/resources/res-file-list.txt</code>
- <br/>
- <code>version.incl</code>
- <br/>
- <code>xerces-c.spec</code>
- <br/>
- <code>doc/Doxyfile</code>
- <br/>
- <code>doc/style/dtd/entities.ent</code>
-
- </li>
-
- <li>Update the release documentation in the following files:<br/>
- <code>doc/migration.xml</code>
- <br/>
- <code>doc/migration_archive.xml</code>
- <br/>
- <code>doc/releases.xml</code>
- <br/>
- <code>doc/releases_archive.xml</code>
- <br/>
- <code>doc/feedback.xml</code>
- <br/>
- <code>credits.txt</code>
- </li>
-
- <li>Build and test the release on the platforms that binaries are being produced for.
- <br/>The source packages should be named xerces-c-src_x_y_z.zip/tar.gz. In order for
- rpm to work correctly the actual directory containing the source that will be
- zipped/tarred up should be xerces-c-src_x_y_z.
- <br/>The binary packages should be named xerces-c_x_y_z.zip/tar.gz.
- </li>
-
- <li>
- Generate PGP/GNUPG signatures for dist binaries and source packages.<br/>
- That is, add public key to the SVN <code>KEYS</code> file if necessary
- and make sure public key is on a key server or two. You will also need
- to update the KEYS file on the website:
- <br/>
- <code>scp KEYS username@minotaur.apache.org:/www/www.apache.org/dist/xml/xerces-c</code>
- </li>
-
- <li>Upload the binaries and signatures to the dist section of
- the website, from the directory containing the binaries:
- <br/>
- <code>scp * username@minotaur.apache.org:/www/www.apache.org/dist/xml/xerces-c/binaries</code>
- </li>
-
- <li>Upload the source packages and signatures to the dist section of
- the website, from the directory containing the sources:
- <br/>
- <code>scp * username@minotaur.apache.org:/www/www.apache.org/dist/xml/xerces-c/source</code>
- </li>
-
- <li>Logon to minotaur.
- <br/>
- <code>ssh minotaur.apache.org</code>
- </li>
-
- <li>
- Generate md5 signatures for dist binaries and sources on minotaur using:
- <br/>
- <code>md5 -r xerces-c_x_y_z.tar.gz > xerces-c_x_y_z.tar.gz.md5</code>
- </li>
-
- <li>Make sure the packages have the correct permissions (chmod 664*).</li>
-
- <li>Remove the previous release source and binaries (double checked that they
- are archived) in the source and binaries directories. Remove the links in the
- /www/www.apache.org/dist/xml/xerces-c directory (*current* that were pointing
- at the old sources in the source directory).
- </li>
-
- <li>Create the new links for the source (do for each file including asc and md5):
- <br/>
- <code>ln -s ./source/xerces-c-src_x_y_z.zip xerces-c-current.zip</code>
- </li>
-
- <li>Go to the archive, /www/archive.apache.org/dist/xml/xerces-c and create a
- directory for the previous release (Xerces-C_x_y_a). Move over the contents of
- the source and binaries directories to this new directory. Remove the *current* links.
- </li>
-
- <li>Update the archive.
- <br/>
- <code>cd /www/www.apache.org/dist/xml/xerces-c</code>
- <br/>
- <code>cp -R * /www/archive.apache.org/dist/xml/xerces-c</code>
- </li>
-
- <li>Verify that the downloads are available. Note that it can take up to 24 hours
- to for the mirrors to be updated.
- </li>
-
- <li>Update the website by taking a binary package and extracting the doc/html directories.
- The web pages are stored in /www/xml.apache.org/xerces-c. You will also need to update
- the documentation pdf in the pdf directory (which has both a pdf and pdf.tar.gz). Recommend
- copying the new documentation over the existing files. Be sure to change the permissions
- on the files and directories:
- <br/>
- <code>find . -type f -exec chmod 664 {} ;</code>
- <br/>
- <code>find . -type d -exec chmod 775 {} ;</code>
- <br/>If the binaries are for different platforms you may also need to update the
- download.html file to point to the new binaries.
- <br/>Verify that the website is updated (may take a while to be refreshed on the
- real webserver).
- </li>
-
- <li>Send out an announcement e-mail to the c-dev@xerces.apache.org and c-users@xerces.apache.org mailing lists
- and cc the announcements@xml.apache.org and pmc@xerces.apache.org mailing lists.
- </li>
-
- <li>Update the list of versions in Jira for xerces-c.
- </li>
-
- <li>Tag the release in SVN
- (tags for releases usually have the form Xerces-C_x_y_z
- where x.y.z is the Xerces-C release number) by doing:
- <br/>
- <code>svn copy https://svn.apache.org/repos/asf/xerces/c \
- https://svn.apache.org/repos/asf/xerces/c/tags/Xerces-C_x_y_z \
- -m "Tagging the Xercesc x.y release" </code>
- <br/>For more information on tagging see http://svnbook.red-bean.com/nightly/en/svn.branchmerge.tags.html.
- </li>
- </ol>
- </a>
- </faq>
-
</faqs>
Modified: xerces/c/trunk/doc/faq-distrib.xml
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/faq-distrib.xml?rev=697763&r1=697762&r2=697763&view=diff
==============================================================================
--- xerces/c/trunk/doc/faq-distrib.xml (original)
+++ xerces/c/trunk/doc/faq-distrib.xml Mon Sep 22 02:50:49 2008
@@ -20,125 +20,58 @@
<faqs title="Distributing &XercesCName;">
- <faq title="What are the differences between Xerces-C and XML4C?">
- <q>What are the differences between Xerces-C and XML4C?</q>
+ <faq title="Can I use &XercesCName; in my product?">
+ <q>Can I use &XercesCName; in my product?</q>
<a>
+ <p>Most likely yes. &XercesCName; is distributed under
+ the terms of the Apache Software License version 2.0
+ which is a fairly permissive license. In particular,
+ it allows you to distribute your application in
+ binary form without requiring you to also release
+ the source code. Read the license agreement for more
+ information and if you still have further questions,
+ then please address them to the
+ <jump href="&MailURI;">&XercesCName; user mailing list</jump>.</p>
- <p>By default &XercesCName; has intrinsic support for ASCII, UTF-8, UTF-16
- (Big/Small Endian), UCS4 (Big/Small Endian), EBCDIC code pages IBM037, IBM1047 and
- IBM1140 encodings, ISO-8859-1 (aka Latin1) and Windows-1252. This means that it can parse
- input XML files in these above mentioned encodings.</p>
-
- <p>However, if you wish to parse XML files in any other
- encodings, say in Shift-JIS, Big5 etc., then you will
- need to build &XercesCName; with the <jump
- href="http://icu-project.org/">
- International Components for Unicode (ICU)</jump> library.</p>
-
-
- <p><jump href="http://alphaworks.ibm.com/tech/xml4c">XML4C</jump>
- is simply &XercesCName; built with ICU.</p>
</a>
</faq>
- <faq title="Which DLL's do I need to distribute with my application?">
- <q>Which DLL's do I need to distribute with my application?</q>
+ <faq title="Which files do I need to distribute with my application?">
+ <q>Which files do I need to distribute with my application?</q>
<a>
-
<p>You only need to distribute <em>one</em> file:<br></br>
- &XercesC3WindowsDLL;.dll for Windows, or<br/>
- &XercesC3UnixLib;&XercesC3UnixSoName;.a for AIX, or<br/>
- &XercesC3UnixLib;.so.&XercesC3UnixSoName; for Solaris/Linux, or<br/>
- &XercesC3UnixLib;.sl.&XercesC3UnixSoName; for HP-UX on PA-RISC, or<br/>
- &XercesC3UnixLib;.so.&XercesC3UnixSoName; for HP-UX on IA64, or<br/>
- &XercesC3UnixLib;.&XercesC3UnixSoName;.dylib for Mac OS X.
+ &XercesC3WindowsDLL;.dll for Windows<br/>
+ &XercesC3UnixLib;-&XercesC3UnixSoVersion;.a for AIX<br/>
+ &XercesC3UnixLib;-&XercesC3UnixSoVersion;so. for Solaris/Linux<br/>
+ &XercesC3UnixLib;-&XercesC3UnixSoVersion;.sl for HP-UX on PA-RISC<br/>
+ &XercesC3UnixLib;-&XercesC3UnixSoVersion;.so for HP-UX on IA64<br/>
+ &XercesC3UnixLib;-&XercesC3UnixSoVersion;.dylib for Mac OS X
</p>
- <p>However, if you are using the ICU transcoder then in
- <em>addition</em> to the library file
- mentioned above, you also need to ship:</p>
-
- <ol>
- <li><em>ICU shared library file</em>:<br></br>
- icuuc*.dll for Windows, or<br></br>
- libicuuc*.a for AIX, or<br></br>
- libicuuc*.so for Solaris/Linux, or<br></br>
- libicuuc*.sl for HP-UX on PA-RISC, or<br></br>
- libicuuc*.so for HP-UX on IA64, or<br></br>
- libicuuc*.dylib for Mac OS X.</li>
-
- <li><em>ICU converter data shared library file:</em><br></br>
- icudt*.dll for Windows, or<br></br>
- libicudt*.a for AIX, or<br></br>
- libicudt*.so for Solaris/Linux, or<br></br>
- libicudt*.sl for HP-UX on PA-RISC, or<br></br>
- libicudt*.so for HP-UX on IA-64, or<br></br>
- libicudt*.dylib for Mac OS X.</li>
-
- <li><em>The &XercesCName; Message file:</em><br></br>
- XercesMessages*.dll for Windows, or<br></br>
- libXercesMessages*.a for AIX, or<br></br>
- libXercesMessages*.so for Solaris/Linux, or<br></br>
- libXercesMessages*.sl for HP-UX on PA-RISC, or<br></br>
- libXercesMessages*.so for HP-UX on IA64, or<br></br>
- libXercesMessages*.dylib for Mac OS X.</li>
- </ol>
- </a>
- </faq>
-
- <faq title="How do I package the sources to create a binary drop?">
+ <p>Note, however, that if you built &XercesCName; with dependencies
+ on other libraries (e.g., ICU for transcoder support or libcurl
+ for net accessor support) then you will need to ship those
+ libraries as well.</p>
- <q>How do I package the sources to create a binary drop?</q>
-
- <a>
- <p>You have to first compile the sources inside your IDE to
- create the required DLLs and EXEs. Then you need to copy
- over the binaries to another directory for the binary
- drop. A perl script has been provided to give you a jump
- start. You need to install perl on your machine for the script to work.
- If you have changed your source tree, you have to modify the script to suit
- your current directory structure. To invoke the
- script, go to the \<&XercesCProjectName;>\scripts directory, and type:</p>
-<source>perl packageBinaries.pl</source>
-
- <p>You will get a message that somewhat looks like this (changes always happen,
- we are evolving you see!): </p>
-
-<source>Usage is: packageBinaries <options>
-options are: -s <source_directory>
- -o <target_directory>
- -c <C compiler name> (e.g. gcc or xlc_r)
- -x <C++ compiler name> (e.g. g++ or xlC_r)
- -m <message loader> can be 'inmem', 'icu' or 'iconv'
- -n <net accessor> can be 'fileonly' or 'libcurl'
- -t <transcoder> can be 'icu' or 'native'
- -r <thread option> can be 'pthread' or 'dce' (only used on HP-11)
- -h to get help on these commands
-Example: perl packageBinaries.pl -s$HOME/&XercesC3SrcInstallDir;
- -o$HOME/&XercesC3InstallDir;
- -cgcc -xg++ -minmem
- -nfileonly -tnative</source>
-
- <p>Make sure that your compiler can be invoked from the command line and
- follow the instructions to produce a binary drop.</p>
+ <p>You can also link your application to a static version
+ of the &XercesCName; library in which case you won't need
+ to distribute any extra libraries.</p>
</a>
</faq>
- <faq title="I do not see binaries for my platform. When will they be available?">
+ <faq title="I do not see a binary for my platform. When will it be available?">
- <q>I do not see binaries for my platform. When will they be available?</q>
+ <q>I do not see a binary for my platform. When will it be available?</q>
<a>
- <p>The reason why you see binaries only for some specific
+ <p>The reason why you see binaries only for some specific
platforms is that we have had the maximum requests for
them. Moreover, we have limited resources and hence cannot
publish binaries for every platform. If you wish to
contribute your time and effort in building binaries for a
specific platform/environment then please send a mail to the
- <jump href="&MailURI;">&XercesCName; developer mailing list</jump>.
- We can definitely use any extra help in this open source
- project</p>
+ <jump href="&MailURI;">&XercesCName; developer mailing list</jump>.</p>
</a>
</faq>
@@ -148,14 +81,13 @@
<q>When will a port to my platform be available?</q>
<a>
- <p>We would like to see &XercesCProjectName; ported to as
- many platforms as there are. Again, due to limited resources
- we cannot do all the ports. We will help you make this port
- happen. Here are some <jump
+ <p>We would like to see &XercesCName; ported to as
+ many platforms as practical. However, due to limited resources
+ we cannot do all the ports. Here are the <jump
href="program-others-&XercesC3Series;.html#PortingGuidelines">Porting
Guidelines</jump>.</p>
- <p>We strongly encourage you to submit the changes that
+ <p>We encourage you to submit the changes that
are required to make it work on another platform. We will
incorporate these changes in the source code base and make
them available in the future releases.</p>
@@ -165,82 +97,4 @@
.</p>
</a>
</faq>
-
-
- <faq title="How can I port &XercesCProjectName; to my favourite platform?">
- <q>How can I port &XercesCProjectName; to my favourite platform?</q>
- <a>
- <p>Here are some <jump
- href="program-others-&XercesC3Series;.html#PortingGuidelines">Porting
- Guidelines</jump>.</p>
- </a>
- </faq>
-
-
-
- <faq title="What application do you use to create the documentation?">
- <q>What application do you use to create the documentation?</q>
- <a>
- <p>We have used an internal XML based application to create the
- documentation. The documentation files are all written in XML and the
- application, internally codenamed StyleBook, makes use of XSL to transform
- it into an HTML document that you are seeing right now.
- It is currently available on the
- <jump href="http://xml.apache.org/">Apache</jump> open source website as
- <jump href="http://xml.apache.org/cocoon/index.html">Cocoon</jump>.</p>
-
- <p>The API documentation is generated using
- <jump href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</jump> and
- <jump href="http://www.research.att.com/sw/tools/graphviz/">GraphViz</jump>.</p>
-
- <p>See <jump href="faq-build-&XercesC3Series;.html#faq-18">
- FAQ: Regenerating (API) documentation?</jump></p>
-
- </a>
- </faq>
-
-
- <faq title="Can I use &XercesCProjectName; in my product?">
- <q>Can I use &XercesCProjectName; in my product?</q>
- <a>
- <p>Yes! Read the license agreement first and if you still
- have further questions, then please address them to the
- <jump href="&MailURI;">&XercesCName; user mailing list</jump>.</p>
-
- </a>
-</faq>
-
-
- <faq title="How do I uninstall &XercesCName;?">
- <q>How do I uninstall &XercesCName;?</q>
- <a>
- <p>&XercesCName; only installs itself in a single directory and does not
- set any registry entries. Thus, to uninstall, you only need to remove the
- directory where you installed it, and all &XercesCName; related files will be
- removed.</p>
- </a>
- </faq>
- <faq title="I am getting a tar checksum error on Solaris. What's the problem?">
- <q>I am getting a tar checksum error on Solaris. What's the problem?</q>
- <a>
- <p>The problem is caused by a limitation in the original tar spec, which
- prevented it from archiving files with long pathnames. Unfortunately,
- various current versions of tar use different extensions for eliminating
- this restriction which are incompatible with each other (or they do not
- remove the restriction at all). Rather than altering the pathnames for
- the &XercesCName; package, which would make them compatible with the original
- tar spec but make it more difficult to know what was where, it was
- decided to use GNU tar (gtar), which handles arbitrarily long pathnames
- and is freely available on every platform on which &XercesCName; is
- supported. If you don't already have GNU tar installed on your system,
- you can obtain it from the Free Software Foundation
- <jump href="http://www.gnu.org/software/tar/tar.html">
- http://www.gnu.org/software/tar/tar.html</jump>. For additional
- background information on this problem, see the online manual
- <jump href="http://www.gnu.org/manual/tar/html_node/tar_117.html#SEC112">
- GNU tar and POSIX tar </jump> for the utility.
- </p>
- </a>
- </faq>
</faqs>
-
Modified: xerces/c/trunk/doc/faq-other.xml
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/faq-other.xml?rev=697763&r1=697762&r2=697763&view=diff
==============================================================================
--- xerces/c/trunk/doc/faq-other.xml (original)
+++ xerces/c/trunk/doc/faq-other.xml Mon Sep 22 02:50:49 2008
@@ -19,93 +19,23 @@
<!DOCTYPE faqs SYSTEM "sbk:/style/dtd/faqs.dtd">
<faqs title="Other &XercesCName; Questions">
- <faq title="Are the Xerces parsers Year-2000-compliant?">
- <q>Are the Xerces parsers Year-2000-compliant?</q>
- <a>
- <p>Yes, Xerces-J and Xerces-C are Year 2000 compliant.
- They do not currently use any dates at all (at least until the XML
- Schema date datatypes are fully supported). However, you may still
- have Y2K problems if the underlying OS or Java implementation has
- problems with dates past year 2000 (e.g. OS calls which accept or
- return year numbers).</p>
- <p>Most (UNIX) systems store dates internally as signed 32-bit
- integers which contain the number of seconds since 1st January 1970,
- so the magic boundary to worry about is the year 2038 and not 2000.
- But modern operating systems shouldn't cause any trouble at all.</p>
-
- <p>The Apache Xerces project is an open-source software product
- of the Apache Software Foundation. The project and the Foundation
- cannot and does not offer legal assurances regarding any suitability
- of the software for your application. There are several commercial
- support organizations and derivative products available that may be
- able to certify the software and provide you with any assurances you
- may require (IBM's Websphere product is one of them).</p>
- <p>The Apache HTTP server software is distributed with the following
- disclaimer, found in the software license: </p>
-<source>THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
-WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
-OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
-ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
-USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
-OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGE.</source>
- </a>
- </faq>
-
<faq title="How do I determine the version of &XercesCName; I am using?">
<q>How do I determine the version of &XercesCName; I am using?</q>
<a>
-
<p>The version string for &XercesCName; is in one of the header files. Look
inside the file <code>src/xercesc/util/XercesVersion.hpp</code> or, in the binary distribution,
look in <code>include/xercesc/utils/XercesVersion.hpp</code>. </p>
<p>If you don't have the header files, you have to find the version
information from the shared library name. On Windows right click on
- the DLL name &XercesC3WindowsDLL;.dll in the bin directory and look up
- properties. The version information may be found on the Version tab.</p>
+ the DLL name in the bin directory and look up
+ properties. The version information can be found in the Version tab.</p>
- <p>On AIX, just look for the library name &XercesC3UnixLib;&XercesC3UnixSoName;.a (or
- &XercesC3UnixLib;.so.&XercesC3UnixSoName; on Solaris/Linux/IA64 HP-UX
- and &XercesC3UnixLib;.sl.&XercesC3UnixSoName; on PA-RISC HP-UX). The
- version number is indicated in the name of the library.</p>
+ <p>On UNIX/Linux/Mac OS X platforms the version is
+ embedded into the library name.</p>
</a>
</faq>
- <faq title="I can't use C++. Do you have a Java version?">
-
- <q>I can't use C++. Do you have a Java version?</q>
-
- <a>
-
- <p>Yes. The Xerces family of products also has a Java version. More
- information is available at:
- <jump href="http://xerces.apache.org/xerces2-j/index.html">
- http://xerces.apache.org/xerces2-j/index.html</jump></p>
-
- </a>
- </faq>
-
-
- <faq title="Where can I find additional information on XML?">
-
- <q>Where can I find additional information on XML?</q>
-
- <a>
-
- <p>The Web. <jump href="http://www.oasis-open.org/cover/xml.html">
- http://www.oasis-open.org/cover/xml.html</jump> is an excellent place to start,
- with links to overviews, FAQs, specifications, industry news, applications and
- other software, related standards, etc.</p>
-
- </a>
- </faq>
-
<faq title="Is there any kind of support available for &XercesCName;?">
<q>Is there any kind of support available for &XercesCName;?</q>
<a>
@@ -114,9 +44,7 @@
<p>Every volunteer project obtains its strength from the people involved in
it. Mailing lists provide a simple and effective communication mechanism. You
are welcome to join any of these mailing lists (or all of them if you wish).
- You can choose to lurk, or to actively participate. It is up to you. Before you
- join these lists, you should look over the resources in the Reference Library
- section</p>
+ You can choose to lurk, or to actively participate. It is up to you.</p>
<p>Instructions for subscribing as well as archives are available at the
<jump href="&MailURI;">&XercesCName; mailing lists</jump> page.</p>
@@ -134,53 +62,4 @@
</a>
</faq>
- <faq title="I have a patch to the &XercesCName; source code. How do I submit it?">
- <q>I have a patch to the &XercesCName; source code. How do I submit it?</q>
- <a>
- <p>Mail it to the <jump href="&MailURI;">&XercesCName;
- development mailing list</jump>. Its also a good idea to add a report to
- <jump href="&BugURI;">&XercesCName; bug database</jump> to track the issue.
- There are no set rules about
- how or what must be included -- if you have fixed a problem or enhanced the code
- in some way, we really would like to get your changes, and will take them in
- any reasonable form.</p>
-
- <p>Generally a diff of the changed files against the current sources from the
- <jump href="&RepURI;">&XercesCName; repository</jump> is good, along with some kind of
- description of what the change is. (Working with the current sources is important!)</p>
- </a>
- </faq>
-
- <faq title="Where can I get predefined character entity definitions?">
-
- <q>Where can I get predefined character entity definitions??</q>
-
- <a>
-
- <p> Download <jump href="http://www.w3.org/TR/xhtml1/xhtml1.zip">
- http://www.w3.org/TR/xhtml1/xhtml1.zip. </jump></p>
-
- </a>
- </faq>
-
- <faq title="Does &XercesCName; support XPath?">
-
- <q> Does &XercesCName; support XPath?</q>
-
- <a>
-
- <p>The &XercesCName; &XercesC3Version; only has partial XPath implementation
- for the purposes of handling Schema identity constraints.
- The same engine is made available through the DOMDocument::evaluate API to
- let the user perform simple XPath queries involving DOMElement nodes only,
- with no predicate testing and allowing the "//" operator only as the initial
- step; for full XPath support, you can refer to the
- <jump href="http://xqilla.sourceforge.net">XQilla</jump> and
- <jump href="http://xml.apache.org/xalan-c/overview.html">Apache Xalan C++</jump>
- Open Source projects.
- </p>
-
- </a>
- </faq>
-
</faqs>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xerces.apache.org
For additional commands, e-mail: commits-help@xerces.apache.org