← Back to branch summary

~ubuntu-branches/ubuntu/trusty/pxp/trusty

« back to all changes in this revision

Viewing changes to doc/manual/html/ref/Pxp_document.document-c.html

  • Committer: Package Import Robot
  • Author(s): Stéphane Glondu
  • Date: 2013-07-11 11:21:26 UTC
  • mfrom: (6.1.3 sid)
  • Revision ID: package-import@ubuntu.com-20130711112126-5wysiuf0cgjo376r
Tags: 1.2.4-1
* Team upload
* New upstream release
* Update Vcs-*

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/manual/html/ref/Pxp_document.document-c.html
37
37
<link title="Example_readme" rel="Chapter" href="Example_readme.html"><title>PXP Reference : Pxp_document.document</title>
38
38
</head>
39
39
<body>
40
 
<div class="navbar"><a href="Pxp_document.namespace_attribute_impl-c.html">Previous</a>
41
 
&nbsp;<a href="Pxp_document.html">Up</a>
 
40
<div class="navbar"><a class="pre" href="Pxp_document.namespace_attribute_impl-c.html" title="Pxp_document.namespace_attribute_impl">Previous</a>
 
41
&nbsp;<a class="up" href="Pxp_document.html" title="Pxp_document">Up</a>
42
42
&nbsp;</div>
43
 
<center><h1>Class <a href="type_Pxp_document.document.html">Pxp_document.document</a></h1></center>
44
 
<br>
45
 
<pre><span name="TYPEdocument"><span class="keyword">class</span> <code class="type">[< clone : 'a; node : 'a <a href="Pxp_document.node-c.html">node</a>;<br>       set_node : 'a <a href="Pxp_document.node-c.html">node</a> -> unit; .. ><br>     as 'a]</code> document</span> : <code class="type">?swarner:Pxp_types.symbolic_warnings -> Pxp_types.collect_warnings -> Pxp_types.rep_encoding -> </code><code class="code"><span class="keyword">object</span></code> <a href="Pxp_document.document-c.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>Documents are used to represent closed documents that may
 
43
<h1>Class <a href="type_Pxp_document.document.html">Pxp_document.document</a></h1>
 
44
<pre><span name="TYPEdocument"><span class="keyword">class</span> <code class="type">[< clone : 'a; node : 'a <a href="Pxp_document.node-c.html">node</a>;<br>       set_node : 'a <a href="Pxp_document.node-c.html">node</a> -> unit; .. ><br>     as 'a]</code> document</span> : <code class="type">?swarner:<a href="Pxp_types.html#TYPEsymbolic_warnings">Pxp_types.symbolic_warnings</a> -> <a href="Pxp_types.html#TYPEcollect_warnings">Pxp_types.collect_warnings</a> -> <a href="Pxp_types.html#TYPErep_encoding">Pxp_types.rep_encoding</a> -> </code><code class="code"><span class="keyword">object</span></code> <a href="Pxp_document.document-c.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>Documents are used to represent closed documents that may
46
45
 consist of an XML declaration, a DTD, and a node tree.
47
46
<p>
48
47
 
78
77
Returns the DTD of the root element.
79
78
 Fails if there is no root element.<br>
80
79
</div>
81
 
<pre><span id="METHODencoding"><span class="keyword">method</span> encoding</span> : <code class="type">Pxp_types.rep_encoding</code></pre><div class="info">
 
80
<pre><span id="METHODencoding"><span class="keyword">method</span> encoding</span> : <code class="type"><a href="Pxp_types.html#TYPErep_encoding">Pxp_types.rep_encoding</a></code></pre><div class="info">
82
81
Returns the string encoding of the document = the encoding of
83
82
 the root element = the encoding of the element tree = the
84
83
 encoding of the DTD.
112
111
        method uses the display prefixes, i.e. the prefixes as they orginally
113
112
        have been in the parsed XML text. This means for parsed XML text
114
113
        <code class="code">display</code> produces an more exact copy of the text, whereas 
115
 
        <code class="code">write</code> shows the prefixes as they are seen by the program.<pre><span id="METHODwrite"><span class="keyword">method</span> write</span> : <code class="type">?default:string -><br>       ?prefer_dtd_reference:bool -><br>       ?dtd_style:[ `Auto | `Included | `Omit | `Reference ] -><br>       ?minimization:[ `AllEmpty | `DeclaredEmpty | `None ] -><br>       Pxp_types.output_stream -> Pxp_types.encoding -> unit</code></pre><div class="info">
 
114
        <code class="code">write</code> shows the prefixes as they are seen by the program.<pre><span id="METHODwrite"><span class="keyword">method</span> write</span> : <code class="type">?default:string -><br>       ?prefer_dtd_reference:bool -><br>       ?dtd_style:[ `Auto | `Included | `Omit | `Reference ] -><br>       ?minimization:[ `AllEmpty | `DeclaredEmpty | `None ] -><br>       <a href="Pxp_types.html#TYPEoutput_stream">Pxp_types.output_stream</a> -> <a href="Pxp_types.html#TYPEencoding">Pxp_types.encoding</a> -> unit</code></pre><div class="info">
116
115
Write the document to the passed
117
116
 output stream; the passed encoding used. The format
118
117
 is compact (the opposite of "pretty printing").
143
142
 declared as empty in the DTD. <code class="code"><span class="keywordsign">`</span><span class="constructor">None</span></code> does not minimize at all
144
143
 and is the default.<br>
145
144
</div>
146
 
<pre><span id="METHODdisplay"><span class="keyword">method</span> display</span> : <code class="type">?prefer_dtd_reference:bool -><br>       ?dtd_style:[ `Auto | `Included | `Omit | `Reference ] -><br>       ?minimization:[ `AllEmpty | `DeclaredEmpty | `None ] -><br>       Pxp_types.output_stream -> Pxp_types.encoding -> unit</code></pre><div class="info">
 
145
<pre><span id="METHODdisplay"><span class="keyword">method</span> display</span> : <code class="type">?prefer_dtd_reference:bool -><br>       ?dtd_style:[ `Auto | `Included | `Omit | `Reference ] -><br>       ?minimization:[ `AllEmpty | `DeclaredEmpty | `None ] -><br>       <a href="Pxp_types.html#TYPEoutput_stream">Pxp_types.output_stream</a> -> <a href="Pxp_types.html#TYPEencoding">Pxp_types.encoding</a> -> unit</code></pre><div class="info">
147
146
Write the document to the passed
148
147
 output stream; the passed encoding used. The format
149
148
 is compact (the opposite of "pretty printing").