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

« back to all changes in this revision

Viewing changes to modules/xml/help/en_US/xmlFormat.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="xmlFormat" xml:lang="en">
14
 
  <refnamediv>
15
 
    <refname>xmlFormat</refname>
16
 
    <refpurpose>Format a Scilab variable into XML</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>
21
 
      xmlCode = xmlFormat(scilabVar)
22
 
    </synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>scilabVar</term>
29
 
        <listitem>
30
 
          <para>scilabVar, a Scilab's variable</para>
31
 
        </listitem>
32
 
      </varlistentry>
33
 
      <varlistentry>
34
 
        <term>xmlCode</term>
35
 
        <listitem>
36
 
          <para>xmlCode, a string containing XML code</para>
37
 
        </listitem>
38
 
      </varlistentry>
39
 
    </variablelist>
40
 
  </refsection>
41
 
  <refsection>
42
 
    <title>Description</title>
43
 
    <para>This function does nothing by itself ! It needs to be overloaded to be useful.</para>
44
 
    <para>It is used when a Scilab variable is inserted in the XML tree.</para>
45
 
  </refsection>
46
 
  <refsection>
47
 
    <title>Examples</title>
48
 
    <programlisting role="example"><![CDATA[
 
14
    <refnamediv>
 
15
        <refname>xmlFormat</refname>
 
16
        <refpurpose>Format a Scilab variable into XML</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>
 
21
            xmlCode = xmlFormat(scilabVar)
 
22
        </synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>scilabVar</term>
 
29
                <listitem>
 
30
                    <para>scilabVar, a Scilab's variable</para>
 
31
                </listitem>
 
32
            </varlistentry>
 
33
            <varlistentry>
 
34
                <term>xmlCode</term>
 
35
                <listitem>
 
36
                    <para>xmlCode, a string containing XML code</para>
 
37
                </listitem>
 
38
            </varlistentry>
 
39
        </variablelist>
 
40
    </refsection>
 
41
    <refsection>
 
42
        <title>Description</title>
 
43
        <para>This function does nothing by itself ! It needs to be overloaded to be useful.</para>
 
44
        <para>It is used when a Scilab variable is inserted in the XML tree.</para>
 
45
    </refsection>
 
46
    <refsection>
 
47
        <title>Examples</title>
 
48
        <programlisting role="example"><![CDATA[
49
49
    doc = xmlReadStr("<root><a att=""foo"" rib=""bar""><b>Hello</b></a></root>");
50
50
    // This code will fail:
51
51
    // doc.root.children(1.5) = 1.23456;
60
60
 
61
61
    xmlDelete(doc);
62
62
    ]]></programlisting>
63
 
  </refsection>
64
 
  <refsection>
65
 
    <title>History</title>
66
 
    <revhistory>
67
 
      <revision>
68
 
        <revnumber>5.4.0</revnumber>
69
 
        <revremark>XML module introduced.</revremark>
70
 
      </revision>
71
 
    </revhistory>
72
 
  </refsection>
 
63
    </refsection>
 
64
    <refsection>
 
65
        <title>History</title>
 
66
        <revhistory>
 
67
            <revision>
 
68
                <revnumber>5.4.0</revnumber>
 
69
                <revremark>XML module introduced.</revremark>
 
70
            </revision>
 
71
        </revhistory>
 
72
    </refsection>
73
73
</refentry>