AIR
/
mxml
mirror of https://github.com/michaelrsweet/mxml.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doco updates.

Browse Source
pull/193/head
Michael R Sweet 14 years ago
parent ec9a6566d7
commit ccd0f5e225
4 changed files with 46 additions and 27 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 46
      doc/intro.html
  2. 4
      doc/reference.html
  3. 21
      doc/relnotes.html
  4. 2
      mxml.xml

46
doc/intro.html
Unescape View File

@ -1,29 +1,28 @@
<html>
<head>
<title>Mini-XML Programmers Manual, Version 2.6</title>
<meta name='copyright' content='Copyright 2003-2009'>
<meta name='author' content='Michael R. Sweet'>
<meta name='keywords' content='XML, C, C++, library'>
<title>Mini-XML Programmers Manual, Version 2.7</title>
<meta name="copyright" content="Copyright 2003-2010">
<meta name="author" content="Michael R. Sweet">
<meta name="keywords" content="XML, C, C++, library">
</head>
<body>
<h1 align='right'><a name='INTRO'><img src="0.gif" align="right"
<h1 align="right"><a name="INTRO"><img src="0.gif" align="right"
hspace="10" width="100" height="100" alt="0"></a>Introduction</h1>
<p>This programmers manual describes Mini-XML version 2.6, a small
<p>This programmers manual describes Mini-XML version 2.7, a small
XML parsing library that you can use to read and write XML data
files in your C and C++ applications.</p>
<p>Mini-XML was initially developed for the <a
href='http://gutenprint.sf.net/'>Gutenprint</a> project to replace
href="http://gutenprint.sf.net/">Gutenprint</a> project to replace
the rather large and unwieldy <tt>libxml2</tt> library with
something substantially smaller and easier-to-use. It all began one
morning in June of 2003 when Robert posted the following sentence to
the developer's list:</p>
<blockquote><em>It's bad enough that we require libxml2, but rolling
our own XML parser is a bit more than we can
handle.</em></blockquote>
our own XML parser is a bit more than we can handle.</em></blockquote>
<p>I then replied with:</p>
@ -38,7 +37,7 @@ and removed libxml2.</p>
<p>Thanks to lots of feedback and support from various
developers, Mini-XML has evolved since then to provide a more
complete XML implementation and now stands at a whopping 3,441
complete XML implementation and now stands at a whopping 3,747
lines of code, compared to 103,893 lines of code for libxml2
version 2.6.9.</p>
@ -47,11 +46,10 @@ following projects/software applications:</p>
<ul>
<li><a href='http://www.cups.org/'>Common UNIX Printing
System</a></li>
<li><a href="http://www.cups.org/">CUPS</a></li>
<li><a
href='http://zynaddsubfx.sourceforge.net'>ZynAddSubFX</a></li>
href="http://zynaddsubfx.sourceforge.net">ZynAddSubFX</a></li>
</ul>
@ -68,36 +66,36 @@ appendices:</p>
<ul>
<li>Chapter 1, "<a href='#INSTALL'>Building,
<li>Chapter 1, "<a href="#INSTALL">Building,
Installing, and Packaging Mini-XML</a>", provides
compilation, installation, and packaging instructions for
Mini-XML.</li>
<li>Chapter 2, "<a href='#BASICS'>Getting
<li>Chapter 2, "<a href="#BASICS">Getting
Started with Mini-XML</a>", shows how to use the
Mini-XML library in your programs.</li>
<li>Chapter 3, "<a href='#ADVANCED'>More
<li>Chapter 3, "<a href="#ADVANCED">More
Mini-XML Programming Techniques</a>", shows additional
ways to use the Mini-XML library.</li>
<li>Chapter 4, "<a href='#MXMLDOC'>Using the
<li>Chapter 4, "<a href="#MXMLDOC">Using the
mxmldoc Utility</a>", describes how to use the
<tt>mxmldoc(1)</tt> program to generate software
documentation.</li>
<li>Appendix A, "<a href='#LICENSE'>Mini-XML License</a>",
<li>Appendix A, "<a href="#LICENSE">Mini-XML License</a>",
provides the terms and conditions for using and distributing
Mini-XML.</li>
<li>Appendix B, "<a href='#RELNOTES'>Release Notes</a>",
<li>Appendix B, "<a href="#RELNOTES">Release Notes</a>",
lists the changes in each release of Mini-XML.</li>
<li>Appendix C, "<a href='#REFERENCE'>Library
<li>Appendix C, "<a href="#REFERENCE">Library
Reference</a>", contains a complete reference for
Mini-XML, generated by <tt>mxmldoc</tt>.</li>
<li>Appendix D, "<a href='#SCHEMA'>XML Schema</a>", shows
<li>Appendix D, "<a href="#SCHEMA">XML Schema</a>", shows
the XML schema used for the XML files produced by
<tt>mxmldoc</tt>.</li>
@ -179,7 +177,7 @@ manual:</p>
used for XML.<br><br></dd>
<dt><a
href='http://www.w3.org/TR/2004/REC-xml-20040204/'>Extensible
href="http://www.w3.org/TR/2004/REC-xml-20040204/">Extensible
Markup Language (XML) 1.0 (Third Edition)</a></dt>
<dd>The XML specification from the World Wide Web
@ -190,8 +188,8 @@ manual:</p>
<!-- NEED 6 -->
<h2>Legal Stuff</h2>
<p>The Mini-XML library is copyright 2003-2009 by Michael Sweet. License terms
are described in <a href='#LICENSE'>Appendix A - Mini-XML License</a>.</p>
<p>The Mini-XML library is copyright 2003-2010 by Michael Sweet. License terms
are described in <a href="#LICENSE">Appendix A - Mini-XML License</a>.</p>
</body>
</html>

4
doc/reference.html
Unescape View File

@ -182,7 +182,7 @@ using a SAX callback.">mxmlSAXLoadFd</a></li>
using a SAX callback.">mxmlSAXLoadFile</a></li>
<li><a href="#mxmlSAXLoadString" title="Load a string into an XML node tree
using a SAX callback.">mxmlSAXLoadString</a></li>
<li><a href="#mxmlSaveAllocString" title="Save an XML node tree to an allocated string.">mxmlSaveAllocString</a></li>
<li><a href="#mxmlSaveAllocString" title="Save an XML tree to an allocated string.">mxmlSaveAllocString</a></li>
<li><a href="#mxmlSaveFd" title="Save an XML tree to a file descriptor.">mxmlSaveFd</a></li>
<li><a href="#mxmlSaveFile" title="Save an XML tree to a file.">mxmlSaveFile</a></li>
<li><a href="#mxmlSaveString" title="Save an XML node tree to a string.">mxmlSaveString</a></li>
@ -1008,7 +1008,7 @@ node is closed or after each data, comment, CDATA, or directive node.
</p>
<h3 class="function"><a name="mxmlSaveAllocString">mxmlSaveAllocString</a></h3>
<p class="description">Save an XML node tree to an allocated string.</p>
<p class="description">Save an XML tree to an allocated string.</p>
<p class="code">
char *mxmlSaveAllocString (<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="#mxml_node_t">mxml_node_t</a> *node,<br>

21
doc/relnotes.html
Unescape View File

@ -5,6 +5,27 @@
hspace="10" width="100" height="100" alt="B"></a>Release Notes</h1>
<h2 _hd_omit_toc>Changes in Mini-XML 2.7</h2>
<ul>
<li>Updated the source headers to reference the Mini-XML license and its
exceptions to the LGPL2 (STR #108)</li>
<li>The shared library did not include a destructor for the thread-
specific data key on UNIX-based operating systems (STR #103)</li>
<li>mxmlLoad* did not error out on XML with multiple root nodes (STR
#101)</li>
<li>Fixed an issue with the _mxml_vstrdupf function (STR #107)</li>
<li>mxmlSave* no longer write all siblings of the passed node, just that
node and its children (STR #109)</li>
</ul>
<h2 _hd_omit_toc>Changes in Mini-XML 2.6</h2>
<ul>

2
mxml.xml
Unescape View File

@ -744,7 +744,7 @@ node is closed or after each data, comment, CDATA, or directive node.
<type>char *</type>
<description>Allocated string or NULL</description>
</returnvalue>
<description>Save an XML node tree to an allocated string.
<description>Save an XML tree to an allocated string.
This function returns a pointer to a string containing the textual
representation of the XML node tree. The string should be freed

Write Preview
Loading…
Cancel
Save