Xcos documentation: improve the rendering for data structures
[scilab.git] / scilab / modules / xcos / help / en_US / scilab_data_structures / scicos_diagram.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_diagram">
25     <refnamediv>
26         <refname>scicos_diagram</refname>
27         <refpurpose>Define a scs_m structure</refpurpose>
28     </refnamediv>
29     <refsection id="Module_scicos_diagram">
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="diagram_scicos_diagram">
40         <title>diagram</title>
41         <para>
42             Type : scilab tlist of type <code>"diagram"</code> with fields : 
43             <link linkend="scicos_diagram_props">props</link>, 
44             <link linkend="scicos_diagram_objs">objs</link> and 
45             <link linkend="scicos_diagram_version">version</link>.
46         </para>
47         <refsect2 id="scicos_diagram_props">
48             <title>props</title>
49             <para>Diagram properties.</para>
50             <para>This entry contains various information such some main diagram initials values.</para>
51             <para>
52                 Type : <link linkend="scicos_params">params</link> .
53             </para>
54         </refsect2>
55         <refsect2 id="scicos_diagram_objs">
56             <title>objs</title>
57             <para> List of objects included in the Xcos diagram.</para>
58             <para>
59                 The objects can also be deleted object data structure. Deleted object data structure is marked <code>list('Deleted')</code>. This objects are temporaries that will be removed on save or load.
60             </para>
61             <para> 
62                 Size : total number of objects in the diagram.
63             </para>
64             <para>
65                 Type : list of <link linkend="scicos_block">"Block"</link>, <link linkend="scicos_link">"Link"</link> or <code>"Text"</code>.
66             </para>
67         </refsect2>
68         <refsect2 id="scicos_diagram_version">
69             <title>version</title>
70             <para> A string that gives the version of the Xcos diagram. This is used to provide compatibility with old diagram.</para>
71             <para> Note that you can get the current version of Xcos by using the entry 'About Xcos' in the help menu or by using the function get_scicos_version().</para>
72             <para> 
73                 Size : 1.
74             </para>
75             <para>
76                 Type : String.
77             </para>
78         </refsect2>
79     </refsection>
80     <refsection>
81         <title>Examples</title>
82         <programlisting role="example"><![CDATA[ 
83 loadXcosLibs();              // load standard library
84
85 scs_m = scicos_diagram();    // new diagram
86 tree_show(scs_m);            // display it
87  ]]></programlisting>
88         <programlisting role="example"><![CDATA[ 
89 scs_m = scicos_diagram(),
90 scs_m.props.title = "My_new_schema"
91  ]]></programlisting>
92     </refsection>
93 </refentry>