← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/xml/help/en_US/xmlRead.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/xml/help/en_US/xmlRead.xml
11
11
*
12
12
-->
13
13
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="xmlRead" xml:lang="en">
14
 
  <refnamediv>
15
 
    <refname>xmlRead</refname>
16
 
    <refpurpose>Read a XML stream from a local or distant file</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>
21
 
      doc = xmlRead(path [, validateDTD])
22
 
    </synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>path</term>
29
 
        <listitem>
30
 
          <para>a string, the path to the file to read.</para>
31
 
        </listitem>
32
 
      </varlistentry>
33
 
      <varlistentry>
34
 
        <term>validateDTD</term>
35
 
        <listitem>
36
 
          <para>a boolean to indicate if the document must be validated.</para>
37
 
        </listitem>
38
 
      </varlistentry>
39
 
      <varlistentry>
40
 
        <term>doc</term>
41
 
        <listitem>
42
 
          <para>a mlist typed XMLDoc</para>
43
 
        </listitem>
44
 
      </varlistentry>
45
 
    </variablelist>
46
 
  </refsection>
47
 
  <refsection>
48
 
    <title>Description</title>
49
 
    <para>Read and parse a XML file. The returned document allows to access to the DOM tree which is kept in memory.</para>
50
 
    <para>If validateDTD is set to true, the document will be validated or not during the parsing operation.</para>
51
 
    <para>
52
 
      It is important to notice that the tree must be freed (to avoid memory leaks) with the function <link linkend="xmlDelete">xmlDelete</link>.
53
 
    </para>
54
 
  </refsection>
55
 
  <refsection>
56
 
    <title>Examples</title>
57
 
    <programlisting role="example"><![CDATA[
 
14
    <refnamediv>
 
15
        <refname>xmlRead</refname>
 
16
        <refpurpose>Read a XML stream from a local or distant file</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>
 
21
            doc = xmlRead(path [, validateDTD])
 
22
        </synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>path</term>
 
29
                <listitem>
 
30
                    <para>a string, the path to the file to read.</para>
 
31
                </listitem>
 
32
            </varlistentry>
 
33
            <varlistentry>
 
34
                <term>validateDTD</term>
 
35
                <listitem>
 
36
                    <para>a boolean to indicate if the document must be validated.</para>
 
37
                </listitem>
 
38
            </varlistentry>
 
39
            <varlistentry>
 
40
                <term>doc</term>
 
41
                <listitem>
 
42
                    <para>a mlist typed XMLDoc</para>
 
43
                </listitem>
 
44
            </varlistentry>
 
45
        </variablelist>
 
46
    </refsection>
 
47
    <refsection>
 
48
        <title>Description</title>
 
49
        <para>Read and parse a XML file. The returned document allows to access to the DOM tree which is kept in memory.</para>
 
50
        <para>If validateDTD is set to true, the document will be validated or not during the parsing operation.</para>
 
51
        <para>
 
52
            It is important to notice that the tree must be freed (to avoid memory leaks) with the function <link linkend="xmlDelete">xmlDelete</link>.
 
53
        </para>
 
54
    </refsection>
 
55
    <refsection>
 
56
        <title>Examples</title>
 
57
        <programlisting role="example"><![CDATA[
58
58
    doc = xmlRead("http://www.w3.org/TR/2009/REC-xml-names-20091208/xml-names-10-3e.xml");
59
59
    e = doc.root.children(1).children(1)
60
60
    e.name
68
68
    // We delete the doc
69
69
    xmlDelete(doc);
70
70
    ]]></programlisting>
71
 
  </refsection>
72
 
  <refsection role="see also">
73
 
    <title>See Also</title>
74
 
    <simplelist type="inline">
75
 
      <member>
76
 
        <link linkend="xmlReadStr">xmlReadStr</link>
77
 
      </member>
78
 
      <member>
79
 
        <link linkend="xmlGetOpenDocs">xmlGetOpenDocs</link>
80
 
      </member>
81
 
      <member>
82
 
        <link linkend="xmlDelete">xmlDelete</link>
83
 
      </member>
84
 
      <member>
85
 
        <link linkend="xmlDocument">xmlDocument</link>
86
 
      </member>
87
 
      <member>
88
 
        <link linkend="xmlXPath">xmlXPath</link>
89
 
      </member>
90
 
      <member>
91
 
        <link linkend="xmlValidate">xmlValidate</link>
92
 
      </member>
93
 
    </simplelist>
94
 
  </refsection>
95
 
  <refsection>
96
 
    <title>History</title>
97
 
    <revhistory>
98
 
      <revision>
99
 
        <revnumber>5.4.0</revnumber>
100
 
        <revremark>XML module introduced.</revremark>
101
 
      </revision>
102
 
    </revhistory>
103
 
  </refsection>
 
71
    </refsection>
 
72
    <refsection role="see also">
 
73
        <title>See Also</title>
 
74
        <simplelist type="inline">
 
75
            <member>
 
76
                <link linkend="xmlReadStr">xmlReadStr</link>
 
77
            </member>
 
78
            <member>
 
79
                <link linkend="xmlGetOpenDocs">xmlGetOpenDocs</link>
 
80
            </member>
 
81
            <member>
 
82
                <link linkend="xmlDelete">xmlDelete</link>
 
83
            </member>
 
84
            <member>
 
85
                <link linkend="xmlDocument">xmlDocument</link>
 
86
            </member>
 
87
            <member>
 
88
                <link linkend="xmlXPath">xmlXPath</link>
 
89
            </member>
 
90
            <member>
 
91
                <link linkend="xmlValidate">xmlValidate</link>
 
92
            </member>
 
93
        </simplelist>
 
94
    </refsection>
 
95
    <refsection>
 
96
        <title>History</title>
 
97
        <revhistory>
 
98
            <revision>
 
99
                <revnumber>5.4.0</revnumber>
 
100
                <revremark>XML module introduced.</revremark>
 
101
            </revision>
 
102
        </revhistory>
 
103
    </refsection>
104
104
</refentry>