From e46e20d3f568c70a11e4eb126b03fb4cc9695105 Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Fri, 14 Jul 2000 15:02:46 +0000 Subject: [PATCH] Regenerated the docs on my work station, Daniel --- ChangeLog | 4 + doc/html/book1.html | 276 +++++++++++ doc/html/gnome-xml-debugxml.html | 38 +- doc/html/gnome-xml-encoding.html | 47 +- doc/html/gnome-xml-entities.html | 55 ++- doc/html/gnome-xml-htmlparser.html | 222 +++++++-- doc/html/gnome-xml-htmltree.html | 497 +++++++++++++++++++- doc/html/gnome-xml-nanoftp.html | 62 +-- doc/html/gnome-xml-nanohttp.html | 28 +- doc/html/gnome-xml-parserinternals.html | 578 ++++++++++++++++++++---- doc/html/gnome-xml-sax.html | 104 ++--- doc/html/gnome-xml-tree.html | 524 ++++++++++++++------- doc/html/gnome-xml-valid.html | 152 +++---- doc/html/gnome-xml-xml-error.html | 22 +- doc/html/gnome-xml-xmlio.html | 78 ++-- doc/html/gnome-xml-xmlmemory.html | 48 +- doc/html/gnome-xml-xpath.html | 76 ++-- doc/html/index.sgml | 12 +- doc/html/libxml-notes.html | 6 +- 19 files changed, 2156 insertions(+), 673 deletions(-) diff --git a/ChangeLog b/ChangeLog index c5019df4..ed6df72e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +Fri Jul 14 17:01:14 CEST 2000 Daniel Veillard + + * doc/ regenerated the docs + Fri Jul 14 16:12:20 MEST 2000 Daniel Veillard * doc/encoding.html doc/xml.html: added I18N doc diff --git a/doc/html/book1.html b/doc/html/book1.html index e69de29b..e066da65 100644 --- a/doc/html/book1.html +++ b/doc/html/book1.html @@ -0,0 +1,276 @@ +Gnome XML Library Reference Manual

Gnome XML Library Reference Manual

Daniel Veillard

    Daniel.Veillard@w3.org
+   

Copyright © 1999 by Daniel Veillard

This manual documents the interfaces of the libxml + library and has some short notes to help get you up to speed + with using the library.

Permission is granted to make and distribute verbatim + copies of this manual provided the copyright notice and this + permission notice are preserved on all copies.

Permission is granted to copy and distribute modified + versions of this manual under the conditions for verbatim + copying, provided also that the entire resulting derived work is + distributed under the terms of a permission notice identical to + this one.

Permission is granted to copy and distribute translations + of this manual into another language, under the above conditions + for modified versions.

Table of Contents
Libxml Programming Notes
Libxml Library Reference
parser —
SAX —
tree —
entities —
valid —
uri —
xml-error —
HTMLparser —
HTMLtree —
xpath —
nanohttp —
nanoftp —
xmlIO —
parserInternals —
encoding —
debugXML —
xmlmemory —


   Next Page >>>
 Libxml Programming Notes
\ No newline at end of file diff --git a/doc/html/gnome-xml-debugxml.html b/doc/html/gnome-xml-debugxml.html index 3c8a1da6..6d688710 100644 --- a/doc/html/gnome-xml-debugxml.html +++ b/doc/html/gnome-xml-debugxml.html @@ -115,7 +115,7 @@ SIZE="3" >

Name

Synopsis

Description

Details

Name

Synopsis

Description

Details

Name

Synopsis

Description

Details

TODO !!!! Once moved to UTF-8 internal encoding, the encoding of non-ascii -get erroneous.

Name

Synopsis

htmlParseFile (const char *filename, const char *encoding); +int UTF8ToHtml (unsigned char *out, + int *outlen, + unsigned char *in, + int *inlen); void htmlFreeParserCtxt

Description

Details

UTF8ToHtml ()

int         UTF8ToHtml                      (unsigned char *out,
+                                             int *outlen,
+                                             unsigned char *in,
+                                             int *inlen);

Take a block of UTF-8 chars in and try to convert it to an ASCII +plus HTML entities block of chars out.

out : a pointer to an array of bytes to store the result
outlen : the length of out
in : a pointer to an array of UTF-8 chars
inlen : the length of in
Returns :0 if success, -2 if the transcoding fails, or -1 otherwise +The value of inlen after return is the number of octets consumed +as the return value is positive, else unpredictiable. +The value of outlen after return is the number of octets consumed.

Name

Synopsis

HTML_COMMENT_NODE +htmlDocPtr htmlNewDoc (const xmlChar *URI, + const xmlChar *ExternalID); +const xmlChar* htmlGetMetaEncoding (htmlDocPtr doc); +int htmlSetMetaEncoding (htmlDocPtr doc, + const xmlChar *encoding); void htmlDocDumpMemoryxmlChar **mem, int *size); -void htmlDocDump (xmlNodePtr cur); cur); +int htmlSaveFileEnc (const char *filename, + xmlDocPtr cur, + const char *encoding);

Description

Details

htmlNewDoc ()

htmlDocPtr  htmlNewDoc                      (const xmlChar *URI,
+                                             const xmlChar *ExternalID);

URI : URI for the dtd, or NULL
ExternalID : the external ID of the DTD, or NULL
Returns :a new document

htmlGetMetaEncoding ()

const xmlChar* htmlGetMetaEncoding          (htmlDocPtr doc);

Encoding definition lookup in the Meta tags

doc : the document
Returns :the current encoding as flagged in the HTML source

htmlSetMetaEncoding ()

int         htmlSetMetaEncoding             (htmlDocPtr doc,
+                                             const xmlChar *encoding);

Sets the current encoding in the Meta tags +NOTE: this will not change the document content encoding, just +the META flag associated.

doc : the document
encoding : the encoding string
Returns :0 in case of success and -1 in case of error

void        htmlDocDump                     (int         htmlDocDump                     (FILE *f,
@@ -492,6 +820,21 @@ ALIGN="LEFT"
 VALIGN="TOP"
 >  the documentReturns : the number of byte written or -1 in case of failure.
Dump an HTML document to a file.
Dump an HTML document to a file. If filename is "-" the stdout file is
+used.
  the filename  the filename (or URL)
htmlSaveFileEnc ()
int         htmlSaveFileEnc                 (const char *filename,
+                                             xmlDocPtr cur,
+                                             const char *encoding);
Dump an HTML document to a file using a given encoding.
filename :  the filename
cur :  the document
encoding : 
Returns : the number of byte written or -1 in case of failure.
Name
Synopsis
Description
Details
Tries to change the remote directory
   an FTP context   a directory on the server -1 incase of error, 1 if CWD worked, 0 if it failed
Name
Synopsis
Description
Details
Name
Synopsis
                  (xmlParserCtxtPtr ctxt);
ctxt); +int xmlCurrentChar (xmlParserCtxtPtr ctxt, + int *len); +int xmlCopyChar (int len, + xmlChar *out, + int val); +void xmlNextChar (xmlParserCtxtPtr ctxt); +void xmlParserInputShrink (xmlParserInputPtr in);

Description

Details

parse an XML qualified name string

parse an UTF8 encoded XML qualified name string

[NS 5] QName ::= (Prefix ':')? LocalPart

xmlCurrentChar ()

int         xmlCurrentChar                  (xmlParserCtxtPtr ctxt,
+                                             int *len);

The current char value, if using UTF-8 this may actaully span multiple +bytes in the input buffer. Implement the end of line normalization: +2.11 End-of-Line Handling +Wherever an external parsed entity or the literal entity value +of an internal parsed entity contains either the literal two-character +sequence "xDxA" or a standalone literal xD, an XML processor +must pass to the application the single character xA. +This behavior can conveniently be produced by normalizing all +line breaks to xA on input, before parsing.)

ctxt : the XML parser context
len : pointer to the length of the char read
Returns :the current char value and its lenght

xmlCopyChar ()

int         xmlCopyChar                     (int len,
+                                             xmlChar *out,
+                                             int val);

append the char value in the array

len : pointer to the length of the char read (or zero)
out : 
val : the char value
Returns :the number of xmlChar written

xmlNextChar ()

void        xmlNextChar                     (xmlParserCtxtPtr ctxt);

Skip to the next char input char.

ctxt : the XML parser context

xmlParserInputShrink ()

void        xmlParserInputShrink            (xmlParserInputPtr in);

This function removes used input for the parser.

in : an XML parser input

-#define extern const xmlChar

Description

Details

extern

#define     extern

Name

Synopsis

xmlChar *SystemID); +xmlDtdPtr xmlGetIntSubset (xmlDocPtr doc); void xmlFreeDtdxmlChar *name); xmlAttrPtr xmlHasProp (xmlNodePtr node, + const xmlChar *name); +xmlChar*

Description

Details

xmlGetIntSubset ()

xmlDtdPtr   xmlGetIntSubset                 (xmlDocPtr doc);

Get the internal subset of a document

doc : the document pointer
Returns :a pointer to the DTD structure or NULL if not found

Is this node a Text node ?

Checks whether this node is an empty or whitespace only +(and possibly ignorable) text-node.

xmlHasProp ()

xmlAttrPtr  xmlHasProp                      (xmlNodePtr node,
+                                             const xmlChar *name);

Search an attribute associated to a node +This function also looks in DTD attribute declaration for FIXED or +default declaration values unless DTD use has been turned off.

node : the node
name : the attribute name
Returns :the attribute or the attribute declaration or NULL if +neither was found.

the number of file written or -1 in case of failure. the number of byte written or -1 in case of failure.

the number of file written or -1 in case of failure. the number of byte written or -1 in case of failure.

the number of file written or -1 in case of failure. the number of byte written or -1 in case of failure.

Name

Synopsis

Description

Details

Name

Synopsis

Description

Details

Name

Synopsis

Description

Details

the number of file written or -1 in case of failure. the number of byte written or -1 in case of failure.

Name

Synopsis

Description

Details

Name

Synopsis

Description

Details

- @@ -199,6 +198,7 @@ + @@ -256,6 +256,7 @@ + @@ -426,6 +427,7 @@ + @@ -433,11 +435,15 @@ + + + + @@ -632,6 +638,10 @@ + + + + diff --git a/doc/html/libxml-notes.html b/doc/html/libxml-notes.html index 9c591047..985cbef7 100644 --- a/doc/html/libxml-notes.html +++ b/doc/html/libxml-notes.html @@ -4,7 +4,7 @@ >Libxml Programming Notes