← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/compatibility_functions/help/en_US/mtlb_axis.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/compatibility_functions/help/en_US/mtlb_axis.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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="mtlb_axis">
14
 
  <refnamediv>
15
 
    <refname>mtlb_axis</refname>
16
 
    <refpurpose>Matlab axis emulation
17
 
      function
18
 
    </refpurpose>
19
 
  </refnamediv>
20
 
  <refsynopsisdiv>
21
 
    <title>Calling Sequence</title>
22
 
    <synopsis>mtlb_axis(X)
23
 
      mtlb_axis(st)
24
 
      mtlb_axis(axeshandle, ...)
25
 
      [mode,visibility,direction]=mtlb_axis('state')
26
 
    </synopsis>
27
 
  </refsynopsisdiv>
28
 
  <refsection>
29
 
    <title>Arguments</title>
30
 
    <variablelist>
31
 
      <varlistentry>
32
 
        <term>X</term>
33
 
        <listitem>
34
 
          <para>a vector of reals ([xmin xmax ymin ymax] or [xmin xmax ymin
35
 
            ymax zmin zmax])
36
 
          </para>
37
 
        </listitem>
38
 
      </varlistentry>
39
 
    </variablelist>
40
 
    <variablelist>
41
 
      <varlistentry>
42
 
        <term>st</term>
43
 
        <listitem>
44
 
          <para>a string ('auto', 'manual', 'tight', 'ij', 'xy', 'equal',
45
 
            'square', 'vis3d', 'off', 'on')
46
 
          </para>
47
 
        </listitem>
48
 
      </varlistentry>
49
 
    </variablelist>
50
 
    <variablelist>
51
 
      <varlistentry>
52
 
        <term>axeshandle</term>
53
 
        <listitem>
54
 
          <para>handle of the current axes entity</para>
55
 
        </listitem>
56
 
      </varlistentry>
57
 
    </variablelist>
58
 
  </refsection>
59
 
  <refsection>
60
 
    <title>Description</title>
61
 
    <para>
62
 
      Matlab <literal>axis</literal> have not a Scilab equivalent function.
63
 
    </para>
64
 
    <para>
65
 
      The function <literal>mtlb_axis(...)</literal> is used by
66
 
      <literal>mfile2sci</literal> to replace <literal>axis(...)</literal> when it was not
67
 
      possible to know what were the inputs while porting Matlab code to Scilab.
68
 
      This function will determine the correct semantic at run time (axis
69
 
      <literal>fill</literal>, axis <literal>image</literal> and axis <literal>normal</literal>
70
 
      are not implemented). If you want to have a more efficient code it is
71
 
      possible to replace <literal>mtlb_axis</literal> call by <literal>get(axeshandle,
72
 
        prop)
73
 
      </literal>
74
 
      call (prop is an axis property, see
75
 
      <link linkend="axis_properties">axis_properties</link>)
76
 
    </para>
77
 
    <para>
78
 
      Caution: <literal>mtlb_axis</literal> has not to be used for hand coded
79
 
      functions.
80
 
    </para>
81
 
  </refsection>
 
14
    <refnamediv>
 
15
        <refname>mtlb_axis</refname>
 
16
        <refpurpose>Matlab axis emulation
 
17
            function
 
18
        </refpurpose>
 
19
    </refnamediv>
 
20
    <refsynopsisdiv>
 
21
        <title>Calling Sequence</title>
 
22
        <synopsis>mtlb_axis(X)
 
23
            mtlb_axis(st)
 
24
            mtlb_axis(axeshandle, ...)
 
25
            [mode,visibility,direction]=mtlb_axis('state')
 
26
        </synopsis>
 
27
    </refsynopsisdiv>
 
28
    <refsection>
 
29
        <title>Arguments</title>
 
30
        <variablelist>
 
31
            <varlistentry>
 
32
                <term>X</term>
 
33
                <listitem>
 
34
                    <para>a vector of reals ([xmin xmax ymin ymax] or [xmin xmax ymin
 
35
                        ymax zmin zmax])
 
36
                    </para>
 
37
                </listitem>
 
38
            </varlistentry>
 
39
        </variablelist>
 
40
        <variablelist>
 
41
            <varlistentry>
 
42
                <term>st</term>
 
43
                <listitem>
 
44
                    <para>a string ('auto', 'manual', 'tight', 'ij', 'xy', 'equal',
 
45
                        'square', 'vis3d', 'off', 'on')
 
46
                    </para>
 
47
                </listitem>
 
48
            </varlistentry>
 
49
        </variablelist>
 
50
        <variablelist>
 
51
            <varlistentry>
 
52
                <term>axeshandle</term>
 
53
                <listitem>
 
54
                    <para>handle of the current axes entity</para>
 
55
                </listitem>
 
56
            </varlistentry>
 
57
        </variablelist>
 
58
    </refsection>
 
59
    <refsection>
 
60
        <title>Description</title>
 
61
        <para>
 
62
            Matlab <literal>axis</literal> have not a Scilab equivalent function.
 
63
        </para>
 
64
        <para>
 
65
            The function <literal>mtlb_axis(...)</literal> is used by
 
66
            <literal>mfile2sci</literal> to replace <literal>axis(...)</literal> when it was not
 
67
            possible to know what were the inputs while porting Matlab code to Scilab.
 
68
            This function will determine the correct semantic at run time (axis
 
69
            <literal>fill</literal>, axis <literal>image</literal> and axis <literal>normal</literal>
 
70
            are not implemented). If you want to have a more efficient code it is
 
71
            possible to replace <literal>mtlb_axis</literal> call by <literal>get(axeshandle,
 
72
                prop)
 
73
            </literal>
 
74
            call (prop is an axis property, see
 
75
            <link linkend="axis_properties">axis_properties</link>)
 
76
        </para>
 
77
        <para>
 
78
            Caution: <literal>mtlb_axis</literal> has not to be used for hand coded
 
79
            functions.
 
80
        </para>
 
81
    </refsection>
82
82
</refentry>