Xcos documentation: improve the rendering for data structures
[scilab.git] / scilab / modules / xcos / help / en_US / scilab_data_structures / scicos_block.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scicos
4  * 
5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
7  * 
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  * 
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  * 
22  * See the file ./license.txt
23  -->
24 <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" xmlns:scilab="http://www.scilab.org" xml:id="scicos_block">
25     <refnamediv>
26         <refname>scicos_block</refname>
27         <refpurpose>Define a block structure</refpurpose>
28     </refnamediv>
29     <refsection id="Module_scicos_block">
30         <title>Module</title>
31         <itemizedlist>
32             <listitem>
33                 <para>
34                     <link linkend="xcos">xcos</link>
35                 </para>
36             </listitem>
37         </itemizedlist>
38     </refsection>
39     <refsection id="block_scicos_block">
40         <title>block</title>
41         <para>
42             Basic  structure that define a xcos block.
43         </para>
44         <para>
45             Type : scilab tlist of type <code>"Block"</code> with fields :
46             <link linkend="scicos_block_graphics">graphics</link>, 
47             <link linkend="scicos_block_model">model</link>, 
48             <link linkend="scicos_block_gui">gui</link> and 
49             <link linkend="scicos_block_doc">doc</link>.
50         </para>
51         <refsect2 id="scicos_block_graphics">
52             <title>graphics</title>
53             <para> Scilab object including graphical information concerning the features of the block.</para>
54             <para>
55                 Type : <link linkend="scicos_graphics">graphics</link>.
56             </para>
57         </refsect2>
58         <refsect2 id="scicos_block_model">
59             <title>model</title>
60             <para> Scilab list that contains the features of the block used for the compilation.</para>
61             <para>
62                 Type : <link linkend="scicos_model">model</link>.
63             </para>
64         </refsect2>
65         <refsect2 id="scicos_block_gui">
66             <title>gui</title>
67             <para> The name of the Scilab GUI function associated with the block.</para>
68             <para> 
69                 Size : 1.
70             </para>
71             <para>
72                 Type : string.
73             </para>
74         </refsect2>
75         <refsect2 id="scicos_block_doc">
76             <title>doc</title>
77             <para> Field used for documentation of the block
78                 Size : 1.
79             </para>
80             <para>
81                 Type : list or string.
82             </para>
83         </refsect2>
84     </refsection>
85     <refsection>
86         <title>Examples</title>
87         <programlisting role="example"><![CDATA[ 
88 loadXcosLibs();              // load standard library
89
90 blk = BIGSOM_f("define");    // new specific block
91 tree_show(blk);              // display it
92  ]]></programlisting>
93         <programlisting role="example"><![CDATA[ 
94 blk = scicos_block(),
95 blk.model.rpar = 1
96  ]]></programlisting>
97     </refsection>
98 </refentry>
99