Re: [xml] [Proposal] How about write a book for LibXML2?



Hi everyone.

Whether you decide on a wiki or a book, please include Solaris and OpenSolaris when listing supported OSs.

FYI: We here at OpenSolaris and Sun are using libxml2 in a big and interesting way for our new installation tool projects, specifically Distribution Constructor and Auto-Installer. Please see http://www.opensolaris.org/os/project/caiman for more info.

   Thanks,
   Jack

Just to throw something out there, I sketched out a preliminary layout
that could be used (and of course improved upon) as a skeleton for a
DocBook or Wiki:

The libxml2 Library

Introduction
  History
  What is libxml2?
  What libxml2 Is Not
  libxml2 Architecture

Getting started
  Installing libxml2
    Binaries
      Linux
        Ubuntu / Debian
        OpenSUSE
        Fedora
        Gentoo
      FreeBSD
      OpenBSD
      Windows
      MacOS X
    Building from source
      Download libxml2
        Stable Version
        Subversion
      Configure Options
      Building
        Linux / BSD
        Windows
        MacOS X
  Quick Start
    Hello World
    Building Your Program

The libxml2 APIs
  Choosing the Right API
  The Tree API
    Introduction
    Basic Example
    Complex Example
    Common Problems
  The Reader API
    Introduction
    Basic Example
    Complex Example
    Common Problems
  The SAX2 API
    Introduction
    Basic Example
    Complex Example
    Common Problems
  The HTML API
    Introduction
    Basic Example
    Complex Example
    Common Problems
  XPath API
    Introduction
    Basic Example
    Complex Example
    Common Problems
  XPointer API
    Introduction
    Basic Example
    Complex Example
    Common Problems
  XInclude API
    Introduction
    Basic Example
    Complex Example
    Common Problems
  Utility APIs
    String Handling
    HTTP / FTP
    XML and SGML Catalogs
    String Dictionaries
    Hash Tables
  Putting It All Together
    (Some more complex "task oriented" examples exercising
     the various APIs and using XML found in the wild)

Validation
  Introduction
  DTDs
  XML Schemas
  RelaxNG
  Schematron

Namespaces
  Introduction
  Basic Example
  Complex Example
  Common Problems

Error Handling
  Introduction
  Basic Example
  Complex Example
  Common Problems

Threads
  Introduction
  Thread Safety
  Basic Example
  Complex Example
  Common Problems

Language Bindings
  Perl
  PHP
  Python
  Ruby

Appendix
  A See Also
  B Acknowledgements

As you can see the sections for the various APIs are pretty sparse and
repetitive, with just an introduction to each API along with some
examples, the idea being that the current examples on xmlsoft.org can
be taken and improved upon, and as people (hopefully) contribute more
hands on and anecdotal information, those sections could be fleshed
out.

Any comments? I've probably left something out.

Are you dead against giving a wiki a try again Daniel? Even a
"registration required" one? If so, I could arrange this skeleton into
a DocBook XML instead and send it over.

Regards,
Elvis

 Best Regards
-Scord

Motorola Software Center
[x] Public
[ ] Internal
[ ] Motorola Confidential Restricted
 Heh, finally a smart non threatening way to label expected recipient
for mails issued by a corporation. Nice !
Yea I jumped at that too! Finally! :)

Regards,
Elvis

Daniel

--
Daniel Veillard      | libxml Gnome XML XSLT toolkit  http://xmlsoft.org/
daniel veillard com  | Rpmfind RPM search engine http://rpmfind.net/
http://veillard.com/ | virtualization library  http://libvirt.org/
_______________________________________________
xml mailing list, project page  http://xmlsoft.org/
xml gnome org
http://mail.gnome.org/mailman/listinfo/xml

_______________________________________________
xml mailing list, project page  http://xmlsoft.org/
xml gnome org
http://mail.gnome.org/mailman/listinfo/xml




[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]