AIR/mxml
1
0
Fork 0
mirror of https://github.com/michaelrsweet/mxml.git synced 2024-11-24 11:25:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for v3.3.

Browse Source
This commit is contained in:
Michael R Sweet 2021-10-26 16:29:57 -04:00
parent 42d766cb86
commit 04c5b938e4
No known key found for this signature in database
GPG Key ID: 999559A027815955
8 changed files with 18 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/body.md
View File

@ -1,8 +1,8 @@
--- ---
title: Mini-XML 3.2 API Reference title: Mini-XML 3.3 Programming Manual
author: Michael R Sweet author: Michael R Sweet
copyright: Copyright © 2003-2021, All Rights Reserved. copyright: Copyright © 2003-2021, All Rights Reserved.
version: 3.2 version: 3.3
... ...
# Introduction # Introduction
@ -49,7 +49,7 @@ integrated Mini-XML into Gutenprint and removed libxml2.
Thanks to lots of feedback and support from various developers, Mini-XML has 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 evolved since then to provide a more complete XML implementation and now stands
at a whopping 4,186 lines of code, compared to 196,141 lines of code for libxml2 at a whopping 4,300 lines of code, compared to 196,141 lines of code for libxml2
version 2.9.9. version 2.9.9.
@ -62,7 +62,7 @@ tracker, and find other resources.
## Legal Stuff ## Legal Stuff
The Mini-XML library is copyright © 2003-2019 by Michael R Sweet and is provided The Mini-XML library is copyright © 2003-2021 by Michael R Sweet and is provided
under the Apache License Version 2.0 with an exception to allow linking against under the Apache License Version 2.0 with an exception to allow linking against
GPL2/LGPL2-only software. See the files "LICENSE" and "NOTICE" for more GPL2/LGPL2-only software. See the files "LICENSE" and "NOTICE" for more
information. information.

2
doc/footer.man
View File

@ -1,4 +1,4 @@
.SH SEE ALSO .SH SEE ALSO
Mini-XML Programmers Manual, https://www.msweet.org/mxml Mini-XML Programmers Manual, https://www.msweet.org/mxml
.SH COPYRIGHT .SH COPYRIGHT
Copyright \[co] 2003-2019 by Michael R Sweet. Copyright \[co] 2003-2021 by Michael R Sweet.

BIN
doc/mxml-cover.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 1.2 MiB

BIN
doc/mxml-cover.opacity
View File

Binary file not shown.

BIN
doc/mxml-cover.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 612 KiB

After

Width:  |  Height:  |  Size: 680 KiB

11
doc/mxml.3
View File

@ -1,4 +1,4 @@
.TH mxml 3 "Mini-XML API" "2021-05-30" "Mini-XML API" .TH mxml 3 "Mini-XML API" "2021-10-26" "Mini-XML API"
.SH NAME .SH NAME
mxml \- Mini-XML API mxml \- Mini-XML API
.SH INCLUDE FILE .SH INCLUDE FILE
@ -1040,12 +1040,11 @@ char * mxmlSaveAllocString (
.PP .PP
This function returns a pointer to a string containing the textual This function returns a pointer to a string containing the textual
representation of the XML node tree. The string should be freed representation of the XML node tree. The string should be freed
using the free() function when you are done with it. \fBNULL\fR is returned using \fBfree()\fR when you are done with it. \fBNULL\fR is returned if the node
if the node would produce an empty string or if the string cannot be would produce an empty string or if the string cannot be allocated.
allocated.
.PP .PP
The callback argument specifies a function that returns a whitespace The callback argument specifies a function that returns a whitespace
string or NULL before and after each element. If \fBMXML_NO_CALLBACK\fR string or \fBNULL\fR before and after each element. If \fBMXML_NO_CALLBACK\fR
is specified, whitespace will only be added before \fBMXML_TEXT\fR nodes is specified, whitespace will only be added before \fBMXML_TEXT\fR nodes
with leading whitespace and before attribute names inside opening with leading whitespace and before attribute names inside opening
element tags. element tags.
@ -1362,4 +1361,4 @@ typedef enum mxml_type_e mxml_type_t;
.SH SEE ALSO .SH SEE ALSO
Mini-XML Programmers Manual, https://www.msweet.org/mxml Mini-XML Programmers Manual, https://www.msweet.org/mxml
.SH COPYRIGHT .SH COPYRIGHT
Copyright \[co] 2003-2019 by Michael R Sweet. Copyright \[co] 2003-2021 by Michael R Sweet.

BIN
doc/mxml.epub
View File

Binary file not shown.

17
doc/mxml.html
View File

@ -1,13 +1,13 @@
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en-US"> <html lang="en-US">
<head> <head>
<title>Mini-XML 3.2 API Reference</title> <title>Mini-XML 3.3 Programming Manual</title>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8"> <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<meta name="generator" content="codedoc v3.7"> <meta name="generator" content="codedoc v3.7">
<meta name="author" content="Michael R Sweet"> <meta name="author" content="Michael R Sweet">
<meta name="language" content="en-US"> <meta name="language" content="en-US">
<meta name="copyright" content="Copyright © 2003-2021, All Rights Reserved."> <meta name="copyright" content="Copyright © 2003-2021, All Rights Reserved.">
<meta name="version" content="3.2"> <meta name="version" content="3.3">
<style type="text/css"><!-- <style type="text/css"><!--
body { body {
background: white; background: white;
@ -245,7 +245,7 @@ span.string {
<body> <body>
<div class="header"> <div class="header">
<p><img class="title" src="mxml-cover.png"></p> <p><img class="title" src="mxml-cover.png"></p>
<h1 class="title">Mini-XML 3.2 API Reference</h1> <h1 class="title">Mini-XML 3.3 Programming Manual</h1>
<p>Michael R Sweet</p> <p>Michael R Sweet</p>
<p>Copyright © 2003-2021, All Rights Reserved.</p> <p>Copyright © 2003-2021, All Rights Reserved.</p>
</div> </div>
@ -406,11 +406,11 @@ span.string {
<p>Given the limited scope of what you use in XML, it should be trivial to code a mini-XML API in a few hundred lines of code.</p> <p>Given the limited scope of what you use in XML, it should be trivial to code a mini-XML API in a few hundred lines of code.</p>
</blockquote> </blockquote>
<p>I took my own challenge and coded furiously for two days to produced the initial public release of Mini-XML, total lines of code: 696. Robert promptly integrated Mini-XML into Gutenprint and removed libxml2.</p> <p>I took my own challenge and coded furiously for two days to produced the initial public release of Mini-XML, total lines of code: 696. Robert promptly integrated Mini-XML into Gutenprint 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 4,186 lines of code, compared to 196,141 lines of code for libxml2 version 2.9.9.</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 4,300 lines of code, compared to 196,141 lines of code for libxml2 version 2.9.9.</p>
<h3 class="title" id="resources">Resources</h3> <h3 class="title" id="resources">Resources</h3>
<p>The Mini-XML home page can be found at <a href="https://www.msweet.org/mxml">https://www.msweet.org/mxml</a>. From there you can download the current version of Mini-XML, access the issue tracker, and find other resources.</p> <p>The Mini-XML home page can be found at <a href="https://www.msweet.org/mxml">https://www.msweet.org/mxml</a>. From there you can download the current version of Mini-XML, access the issue tracker, and find other resources.</p>
<h3 class="title" id="legal-stuff">Legal Stuff</h3> <h3 class="title" id="legal-stuff">Legal Stuff</h3>
<p>The Mini-XML library is copyright © 2003-2019 by Michael R Sweet and is provided under the Apache License Version 2.0 with an exception to allow linking against GPL2/LGPL2-only software. See the files &quot;LICENSE&quot; and &quot;NOTICE&quot; for more information.</p> <p>The Mini-XML library is copyright © 2003-2021 by Michael R Sweet and is provided under the Apache License Version 2.0 with an exception to allow linking against GPL2/LGPL2-only software. See the files &quot;LICENSE&quot; and &quot;NOTICE&quot; for more information.</p>
<h2 class="title" id="using-mini-xml">Using Mini-XML</h2> <h2 class="title" id="using-mini-xml">Using Mini-XML</h2>
<p>Mini-XML provides a single header file which you include:</p> <p>Mini-XML provides a single header file which you include:</p>
<pre><code>#include &lt;mxml.h&gt; <pre><code>#include &lt;mxml.h&gt;
@ -2229,12 +2229,11 @@ char *mxmlSaveAllocString(<a href="#mxml_node_t">mxml_node_t</a> *node, <a href=
<h4 class="discussion">Discussion</h4> <h4 class="discussion">Discussion</h4>
<p class="discussion">This function returns a pointer to a string containing the textual <p class="discussion">This function returns a pointer to a string containing the textual
representation of the XML node tree. The string should be freed representation of the XML node tree. The string should be freed
using the free() function when you are done with it. <code>NULL</code> is returned using <code>free()</code> when you are done with it. <code>NULL</code> is returned if the node
if the node would produce an empty string or if the string cannot be would produce an empty string or if the string cannot be allocated.<br>
allocated.<br>
<br> <br>
The callback argument specifies a function that returns a whitespace The callback argument specifies a function that returns a whitespace
string or NULL before and after each element. If <code>MXML_NO_CALLBACK</code> string or <code>NULL</code> before and after each element. If <code>MXML_NO_CALLBACK</code>
is specified, whitespace will only be added before <code>MXML_TEXT</code> nodes is specified, whitespace will only be added before <code>MXML_TEXT</code> nodes
with leading whitespace and before attribute names inside opening with leading whitespace and before attribute names inside opening
element tags.</p> element tags.</p>