<html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of exceptions" rel=Appendix href="index_exceptions.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Dtd" rel="Chapter" href="Dtd.html"> <link title="Xml" rel="Chapter" href="Xml.html"> <link title="XmlParser" rel="Chapter" href="XmlParser.html"><title>Index of values</title> </head> <body> <center><h1>Index of values</h1></center> <table> <tr><td align="left"><br>A</td></tr> <tr><td><a href="Xml.html#VALabs_range">abs_range</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> Get the absolute character range the error occured at. </div> </td></tr> <tr><td><a href="Xml.html#VALattrib">attrib</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> <code class="code">attrib xdata "href"</code> returns the value of the <code class="code">"href"</code> attribute of the xml node (attribute matching is case-insensitive). </div> </td></tr> <tr><td><a href="Xml.html#VALattribs">attribs</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> <code class="code">attribs xdata</code> returns the attribute list of the xml node. </div> </td></tr> <tr><td align="left"><br>C</td></tr> <tr><td><a href="Dtd.html#VALcheck">check</a> [<a href="Dtd.html">Dtd</a>]</td> <td><div class="info"> Check the Dtd data structure declaration and return a checked DTD. </div> </td></tr> <tr><td><a href="XmlParser.html#VALcheck_eof">check_eof</a> [<a href="XmlParser.html">XmlParser</a>]</td> <td><div class="info"> When a Xml document is parsed, the parser will check that the end of the document is reached, so for example parsing <code class="code">"<A/><B/>"</code> will fail instead of returning only the A element. </div> </td></tr> <tr><td><a href="Dtd.html#VALcheck_error">check_error</a> [<a href="Dtd.html">Dtd</a>]</td> <td></td></tr> <tr><td><a href="Xml.html#VALchildren">children</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> <code class="code">children xdata</code> returns the children list of the xml node Raise <a href="Xml.html#EXCEPTIONNot_element"><code class="code">Xml.Not_element</code></a> if the xml is not an element </div> </td></tr> <tr><td><a href="XmlParser.html#VALconcat_pcdata">concat_pcdata</a> [<a href="XmlParser.html">XmlParser</a>]</td> <td><div class="info"> When several PCData elements are separed by a \n (or \r\n), you can either split the PCData in two distincts PCData or merge them with \n as seperator into one PCData. </div> </td></tr> <tr><td align="left"><br>E</td></tr> <tr><td><a href="Xml.html#VALerror">error</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> Get a full error message from an Xml error. </div> </td></tr> <tr><td><a href="Xml.html#VALerror_msg">error_msg</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> Get the Xml error message as a string. </div> </td></tr> <tr><td align="left"><br>F</td></tr> <tr><td><a href="Xml.html#VALfold">fold</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> <code class="code">fold f init xdata</code> is equivalent to <code class="code">List.fold_left f init (Xml.children xdata)</code> Raise <a href="Xml.html#EXCEPTIONNot_element"><code class="code">Xml.Not_element</code></a> if the xml is not an element </div> </td></tr> <tr><td align="left"><br>I</td></tr> <tr><td><a href="Xml.html#VALiter">iter</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> <code class="code">iter f xdata</code> calls f on all children of the xml node. </div> </td></tr> <tr><td align="left"><br>L</td></tr> <tr><td><a href="Xml.html#VALline">line</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> Get the line the error occured at. </div> </td></tr> <tr><td align="left"><br>M</td></tr> <tr><td><a href="XmlParser.html#VALmake">make</a> [<a href="XmlParser.html">XmlParser</a>]</td> <td><div class="info"> This function returns a new parser with default options. </div> </td></tr> <tr><td><a href="Xml.html#VALmap">map</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> <code class="code">map f xdata</code> is equivalent to <code class="code">List.map f (Xml.children xdata)</code> Raise <a href="Xml.html#EXCEPTIONNot_element"><code class="code">Xml.Not_element</code></a> if the xml is not an element </div> </td></tr> <tr><td align="left"><br>P</td></tr> <tr><td><a href="XmlParser.html#VALparse">parse</a> [<a href="XmlParser.html">XmlParser</a>]</td> <td><div class="info"> Once the parser is configurated, you can run the parser on a any kind of xml document source to parse its contents into an Xml data structure. </div> </td></tr> <tr><td><a href="Dtd.html#VALparse_error">parse_error</a> [<a href="Dtd.html">Dtd</a>]</td> <td></td></tr> <tr><td><a href="Xml.html#VALparse_file">parse_file</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> Parse the named file into an Xml data structure. </div> </td></tr> <tr><td><a href="Dtd.html#VALparse_file">parse_file</a> [<a href="Dtd.html">Dtd</a>]</td> <td><div class="info"> Parse the named file into a Dtd data structure. </div> </td></tr> <tr><td><a href="Xml.html#VALparse_in">parse_in</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> Read the content of the in_channel and parse it into an Xml data structure. </div> </td></tr> <tr><td><a href="Dtd.html#VALparse_in">parse_in</a> [<a href="Dtd.html">Dtd</a>]</td> <td><div class="info"> Read the content of the in_channel and parse it into a Dtd data structure. </div> </td></tr> <tr><td><a href="Xml.html#VALparse_string">parse_string</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> Parse the string containing an Xml document into an Xml data structure. </div> </td></tr> <tr><td><a href="Dtd.html#VALparse_string">parse_string</a> [<a href="Dtd.html">Dtd</a>]</td> <td><div class="info"> Parse the string containing a Dtd document into a Dtd data structure. </div> </td></tr> <tr><td><a href="Xml.html#VALpcdata">pcdata</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> <code class="code">pcdata xdata</code> returns the PCData value of the xml node. </div> </td></tr> <tr><td><a href="XmlParser.html#VALprove">prove</a> [<a href="XmlParser.html">XmlParser</a>]</td> <td><div class="info"> This function enable or disable automatic DTD proving with the parser. </div> </td></tr> <tr><td><a href="Dtd.html#VALprove">prove</a> [<a href="Dtd.html">Dtd</a>]</td> <td><div class="info"> Prove an Xml document using a checked DTD and an entry point. </div> </td></tr> <tr><td><a href="Dtd.html#VALprove_error">prove_error</a> [<a href="Dtd.html">Dtd</a>]</td> <td></td></tr> <tr><td align="left"><br>R</td></tr> <tr><td><a href="Xml.html#VALrange">range</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> Get the relative character range (in current line) the error occured at. </div> </td></tr> <tr><td><a href="XmlParser.html#VALresolve">resolve</a> [<a href="XmlParser.html">XmlParser</a>]</td> <td><div class="info"> When parsing an Xml document from a file using the <a href="Xml.html#VALparse_file"><code class="code">Xml.parse_file</code></a> function, the DTD file if declared by the Xml document has to be in the same directory as the xml file. </div> </td></tr> <tr><td align="left"><br>T</td></tr> <tr><td><a href="Xml.html#VALtag">tag</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> <code class="code">tag xdata</code> returns the tag value of the xml node. </div> </td></tr> <tr><td><a href="Xml.html#VALto_string">to_string</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> Print the xml data structure into a compact xml string (without any user-readable formating ). </div> </td></tr> <tr><td><a href="Dtd.html#VALto_string">to_string</a> [<a href="Dtd.html">Dtd</a>]</td> <td><div class="info"> Print a DTD element into a string. </div> </td></tr> <tr><td><a href="Xml.html#VALto_string_fmt">to_string_fmt</a> [<a href="Xml.html">Xml</a>]</td> <td><div class="info"> Print the xml data structure into an user-readable string with tabs and lines break between different nodes. </div> </td></tr> </table><br> </body> </html>
