Doco updates.

pull/193/head
Michael R Sweet 21 years ago
parent 3aded463be
commit 725aaec2d8
  1. 4
      CHANGES
  2. 12
      README
  3. 8
      TODO
  4. 611
      configure
  5. 56
      doc/advanced.html
  6. 3
      doc/relnotes.html

@ -1,9 +1,11 @@
README - 06/18/2004 README - 06/21/2004
------------------- -------------------
CHANGES IN Mini-XML 2.0 CHANGES IN Mini-XML 2.0
- New programmers manual. - New programmers manual.
- Added Visual C++ project files for Microsoft Windows
users.
- Added optimizations to mxmldoc, mxmlSaveFile(), and - Added optimizations to mxmldoc, mxmlSaveFile(), and
mxmlIndexNew() (STR #2) mxmlIndexNew() (STR #2)
- mxmlEntityAddCallback() now returns an integer status - mxmlEntityAddCallback() now returns an integer status

@ -1,4 +1,4 @@
README - 06/18/2004 README - 06/21/2004
------------------- -------------------
@ -29,11 +29,7 @@ INTRODUCTION
Mini-XML doesn't do validation or other types of processing Mini-XML doesn't do validation or other types of processing
on the data based upon schema files or other sources of on the data based upon schema files or other sources of
definition information, nor does it support character definition information.
entities other than those required by the XML
specification. Also, since Mini-XML does not support the
UTF-16 encoding, it is technically not a conforming XML
consumer/client.
BUILDING Mini-XML BUILDING Mini-XML
@ -59,6 +55,10 @@ BUILDING Mini-XML
make make
If you are using Mini-XML under Microsoft Windows with
Visual C++, use the included project files in the "vcnet"
subdirectory to build the library.
INSTALLING Mini-XML INSTALLING Mini-XML

@ -1,15 +1,11 @@
TODO - 05/16/2004 TODO - 06/21/2004
----------------- -----------------
- New documentation.
-- Use HTMLDOC to generate
-- Provide more tutorials
-- Release notes
- Add access methods and make node structure opaque. - Add access methods and make node structure opaque.
-- To allow for C++ migration -- To allow for C++ migration
-- To make future binary compatibility easier -- To make future binary compatibility easier
- Add VC++/VC++.NET project files. - Add VC++/VC++.NET project files.
-- Include DLL .def file for making a DLL. -- Include DLL .def file for making a DLL?
- Add C++ class/struct. - Add C++ class/struct.
-- Make this the core implementation which the C API accesses? -- Make this the core implementation which the C API accesses?
-- Class would allow for subclassing, is that necessary? -- Class would allow for subclassing, is that necessary?

611
configure vendored

File diff suppressed because it is too large Load Diff

@ -266,15 +266,61 @@ href='#mxmlIndexEnum'><tt>mxmlIndexEnum()</tt></a>, <a
href='#mxmlIndexFind'><tt>mxmlIndexFind()</tt></a>, and <a href='#mxmlIndexFind'><tt>mxmlIndexFind()</tt></a>, and <a
href='#mxmlIndexReset'><tt>mxmlIndexReset()</tt></a> functions href='#mxmlIndexReset'><tt>mxmlIndexReset()</tt></a> functions
are used to access the nodes in the index. The <a are used to access the nodes in the index. The <a
href='#mxmlIndexEnum'><tt>mxmlIndexEnum()</tt></a> function href='#mxmlIndexReset'><tt>mxmlIndexReset()</tt></a> function
enumerates each of the nodes in the index.</p> resets the "current" node pointer in the index, allowing you to
do new searches and enumerations on the same index. Typically
you will call this function prior to your calls to <a
href='#mxmlIndexEnum'><tt>mxmlIndexEnum()</tt></a> and <a
href='#mxmlIndexFind'><tt>mxmlIndexFind()</tt></a>.</p>
<p>The <a href='#mxmlIndexEnum'><tt>mxmlIndexEnum()</tt></a>
function enumerates each of the nodes in the index and can be
used in a loop as follows:</p>
<pre>
<a href='#mxml_node_t'>mxml_node_t</a> *node;
<a href='#mxml_index_t'>mxml_index_t</a> *ind;
mxmlIndexReset(ind);
while ((node = mxmlIndexEnum(ind)) != NULL)
{
// do something with node
}
</pre>
<p>The <a href='#mxmlIndexFind'><tt>mxmlIndexFind()</tt></a> <p>The <a href='#mxmlIndexFind'><tt>mxmlIndexFind()</tt></a>
function</p> function locates the next occurrence of the named element and
attribute value in the index. It can be used to find all
matching elements in an index, as follows:</p>
<pre>
<a href='#mxml_node_t'>mxml_node_t</a> *node;
<a href='#mxml_index_t'>mxml_index_t</a> *ind;
mxmlIndexReset(ind);
while ((node = mxmlIndexFind(ind, "element", "attr-value")) != NULL)
{
// do something with node
}
</pre>
<p>The second and third arguments represent the element name and
attribute value, respectively. A <tt>NULL</tt> pointer is used
to return all elements or attributes in the index. Passing
<tt>NULL</tt> for both the element name and attribute value
is equivalent to calling <tt>mxmlIndexEnum</tt>.</p>
<p>When you are done using the index, delete it using the
<a href='#mxmlIndexDelete()'><tt>mxmlIndexDelete()</tt></a>
function:</p>
<p>The <a href='#mxmlIndexReset'><tt>mxmlIndexReset()</tt></a> <pre>
function</p> <a href='#mxml_index_t'>mxml_index_t</a> *ind;
mxmlIndexDelete(ind);
</pre>
</body> </body>
</html> </html>

@ -9,6 +9,9 @@
<li>New programmers manual.</li> <li>New programmers manual.</li>
<li>Added Visual C++ project files for Microsoft Windows
users.</li>
<li>Added optimizations to mxmldoc, mxmlSaveFile(), and <li>Added optimizations to mxmldoc, mxmlSaveFile(), and
mxmlIndexNew() (STR #2)</li> mxmlIndexNew() (STR #2)</li>

Loading…
Cancel
Save