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

« back to all changes in this revision

Viewing changes to modules/xml/help/en_US/xmlAsText.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:
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="xmlAsText" xml:lang="en">
14
 
  <refnamediv>
15
 
    <refname>xmlAsText</refname>
16
 
    <refpurpose>Convert the result of a XPath query into a row of strings</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>
21
 
      strings = xmlAsText(xp)
22
 
    </synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>xp</term>
29
 
        <listitem>
30
 
          <para>xp, a XML mlist typed XMLSet or XMLList</para>
31
 
        </listitem>
32
 
      </varlistentry>
33
 
      <varlistentry>
34
 
        <term>strings</term>
35
 
        <listitem>
36
 
          <para>strings, a single row of strings</para>
37
 
        </listitem>
38
 
      </varlistentry>
39
 
    </variablelist>
40
 
  </refsection>
41
 
  <refsection>
42
 
    <title>Description</title>
43
 
    <para>The result of a XPath query or the children of a node can be a set of XMLElements, so the aim of this function is to convert the contents of each nodes into a string.</para>
44
 
  </refsection>
45
 
  <refsection>
46
 
    <title>Examples</title>
47
 
    <programlisting role="example"><![CDATA[
 
14
    <refnamediv>
 
15
        <refname>xmlAsText</refname>
 
16
        <refpurpose>Convert the result of a XPath query into a row of strings</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>
 
21
            strings = xmlAsText(xp)
 
22
        </synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>xp</term>
 
29
                <listitem>
 
30
                    <para>xp, a XML mlist typed XMLSet or XMLList</para>
 
31
                </listitem>
 
32
            </varlistentry>
 
33
            <varlistentry>
 
34
                <term>strings</term>
 
35
                <listitem>
 
36
                    <para>strings, a single row of strings</para>
 
37
                </listitem>
 
38
            </varlistentry>
 
39
        </variablelist>
 
40
    </refsection>
 
41
    <refsection>
 
42
        <title>Description</title>
 
43
        <para>The result of a XPath query or the children of a node can be a set of XMLElements, so the aim of this function is to convert the contents of each nodes into a string.</para>
 
44
    </refsection>
 
45
    <refsection>
 
46
        <title>Examples</title>
 
47
        <programlisting role="example"><![CDATA[
48
48
    doc = xmlReadStr("<root><a>Hello</a><a>Scilab</a><a>World</a></root>");
49
49
 
50
50
    // Retrieve the content of the nodes with name equals to "a"
55
55
 
56
56
    xmlDelete(doc);
57
57
    ]]></programlisting>
58
 
  </refsection>
59
 
  <refsection role="see also">
60
 
    <title>See Also</title>
61
 
    <simplelist type="inline">
62
 
      <member>
63
 
        <link linkend="xmlXPath">xmlXPath</link>
64
 
      </member>
65
 
      <member>
66
 
        <link linkend="xmlAsNumber">xmlAsNumber</link>
67
 
      </member>
68
 
    </simplelist>
69
 
  </refsection>
70
 
  <refsection>
71
 
    <title>History</title>
72
 
    <revhistory>
73
 
      <revision>
74
 
        <revnumber>5.4.0</revnumber>
75
 
        <revremark>XML module introduced.</revremark>
76
 
      </revision>
77
 
    </revhistory>
78
 
  </refsection>
 
58
    </refsection>
 
59
    <refsection role="see also">
 
60
        <title>See Also</title>
 
61
        <simplelist type="inline">
 
62
            <member>
 
63
                <link linkend="xmlXPath">xmlXPath</link>
 
64
            </member>
 
65
            <member>
 
66
                <link linkend="xmlAsNumber">xmlAsNumber</link>
 
67
            </member>
 
68
        </simplelist>
 
69
    </refsection>
 
70
    <refsection>
 
71
        <title>History</title>
 
72
        <revhistory>
 
73
            <revision>
 
74
                <revnumber>5.4.0</revnumber>
 
75
                <revremark>XML module introduced.</revremark>
 
76
            </revision>
 
77
        </revhistory>
 
78
    </refsection>
79
79
</refentry>