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

« back to all changes in this revision

Viewing changes to modules/demo_tools/help/en_US/demo_choose.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: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="demo_choose">
14
 
  <refnamediv>
15
 
    <refname>demo_choose</refname>
16
 
    <refpurpose> create a dialog box for the choice of options </refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>num = demo_choose(fil)</synopsis>
21
 
  </refsynopsisdiv>
22
 
  <refsection>
23
 
    <title>Description</title>
24
 
    <para>
25
 
      The function demo_choose create a dialog box for the choice of options. It 
26
 
      takes as argument the binary file 'fil'. This file is built by a .sce file 
27
 
      written like below. It shall contain the variables 'choice', an array of text
28
 
      within bracket (the different options), and 'titl', the title of the dialog 
29
 
      box. After that, the .sce file shall save both variables in the binary file 
30
 
      in argument.
31
 
      Before the use of demo_choose, the .sce file shall be executed.
32
 
      The function demo_choose returns the number of line chosen in the options 
33
 
      array.
34
 
    </para>
35
 
  </refsection>
36
 
  <refsection>
37
 
    <title>Examples</title>
38
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>demo_choose</refname>
 
16
        <refpurpose> create a dialog box for the choice of options </refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>num = demo_choose(fil)</synopsis>
 
21
    </refsynopsisdiv>
 
22
    <refsection>
 
23
        <title>Description</title>
 
24
        <para>
 
25
            The function demo_choose create a dialog box for the choice of options. It 
 
26
            takes as argument the binary file 'fil'. This file is built by a .sce file 
 
27
            written like below. It shall contain the variables 'choice', an array of text
 
28
            within bracket (the different options), and 'titl', the title of the dialog 
 
29
            box. After that, the .sce file shall save both variables in the binary file 
 
30
            in argument.
 
31
            Before the use of demo_choose, the .sce file shall be executed.
 
32
            The function demo_choose returns the number of line chosen in the options 
 
33
            array.
 
34
        </para>
 
35
    </refsection>
 
36
    <refsection>
 
37
        <title>Examples</title>
 
38
        <programlisting role="example"><![CDATA[ 
39
39
exec('SCI/demos/control/pid/pid_ch_2.sce');
40
40
[n]=demo_choose('SCI/demos/control/pid/pid_ch_2.bin');
41
41
select n
47
47
    mode(-1)
48
48
end
49
49
 ]]></programlisting>
50
 
  </refsection>
51
 
  <refsection role="see also">
52
 
    <title>See Also</title>
53
 
    <simplelist type="inline">
54
 
      <member>
55
 
        <link linkend="x_choose">x_choose</link>
56
 
      </member>
57
 
      <member>
58
 
        <link linkend="demo_mdialog">demo_mdialog</link>
59
 
      </member>
60
 
    </simplelist>
61
 
  </refsection>
 
50
    </refsection>
 
51
    <refsection role="see also">
 
52
        <title>See Also</title>
 
53
        <simplelist type="inline">
 
54
            <member>
 
55
                <link linkend="x_choose">x_choose</link>
 
56
            </member>
 
57
            <member>
 
58
                <link linkend="demo_mdialog">demo_mdialog</link>
 
59
            </member>
 
60
        </simplelist>
 
61
    </refsection>
62
62
</refentry>