--- /dev/null
+<HTML
+><HEAD
+><TITLE
+>The objects representing the document</TITLE
+><META
+NAME="GENERATOR"
+CONTENT="Modular DocBook HTML Stylesheet Version 1.46"><LINK
+REL="HOME"
+TITLE="The PXP user's guide"
+HREF="index.html"><LINK
+REL="UP"
+TITLE="User's guide"
+HREF="p34.html"><LINK
+REL="PREVIOUS"
+TITLE="Example: An HTML backend for the readme
+DTD"
+HREF="x738.html"><LINK
+REL="NEXT"
+TITLE="The class type node"
+HREF="x939.html"><LINK
+REL="STYLESHEET"
+TYPE="text/css"
+HREF="markup.css"></HEAD
+><BODY
+CLASS="CHAPTER"
+BGCOLOR="#FFFFFF"
+TEXT="#000000"
+LINK="#0000FF"
+VLINK="#840084"
+ALINK="#0000FF"
+><DIV
+CLASS="NAVHEADER"
+><TABLE
+WIDTH="100%"
+BORDER="0"
+CELLPADDING="0"
+CELLSPACING="0"
+><TR
+><TH
+COLSPAN="3"
+ALIGN="center"
+>The PXP user's guide</TH
+></TR
+><TR
+><TD
+WIDTH="10%"
+ALIGN="left"
+VALIGN="bottom"
+><A
+HREF="x738.html"
+>Prev</A
+></TD
+><TD
+WIDTH="80%"
+ALIGN="center"
+VALIGN="bottom"
+></TD
+><TD
+WIDTH="10%"
+ALIGN="right"
+VALIGN="bottom"
+><A
+HREF="x939.html"
+>Next</A
+></TD
+></TR
+></TABLE
+><HR
+ALIGN="LEFT"
+WIDTH="100%"></DIV
+><DIV
+CLASS="CHAPTER"
+><H1
+><A
+NAME="AEN893"
+>Chapter 3. The objects representing the document</A
+></H1
+><DIV
+CLASS="TOC"
+><DL
+><DT
+><B
+>Table of Contents</B
+></DT
+><DT
+>3.1. <A
+HREF="c893.html#AEN897"
+>The <TT
+CLASS="LITERAL"
+>document</TT
+> class</A
+></DT
+><DT
+>3.2. <A
+HREF="x939.html"
+>The class type <TT
+CLASS="LITERAL"
+>node</TT
+></A
+></DT
+><DT
+>3.3. <A
+HREF="x1439.html"
+>The class type <TT
+CLASS="LITERAL"
+>extension</TT
+></A
+></DT
+><DT
+>3.4. <A
+HREF="x1496.html"
+>Details of the mapping from XML text to the tree representation</A
+></DT
+></DL
+></DIV
+><P
+><I
+CLASS="EMPHASIS"
+>This description might be out-of-date. See the module interface files
+for updated information.</I
+></P
+><DIV
+CLASS="SECT1"
+><H1
+CLASS="SECT1"
+><A
+NAME="AEN897"
+>3.1. The <TT
+CLASS="LITERAL"
+>document</TT
+> class</A
+></H1
+><P
+><PRE
+CLASS="PROGRAMLISTING"
+>class [ 'ext ] document :
+ Pxp_types.collect_warnings ->
+ object
+ method init_xml_version : string -> unit
+ method init_root : 'ext node -> unit
+
+ method xml_version : string
+ method xml_standalone : bool
+ method dtd : dtd
+ method root : 'ext node
+
+ method encoding : Pxp_types.rep_encoding
+
+ method add_pinstr : proc_instruction -> unit
+ method pinstr : string -> proc_instruction list
+ method pinstr_names : string list
+
+ method write : Pxp_types.output_stream -> Pxp_types.encoding -> unit
+
+ end
+;;</PRE
+>
+
+The methods beginning with <TT
+CLASS="LITERAL"
+>init_</TT
+> are only for internal use
+of the parser.</P
+><P
+></P
+><UL
+COMPACT="COMPACT"
+><LI
+STYLE="list-style-type: disc"
+><P
+><TT
+CLASS="LITERAL"
+>xml_version</TT
+>: returns the version string at the beginning of
+the document. For example, "1.0" is returned if the document begins with
+<TT
+CLASS="LITERAL"
+><?xml version="1.0"?></TT
+>.</P
+></LI
+><LI
+STYLE="list-style-type: disc"
+><P
+><TT
+CLASS="LITERAL"
+>xml_standalone</TT
+>: returns the boolean value of
+<TT
+CLASS="LITERAL"
+>standalone</TT
+> declaration in the XML declaration. If the
+<TT
+CLASS="LITERAL"
+>standalone</TT
+> attribute is missing, <TT
+CLASS="LITERAL"
+>false</TT
+> is
+returned. </P
+></LI
+><LI
+STYLE="list-style-type: disc"
+><P
+><TT
+CLASS="LITERAL"
+>dtd</TT
+>: returns a reference to the global DTD object.</P
+></LI
+><LI
+STYLE="list-style-type: disc"
+><P
+><TT
+CLASS="LITERAL"
+>root</TT
+>: returns a reference to the root element.</P
+></LI
+><LI
+STYLE="list-style-type: disc"
+><P
+><TT
+CLASS="LITERAL"
+>encoding</TT
+>: returns the internal encoding of the
+document. This means that all strings of which the document consists are
+encoded in this character set.</P
+></LI
+><LI
+STYLE="list-style-type: disc"
+><P
+><TT
+CLASS="LITERAL"
+>pinstr</TT
+>: returns the processing instructions outside the DTD
+and outside the root element. The argument passed to the method names a
+<I
+CLASS="EMPHASIS"
+>target</I
+>, and the method returns all instructions with this
+target. The target is the first word inside <TT
+CLASS="LITERAL"
+><?</TT
+> and
+<TT
+CLASS="LITERAL"
+>?></TT
+>.</P
+></LI
+><LI
+STYLE="list-style-type: disc"
+><P
+><TT
+CLASS="LITERAL"
+>pinstr_names</TT
+>: returns the names of the processing instructions</P
+></LI
+><LI
+STYLE="list-style-type: disc"
+><P
+><TT
+CLASS="LITERAL"
+>add_pinstr</TT
+>: adds another processing instruction. This method
+is used by the parser itself to enter the instructions returned by
+<TT
+CLASS="LITERAL"
+>pinstr</TT
+>, but you can also enter additional instructions.</P
+></LI
+><LI
+STYLE="list-style-type: disc"
+><P
+><TT
+CLASS="LITERAL"
+>write</TT
+>: writes the document to the passed stream as XML
+text using the passed (external) encoding. The generated text is always valid
+XML and can be parsed by PXP; however, the text is badly formatted (this is not
+a pretty printer).</P
+></LI
+></UL
+></DIV
+></DIV
+><DIV
+CLASS="NAVFOOTER"
+><HR
+ALIGN="LEFT"
+WIDTH="100%"><TABLE
+WIDTH="100%"
+BORDER="0"
+CELLPADDING="0"
+CELLSPACING="0"
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+><A
+HREF="x738.html"
+>Prev</A
+></TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="index.html"
+>Home</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+><A
+HREF="x939.html"
+>Next</A
+></TD
+></TR
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+>Example: An HTML backend for the <I
+CLASS="EMPHASIS"
+>readme</I
+>
+DTD</TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="p34.html"
+>Up</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+>The class type <TT
+CLASS="LITERAL"
+>node</TT
+></TD
+></TR
+></TABLE
+></DIV
+></BODY
+></HTML
+>
\ No newline at end of file
projects / helm.git / blobdiff