Prep for Mini-XML v2.7 release.

This commit is contained in:
Michael R Sweet 2011-12-21 07:48:59 +00:00
parent 2283c7065a
commit 5e785816aa
10 changed files with 71 additions and 107 deletions

View File

@ -1,8 +1,9 @@
CHANGES - 2011-12-09
CHANGES - 2011-12-20
--------------------
CHANGES IN Mini-XML 2.7
- Added 64-bit configurations to the VC++ project files (STR #129)
- Fixed conformance of mxmldoc's HTML and CSS output.
- Added data accessor ("get") functions and made the mxml_node_t and
mxml_index_t structures private but still available in the Mini-XML

2
README
View File

@ -1,4 +1,4 @@
README - 2011-01-02
README - 2011-12-20
-------------------

67
TODO
View File

@ -1,72 +1,7 @@
TODO - 2008-11-19
TODO - 2011-12-20
-----------------
- Add access methods and make node structure opaque.
-- To allow for C++ migration
-- To make future binary compatibility easier
- Add C++ class/struct.
-- Make this the core implementation which the C API accesses?
-- Class would allow for subclassing, is that necessary?
- Binary XML support???
- Add "--docset foo" option to generate an Xcode docset bundle,
"--feed-name bar" and "--feed-url http://..."
docset
Contents
Info.plist
Nodes.xml
Resources
Documents
index.html
Tokens.xml
Run /Developer/usr/bin/docsetutil to generate index files
Info.plist:
DocSetFeedName ("cups.org", "Easy Software Products", etc.)
DocSetFeedURL ("")
CFBundleName (title)
CFBundleIdentifier (docset)
Nodes.xml:
<?xml version="1.0" encoding="utf-8"?>
<DocSetNodes version="1.0">
<TOC>
<Node id="1" type="folder">
<Name>name</Name>
<Path>index.html</Path>
</Node>
</TOC>
</DocSetNodes>
Tokens.xml:
<?xml version="1.0" encoding="utf-8"?>
<File path="index.html">
<Token>
<TokenIdentifier>
<Name></Name>
<APILanguage>c or cpp</APILanguage>
<Type>type</Type>
<Scope>classname</Scope>
</TokenIdentifier>
<Anchor>anchor string</Anchor>
<Abstract>summary</Abstract>
<Declaration>prototype</Declaration>
OR
<TokenIdentifier>//apple_ref/lang/type/scope/name</TokenIdentifier>
</Token>
...
</File>
types: http://developer.apple.com/documentation/DeveloperTools/Conceptual/HeaderDoc/anchors/chapter_950_section_2.html
tag struct, union, or enum tag
econst an enumerated constant—that is, a symbol defined inside an enum
tdef typedef name (or Pascal type)
data global or file-static data
func function name (without '()')
cl class name
instm an instance method 'clm' a class (or static [in java or c++]) method
func C++ scoped function (i.e. not extern 'C'); includes return type and signature.

View File

@ -2026,6 +2026,8 @@ hspace="10" src="A.gif" width="100"></A>Mini-XML License</H1>
hspace="10" src="B.gif" width="100"></A>Release Notes</H1>
<H2><A NAME="7_1">Changes in Mini-XML 2.7</A></H2>
<UL>
<LI>Added 64-bit configurations to the VC++ project files (STR #129)</LI>
<LI>Fixed conformance of mxmldoc's HTML and CSS output.</LI>
<LI>Added data accessor (&quot;get&quot;) functions and made the mxml_node_t and
mxml_index_t structures private but still available in the Mini-XML
header to preserve source compatibility (STR #118)</LI>
@ -2489,6 +2491,7 @@ mxml_save_cb_t</A></LI>
<LI><A href="#mxml_type_e" title="The XML node type.">mxml_type_e</A></LI>
</UL>
</LI>
</UL>
<H2 class="title"><A name="FUNCTIONS">Functions</A></H2>
<H3 class="function"><A name="mxmlAdd">mxmlAdd</A></H3>
<P class="description">Add a node to a tree.</P>
@ -3681,8 +3684,8 @@ NULL</CODE>.</P>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not a CDATA
element node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not a CDATA element node.</P>
<H3 class="function"><A NAME="8_2_57">
<!--span class=&quot;info&quot;-->
&nbsp;Mini-XML 2.1&nbsp;<A name="mxmlSetCustom">mxmlSetCustom</A></A></H3>
@ -3706,8 +3709,8 @@ NULL</CODE>.</P>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not a custom
node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not a custom node.</P>
<H3 class="function"><A name="mxmlSetCustomHandlers">
mxmlSetCustomHandlers</A></H3>
<P class="description">Set the handling functions for custom data.</P>
@ -3774,8 +3777,8 @@ mxmlSetCustomHandlers</A></H3>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not an integer
node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not an integer node.</P>
<H3 class="function"><A name="mxmlSetOpaque">mxmlSetOpaque</A></H3>
<P class="description">Set the value of an opaque node.</P>
<P class="code"> int mxmlSetOpaque (
@ -3792,8 +3795,8 @@ mxmlSetCustomHandlers</A></H3>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not an opaque
node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not an opaque node.</P>
<H3 class="function"><A name="mxmlSetReal">mxmlSetReal</A></H3>
<P class="description">Set the value of a real number node.</P>
<P class="code"> int mxmlSetReal (
@ -3810,8 +3813,8 @@ mxmlSetCustomHandlers</A></H3>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not a real number
node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not a real number node.</P>
<H3 class="function"><A name="mxmlSetText">mxmlSetText</A></H3>
<P class="description">Set the value of a text node.</P>
<P class="code"> int mxmlSetText (
@ -3831,7 +3834,8 @@ mxmlSetCustomHandlers</A></H3>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not a text node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not a text node.</P>
<H3 class="function"><A name="mxmlSetTextf">mxmlSetTextf</A></H3>
<P class="description">Set the value of a text node to a formatted
string.</P>
@ -3855,7 +3859,8 @@ mxmlSetCustomHandlers</A></H3>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not a text node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not a text node.</P>
<H3 class="function"><A NAME="8_2_66">
<!--span class=&quot;info&quot;-->
&nbsp;Mini-XML 2.7&nbsp;<A name="mxmlSetUserData">mxmlSetUserData</A></A></H3>
@ -4023,7 +4028,6 @@ mxml_sax_event_e</A> mxml_sax_event_t;</P>
<DT>MXML_TEXT</DT>
<DD class="description">Text fragment</DD>
</DL>
</UL>
</DIV><HR NOSHADE>
<H1 align="right"><A name="SCHEMA"><IMG align="right" alt="D" height="100"
hspace="10" src="D.gif" width="100"></A>XML Schema</H1>

View File

@ -9,6 +9,8 @@ hspace="10" width="100" height="100" alt="B"></a>Release Notes</h1>
<ul>
<li>Added 64-bit configurations to the VC++ project files (STR #129)</li>
<li>Fixed conformance of mxmldoc's HTML and CSS output.</li>
<li>Added data accessor ("get") functions and made the mxml_node_t and

View File

@ -202,6 +202,7 @@ mxml_save_cb_t</A></LI>
<LI><A href="#mxml_type_e" title="The XML node type.">mxml_type_e</A></LI>
</UL>
</LI>
</UL>
<H2 class="title"><A name="FUNCTIONS">Functions</A></H2>
<H3 class="function"><A name="mxmlAdd">mxmlAdd</A></H3>
<P class="description">Add a node to a tree.</P>
@ -1394,8 +1395,8 @@ NULL</CODE>.</P>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not a CDATA
element node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not a CDATA element node.</P>
<H3 class="function"><A NAME="8_2_57">
<!--span class=&quot;info&quot;-->
&nbsp;Mini-XML 2.1&nbsp;<A name="mxmlSetCustom">mxmlSetCustom</A></A></H3>
@ -1419,8 +1420,8 @@ NULL</CODE>.</P>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not a custom
node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not a custom node.</P>
<H3 class="function"><A name="mxmlSetCustomHandlers">
mxmlSetCustomHandlers</A></H3>
<P class="description">Set the handling functions for custom data.</P>
@ -1487,8 +1488,8 @@ mxmlSetCustomHandlers</A></H3>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not an integer
node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not an integer node.</P>
<H3 class="function"><A name="mxmlSetOpaque">mxmlSetOpaque</A></H3>
<P class="description">Set the value of an opaque node.</P>
<P class="code"> int mxmlSetOpaque (
@ -1505,8 +1506,8 @@ mxmlSetCustomHandlers</A></H3>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not an opaque
node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not an opaque node.</P>
<H3 class="function"><A name="mxmlSetReal">mxmlSetReal</A></H3>
<P class="description">Set the value of a real number node.</P>
<P class="code"> int mxmlSetReal (
@ -1523,8 +1524,8 @@ mxmlSetCustomHandlers</A></H3>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not a real number
node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not a real number node.</P>
<H3 class="function"><A name="mxmlSetText">mxmlSetText</A></H3>
<P class="description">Set the value of a text node.</P>
<P class="code"> int mxmlSetText (
@ -1544,7 +1545,8 @@ mxmlSetCustomHandlers</A></H3>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not a text node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not a text node.</P>
<H3 class="function"><A name="mxmlSetTextf">mxmlSetTextf</A></H3>
<P class="description">Set the value of a text node to a formatted
string.</P>
@ -1568,7 +1570,8 @@ mxmlSetCustomHandlers</A></H3>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not a text node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not a text node.</P>
<H3 class="function"><A NAME="8_2_66">
<!--span class=&quot;info&quot;-->
&nbsp;Mini-XML 2.7&nbsp;<A name="mxmlSetUserData">mxmlSetUserData</A></A></H3>
@ -1736,7 +1739,6 @@ mxml_sax_event_e</A> mxml_sax_event_t;</P>
<DT>MXML_TEXT</DT>
<DD class="description">Text fragment</DD>
</DL>
</UL>
</DIV><HR NOSHADE>
<A HREF="index.html">Contents</A>
<A HREF="relnotes.html">Previous</A>

View File

@ -32,6 +32,7 @@ A { text-decoration: none }
hspace="10" src="B.gif" width="100"></A>Release Notes</H1>
<H2><A NAME="7_1">Changes in Mini-XML 2.7</A></H2>
<UL>
<LI>Fixed conformance of mxmldoc's HTML and CSS output.</LI>
<LI>Added data accessor (&quot;get&quot;) functions and made the mxml_node_t and
mxml_index_t structures private but still available in the Mini-XML
header to preserve source compatibility (STR #118)</LI>

View File

@ -2026,6 +2026,7 @@ hspace="10" src="A.gif" width="100"></A>Mini-XML License</H1>
hspace="10" src="B.gif" width="100"></A>Release Notes</H1>
<H2><A NAME="7_1">Changes in Mini-XML 2.7</A></H2>
<UL>
<LI>Fixed conformance of mxmldoc's HTML and CSS output.</LI>
<LI>Added data accessor (&quot;get&quot;) functions and made the mxml_node_t and
mxml_index_t structures private but still available in the Mini-XML
header to preserve source compatibility (STR #118)</LI>
@ -2489,6 +2490,7 @@ mxml_save_cb_t</A></LI>
<LI><A href="#mxml_type_e" title="The XML node type.">mxml_type_e</A></LI>
</UL>
</LI>
</UL>
<H2 class="title"><A name="FUNCTIONS">Functions</A></H2>
<H3 class="function"><A name="mxmlAdd">mxmlAdd</A></H3>
<P class="description">Add a node to a tree.</P>
@ -3681,8 +3683,8 @@ NULL</CODE>.</P>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not a CDATA
element node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not a CDATA element node.</P>
<H3 class="function"><A NAME="8_2_57">
<!--span class=&quot;info&quot;-->
&nbsp;Mini-XML 2.1&nbsp;<A name="mxmlSetCustom">mxmlSetCustom</A></A></H3>
@ -3706,8 +3708,8 @@ NULL</CODE>.</P>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not a custom
node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not a custom node.</P>
<H3 class="function"><A name="mxmlSetCustomHandlers">
mxmlSetCustomHandlers</A></H3>
<P class="description">Set the handling functions for custom data.</P>
@ -3774,8 +3776,8 @@ mxmlSetCustomHandlers</A></H3>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not an integer
node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not an integer node.</P>
<H3 class="function"><A name="mxmlSetOpaque">mxmlSetOpaque</A></H3>
<P class="description">Set the value of an opaque node.</P>
<P class="code"> int mxmlSetOpaque (
@ -3792,8 +3794,8 @@ mxmlSetCustomHandlers</A></H3>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not an opaque
node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not an opaque node.</P>
<H3 class="function"><A name="mxmlSetReal">mxmlSetReal</A></H3>
<P class="description">Set the value of a real number node.</P>
<P class="code"> int mxmlSetReal (
@ -3810,8 +3812,8 @@ mxmlSetCustomHandlers</A></H3>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not a real number
node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not a real number node.</P>
<H3 class="function"><A name="mxmlSetText">mxmlSetText</A></H3>
<P class="description">Set the value of a text node.</P>
<P class="code"> int mxmlSetText (
@ -3831,7 +3833,8 @@ mxmlSetCustomHandlers</A></H3>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not a text node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not a text node.</P>
<H3 class="function"><A name="mxmlSetTextf">mxmlSetTextf</A></H3>
<P class="description">Set the value of a text node to a formatted
string.</P>
@ -3855,7 +3858,8 @@ mxmlSetCustomHandlers</A></H3>
<H4 class="returnvalue">Return Value</H4>
<P class="description">0 on success, -1 on failure</P>
<H4 class="discussion">Discussion</H4>
<P class="discussion">The node is not changed if it is not a text node.</P>
<P class="discussion">The node is not changed if it (or its first child)
is not a text node.</P>
<H3 class="function"><A NAME="8_2_66">
<!--span class=&quot;info&quot;-->
&nbsp;Mini-XML 2.7&nbsp;<A name="mxmlSetUserData">mxmlSetUserData</A></A></H3>
@ -4023,7 +4027,6 @@ mxml_sax_event_e</A> mxml_sax_event_t;</P>
<DT>MXML_TEXT</DT>
<DD class="description">Text fragment</DD>
</DL>
</UL>
</DIV><HR NOSHADE>
<H1 align="right"><A name="SCHEMA"><IMG align="right" alt="D" height="100"
hspace="10" src="D.gif" width="100"></A>XML Schema</H1>

16
www/org.minixml.atom Normal file
View File

@ -0,0 +1,16 @@
<?xml version="1.0" standalone="no"?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:docset="http://developer.apple.com/rss/docset_extensions" xml:lang="en">
<id>http://www.minixml.org/org.minixml.atom/20111220234804</id>
<title type="text">minixml.org</title>
<link rel="self" href="http://www.minixml.org/org.minixml.atom"></link>
<updated>2011-12-20T23:48:04-08:00</updated>
<entry>
<id>tag:www.minixml.org,2011-12-20:org.minixml.docset/2.7.0</id>
<title type="text">Mini-XML API Reference</title>
<updated>2011-12-20T23:48:04-08:00</updated>
<content type="text">Mini-XML API Reference (v2.7.0)</content>
<link rel="enclosure" type="application/octet-stream" href="http://www.minixml.org/org.minixml.xar" length="48828"></link>
<docset:identifier>org.minixml.docset</docset:identifier>
<docset:version>2.7.0</docset:version>
</entry>
</feed>

BIN
www/org.minixml.xar Normal file

Binary file not shown.