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/02/25 16:35:11 UTC
svn commit: r630879 [2/4] - in /xerces/c/trunk/doc: ./ html/ html/apiDocs-3/
html/apiDocs/ style/dtd/ style/graphics/ style/resources/ style/stylesheets/
Modified: xerces/c/trunk/doc/faq-contributing.xml
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/faq-contributing.xml?rev=630879&r1=630878&r2=630879&view=diff
==============================================================================
--- xerces/c/trunk/doc/faq-contributing.xml (original)
+++ xerces/c/trunk/doc/faq-contributing.xml Mon Feb 25 07:35:02 2008
@@ -31,15 +31,14 @@
</p>
<ol>
<li>Check out and build the most recent Xerces code. For
- instructions on how to do this, see <jump
- href="http://xml.apache.org/svn.html">Apache XML Project Subversion
- Information</jump>. If you do this, you can confirm that your
+ instructions on how to do this, see <jump href="&RepURI;">Xerces-C++
+ Repository Information</jump>. If you do this, you can confirm that your
bug still exists and has not been fixed since the last
release.
</li>
<li>
Write up your bug report as per the instructions described in
- the <jump href="bug-report.html">Bug-Reporting</jump> page.
+ the <jump href="&BugURI;">Bug-Reporting</jump> page.
</li>
<li>
Describe why your solution works.
@@ -47,8 +46,8 @@
<li>
Prepare a patch to fix Xerces 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 xerces source code, do <code>svn diff file</code>
+ for each file you've changed.
Keep in mind the coding guidelines for &XercesCName; as
described below.
</li>
@@ -58,15 +57,16 @@
apply.
</li>
<li>
- Submit a bug report on <jump href="http://issues.apache.org/jira/secure/BrowseProject.jspa?id=10510">Jira</jump>,
- the Apache bug database. Pick the product "Xerces-C++"
- (remembering to attach your patches and test code)
- or, if you think your patch might need some discussion,
- post it to the xerces-c-dev list.
+ Submit a bug report to the Xerces-C++ bug database as
+ described on the <jump href="&BugURI;">Bug-Reporting</jump> page.
+ Pick the product "Xerces-C++" (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>
<li>
- Provide the information required in the Contributors section of the
- <jump href="charter.html">Charter</jump>.
+ If you are submitting a substantial amount of code, provide the
+ information required in the Contributors section of the Project
+ Charter.
</li>
</ol>
</a>
@@ -79,15 +79,15 @@
<p>The informal release policies for &XercesCName; are (using a versioning of version.release.modification):</p>
<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>
+ <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>
<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>
<li>Any normal bug is fixed only in the HEAD branch (latest development code).</li>
</ul>
-
+
<p>The specific source and binary compatibility objectives for these release policies and the corresponding allowed source changes are:</p>
<ul>
<li>x.x.x to x.x.y: the API is the same to ensure binary compatibility.</li>
@@ -96,8 +96,8 @@
<ul>
<li>Add new non-virtual functions.</li>
<li>Add new classes.</li>
- <li>Add new STATIC data members.</li>
- </ul>
+ <li>Add new STATIC data members.</li>
+ </ul>
<li>To maintain binary compatibility you cannot:</li>
<ul>
<li>Add new virtual functions as this will change the layout of the virtual function table.</li>
@@ -112,11 +112,11 @@
</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
+ <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>
- </ul>
+ </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>
<li>In this situation, a separate branch of the code will be created so that bug fixes may be applied to the last version.</li>
@@ -125,57 +125,57 @@
</ul>
</a>
</faq>
-
+
<faq title="Coding Conventions">
<q>What are the coding conventions for &XercesCName;?
</q>
- <a>
+ <a>
<p>As with any coding effort, there are always arguments over what coding conventions to use. Everyone thinks
that they have the best style which leads to the entire source tree looking different. This causes consternation
- as well as eye fatigue on subsequent developers that need to maintain the code. Therefore, we are going to
- make an attempt at defining some basic coding conventions for &XercesCName;. When committing files or providing
+ as well as eye fatigue on subsequent developers that need to maintain the code. Therefore, we are going to
+ make an attempt at defining some basic coding conventions for &XercesCName;. When committing files or providing
patches please keep them in mind:</p>
- <ol>
- <li>All classes should have a constructor, destructor, assignment operator and copy constructor to
+ <ol>
+ <li>All classes should have a constructor, destructor, assignment operator and copy constructor to
avoid compiler generated default versions of these.</li>
<ul>
<li>If a class contains only static methods, only a private constructor is required.</li>
<li>If a class contains any virtual methods, the destructor should be virtual.</li>
<li>If a class has a public or protected constructor, it should declare private assignment operator
and copy constructor which are not implemented (unless of course you need either of these).</li>
- </ul>
-
+ </ul>
+
<li>If you add a catch(...) block be sure to add the following block
- <code>
+ <code>
catch(const OutOfMemoryException&)
{
throw;
}
</code> so the OutOfMemory condition does not get absorbed.</li>
-
- <li>If you change the serialization format (by adding something to be serialized or removing something that
+
+ <li>If you change the serialization format (by adding something to be serialized or removing something that
was serialized) increment the XERCES_GRAMMAR_SERIALIZATION_LEVEL constant in XercesVersion.hpp.</li>
-
+
<li>If a class allocates memory or is instantiated with new then it should inherit from XMemory.</li>
-
+
<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
+
+ <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>
-
- <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
+
+ <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>The naming convention for ENUMS should be choosen 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
- should not be converted to mixed case for standards compliance).</li>
-
- </ol>
+ should not be converted to mixed case for standards compliance).</li>
+
+ </ol>
</a>
</faq>
@@ -183,21 +183,20 @@
<q>How does one do a Xerces-C release?
</q>
<a>
- <p>You're in luck--it isn't at all difficult. Just
- follow these steps and you'll be done in no time:
+ <p>Just follow these steps:
</p>
- <ol>
+ <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/VC6/xerces-all/XercesLib/XercesLib.mak</code>
<code>Projects/Win32/VC6/xerces-all/xerces-com/xerces-com.dsp</code>
<code>Projects/Win32/VC7.1/xerces-all/XercesLib/XercesLib.vcproj</code>
<code>Projects/Win32/VC7.1/xerces-all/xerces-com/xerces-com.vcproj</code>
<code>Projects/Win32/VC8/xerces-all/XercesLib/XercesLib.vcproj</code>
<code>Projects/Win32/VC8/xerces-all/xerces-com/xerces-com.vcproj</code>
<br/>
- <code>Projects/MacOS/Xcode/XercesLib/Info-XercesLib.plist</code>
+ <code>Projects/MacOS/Xcode/XercesLib/Info-XercesLib.plist</code>
<code>scripts/packageBinaries.pl</code>
<br/>
<code>src/xercesc/configure.in</code>
@@ -217,10 +216,10 @@
<code>doc/Doxyfile</code>
<br/>
<code>doc/style/dtd/entities.ent</code>
-
+
</li>
-
- <li>Update the release documentation in the following files:<br/>
+
+ <li>Update the release documentation in the following files:<br/>
<code>doc/migration.xml</code>
<br/>
<code>doc/migration_archive.xml</code>
@@ -233,75 +232,75 @@
<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.
+ 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>
-
+ <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>
+
<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>
+ <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).
+ 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
@@ -310,20 +309,20 @@
<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
+ <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:
@@ -336,5 +335,5 @@
</ol>
</a>
</faq>
-
-</faqs>
+
+</faqs>
Modified: xerces/c/trunk/doc/faq-distrib.xml
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/faq-distrib.xml?rev=630879&r1=630878&r2=630879&view=diff
==============================================================================
--- xerces/c/trunk/doc/faq-distrib.xml (original)
+++ xerces/c/trunk/doc/faq-distrib.xml Mon Feb 25 07:35:02 2008
@@ -20,60 +20,40 @@
<faqs title="Distributing &XercesCName;">
- <faq title="What platforms / compilers are being used to build the binary distribution kits?">
-
- <q>What platforms / compilers are being used to build the binary distribution kits?</q>
-
- <a>
-
- <p>&XercesCProjectName; binaries has been built on the following platforms with
- these compilers</p>
-
- &build-winunix-supported-platforms;
-
- </a>
- </faq>
-
<faq title="What are the differences between Xerces-C and XML4C?">
<q>What are the differences between Xerces-C and XML4C?</q>
<a>
- <p>Xerces-C has intrinsic support for ASCII, UTF-8, UTF-16
+ <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 cannot
- use Xerces-C. XML4C addresses this need. It combines Xerces-C
- and <jump
- href="http://ibm.com/software/globalization/icu/">
- International Components for Unicode (ICU)</jump> and
- provides support for over 100 different encodings.
- XML4C also uses ICU Resource Bundle to load the messages.
- </p>
+ 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>ICU is also an open source project but is licensed
- under the <jump
- href="http://www.x.org/terms.htm">
- X License</jump>.
- Information about XML4C is available at <jump
- href="http://www.alphaworks.ibm.com/tech/xml4c">Alphaworks</jump>
- site.</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>
<a>
-
+
<p>You only need to distribute <em>one</em> file:<br></br>
- &XercesCWindowsDLL;.dll for Windows NT/2000, or<br/>
- &XercesCUnixLib;&XercesCUnixSoName;.so for AIX, or<br/>
- &XercesCUnixLib;.so.&XercesCUnixSoName; for Solaris/Linux, or<br/>
- &XercesCUnixLib;.sl.&XercesCUnixSoName; for HP-UX.</p>
+ &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.
+ </p>
<p>However, if you are using the ICU transcoder then in
<em>addition</em> to the library file
@@ -81,23 +61,28 @@
<ol>
<li><em>ICU shared library file</em>:<br></br>
- icuuc*.dll for Windows NT/2000, or<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.</li>
+ 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 NT/2000, or<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.</li>
+ 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 NT/2000, or<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.</li>
-
+ 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>
@@ -130,8 +115,8 @@
-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/&XercesCSrcInstallDir;
- -o$HOME/&XercesCInstallDir;
+Example: perl packageBinaries.pl -s$HOME/&XercesC3SrcInstallDir;
+ -o$HOME/&XercesC3InstallDir;
-cgcc -xg++ -minmem
-nfileonly -tnative</source>
@@ -151,7 +136,7 @@
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="mailto:&XercesCDevelEmailAddress;">&XercesCName; development mailing list</jump>.
+ <jump href="&MailURI;">&XercesCName; developer mailing list</jump>.
We can definitely use any extra help in this open source
project</p>
</a>
@@ -167,7 +152,7 @@
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
- href="program-others.html#PortingGuidelines">Porting
+ href="program-others-&XercesC3Series;.html#PortingGuidelines">Porting
Guidelines</jump>.</p>
<p>We strongly encourage you to submit the changes that
@@ -176,7 +161,7 @@
them available in the future releases.</p>
<p>All porting changes may be sent to the
- <jump href="mailto:&XercesCDevelEmailAddress;">&XercesCName; development mailing list</jump>
+ <jump href="&MailURI;">&XercesCName; developer mailing list</jump>
.</p>
</a>
</faq>
@@ -186,7 +171,7 @@
<q>How can I port &XercesCProjectName; to my favourite platform?</q>
<a>
<p>Here are some <jump
- href="program-others.html#PortingGuidelines">Porting
+ href="program-others-&XercesC3Series;.html#PortingGuidelines">Porting
Guidelines</jump>.</p>
</a>
</faq>
@@ -208,7 +193,7 @@
<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.html#faq-18">
+ <p>See <jump href="faq-build-&XercesC3Series;.html#faq-18">
FAQ: Regenerating (API) documentation?</jump></p>
</a>
@@ -220,8 +205,7 @@
<a>
<p>Yes! Read the license agreement first and if you still
have further questions, then please address them to the
- <jump href="mailto:&XercesCUserEmailAddress;">&XercesCName; user mailing list</jump>
- .</p>
+ <jump href="&MailURI;">&XercesCName; user mailing list</jump>.</p>
</a>
</faq>
Modified: xerces/c/trunk/doc/faq-other.xml
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/faq-other.xml?rev=630879&r1=630878&r2=630879&view=diff
==============================================================================
--- xerces/c/trunk/doc/faq-other.xml (original)
+++ xerces/c/trunk/doc/faq-other.xml Mon Feb 25 07:35:02 2008
@@ -32,7 +32,7 @@
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
@@ -67,12 +67,12 @@
<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 &XercesCWindowsDLL;.dll in the bin directory and look up
+ the DLL name &XercesC3WindowsDLL;.dll in the bin directory and look up
properties. The version information may be found on the Version tab.</p>
- <p>On AIX, just look for the library name &XercesCUnixLib;&XercesCUnixSoName;.so (or
- &XercesCUnixLib;.so.&XercesCUnixSoName; on Solaris/Linux
- and &XercesCUnixLib;.sl.&XercesCUnixSoName; on HP-UX). The
+ <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>
</a>
</faq>
@@ -85,8 +85,8 @@
<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">
- http://xerces.apache.org/xerces2-j</jump></p>
+ <jump href="http://xerces.apache.org/xerces2-j/index.html">
+ http://xerces.apache.org/xerces2-j/index.html</jump></p>
</a>
</faq>
@@ -106,23 +106,50 @@
</a>
</faq>
- <!-- see entities.ent for the content for faq-other-support -->
- &faq-other-support;
+ <faq title="Is there any kind of support available for &XercesCName;?">
+ <q>Is there any kind of support available for &XercesCName;?</q>
+ <a>
+ <p>&XercesCName; comes with <em>no</em> formal support.</p>
+
+ <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>
+
+ <p>Instructions for subscribing as well as archives are available at the
+ <jump href="&MailURI;">&XercesCName; mailing lists</jump> page.</p>
+ </a>
+ </faq>
+
<faq title="I found a defect -- how do I report it?">
<q>I found a defect -- how do I report it?</q>
<a>
-
- <p>See <jump href="bug-report.html">Bug Reporting</jump>.
+ <p>See <jump href="&BugURI;">Bug Reporting</jump>.
</p>
-
</a>
</faq>
- <!-- see entities.ent for the content for faq-other-patch -->
- &faq-other-patch;
+ <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?">
@@ -142,16 +169,16 @@
<a>
- <p>No. The &XercesCName; &XercesCVersion; 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
+ <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
- <jump href="http://xml.apache.org/xalan-c/overview.html">Apache Xalan C++</jump> or
- other Open Source Projects like
- <jump href="http://software.decisionsoft.com">Pathan</jump>.
- </p>
+ 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>
Modified: xerces/c/trunk/doc/faq-parse.xml
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/faq-parse.xml?rev=630879&r1=630878&r2=630879&view=diff
==============================================================================
--- xerces/c/trunk/doc/faq-parse.xml (original)
+++ xerces/c/trunk/doc/faq-parse.xml Mon Feb 25 07:35:02 2008
@@ -26,14 +26,14 @@
<a>
- <p>Yes. The &XercesCName; &XercesCVersion; contains an implementation
+ <p>Yes. The &XercesCName; &XercesC3Version; contains an implementation
of the W3C XML Schema Language, a recommendation of the Worldwide Web Consortium
available in three parts:
<jump href="http://www.w3.org/TR/xmlschema-0/">XML Schema: Primer</jump> and
<jump href="http://www.w3.org/TR/xmlschema-1/">XML Schema: Structures</jump> and
<jump href="http://www.w3.org/TR/xmlschema-2/">XML Schema: Datatypes</jump>.
We consider this implementation complete. See
- <jump href="schema.html#limitation">the Schema page</jump> for limitations.</p>
+ <jump href="schema-&XercesC3Series;.html#limitation">the Schema page</jump> for limitations.</p>
</a>
</faq>
@@ -44,19 +44,19 @@
<a>
- <p>The &XercesCName; &XercesCVersion; contains an implementation
+ <p>The &XercesCName; &XercesC3Version; contains an implementation
of the W3C XML Schema Language, a recommendation of the Worldwide Web Consortium
available in three parts:
<jump href="http://www.w3.org/TR/xmlschema-0/">XML Schema: Primer</jump> and
<jump href="http://www.w3.org/TR/xmlschema-1/">XML Schema: Structures</jump> and
<jump href="http://www.w3.org/TR/xmlschema-2/">XML Schema: Datatypes</jump>.
We consider this implementation complete. See
- <jump href="schema.html#limitation">the Schema page</jump> for limitations.</p>
+ <jump href="schema-&XercesC3Series;.html#limitation">the Schema page</jump> for limitations.</p>
<p>If you find any Schema feature which is specified in the W3C XML Schema Language
- Recommendation does not work with &XercesCName; &XercesCVersion;, we encourage
+ Recommendation does not work with &XercesCName; &XercesC3Version;, we encourage
the submission of bugs as described in
- <jump href="bug-report.html">Bug Reporting</jump> page.
+ <jump href="&BugURI;">Bug-Reporting</jump> page.
</p>
</a>
@@ -75,9 +75,9 @@
<source>
try {
- XERCES_CPP_NAMESPACE_QUALIFIER XMLPlatformUtils::Initialize();
+ XMLPlatformUtils::Initialize();
}
-catch (const XERCES_CPP_NAMESPACE_QUALIFIER XMLException& toCatch) {
+catch (const XMLException& toCatch) {
// Do your failure processing here
}</source>
@@ -90,7 +90,7 @@
<faq title="Is it OK to call the XMLPlatformUtils::Initialize/Terminate pair of routines multiple times in one program?">
<q>Is it OK to call the XMLPlatformUtils::Initialize/Terminate pair of routines multiple times in one program?</q>
<a>
- <p>Yes. Since &XercesCName; &XercesCVersion152;, the code has been enhanced so that
+ <p>Yes. Since &XercesCName; 1.5.2, the code has been enhanced so that
calling XMLPlatformUtils::Initialize/Terminate pair of routines
multiple times in one process is now allowed.
</p>
@@ -176,7 +176,7 @@
<a>
- <p>Please make sure you are using the &XercesCName; &XercesCVersion152; or up.
+ <p>Please make sure you are using the &XercesCName; 1.5.2 or up.
</p>
<p>Earlier version of &XercesCName; does not allow XMLPlatformUtils::Initialize()/Terminate()
@@ -236,7 +236,7 @@
<faq title="I'm suddenly getting segfaults with Xerces-C 2.3.0;
why might this be?">
-
+
<q>I'm suddenly getting segfaults with Xerces-C 2.3.0;
why might this be?</q>
<a>
@@ -281,7 +281,7 @@
the parser object and destroy it explicitly before the
call to XMLPlatformUtils::Terminate() is made.
</p>
- <p>Another way of producing segmentation faults--that again,
+ <p>Another way of producing segmentation faults--that again,
unfortunately, was employed by some of our
samples--is to have calls to XMLPlatformUtils::Terminate()
in a catch block that catches any of Xerces's exceptions.
@@ -291,7 +291,7 @@
default memory manager to destroy dynamically-allocated
objects, their destruction will provoke a segmentation
fault even if a return statement is placed in the catch
- block since the default memory manager will no longer exist.
+ block since the default memory manager will no longer exist.
This practice is now avoided in all our samples.
</p>
</a>
@@ -349,7 +349,7 @@
</p>
<p>If you are using XML4C where ICU is used, you may call ICU function u_cleanup() to clean up
- ICU static data. Please see <jump href="http://ibm.com/software/globalization/icu/">ICU documentation</jump>
+ ICU static data. Please see <jump href="http://icu-project.org/">ICU documentation</jump>
for details.
</p>
</a>
@@ -375,7 +375,7 @@
</p>
<p>If you are using XML4C where ICU is used, you may call ICU function u_cleanup() to clean up
- ICU static data. Please see <jump href="http://ibm.com/software/globalization/icu/">ICU documentation</jump>
+ ICU static data. Please see <jump href="http://icu-project.org/">ICU documentation</jump>
for details.
</p>
</a>
@@ -426,10 +426,10 @@
<faq title="How to write out a DOM tree into a string or an XML file?">
<q>How to write out a DOM tree into a string or an XML file?</q>
<a>
- <p>Please make sure you are using &XercesCName; &XercesCVersion; or up.</p>
+ <p>Please make sure you are using &XercesCName; &XercesC3Version; or up.</p>
<p>You can use
- the DOMLSSerializer::writeToString, or DOMLSSerializer::write to serialize a DOM tree.
+ the DOMLSSerializer::writeToString, or DOMLSSerializer::writeNode to serialize a DOM tree.
Please refer to the sample DOMPrint or the API documentation for more details of
DOMLSSerializer.</p>
</a>
@@ -505,9 +505,9 @@
platforms.</p>
<p>To address the need to make remote connections to resources specified
- using additional protocols, ftp for example, &XercesCName; provides the <code>NetAccessor</code> interface.
- The header file is <code>src/xercesc/util/XMLNetAccessor.hpp</code>.
- This interface allows you to plug in your own implementation of URL
+ using additional protocols, ftp for example, &XercesCName; provides the
+ <code>NetAccessor</code> interface. The header file is <code>src/xercesc/util/XMLNetAccessor.hpp</code>.
+ This interface allows you to plug in your own implementation of URL
networking code into the &XercesCName; parser.</p>
</a>
@@ -567,7 +567,7 @@
parse input XML files in these above mentioned encodings.</p>
<p>XML4C -- the version of Xerces-C available from IBM -- combines Xerces-C
- and <jump href="http://ibm.com/software/globalization/icu/">
+ and <jump href="http://icu-project.org/">
International Components for Unicode (ICU)</jump> and
extends the encoding support to over 100 different encodings that are allowed
by ICU. In particular, all the encodings registered with the
@@ -747,7 +747,7 @@
<source>
// create an XMLTranscoder that is able to transcode between Unicode and Big5
// ASSUMPTION: assumes your underlying transcoding utility supports this encoding Big5
-XMLTranscoder* t =
+XMLTranscoder* t =
XMLPlatformUtils::fgTransService->makeNewTranscoderFor("Big5", failReason, 16*1024, MemoryManager);
// source string is in Unicode, wanna to transcode to Big5
@@ -769,8 +769,8 @@
<p>The function <code>SAX2XMLReader::setProperty(const XMLCh* const name, void* value)</code>
and <code>DOMLSParser::getDomConfig()->setParameter(const XMLCh* name, const void* value)</code>
takes a void pointer for the property value. Application is required to initialize this void pointer
- to a correct type. See <jump href="program-sax2.html#SAX2Properties">SAX2 Programming Guide</jump>
- and <jump href="program-dom.html#DOMLSParserProperties">DOM Programming Guide</jump>
+ to a correct type. See <jump href="program-sax2-&XercesC3Series;.html#SAX2Properties">SAX2 Programming Guide</jump>
+ and <jump href="program-dom-&XercesC3Series;.html#DOMLSParserProperties">DOM Programming Guide</jump>
to learn exactly what type of property value that each property expects for processing.
Passing a void pointer that was initialized with a wrong type will lead to unexpected result.
</p>
@@ -787,7 +787,7 @@
<p>The function <code>void* SAX2XMLReader::getProperty(const XMLCh* const name)</code>
and <code>void* DOMLSParser::getDomConfig()->getParameter(const XMLCh* name)</code>
returns a void pointer for the property value. See
- <jump href="program-sax2.html#SAX2Properties">SAX2 Programming Guide</jump> and
+ <jump href="program-sax2-&XercesC3Series;.html#SAX2Properties">SAX2 Programming Guide</jump> and
exactly what type of object each property returns.
</p>
<p>The parser owns the returned pointer. The memory allocated for
@@ -796,8 +796,8 @@
is deleted, callers need to copy and store the returned information
somewhere else; otherwise you may get unexpected result. Since the returned
pointer is a generic void pointer, see
- <jump href="program-sax2.html#SAX2Properties">SAX2 Programming Guide</jump> and
- <jump href="program-dom.html#DOMLSParserProperties">DOM Programming Guide</jump> to learn
+ <jump href="program-sax2-&XercesC3Series;.html#SAX2Properties">SAX2 Programming Guide</jump> and
+ <jump href="program-dom-&XercesC3Series;.html#DOMLSParserProperties">DOM Programming Guide</jump> to learn
exactly what type of property value each property returns for replication.
</p>
@@ -819,7 +819,7 @@
validation is turned off.
</p>
- <p>To ignore the DTD, with &XercesCName; &XercesCVersion; or up, you can call
+ <p>To ignore the DTD, with &XercesCName; &XercesC3Version; or up, you can call
<code>setLoadExternalDTD(false)</code> (or
<code>setFeature(XMLUni::fgXercesLoadExternalDTD, false)</code>
to disable the loading of external DTD. The parser will then ignore
@@ -869,7 +869,7 @@
back to the parser, it will not print the DOMNode node value as is. The DOMLSSerializer
may do some "touch up" to the output data for it to be parsable.</p>
- <p>See <jump href="program-dom.html#DOMLSSerializerEntityRef">How does DOMLSSerializer handle built-in entity
+ <p>See <jump href="program-dom-&XercesC3Series;.html#DOMLSSerializerEntityRef">How does DOMLSSerializer handle built-in entity
Reference in node value?</jump> to understand further how DOMLSSerializer touches up the entity reference.
</p>
</a>
@@ -882,8 +882,8 @@
<a>
<p>In most cases, the parser handles deleting documents when the parser gets deleted. However, if an application
- needs to release a document, it shall adopt the document before releasing it, so that the parser
- knows that the ownership of this particular document is transfered to the application and will not
+ needs to release a document, it shall adopt the document before releasing it, so that the parser
+ knows that the ownership of this particular document is transfered to the application and will not
try to delete it once the parser gets deleted.
</p>
@@ -901,15 +901,15 @@
DOMNode *doc = parser->getDocument();
...
parser->adoptDocument();
-doc->release();
+doc->release();
...
delete parser;
</source>
- <p>The alternative to release document is to call parser's resetDocumentPool(), which releases
+ <p>The alternative to release document is to call parser's resetDocumentPool(), which releases
all the documents parsed.
</p>
-
+
</a>
</faq>
@@ -920,7 +920,7 @@
<a>
<p>With the introduction of the configurable memory manager, we didn't want to break users by
- changing the signature of the existing methods (for example, transcode and replicate). Also,
+ changing the signature of the existing methods (for example, transcode and replicate). Also,
we did not want to provide a default memory
manager as it would introduce a side effect with users experiencing some strange core dumps.
The latter will occur when the scope of the string allocated is beyond that of
@@ -931,5 +931,5 @@
</a>
</faq>
-
+
</faqs>
Modified: xerces/c/trunk/doc/install.xml
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/install.xml?rev=630879&r1=630878&r2=630879&view=diff
==============================================================================
--- xerces/c/trunk/doc/install.xml (original)
+++ xerces/c/trunk/doc/install.xml Mon Feb 25 07:35:02 2008
@@ -20,168 +20,198 @@
<s1 title="Installation">
+ <ul>
+ <li><link anchor="Windows">Installation Instructions for Windows</link></li>
+ <li><link anchor="Unix">Installation Instructions for UNIX/Mac OS X/Linux</link></li>
+ <li><link anchor="Cygwin">Installation Instructions for Cygwin</link></li>
+ </ul>
+
+ <anchor name="Windows"/>
+ <s2 title="Windows">
+
+ <p>This section contains installation instructions for the Windows
+ platform.</p>
- <s2 title="Windows NT/2000">
<s3 title="Source distribution">
- <p>The &XercesCName; source is available in the source distribution.
- </p>
+ <p>The &XercesCName; source is available in the source distribution:
+ &XercesC3SrcInstallDir;.zip.</p>
+
<p>Install the &XercesCName; source distribution by using <code>unzip</code>
- on the &XercesCSrcInstallDir;.zip archive in the Windows environment. You can
- use WinZip, or any other UnZip utility.</p>
-<source>unzip &XercesCSrcInstallDir;.zip</source>
- <p>This creates a '&XercesCSrcInstallDir;' sub-directory
+ on the &XercesC3SrcInstallDir;.zip archive in the Windows environment. You can
+ use WinZip, or any other UnZip utility:</p>
+<source>
+unzip &XercesC3SrcInstallDir;.zip
+</source>
+ <p>This creates the '&XercesC3SrcInstallDir;' sub-directory
containing the &XercesCName; source distribution. </p>
<p>If you need to build the &XercesCName; source after installation,
- please follow the <jump href="build.html">Build Instructions</jump>.</p>
+ please follow the <jump href="build-&XercesC3Series;.html">Build Instructions</jump>.</p>
</s3>
<s3 title="Binary distribution">
<p>Install the &XercesCName; binary distribution by using <code>unzip</code>
- on the &XercesCInstallDir;-win32.zip archive in the Windows environment. You can
- use WinZip, or any other UnZip utility.</p>
-<source>unzip &XercesCInstallDir;-win32.zip</source>
- <p>This creates a '&XercesCInstallDir;-win32' sub-directory
- containing the &XercesCName; binary distribution. </p>
-
- <p>You need to add the '&XercesCInstallDir;-win32\bin'
- directory to your path: </p>
-
- <p>To do this under Windows NT, go to the start menu, click the
- settings menu and select control panel. When the control panel opens,
- double click on System and select the 'Environment' tab.
- Locate the PATH variable under system variables
- and add <full_path_to_&XercesCInstallDir;>\bin to the PATH variable.
- To do this under Windows 2000 add this line to your AUTOEXEC.BAT file:</p>
-<source>SET PATH=<full_path_to_&XercesCInstallDir;>\bin;%PATH%</source>
- <p>or run the <code>SET PATH</code> command in your shell window.</p>
-
- <p>Besides, if the parser is built with icu message loader (like IBM XML4C binaries),
- or message catalog loader, then you need to create a new environment variable, XERCESC_NLS_HOME
- to point to the directory, $XERCESCROOT/msg, where the message files reside.</p>
-<source>SET XERCESC_NLS_HOME=<full_path_to_&XercesCInstallDir;>\msg</source>
-
- <p>The binary distribution has the built parser library and some samples executables.
- Please refer to the <jump href="samples.html">Samples</jump> for how to run the samples.</p>
+ on the &XercesC3InstallDir;-{arch}-windows-{compiler}.zip archive in
+ the Windows environment. Here {arch} denotes the CPU architecture
+ and {compiler} denotes the C++ compiler of your choice. You can use
+ WinZip, or any other UnZip utility. For example:</p>
+
+<source>
+unzip &XercesC3InstallDir;-x86-windows-vc_8_0.zip
+</source>
+
+ <p>This creates a '&XercesC3InstallDir;-x86-windows-vc_8_0'
+ sub-directory containing the &XercesCName; binary distribution.</p>
+
+ <p>You need to add the '&XercesC3InstallDir;-{arch}-windows-{compiler}\bin'
+ directory to your path.
+ To do this go to the start menu, click the settings menu and
+ select control panel. When the control panel opens, double
+ click on System and select the 'Environment' tab.
+ Locate the PATH variable under system variables and add
+ <full-path-to-&XercesC3InstallDir;-{arch}-windows-{compiler}>\bin
+ to the PATH variable.</p>
+
+ <p>The binary distribution contains the pre-built parser libraries
+ and sample executables. Please refer to the
+ <jump href="samples-&XercesC3Series;.html">Samples</jump> for how to run the
+ samples.</p>
</s3>
</s2>
+ <anchor name="Unix"/>
<s2 title="UNIX">
+
+ <p>This section contains installation instructions for the UNIX,
+ Linux, and Mac OS X platforms.</p>
+
<s3 title="Source distribution">
- <p>The &XercesCName; source is available in the source distribution.
- </p>
- <p>Install the &XercesCName; source distribution &XercesCSrcInstallDir;.tar.gz by extracting the files
- from the compressed archive.</p>
+ <p>The &XercesCName; source is available in the source distribution:
+ &XercesC3SrcInstallDir;.tar.gz.</p>
+
+ <p>Install the &XercesCName; source distribution
+ &XercesC3SrcInstallDir;.tar.gz by extracting the files
+ from the compressed archive:</p>
<source>
-gunzip &XercesCSrcInstallDir;.tar.gz
-tar &XercesCSrcInstallDir;.tar
+gzip -d &XercesC3SrcInstallDir;.tar.gz
+tar -xf &XercesC3SrcInstallDir;.tar
</source>
- <p>This creates a '&XercesCSrcInstallDir;' sub-directory
- containing the &XercesCName; source distribution. </p>
-
- <note>On Solaris, please use <code>gtar</code> instead of tar. &install-faq-distrib11;</note>
+ <p>This creates the '&XercesC3SrcInstallDir;' sub-directory
+ containing the &XercesCName; source distribution. </p>
<p>If you need to build the &XercesCName; source after installation,
- please follow the <jump href="build.html">Build Instructions</jump>.</p>
+ please follow the <jump href="build-&XercesC3Series;.html">Build Instructions</jump>.</p>
</s3>
<s3 title="Binary distribution">
- <p>Install the binary distribution &XercesCInstallDir;-xxx.tar.gz by extracting the files
- from the compressed archive; where 'xxx' is the corresponding UNIX platform.
+ <p>Install the binary distribution &XercesC3InstallDir;-{arch}-{os}-{compiler}.tar.gz
+ by extracting the files from the compressed archive. Here {arch}
+ denotes the CPU architecture, {os} denotes the operating system,
+ and {compiler} denotes the C++ compiler of your choice.
For example:</p>
<source>
-gunzip &XercesCInstallDir;-linux.tar.gz
-tar -xvf &XercesCInstallDir;-linux.tar
+gzip -d &XercesC3InstallDir;-x86-linux-gcc_3_4.tar.gz
+tar -xf &XercesC3InstallDir;-x86-linux-gcc_3_4.tar
</source>
- <p>This will create an '&XercesCInstallDir;-linux' sub-directory
- containing the &XercesCName; binary distribution. </p>
-
- <note>On Solaris, please use <code>gtar</code> instead of tar. &install-faq-distrib11;</note>
+ <p>This will create an '&XercesC3InstallDir;-x86-linux-gcc_3_4'
+ sub-directory containing the &XercesCName; binary distribution.</p>
<p>You will need to add the
- &XercesCInstallDir;-linux/bin directory to your PATH environment variable:</p>
+ &XercesC3InstallDir;-{arch}-{os}-{compiler}/bin directory to your
+ PATH environment variable:</p>
<p>For Bourne Shell, K Shell or Bash, type: </p>
-<source>export PATH="$PATH:$HOME/&XercesCInstallDir;-linux/bin"</source>
+<source>
+export PATH="$PATH:<full-path-to-&XercesC3InstallDir;-{arch}-{os}-{compiler}>/bin"
+</source>
<p>For C Shell, type:</p>
-<source>setenv PATH "$PATH:$HOME/&XercesCInstallDir;-linux/bin"</source>
+<source>
+setenv PATH "$PATH:<full-path-to-&XercesC3InstallDir;-{arch}-{os}-{compiler}>/bin"
+</source>
<p>If you wish to make this setting permanent, you need to change
- your profile by changing your setup files which can be either .profile or .kshrc.</p>
+ your profile by changing your setup files which can be either
+ .profile or .kshrc.</p>
<p>In addition, you will also need to set the library search path.
- (LIBPATH on AIX, LD_LIBRARY_PATH on Solaris and Linux, SHLIB_PATH on HP-UX,
- and DYLD_LIBRARY_PATH on Mac OS X).</p>
+ (LIBPATH on AIX, LD_LIBRARY_PATH on Solaris and Linux,
+ SHLIB_PATH on HP-UX, and DYLD_LIBRARY_PATH on Mac OS X).</p>
- <p>For Bourne Shell, K Shell or Bash, type:</p>
-<source>
-export LIBPATH=$XERCESCROOT/lib:$LIBPATH (on AIX)
-export LD_LIBRARY_PATH=$XERCESCROOT/lib:$LD_LIBRARY_PATH (on Solaris, Linux)
-export SHLIB_PATH=$XERCESCROOT/lib:$SHLIB_PATH (on HP-UX)
-export DYLD_LIBRARY_PATH=$XERCESCROOT/lib:$DYLD_LIBRARY_PATH (on Mac OS X)</source>
+ <p>In the following shell commands, the <xerces-path>
+ denotes the full path to the
+ &XercesC3InstallDir;-{arch}-{os}-{compiler} directory. For
+ Bourne Shell, K Shell or Bash, type:</p>
+<source>
+export LIBPATH=<xerces-path>/lib:$LIBPATH (AIX)
+export LD_LIBRARY_PATH=<xerces-path>/lib:$LD_LIBRARY_PATH (Solaris, Linux)
+export SHLIB_PATH=<xerces-path>/lib:$SHLIB_PATH (HP-UX)
+export DYLD_LIBRARY_PATH=<xerces-path>/lib:$DYLD_LIBRARY_PATH (Mac OS X)
+</source>
<p>For C Shell, type:</p>
<source>
-setenv LIBPATH "$XERCESCROOT/lib:$LIBPATH" (on AIX)
-setenv LD_LIBRARY_PATH "$XERCESCROOT/lib:$LD_LIBRARY_PATH" (on Solaris, Linux)
-setenv SHLIB_PATH "$XERCESCROOT/lib:$SHLIB_PATH" (on HP-UX)
-setenv DYLD_LIBRARY_PATH "$XERCESCROOT/lib:$DYLD_LIBRARY_PATH" (Mac OS X)</source>
-
- <p>Besides, if the parser is built with icu message loader (like IBM XML4C binaries),
- or message catalog loader, then you need to create a new environment variable, XERCESC_NLS_HOME
- to point to the directory, $XERCESCROOT/msg, where the message files reside.</p>
-<source>
-export XERCESC_NLS_HOME=$XERCESCROOT/msg
-or
-setenv XERCESC_NLS_HOME=$XERCESCROOT/msg
-</source>
-
- <p>The binary distribution has the built parser library and some samples executables.
- Please refer to the <jump href="samples.html">Samples</jump> for how to run the samples.</p>
+setenv LIBPATH "<xerces-path>/lib:$LIBPATH" (AIX)
+setenv LD_LIBRARY_PATH "<xerces-path>/lib:$LD_LIBRARY_PATH" (Solaris, Linux)
+setenv SHLIB_PATH "<xerces-path>/lib:$SHLIB_PATH" (HP-UX)
+setenv DYLD_LIBRARY_PATH "<xerces-path>/lib:$DYLD_LIBRARY_PATH" (Mac OS X)
+</source>
+ <p>The binary distribution contains the pre-built parser libraries
+ and sample executables. Please refer to the
+ <jump href="samples-&XercesC3Series;.html">Samples</jump> for how to run the
+ samples.</p>
</s3>
</s2>
+ <anchor name="Cygwin"/>
<s2 title="Cygwin">
+
+ <p>This section contains installation instructions for the Cygwin
+ platform.</p>
+
<s3 title="Source distribution">
- <p>The &XercesCName; source is available in the source distribution.
- </p>
- <p>Install the &XercesCName; source distribution &XercesCSrcInstallDir;.tar.gz by extracting the files
- from the compressed archive.</p>
+ <p>The &XercesCName; source is available in the source distribution:
+ &XercesC3SrcInstallDir;.tar.gz.</p>
+
+ <p>Install the &XercesCName; source distribution
+ &XercesC3SrcInstallDir;.tar.gz by extracting the files
+ from the compressed archive:</p>
<source>
-tar -xvzf &XercesCSrcInstallDir;.tar.gz
+tar -xfz &XercesC3SrcInstallDir;.tar.gz
</source>
- <p>This creates a '&XercesCSrcInstallDir;' sub-directory
- containing the &XercesCName; source distribution. </p>
+ <p>This creates the '&XercesC3SrcInstallDir;' sub-directory
+ containing the &XercesCName; source distribution. </p>
<p>If you need to build the &XercesCName; source after installation,
- please follow the <jump href="build.html">Build Instructions</jump>.</p>
+ please follow the <jump href="build-&XercesC3Series;.html">Build Instructions</jump>.
+ </p>
</s3>
+
<s3 title="Binary distribution">
- <p>Install the binary distribution by running
- <jump href="http://www.cygwin.com">Cygwin</jump> setup.exe.
- When you reach the "Packages" step of the Cygwin Setup wizard,
- expand the "Devel" category, then click in the "New" column next
- to "xerces-c-devel" until it reads "&XercesCVersion;-X".</p>
-
- <p>This will install the necessary libraries and include files
- for the &XercesCName; binary distribution.</p>
-
- <p>If you wish to run programs linked to &XercesCName; that were
- built in the Cygwin environment, you need to add your Cygwin
- "bin" directory to your Windows PATH environment variable.
- In typical Cygwin installations, the bin directory is in the
- Cygwin directory on the drive that windows is installed on.
- For instance, if windows is installed to C:\WINNT\System32,
- Your Cygwin bin directory may be "C:\cygwin\bin".</p>
-
- <p>The binary distribution has the built parser library. Sample
- executables may be available in a future release on the
- Cygwin platform. In the meantime, they may be built from the
- source distribution by following the
- <jump href="build.html">Build Instructions</jump>.</p>
+ <p>Install the binary distribution by running
+ <jump href="http://www.cygwin.com">Cygwin</jump> setup.exe.
+ When you reach the "Packages" step of the Cygwin Setup wizard,
+ expand the "Devel" category, then click in the "New" column next
+ to "xerces-c-devel" until it reads "&XercesC3Version;-X".</p>
+
+ <p>This will install the necessary libraries and include files
+ for the &XercesCName; binary distribution.</p>
+
+ <p>If you wish to run programs linked to &XercesCName; that were
+ built in the Cygwin environment, you need to add your Cygwin
+ "bin" directory to your Windows PATH environment variable.
+ In typical Cygwin installations, the bin directory is in the
+ Cygwin directory on the drive that windows is installed on.
+ For instance, if windows is installed to "C:\Windows\System32",
+ Your Cygwin bin directory may be "C:\cygwin\bin".</p>
+
+ <p>The binary distribution contains the pre-built parser libraries.
+ Sample executables may be available in a future release on the
+ Cygwin platform. In the meantime, they may be built from the
+ source distribution by following the
+ <jump href="build-&XercesC3Series;.html">Build Instructions</jump>.</p>
</s3>
</s2>
</s1>
Modified: xerces/c/trunk/doc/migration.xml
URL: http://svn.apache.org/viewvc/xerces/c/trunk/doc/migration.xml?rev=630879&r1=630878&r2=630879&view=diff
==============================================================================
--- xerces/c/trunk/doc/migration.xml (original)
+++ xerces/c/trunk/doc/migration.xml Mon Feb 25 07:35:02 2008
@@ -21,111 +21,59 @@
<s1 title="Migration">
<s2 title="Migration Archive">
- <p>For migration information to &XercesCName; 2.5.0 or earlier,
- please refer to <jump href="migrate_archive.html">Migration Archive. </jump></p>
+ <p>For migration information to &XercesCName; 2.7.0 or earlier,
+ please refer to <jump href="migrate_archive-&XercesC3Series;.html">Migration Archive. </jump></p>
</s2>
- <s2 title="Migrating from &XercesCName; 2.5.0 to &XercesCName; &XercesCVersion;">
+ <s2 title="Migrating from &XercesCName; 2.7.0 to &XercesCName; &XercesC3Version;">
<p>The following section is a discussion of the technical differences between
- &XercesCName; 2.5.0 code base and the &XercesCName; &XercesCVersion;.</p>
+ &XercesCName; 2.7.0 code base and the &XercesCName; &XercesC3Version;.</p>
<p>Topics discussed are:</p>
<ul>
- <li><link anchor="NewFeatures260">New features in &XercesCName; &XercesCVersion;</link></li>
- <li><link anchor="API260">Public API Changes</link></li>
+ <li><link anchor="NewFeatures280">New features in &XercesCName; &XercesC3Version;</link></li>
+ <li><link anchor="API280">Public API Changes</link></li>
<ul>
- <li><link anchor="NewAPI260">New Public API</link></li>
- <li><link anchor="ModifiedAPI260">Modified Public API</link></li>
- <li><link anchor="DeprecatedAPI260">Deprecated/Removed Public API</link></li>
- <li>Please note the following source code incompatibility: Rename VALUE_CONSTRAINT enumeration values in XSConstants.hpp due to conflict with system header. New
- values are VALUE_CONSTRAINT_NONE, VALUE_CONSTRAINT_DEFAULT and VALUE_CONSTRAINT_FIXED. Old
- values are VC_NONE, VC_DEFAULT and VC_FIXED.</li>
- <li>Also note that if you have implemented your own XMLGrammarPool implementation, that
- the original getXSModel has been marked deprecated and a new method, of the same
- name, that takes a bool parameter has been added. This new getXSModel needs
- to always return an XSModel.</li>
+ <li><link anchor="NewAPI280">New Public API</link></li>
+ <li><link anchor="ModifiedAPI280">Modified Public API</link></li>
+ <li><link anchor="DeprecatedAPI280">Deprecated/Removed Public API</link></li>
</ul>
</ul>
- <anchor name="NewFeatures260"/>
- <s3 title="New features in &XercesCName; &XercesCVersion;">
+ <anchor name="NewFeatures280"/>
+ <s3 title="New features in &XercesCName; &XercesC3Version;">
<ul>
- <li>Reduce footprint of DLL by building the deprecated DOM as a separate library</li>
- <li>Improve packaging scripts</li>
- <li>Enable ID's to work on all kinds of schema components</li>
- <li>Add messages to DOMExceptions along with the error code</li>
- <li>Improve annotation error-reporting capabilities</li>
- <li>Make grammar caching work with DTD internal subsets</li>
- <li>Bring parser up to the XML 1.0 3rd Edition</li>
- <li>Update to the XML 1.1 recommendation</li>
- <li>Add new method to DOMDocument so that DOM level-2 style DOMDocumentTypes (which have a
- DOMDocument to own them) can be created</li>
- <li>Feature for disabling identity constraints</li>
- <li>Update schema errata</li>
- <li>Provide means to get actual values out of PSVI/schema component model</li>
- <li>Synthesize annotation components for non-schema attributes</li>
- <li>Expose partial PSVIElement information at the start element call</li>
- <li>Externalize validation, actual/canonical value production for arbitrary strings</li>
- <li>Laxly validate schema annotations</li>
- <li>Upgrade to ICU 3.0</li>
- <li>Handle elements with a large number of attributes more efficiently</li>
+ <li>Exponential growth of memory block (from 16KB to 128KB) that are allocated by the DOM heap.</li>
+ <li>The NODE_CLONED notification is now sent to each node's user data handler when cloning the entire DOMDocument.</li>
+ <li>On Windows extract the registry code page from MIME\Database\Charset\<encoding>\@InternetEncoding instead of MIME\Database\Charset\<encoding>\@Codepage.</li>
+ <li>Allow whitespace-only nodes to be added as children of a DOMDocument.</li>
+ <li>When a node is cloned or imported the type information (PSVI) is also copied.</li>
+ <li>When using SAX2, including XMLReaderFactory to use createXMLReader doesn't include xercesc/parsers/SAX2XMLReaderImpl.hpp anymore. If you need to cast the SAX2XMLReader to SAX2XMLReaderImpl,
+ you need to include this header yourself.</li>
</ul>
</s3>
- <anchor name="API260"/>
+ <anchor name="API280"/>
<s3 title="Public API Changes">
<p>The following lists the public API changes between the &XercesCName;
- 2.5.0; and the &XercesCName; &XercesCVersion; releases
+ 2.7.0; and the &XercesCName; &XercesC3Version; releases
of the parser. </p>
- <anchor name="NewAPI260"/>
+ <anchor name="NewAPI280"/>
<s4 title="New Public API">
<ul>
- <li>XSValue</li>
- <li>IdentityConstraintHandler</li>
- <li>XMLBufferFullHandler</li>
- <li>XMLString: removeChar, isValidNOTATION</li>
- <li>XMLUri: normalizeUri</li>
- <li>PSVIHandler: handlePartialElementPSVI</li>
- <li>RefHash family of classes: getHashModulus</li>
- <li>XSAnnotation: setline/col and systemid</li>
- <li>XMLReader: handeEOL</li>
- <li>XMLChar: isValidNmToken</li>
- <li>XMLBigDecimal: parseDecimal, getIntVal</li>
- <li>HexBin: getCanonicalRepresentation, decode</li>
- <li>Base64: getCanonicalRepresentation, decode</li>
- <li>XMLBigInteger: compareValues</li>
- <li>XMLAbstractDoubleFloat: isDataConverted, getValue, isDataOverFlowed</li>
- <li>PSVIItem: getActualValue</li>
- <li>XSSimpleTypeDefinition: getDatatypeValidator</li>
- <li>RefHash2KeysTableOf: transferElement</li>
- <li>XMLGrammarPool: getXSModel</li>
+ <li>XMLBufferMgr: getBufferCount and getAvailableBufferCount</li>
</ul>
</s4>
- <anchor name="ModifiedAPI260"/>
+ <anchor name="ModifiedAPI280"/>
<s4 title="Modified Public API">
- <ul>
- <li>XSerializeEngine constructor</li>
- <li>MACUnicodeConverters</li>
- </ul>
</s4>
- <anchor name="DeprecatedAPI260"/>
+ <anchor name="DeprecatedAPI280"/>
<s4 title="Deprecated/Removed Public API">
- <ul>
- <li>XSerializeEngine constructor</li>
- <li>DTDAttDef: getDOMTypeInfoName, getDOMTypeInfoUri</li>
- <li>DTDElementDecl: getDOMTypeInfoName, getDOMTypeInfoUri</li>
- <li>SchemaAttDef: setAnyDatatypeValidator</li>
- <li>UnionDatatypeValidator: getMemberTypeName, getMemberTypeUri, getMemberTypeAnonymous, getMemberTypeValidator</li>
- <li>XMLAttr: getValidatingTypeURI, getValidatingTypeName, setDatatypeValidator, setSchemaValidated</li>
- <li>ComplexTypeInfo: setContentModel</li>
- <li>XMLGrammarPool: getXSModel</li>
- <li>SAXParser, mark this class deprecated</li>
- </ul>
</s4>
</s3>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xerces.apache.org
For additional commands, e-mail: commits-help@xerces.apache.org