From b4eca043a04e8ef25c51289bc675692eef5da4b1 Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Wed, 18 Apr 2007 19:25:26 +0000 Subject: [PATCH] Save documentation updates. --- doc/install.html | 44 ++++++++---- doc/intro.html | 101 +++++++++++----------------- doc/license.html | 2 +- doc/mxml.html | 166 +++++++++++++++++++++++++++++++++++++++++----- doc/mxmldoc.xsd | 4 +- doc/relnotes.html | 32 ++++----- 6 files changed, 239 insertions(+), 110 deletions(-) diff --git a/doc/install.html b/doc/install.html index d3d3578..68bea3b 100644 --- a/doc/install.html +++ b/doc/install.html @@ -5,12 +5,31 @@ and Packaging Mini-XML

This chapter describes how to build, install, and package -Mini-XML on your system.

+Mini-XML on your system from the source archive. You will need an +ANSI/ISO-C compatible compiler to build Mini-XML - GCC works, as +do most vendors' C compilers. If you are building Mini-XML on +Windows, we recommend using the Visual C++ environment with the +supplied solution file. For other operating systems, you'll need a +POSIX-compatible shell and make program in addition to +the C compiler.

Compiling Mini-XML

-

Mini-XML comes with an autoconf-based configure script; just -type the following command to get things going:

+

Mini-XML comes with both an autoconf-based configure script +and a Visual C++ solution that can be used to compile the library +and associated tools.

+ +

Compiling with Visual C++

+ +

Open the mxml.sln solution in the vcnet +folder. Choose the desired build configuration, "Debug" (the +default) or "Release", and then choose Build Solution +from the Build menu.

+ +

Compiling with Command-Line Tools

+ +

Type the following command to configure the Mini-XML source +code for your system:

     ./configure ENTER
@@ -41,17 +60,18 @@ program to verify that things are working, as follows:

 
 
Installing Mini-XML

 
-
Use the make command with the install
-target to install Mini-XML in the configured directories:

+
If you are using Visual C++, copy the mxml.lib and
+and mxml.h files to the Visual C++ lib and
+include directories, respectively.

+
+
Otherwise, use the make command with the
+install target to install Mini-XML in the configured
+directories:

 
 
     make install ENTER
 

 
-
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 instead.

-
 
 
Creating Mini-XML Packages

 
@@ -86,10 +106,8 @@ to create portable and native packages for your system:

 
The packages are stored in a subdirectory named
 dist for your convenience. The portable packages
 utilize scripts and tar files to install the software on the
-target system; this is especially useful when installing on
-systems with different Linux distributions. Use the
-mxml.install script to install the software and
-mxml.remove script to remove the software.

+target system. After extracting the package archive, use the
+mxml.install script to install the software.

 
 
The native packages will be in the local OS's native format:
 RPM for Red Hat Linux, DPKG for Debian Linux, PKG for Solaris,
diff --git a/doc/intro.html b/doc/intro.html
index 660fa57..46d6b55 100644
--- a/doc/intro.html
+++ b/doc/intro.html
@@ -48,10 +48,10 @@ on the data based upon schema files or other sources of
 definition information, nor does it support character entities
 other than those required by the XML specification.

 
-
+
 
Legal Stuff

 
-
The Mini-XML library is copyright 2003-2005 by Michael
+
The Mini-XML library is copyright 2003-2007 by Michael
 Sweet.

 
 
This library is free software; you can redistribute it and/or
@@ -71,7 +71,7 @@ more details.

 
History

 
 
Mini-XML was initially developed for the Gimp-Print project to
+href='http://gutenprint.sf.net/'>Gutenprint project to
 replace the rather large and unwieldy libxml2 library
 with something substantially smaller and easier-to-use. It all
 began one morning in June of 2003 when Robert posted the
@@ -89,14 +89,16 @@ of code.
 
 
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 Gimp-Print
+code: 696. Robert promptly integrated Mini-XML into Gutenprint
 and removed libxml2.

 
 
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 2,974
+complete XML implementation and now stands at a whopping 3,441
 lines of code, compared to 103,893 lines of code for libxml2
-version 2.6.9. Aside from Gimp-Print, Mini-XML is used for the
+version 2.6.9.

+
+
Aside from Gutenprint, Mini-XML is used for the
 following projects/software applications:

 
 
 
-
+
 
Notation Conventions

 
 
Various font and syntax conventions are used in this guide.
 Examples and their meanings and uses are explained below:

 
-

-
-	
-	
-	
-
-
-
-	
+

 
-	

+	
lpstat

+	lpstat(1)

 
-	
-
-
-
-	
+	
The names of commands; the first mention of a command
+	or function in a chapter is followed by a manual page
+	section number.


 
-	
+	
/var

+	/usr/share/cups/data/testprint.ps

 
-	
-
-
-
-	
+	
File and directory names.


 
-	
+	
Request ID is Printer-123

 
-	
-
-
-
-	
+	
Screen output.


 
-	
+	
lp -d printer filename ENTER

 
-	
-
-
-
-	
+	
Literal user input; special keys like
+	ENTER are in ALL CAPS.


 
-	
+	
12.3

 
-	
-
-
Example   Description
 
lpstat

-	lpstat(1)		   The names of commands; the first mention of a command or
-	function in a chapter is followed by a manual page section
-	number.
 
/var

-	/usr/share/cups/data/testprint.ps		   File and directory names.
 
Request ID is Printer-123   Screen output.
 
lp -d printer filename ENTER   Literal user input; special keys like ENTER are
-	in ALL CAPS.
 
12.3   Numbers in the text are written using the period (.) to indicate
-	the decimal point.

+	
Numbers in the text are written using the period (.)
+	to indicate the decimal point.


 
-
+
+
+
 
Abbreviations

 
 
The following abbreviations are used throughout this
 manual:

 
-

 

 
 	
Gb

-	
Gigabytes, or 1073741824 bytes
 

+	
Gigabytes, or 1073741824 bytes


 
 	
kb

-	
Kilobytes, or 1024 bytes
 

+	
Kilobytes, or 1024 bytes


 
 	
Mb

-	
Megabytes, or 1048576 bytes
 

+	
Megabytes, or 1048576 bytes


 
 	
UTF-8, UTF-16

-	
Unicode Transformation Format, 8-bit or 16-bit
 

+	
Unicode Transformation Format, 8-bit or 16-bit


 
 	
W3C

-	
World Wide Web Consortium
 

+	
World Wide Web Consortium


 
 	
XML

-	
Extensible Markup Language
 

+	
Extensible Markup Language


 
 

-

 
+
 
Other References

 
-

 

 
 	
The Unicode Standard, Version 4.0, Addison-Wesley,
 	ISBN 0-321-18578-1

 
 	
The definition of the Unicode character set which is
-	used for XML.
 

+	used for XML.


 
 	
Extensible
 	Markup Language (XML) 1.0 (Third Edition)

 
 	
The XML specification from the World Wide Web
-	Consortium (W3C)
 

+	Consortium (W3C)


 
 

-

 
 
 
diff --git a/doc/license.html b/doc/license.html
index c84bba0..0bba3af 100644
--- a/doc/license.html
+++ b/doc/license.html
@@ -539,7 +539,7 @@ POSSIBILITY OF SUCH DAMAGES.

 
 
END OF TERMS AND CONDITIONS

 
-
How to Apply These Terms to Your New Libraries

+
How to Apply These Terms to Your New Libraries

 
 
If you develop a new library, and you want it to be of the greatest
 possible use to the public, we recommend making it free software that
diff --git a/doc/mxml.html b/doc/mxml.html
index 0fb9778..f7cd1e8 100644
--- a/doc/mxml.html
+++ b/doc/mxml.html
@@ -3,7 +3,7 @@
 
 Mini-XML Programmers Manual, Version 2.3
 
-
+