Xcos documentation: improve the rendering for data structures 52/17852/3
Clément DAVID [Fri, 4 Mar 2016 12:47:16 +0000 (13:47 +0100)]
Change-Id: Ib933113b266f02fbae5da585110e874f9aa98d02

43 files changed:
scilab/modules/xcos/help/en_US/scilab_data_structures/blocks/CHAPTER [deleted file]
scilab/modules/xcos/help/en_US/scilab_data_structures/blocks/scicos_block.xml [deleted file]
scilab/modules/xcos/help/en_US/scilab_data_structures/blocks/scicos_graphics.xml [deleted file]
scilab/modules/xcos/help/en_US/scilab_data_structures/blocks/scicos_model.xml [deleted file]
scilab/modules/xcos/help/en_US/scilab_data_structures/compilation_simulation/CHAPTER [deleted file]
scilab/modules/xcos/help/en_US/scilab_data_structures/compilation_simulation/scicos_cpr.xml [deleted file]
scilab/modules/xcos/help/en_US/scilab_data_structures/compilation_simulation/scicos_sim.xml [deleted file]
scilab/modules/xcos/help/en_US/scilab_data_structures/compilation_simulation/scicos_state.xml [deleted file]
scilab/modules/xcos/help/en_US/scilab_data_structures/diagram/CHAPTER [deleted file]
scilab/modules/xcos/help/en_US/scilab_data_structures/diagram/scicos_diagram.xml [deleted file]
scilab/modules/xcos/help/en_US/scilab_data_structures/diagram/scicos_params.xml [deleted file]
scilab/modules/xcos/help/en_US/scilab_data_structures/links/CHAPTER [deleted file]
scilab/modules/xcos/help/en_US/scilab_data_structures/links/scicos_link.xml [deleted file]
scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_block.xml [new file with mode: 0644]
scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_cpr.xml [new file with mode: 0644]
scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_diagram.xml [new file with mode: 0644]
scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_graphics.xml [new file with mode: 0644]
scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_link.xml [new file with mode: 0644]
scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_model.xml [new file with mode: 0644]
scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_params.xml [new file with mode: 0644]
scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_sim.xml [new file with mode: 0644]
scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_state.xml [new file with mode: 0644]
scilab/modules/xcos/help/fr_FR/scilab_data_structures/blocks/CHAPTER [deleted file]
scilab/modules/xcos/help/fr_FR/scilab_data_structures/compilation_simulation/CHAPTER [deleted file]
scilab/modules/xcos/help/fr_FR/scilab_data_structures/diagram/CHAPTER [deleted file]
scilab/modules/xcos/help/fr_FR/scilab_data_structures/links/CHAPTER [deleted file]
scilab/modules/xcos/help/ja_JP/scilab_data_structures/blocks/CHAPTER [deleted file]
scilab/modules/xcos/help/ja_JP/scilab_data_structures/compilation_simulation/CHAPTER [deleted file]
scilab/modules/xcos/help/ja_JP/scilab_data_structures/diagram/CHAPTER [deleted file]
scilab/modules/xcos/help/ja_JP/scilab_data_structures/links/CHAPTER [deleted file]
scilab/modules/xcos/help/ja_JP/scilab_data_structures/scicos_block.xml [moved from scilab/modules/xcos/help/ja_JP/scilab_data_structures/blocks/scicos_block.xml with 100% similarity]
scilab/modules/xcos/help/ja_JP/scilab_data_structures/scicos_cpr.xml [moved from scilab/modules/xcos/help/ja_JP/scilab_data_structures/compilation_simulation/scicos_cpr.xml with 100% similarity]
scilab/modules/xcos/help/ja_JP/scilab_data_structures/scicos_diagram.xml [moved from scilab/modules/xcos/help/ja_JP/scilab_data_structures/diagram/scicos_diagram.xml with 100% similarity]
scilab/modules/xcos/help/ja_JP/scilab_data_structures/scicos_graphics.xml [moved from scilab/modules/xcos/help/ja_JP/scilab_data_structures/blocks/scicos_graphics.xml with 100% similarity]
scilab/modules/xcos/help/ja_JP/scilab_data_structures/scicos_link.xml [moved from scilab/modules/xcos/help/ja_JP/scilab_data_structures/links/scicos_link.xml with 100% similarity]
scilab/modules/xcos/help/ja_JP/scilab_data_structures/scicos_model.xml [moved from scilab/modules/xcos/help/ja_JP/scilab_data_structures/blocks/scicos_model.xml with 100% similarity]
scilab/modules/xcos/help/ja_JP/scilab_data_structures/scicos_params.xml [moved from scilab/modules/xcos/help/ja_JP/scilab_data_structures/diagram/scicos_params.xml with 100% similarity]
scilab/modules/xcos/help/ja_JP/scilab_data_structures/scicos_sim.xml [moved from scilab/modules/xcos/help/ja_JP/scilab_data_structures/compilation_simulation/scicos_sim.xml with 100% similarity]
scilab/modules/xcos/help/ja_JP/scilab_data_structures/scicos_state.xml [moved from scilab/modules/xcos/help/ja_JP/scilab_data_structures/compilation_simulation/scicos_state.xml with 100% similarity]
scilab/modules/xcos/help/pt_BR/scilab_data_structures/blocks/.empty [deleted file]
scilab/modules/xcos/help/pt_BR/scilab_data_structures/compilation_simulation/.empty [deleted file]
scilab/modules/xcos/help/pt_BR/scilab_data_structures/diagram/.empty [deleted file]
scilab/modules/xcos/help/pt_BR/scilab_data_structures/links/.empty [deleted file]

diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/blocks/CHAPTER b/scilab/modules/xcos/help/en_US/scilab_data_structures/blocks/CHAPTER
deleted file mode 100644 (file)
index d1f089b..0000000
+++ /dev/null
@@ -1 +0,0 @@
-title = Blocks
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/blocks/scicos_block.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/blocks/scicos_block.xml
deleted file mode 100644 (file)
index 5b3dcac..0000000
+++ /dev/null
@@ -1,120 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Scicos
- * 
- * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
- * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
- * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- *  (at your option) any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * 
- * See the file ./license.txt
- -->
-<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">
-    <refnamediv>
-        <refname>scicos_block</refname>
-        <refpurpose>Define a block structure</refpurpose>
-    </refnamediv>
-    <refsection id="Module_scicos_block">
-        <title>Module</title>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <link linkend="xcos">xcos</link>
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="block_scicos_block">
-        <title>block</title>
-        <para>
-            Basic  structure that define a xcos block.
-        </para>
-        <para>
-            That structure includes fields <link linkend="scicos_graphics">graphics</link>, <link linkend="scicos_model">model</link>,
-            
-            gui and doc.
-        </para>
-        <para>
-        </para>
-        <para>
-        </para>
-        <para>
-            Size : 5.
-        </para>
-        <para>
-            Type : scilab list.
-        </para>
-        <para>
-            
-        </para>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <emphasis role="bold">graphics</emphasis>
-                </para>
-                <para> Scilab object including graphical information concerning the features of the block.</para>
-                <para> 
-                    Size : 14.
-                </para>
-                <para>
-                    Type : scilab list.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">model</emphasis>
-                </para>
-                <para> Scilab list that contains the features of the block used for the compilation.</para>
-                <para> 
-                    Size : 23.
-                </para>
-                <para>
-                    Type : Scilab list.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">gui</emphasis>
-                </para>
-                <para> The name of the Scilab GUI function associated with the block.</para>
-                <para> 
-                    Size : 1.
-                </para>
-                <para>
-                    Type : string.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">doc</emphasis>
-                </para>
-                <para> Field used for documentation of the block
-                    Size : 1.
-                </para>
-                <para>
-                    Type : string.
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="Filecontent_scicos_block">
-        <title>File content</title>
-        <itemizedlist>
-            <listitem>
-                <para> SCI/modules/scicos/macros/scicos_scicos/scicos_block.sci</para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/blocks/scicos_graphics.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/blocks/scicos_graphics.xml
deleted file mode 100644 (file)
index c3ea6aa..0000000
+++ /dev/null
@@ -1,308 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Scicos
- * 
- * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
- * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
- * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- *  (at your option) any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * 
- * See the file ./license.txt
- -->
-<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_graphics">
-    <refnamediv>
-        <refname>scicos_graphics</refname>
-        <refpurpose>Define a graphics structure</refpurpose>
-    </refnamediv>
-    <refsection id="Module_scicos_graphics">
-        <title>Module</title>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <link linkend="xcos">xcos</link>
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="graphics_scicos_graphics">
-        <title>graphics</title>
-        <para>
-            Scilab object including
-            graphical information concerning
-            the features of the block.
-        </para>
-        <para>
-        </para>
-        <para>
-        </para>
-        <para>
-            Size : 14.
-        </para>
-        <para>
-            Type : scilab list.
-        </para>
-        <para>
-            
-        </para>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <emphasis role="bold">orig</emphasis>
-                </para>
-                <para> Vector [xo,yo], where xo is the x coordinate of the block origin and yo is the y coordinate of the block origin.</para>
-                <para> 
-                    [xo,yo] is the coordinate of down-left point of
-                    the block shape.
-                </para>
-                <para>
-                </para>
-                <para> 
-                    Size : 2.
-                </para>
-                <para>
-                    Type : row vector of real.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">sz</emphasis>
-                </para>
-                <para> Vector [w,h], where w is the block width and h the block height.</para>
-                <para> 
-                    Size : 2.
-                </para>
-                <para>
-                    Type : row vector of real.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">flip</emphasis>
-                </para>
-                <para> Set the block orientation. If true the input ports are on the left of the box and output ports are on the right.</para>
-                <para> If false the input ports are on the right of the box and output ports are on the left.</para>
-                <para> 
-                    Size : 1.
-                </para>
-                <para>
-                    Type : boolean.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">theta</emphasis>
-                </para>
-                <para> Set the angle of the Scicos object.</para>
-                <para> This value is in degree and is included in [-360,360].</para>
-                <para> 
-                    Size : 1.
-                </para>
-                <para>
-                    Type : real.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">exprs</emphasis>
-                </para>
-                <para> Strings including formal expressions used in the dialog box of the block.</para>
-                <para> 
-                    Size : number of formal expressions.
-                </para>
-                <para>
-                    Type : column vector of strings.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">pin</emphasis>
-                </para>
-                <para> Vector. pin(i) is the number of the link connected to the ith regular input port (counting from one), or 0 if this port is not connected.</para>
-                <para> 
-                    Size : number of regular input ports.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">pout</emphasis>
-                </para>
-                <para> Vector. pout(i) is the number of the link connected to the ith regular output port (counting from one), or 0 if this port is not connected.</para>
-                <para> 
-                    Size : number of regular output ports.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">pein</emphasis>
-                </para>
-                <para> Vector. pein(i) is the number of the link connected to the ith event input port (counting from one), or 0 if this port is not connected.</para>
-                <para> 
-                    Size : number of events input ports.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">peout</emphasis>
-                </para>
-                <para> Vector. peout(i) is the number of the link connected to the ith event output port (counting from one), or 0 if this port is not connected.</para>
-                <para> 
-                    Size : number of events output ports.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">gr_i</emphasis>
-                </para>
-                <para> Strings including Scilab graphics expressions for customizing the block graphical aspect. This field may be set with Icon sub_menu.</para>
-                <para> 
-                    Size : -.
-                </para>
-                <para>
-                    Type : column vector of strings.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">id</emphasis>
-                </para>
-                <para> A string including an identification for the block. The string is displayed under the block in the diagram.</para>
-                <para> 
-                    Size : 1.
-                </para>
-                <para>
-                    Type : string.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">in_implicit</emphasis>
-                </para>
-                <para> A vector of strings including 'E' or 'I'.</para>
-                <para> 'E' and 'I' stand respectively for explicit and implicit port, and this vector indicates the nature of each input port. For regular blocks (not implicit), this vector is empty or contains only "E".</para>
-                <para> 
-                    Size : nul or number of regular input ports.
-                </para>
-                <para>
-                    Type : column vector of strings.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">out_implicit</emphasis>
-                </para>
-                <para> A vector of strings including 'E' or 'I'.</para>
-                <para> 'E' and 'I' stand respectively for explicit and implicit port, and this vector indicates the nature of each output port. For regular blocks (not implicit), this vector is empty or contains only "E".</para>
-                <para> 
-                    Size : nul or number of regular output ports.
-                </para>
-                <para>
-                    Type : column vector of strings.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">in_style</emphasis>
-                </para>
-                <para> A vector of strings including JGraphX key values style properties.</para>
-                <para>
-                    These style can be used to place text or to change port aspect (eg. round, green port). This is set in semicolon separated key=value set. For example <literal>"shape=ellipse;fillColor=green"</literal> for a round and green port
-                </para>
-                <para> 
-                    Size : nul or number of regular input ports.
-                </para>
-                <para>
-                    Type : column vector of strings.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">out_style</emphasis>
-                </para>
-                <para> A vector of strings including JGraphX key values style properties.</para>
-                <para>
-                    These style can be used to place text or to change port aspect (eg. round, green port). This is set in semicolon separated key=value set. For example <literal>"shape=ellipse;fillColor=green"</literal> for a round and green port
-                </para>
-                <para> 
-                    Size : nul or number of regular output ports.
-                </para>
-                <para>
-                    Type : column vector of strings.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">in_label</emphasis>
-                </para>
-                <para> A vector of strings including ports labels.</para>
-                <para>These labels can be used to update text or to trace information.</para>
-                <para> 
-                    Size : nul or number of regular input ports.
-                </para>
-                <para>
-                    Type : column vector of strings.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">out_label</emphasis>
-                </para>
-                <para> A vector of strings including ports labels.</para>
-                <para>These labels can be used to update text or to trace information.</para>
-                <para> 
-                    Size : nul or number of regular output ports.
-                </para>
-                <para>
-                    Type : column vector of strings.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">style</emphasis>
-                </para>
-                <para> A string.</para>
-                <para> A vector of strings including JGraphX key values style properties.</para>
-                <para>
-                    These style can be used to place text or to change block aspect (eg. shape, image, text). This is set in semicolon separated key=value set. For example <literal>"shape=ellipse;fillColor=red"</literal> for a round and green block
-                </para>
-                <para> 
-                    Size : nul or 1.
-                </para>
-                <para>
-                    Type : a string.
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="Filecontent_scicos_graphics">
-        <title>File content</title>
-        <itemizedlist>
-            <listitem>
-                <para> SCI/modules/scicos/macros/scicos_scicos/scicos_graphics.sci</para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/blocks/scicos_model.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/blocks/scicos_model.xml
deleted file mode 100644 (file)
index 568c650..0000000
+++ /dev/null
@@ -1,706 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Scicos
- *
- * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
- * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- *  (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- *
- * See the file ./license.txt
- -->
-<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_model">
-    <refnamediv>
-        <refname>scicos_model</refname>
-        <refpurpose>Define a model structure</refpurpose>
-    </refnamediv>
-    <refsection id="Module_scicos_model">
-        <title>Module</title>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <link linkend="xcos">xcos</link>
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="model_scicos_model">
-        <title>model</title>
-        <para>
-            Scilab list that contains the features
-            of the block used for the compilation.
-        </para>
-        <para>
-        </para>
-        <para>
-        </para>
-        <para>
-            Size : 23.
-        </para>
-        <para>
-            Type : Scilab list.
-        </para>
-        <para>
-            
-        </para>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <emphasis role="bold">sim</emphasis>
-                </para>
-                <para> A list containing two elements. The first element is a string containing the name of the computational function (C, Fortran,or Scilab). The second element is an integer specifying the type of the computational function. Currently type 4 and 5 are used, but older types continue to work to ensure backward compatibility.</para>
-                <para> For some older case, sim can be a single string and that means that the type is supposed to be 0.</para>
-                <para>
-                    Size : 2.
-                </para>
-                <para>
-                    Type : Scilab list.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">in</emphasis>
-                </para>
-                <para> A vector specifying the number and size of the first dimension of regular input ports indexed from top to bottom of the block. If no input port exist in==[].</para>
-                <para>
-                    The size can be negative, equal to zero or positive :
-                    
-                    
-                </para>
-                <itemizedlist>
-                    <listitem>
-                        <para>If a size is less than zero, the compiler will
-                            try to find the appropriate size.
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>If a size is equal to zero, the compiler will
-                            affect this dimension by added all positive size
-                            found in that vector
-                            
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>If a size is greater than zero, then the size is
-                            explicitly given.
-                        </para>
-                        <para>
-                        </para>
-                        <para>
-                        </para>
-                    </listitem>
-                </itemizedlist>
-                <para>
-                    Size : number of regular input ports.
-                </para>
-                <para>
-                    Type : column vector of integer numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">in2</emphasis>
-                </para>
-                <para> A vector specifying the second dimension of regular input ports indexed from top to bottom of the block.</para>
-                <para> in with in2 formed then the regular input sizes matrix.</para>
-                <para> For compatibility, this dimension can stay empty ([]).</para>
-                <para> That means that the dimensions of input ports will be in,1
-                    The size can be negative, equal to zero or positive :
-                    
-                    
-                </para>
-                <itemizedlist>
-                    <listitem>
-                        <para>If a size is less than zero, the compiler will
-                            try to find the appropriate size.
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>If a size is equal to zero, the compiler will
-                            affect this dimension by added all positive size
-                            found in that vector.
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>If a size is greater than zero, then the size is
-                            explicitly given.
-                        </para>
-                        <para>
-                        </para>
-                        <para>
-                        </para>
-                    </listitem>
-                </itemizedlist>
-                <para>
-                    Size : number of regular input ports.
-                </para>
-                <para>
-                    Type : column vector of integer numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">intyp</emphasis>
-                </para>
-                <para> A vector specifying the types of regular input ports.</para>
-                <para> Its sizes is equal to the sizes of in.</para>
-                <para> The types of regular input ports can be :
-                    
-                </para>
-                <itemizedlist>
-                    <listitem>
-                        <para>1  real matrix,
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>2  complex matrix,
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>3  int32 matrix,
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>4  int16 matrix,
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>5  int8 matrix,
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>6  uint32 matrix,
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>7  uint16 matrix,
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>8  uint8 matrix.
-                        </para>
-                        <para>
-                        </para>
-                        <para>
-                        </para>
-                    </listitem>
-                </itemizedlist>
-                <para>
-                    Size : number of regular input ports.
-                </para>
-                <para>
-                    Type : column vector of integer numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">out</emphasis>
-                </para>
-                <para>
-                    A vector specifying the number and size of the first
-                    dimension of regular output ports indexed from top to
-                    bottom of the block. If no output port exist out==[].
-                </para>
-                <para>
-                    The size can be negative, equal to zero or positive :
-                    
-                    
-                </para>
-                <itemizedlist>
-                    <listitem>
-                        <para>If a size is less than zero, the compiler will
-                            try to find the appropriate size.
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>If a size is equal to zero, the compiler will
-                            affect this dimension by added all positive size
-                            found in that vector
-                            
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>If a size is greater than zero, then the size is
-                            explicitly given.
-                        </para>
-                        <para>
-                        </para>
-                        <para>
-                        </para>
-                    </listitem>
-                </itemizedlist>
-                <para>
-                    Size : number of regular output ports.
-                </para>
-                <para>
-                    Type : column vector of integer numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">out2</emphasis>
-                </para>
-                <para> A vector specifying the second dimension of regular output ports indexed from top to bottom of the block.</para>
-                <para> out with out2 formed then the regular output sizes matrix.</para>
-                <para> For compatibility, this dimension can stay empty ([]). That means that the dimensions of output ports will be out,1
-                    That dimension can be negative, equal to zero or positive :
-                    
-                    
-                </para>
-                <itemizedlist>
-                    <listitem>
-                        <para>If a size is less than zero, the compiler will
-                            try to find the appropriate size.
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>If a size is equal to zero, the compiler will
-                            affect this dimension by added all positive size
-                            found in that vector.
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>If a size is greater than zero, then the size is
-                            explicitly given.
-                        </para>
-                        <para>
-                        </para>
-                        <para>
-                        </para>
-                    </listitem>
-                </itemizedlist>
-                <para>
-                    Size : number of regular output ports.
-                </para>
-                <para>
-                    Type : column vector of integer numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">outtyp</emphasis>
-                </para>
-                <para> A vector specifying the types of regular output ports.</para>
-                <para> Its sizes is equal to the sizes of out.</para>
-                <para> The types of regular output ports can be :
-                    
-                </para>
-                <itemizedlist>
-                    <listitem>
-                        <para>1  real matrix,
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>2  complex matrix,
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>3  int32 matrix,
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>4  int16 matrix,
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>5  int8 matrix,
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>6  uint32 matrix,
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>7  uint16 matrix,
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>8  uint8 matrix.
-                        </para>
-                        <para>
-                        </para>
-                        <para>
-                        </para>
-                    </listitem>
-                </itemizedlist>
-                <para>
-                    Size : number of regular output ports.
-                </para>
-                <para>
-                    Type : column vector of integer numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">evtin</emphasis>
-                </para>
-                <para> A vector specifying the number and sizes of activation inputs. Currently activation ports can be only of size one.</para>
-                <para> If no event input port exists evtin must be equal to [].</para>
-                <para>
-                    Size : number of input event ports.
-                </para>
-                <para>
-                    Type : column vector of integer numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">evtout</emphasis>
-                </para>
-                <para> A vector specifying the number and sizes of activation outputs.</para>
-                <para> Currently activation ports can be only of size one.</para>
-                <para> If no event output port exists evtout must be equal to [].</para>
-                <para>
-                    Size : number of output event ports.
-                </para>
-                <para>
-                    Type : column vector of integer numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">state</emphasis>
-                </para>
-                <para> Vector containing initial values of continuous-time state.</para>
-                <para> Must be [] if no continuous state.</para>
-                <para>
-                    Size : number of continuous-time state.
-                </para>
-                <para>
-                    Type : column vector of real numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">dstate</emphasis>
-                </para>
-                <para> Vector containing initial values of discrete-time state.</para>
-                <para> Must be [] if no discrete state.</para>
-                <para>
-                    Size : number of discrete-time state.
-                </para>
-                <para>
-                    Type : column vector of real numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">odstate</emphasis>
-                </para>
-                <para> List containing initial values of objects state.</para>
-                <para> Must be list() if no objects state.</para>
-                <para>
-                    Objects state can be any types of scilab variable.
-                </para>
-                <para>
-                    In the computational function case of type 4 (C blocks)
-                    only elements containing matrix of real, complex,
-                    int32, int16 ,int8 ,uint32, uit16 and uint8 will be correctly
-                    provided for readind/writing.
-                </para>
-                <para>
-                </para>
-                <para>
-                    Size : number of objects state.
-                </para>
-                <para>
-                    Type : scilab list of scilab objects.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">rpar</emphasis>
-                </para>
-                <para> The vector of floating point block parameters.</para>
-                <para> Must be [] if no floating point parameters.</para>
-                <para>
-                    Size : number of real parameters.
-                </para>
-                <para>
-                    Type : column vector of real numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">ipar</emphasis>
-                </para>
-                <para> The vector of integer block parameters.</para>
-                <para> Must be [] if no integer parameters.</para>
-                <para>
-                    Size : number of integer parameters.
-                </para>
-                <para>
-                    Type : column vector of integer numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">opar</emphasis>
-                </para>
-                <para> List of objects block parameters. Must be list() if no objects parameters.</para>
-                <para>
-                    Objects parameters can be any types of scilab variable.
-                </para>
-                <para>
-                    In the computational function case of type 4 (C blocks)
-                    only elements containing matrix of real, complex,
-                    int32, int16 ,int8 ,uint32, uit16 and uint8 will be correctly
-                    provided for reading.
-                </para>
-                <para>
-                </para>
-                <para>
-                    Size : number of objects parameters.
-                </para>
-                <para>
-                    Type : list of scilab object.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">blocktype</emphasis>
-                </para>
-                <para> Character that can be set to 'c' or 'd' indifferently for standard blocks. 'x' is used if we want to force the computational function to be called during the simulation phase even if the block does not contribute to computation of the state derivative.</para>
-                <para> 'l', 'm' and 's' are reserved. Not to be used.</para>
-                <para>
-                    Size : 1.
-                </para>
-                <para>
-                    Type : Character.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">firing</emphasis>
-                </para>
-                <para> Vector of initial event firing times of size equal to the number of activation output ports (see evout). It contains output initial event dates (Events generated before any input event arises). Negative values stands for no initial event on the corresponding port.
-                    Size : number of output event ports.
-                </para>
-                <para>
-                    Type : column vector of real numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">dep_ut</emphasis>
-                </para>
-                <para> Boolean vector [dep_u, dep_t].</para>
-                <para>
-                    
-                </para>
-                <itemizedlist>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">dep_t</emphasis>
-                        </para>
-                        <para>
-                            true if block is always active.
-                        </para>
-                        <para>
-                            Output depends continuously of the time.
-                            For instance, the GENSIN_f block computes <code>y=sin(t)</code> so <code>dep_ut=[%f %t]</code>.
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">dep_u</emphasis>
-                        </para>
-                        <para>
-                            true if block has direct feed-through,
-                            i.e., at least one of the outputs depends
-                            directly (not through the states) on one
-                            of the inputs.
-                            In other words, when the computational
-                            function is called with flag 1, the value
-                            of an input is used to compute the output.
-                            For instance, the SUM_f block computes <code>y=u1+u2</code> so <code>dep_ut=[%t %f]</code>.
-                        </para>
-                        <para>
-                        </para>
-                        <para>
-                        </para>
-                    </listitem>
-                </itemizedlist>
-                <para>
-                    Size : 2.
-                </para>
-                <para>
-                    Type : Boolean vector.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">label</emphasis>
-                </para>
-                <para> String that defines a label. It can be used to identify a block in order to access or modify its parameters during simulation.</para>
-                <para>
-                    Size : 1.
-                </para>
-                <para>
-                    Type : string.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">nzcross</emphasis>
-                </para>
-                <para> Number of zero-crossing surfaces.</para>
-                <para>
-                    Size : Number of zero-crossing surfaces.
-                </para>
-                <para>
-                    Type : column vector of integer numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">nmode</emphasis>
-                </para>
-                <para> Length of the mode register. Note that this gives the size of the vector mode and not the total number of modes in which a block can operate in. Suppose a block has 3 modes and each mode can take two values, then the block can have up to 23=8 modes.</para>
-                <para>
-                    Size : Number of modes.
-                </para>
-                <para>
-                    Type : column vector of integer numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">equations</emphasis>
-                </para>
-                <para> Used in case of implicit blocks.</para>
-                <para> Data structure of type modelica which contains modelica code description if any. That list contains four entries :
-                    
-                </para>
-                <itemizedlist>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">model</emphasis>
-                        </para>
-                        <para>
-                            a string given the name of the file that contains
-                            the modelica function.
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">inputs</emphasis>
-                        </para>
-                        <para>
-                            a column vector of strings that contains the names of
-                            the modelica variables used as inputs.
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">outputs</emphasis>
-                        </para>
-                        <para>
-                            a column vector of strings that contains the names of
-                            the modelica variables used as outputs.
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">parameters</emphasis>
-                        </para>
-                        <para>
-                            a list with two entries. The first is a vector of strings
-                            for the name of modelica variable names used as parameters
-                            and the second entries is a list that contains the value of
-                            parameters.
-                        </para>
-                        <para>
-                            Names of modelica states can also be informed with
-                            parameters. In that case a third entry is used to do the
-                            difference between parameters and states.
-                        </para>
-                        <para>
-                            For i,e :
-                            mo.parameters=list(['C','v'],list(C,v),[0,1])
-                            means that 'C' is a parameter(0) of value C, and 'v'
-                            is a state(1) with initial value v.
-                        </para>
-                        <para>
-                        </para>
-                        <para>
-                        </para>
-                    </listitem>
-                </itemizedlist>
-                <para>
-                    Size : 5.
-                </para>
-                <para>
-                    Type : scilab list.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">uid</emphasis>
-                </para>
-                <para>Unique identifier string of the block (2^16 per host)</para>
-                <para>This identifier will be only set using the Xcos GUI. To set a specific value at bloc allocation, use the following code:</para>
-                <programlisting role="example">
-                    jimport("java.rmi.server.UID");
-                    juid =  jnewInstance("java.rmi.server.UID");
-                    uid = juid.toString()
-                </programlisting>
-                <para>
-                    Size : 1x1.
-                </para>
-                <para>
-                    Type : String.
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="Filecontent_scicos_model">
-        <title>File content</title>
-        <itemizedlist>
-            <listitem>
-                <para> SCI/modules/scicos/macros/scicos_scicos/scicos_model.sci</para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/compilation_simulation/CHAPTER b/scilab/modules/xcos/help/en_US/scilab_data_structures/compilation_simulation/CHAPTER
deleted file mode 100644 (file)
index ffdb527..0000000
+++ /dev/null
@@ -1 +0,0 @@
-title = Compilation/Simulation
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/compilation_simulation/scicos_cpr.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/compilation_simulation/scicos_cpr.xml
deleted file mode 100644 (file)
index 21aea0e..0000000
+++ /dev/null
@@ -1,123 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Scicos
- * 
- * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
- * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
- * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- *  (at your option) any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * 
- * See the file ./license.txt
- -->
-<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_cpr">
-    <refnamediv>
-        <refname>scicos_cpr</refname>
-        <refpurpose>Compiled Scicos structure</refpurpose>
-    </refnamediv>
-    <refsection id="Module_scicos_cpr">
-        <title>Module</title>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <link linkend="xcos">xcos</link>
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="cpr_scicos_cpr">
-        <title>cpr</title>
-        <para>
-            The Scilab object <link linkend="scicos_cpr">cpr</link>
-            contains 
-            the result of the compilation.
-        </para>
-        <para>
-            That structure includes fields <link linkend="scicos_state">state</link>, <link linkend="scicos_sim">sim</link>,
-            
-            cor and corinv.
-        </para>
-        <para>
-        </para>
-        <para>
-        </para>
-        <para>
-            Size : 5.
-        </para>
-        <para>
-            Type : scilab list.
-        </para>
-        <para>
-            
-        </para>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <emphasis role="bold">state</emphasis>
-                </para>
-                <para> Scilab typed list of type xcs. It contains all the states of the model, that is, everything than can evolve during the simulation.</para>
-                <para> state contains x, z, oz, iz, tevts, evtspt, pointi and outtb.</para>
-                <para> 
-                    Size : 9.
-                </para>
-                <para>
-                    Type : scilab tlist.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">sim</emphasis>
-                </para>
-                <para> Scilab typed list of type scs. It contains static arrays coming from the result of the compilation. That arrays does not evolve during the simulation.</para>
-                <para> 
-                    Size : 33.
-                </para>
-                <para>
-                    Type : scilab tlist.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">cor</emphasis>
-                </para>
-                <para> It is a list with same recursive structure as scs_m. Each leaf contains the index of associated block in sim data structure.
-                    Size : number of objects in scs_m.
-                </para>
-                <para>
-                    Type : scilab list.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">corinv</emphasis>
-                </para>
-                <para> corinv(i) is the path of i th block defined in sim data structure in the scs_m data structure.</para>
-                <para> 
-                    Size : number of blocks in the compiled structre.
-                </para>
-                <para>
-                    Type : scilab list.
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="Filecontent_scicos_cpr">
-        <title>File content</title>
-        <itemizedlist>
-            <listitem>
-                <para> SCI/modules/scicos/macros/scicos_scicos/scicos_cpr.sci</para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/compilation_simulation/scicos_sim.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/compilation_simulation/scicos_sim.xml
deleted file mode 100644 (file)
index dbf1c46..0000000
+++ /dev/null
@@ -1,455 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Scicos
- * 
- * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
- * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
- * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- *  (at your option) any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * 
- * See the file ./license.txt
- -->
-<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_sim">
-    <refnamediv>
-        <refname>scicos_sim</refname>
-        <refpurpose>Define a sim structure</refpurpose>
-    </refnamediv>
-    <refsection id="Module_scicos_sim">
-        <title>Module</title>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <link linkend="xcos">xcos</link>
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="sim_scicos_sim">
-        <title>sim</title>
-        <para>
-            Scilab typed list of type scs. It contains 
-            static arrays coming from the result of the
-            compilation. That arrays does not evolve
-            during the simulation.
-        </para>
-        <para>
-        </para>
-        <para>
-        </para>
-        <para>
-            Size : 33.
-        </para>
-        <para>
-            Type : scilab tlist.
-        </para>
-        <para>
-            
-        </para>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <emphasis role="bold">funs</emphasis>
-                </para>
-                <para> A list containing names of the computational functions or scilab functions.</para>
-                <para> 
-                    Size : number of blocks.
-                </para>
-                <para>
-                    Type : list of strings and/or scilab function.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">xptr</emphasis>
-                </para>
-                <para> A vector pointer to the continuous time state register x. The continuous-time state of block i is state.x(sim.xptr(i):sim.xptr(i+1)-1).</para>
-                <para> 
-                    Size : number of blocks + 1.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">zptr</emphasis>
-                </para>
-                <para> A vector pointer to the discrete time state register z. The discrete-time state of block i is state.z(sim.zptr(i):sim.zptr(i+1)-1).</para>
-                <para> 
-                    Size : number of blocks + 1.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">ozptr</emphasis>
-                </para>
-                <para> A vector pointer to the object discrete state register oz. The object discrete state of block i is state.oz(sim.ozptr(i):sim.ozptr(i+1)-1).</para>
-                <para> 
-                    Size : number of blocks + 1.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">zcptr</emphasis>
-                </para>
-                <para> A vector pointer to the zero-crossing surfaces.</para>
-                <para> register. That vector gives by block the used number of the zero-crossing.</para>
-                <para> 
-                    Size : number of blocks + 1.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">inpptr</emphasis>
-                </para>
-                <para> (sim.inpptr(i+1)-sim.inpptr(i)) gives the number of regular input ports of the i block.</para>
-                <para> inpptr(i) points to the beginning of ith block inputs within the indirection table inplnk.</para>
-                <para> 
-                    Size : number of blocks + 1.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">outptr</emphasis>
-                </para>
-                <para> (sim.outptr(i+1)-sim.outptr(i)) gives the number of regular output ports of the i block.</para>
-                <para> outptr(i) points to the beginning of ith block outputs within the indirection table outlnk.</para>
-                <para> 
-                    Size : number of blocks + 1.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">inplnk</emphasis>
-                </para>
-                <para> (cpr.sim.inplnk(cpr.sim.inpptr(i)-1+j)) is the index of the link connected to the jth input port of the ith block where j goes from 1 to (cpr.sim.inpptr(i+1)-cpr.sim.inpptr(i)).</para>
-                <para> 
-                    Size : total number of regular input port.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">outlnk</emphasis>
-                </para>
-                <para> (cpr.sim.outlnk(cpr.sim.outptr(i)-1+j)) is the index of the link connected to the jth output port of the ith block where j goes from 1 to (cpr.sim.outptr(i+1)-cpr.sim.outptr(i)).</para>
-                <para> 
-                    Size : total number of regular output port.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">rpar</emphasis>
-                </para>
-                <para> Vector of real parameters that is obtained by concatenating the real parameters registers of all the blocks.</para>
-                <para> 
-                    Size : total number of real parameters.
-                </para>
-                <para>
-                    Type : column vector of real numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">rpptr</emphasis>
-                </para>
-                <para> A vector pointer to the real parameters register rpar. The real parameters of block i are sim.rpar(sim.rpptr(i):sim.rpptr(i+1)-1).</para>
-                <para> 
-                    Size : number of blocks + 1.
-                </para>
-                <para>
-                    Type : column vector of integer.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">ipar</emphasis>
-                </para>
-                <para> Vector of integer parameters that is obtained by concatenating the integer parameters registers of all the blocks.</para>
-                <para> 
-                    Size : total number of integer parameters.
-                </para>
-                <para>
-                    Type : column vector of integer.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">ipptr</emphasis>
-                </para>
-                <para> A vector pointer to the integer parameters register ipar. The integer parameters of block i are sim.ipar(sim.ipptr(i):sim.ipptr(i+1)-1).</para>
-                <para> 
-                    Size : number of blocks + 1.
-                </para>
-                <para>
-                    Type : column vector of real numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">opar</emphasis>
-                </para>
-                <para> List of object parameters that is obtained by concatenating the list of object parameters of all the blocks.</para>
-                <para> 
-                    Size : total number of object parameters.
-                </para>
-                <para>
-                    Type : list of scilab objects.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">opptr</emphasis>
-                </para>
-                <para> A vector pointer to the object parameters list opar. The object parameters of block i are sim.opar(sim.opptr(i):sim.opptr(i+1)-1).</para>
-                <para> 
-                    Size : number of blocks + 1.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">clkptr</emphasis>
-                </para>
-                <para> A vector pointer to output activation ports.</para>
-                <para> (cpr.sim.clkptr(i):cpr.sim.clkptr(i+1)-1) gives the number of output event ports of the block i.</para>
-                <para> 
-                    Size : number of blocks + 1.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">ordptr</emphasis>
-                </para>
-                <para> A vector pointer to ordclk designating the part of ordclk corresponding to a given activation.</para>
-                <para> (cpr.sim.ordptr(i):cpr.sim.ordptr(i+1)-1) points to the region within ordclk indicates the number of blocks activated by the output event ports numbered i.</para>
-                <para> 
-                    Size : number of sources of activation + 1.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">execlk</emphasis>
-                </para>
-                <para> Unused.</para>
-                <para> 
-                    Size : -
-                    Type : matrix of real.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">ordclk</emphasis>
-                </para>
-                <para> A matrix associated to blocks activated by output activation ports. The first column contains the block number, and the second, the event code by which the block should be called.</para>
-                <para> 
-                    Size : total number of blocks summed by source of activations.
-                </para>
-                <para>
-                    Type : matrix of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">cord</emphasis>
-                </para>
-                <para> A matrix associated to always active blocks.</para>
-                <para> The first column contains the block number, and the second, the event code by which the block should be called.</para>
-                <para> 
-                    Size : ncord.
-                </para>
-                <para>
-                    Type : matrix of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">oord</emphasis>
-                </para>
-                <para> Subset of cord. Blocks of that matrix have outputs which affect computation of continuous state derivatives.</para>
-                <para> 
-                    Size : noord.
-                </para>
-                <para>
-                    Type : matrix of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">zord</emphasis>
-                </para>
-                <para> Subset of zord. Blocks of that matrix have outputs which affect computation of zero-crossing surfaces.</para>
-                <para> 
-                    Size : nzord.
-                </para>
-                <para>
-                    Type : matrix of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">critev</emphasis>
-                </para>
-                <para> A vector of size equal to the number of activations and containing zeros and ones. The value one indicates that the activation is critical in the sense that the continuous-time solver must be cold restarted.</para>
-                <para> 
-                    Size : number of source of activation.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">nb</emphasis>
-                </para>
-                <para> Number of blocks. Note that the number of blocks may differ from the original number of blocks in the diagram because c_pass2 may duplicate some conditional blocks.</para>
-                <para> 
-                    Size : 1.
-                </para>
-                <para>
-                    Type : integer.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">ztyp</emphasis>
-                </para>
-                <para> A vector of size equal to the number of blocks.</para>
-                <para> A 1 entry indicates that the block may have zero-crossings, even if it does not in the context of the diagram. Usually not used by the simulator.</para>
-                <para> 
-                    Size : number of blocks.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">nblk</emphasis>
-                </para>
-                <para> Not used. Set to nb.</para>
-                <para> 
-                    Size : 1
-                    Type : integer.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">ndcblk</emphasis>
-                </para>
-                <para> Not used.</para>
-                <para> 
-                    Size : -
-                    Type : integer.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">subscr</emphasis>
-                </para>
-                <para> Not used.</para>
-                <para> 
-                    Size : 0
-                    Type : empty real.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">funtyp</emphasis>
-                </para>
-                <para> A vector of size equal to the number of blocks indicating the type of the computational function of the block. Block type can be 0 through 5.</para>
-                <para> Currently only type 4 (C language) and type 5 (Scilab language) computational functions should be used. But older blocks can also be used.</para>
-                <para> 
-                    Size : number of blocks.
-                </para>
-                <para>
-                    Type : column vector of integer.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">iord</emphasis>
-                </para>
-                <para> A matrix associated to blocks that must be activated at the start of the simulation. This includes blocks inheriting from constant blocks and always active blocks.</para>
-                <para> 
-                    Size : niord.
-                </para>
-                <para>
-                    Type : matrix of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">labels</emphasis>
-                </para>
-                <para> A string vector of size equal to the number of blocks containing block labels.</para>
-                <para> 
-                    Size : numbers of blocks.
-                </para>
-                <para>
-                    Type : column vector of strings.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">modptr</emphasis>
-                </para>
-                <para> A vector pointer to the block modes.</para>
-                <para> 
-                    Size : number of blocks + 1.
-                </para>
-                <para>
-                    Type : column vector of integer.
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="Filecontent_scicos_sim">
-        <title>File content</title>
-        <itemizedlist>
-            <listitem>
-                <para> SCI/modules/scicos/macros/scicos_scicos/scicos_sim.sci</para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/compilation_simulation/scicos_state.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/compilation_simulation/scicos_state.xml
deleted file mode 100644 (file)
index a625020..0000000
+++ /dev/null
@@ -1,171 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Scicos
- * 
- * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
- * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
- * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- *  (at your option) any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * 
- * See the file ./license.txt
- -->
-<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_state">
-    <refnamediv>
-        <refname>scicos_state</refname>
-        <refpurpose>Define a state structure</refpurpose>
-    </refnamediv>
-    <refsection id="Module_scicos_state">
-        <title>Module</title>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <link linkend="xcos">xcos</link>
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="state_scicos_state">
-        <title>state</title>
-        <para>
-            Scilab typed list of type xcs. It contains all
-            the states of the model, that is, everything than
-            can evolve during the simulation.
-        </para>
-        <para>
-            state contains x, z, oz, iz, 
-            tevts, evtspt, pointi and outtb.
-        </para>
-        <para>
-        </para>
-        <para>
-        </para>
-        <para>
-            Size : 9.
-        </para>
-        <para>
-            Type : scilab tlist.
-        </para>
-        <para>
-            
-        </para>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <emphasis role="bold">x</emphasis>
-                </para>
-                <para> The continuous-time state register, which is obtained by concatenating the continuous-time states of all the blocks.</para>
-                <para> 
-                    Size : total of all the size of continuous-time state registers.
-                </para>
-                <para>
-                    Type : column vector of real numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">z</emphasis>
-                </para>
-                <para> The discrete-time state register, which is obtained by concatenating the discrete-time states of all the blocks.</para>
-                <para> 
-                    Size : total of all the size of discrete-time state registers.
-                </para>
-                <para>
-                    Type : column vector of real number.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">oz</emphasis>
-                </para>
-                <para> The list of the object discrete-time state, which is obtained by concatenating the object discrete-time states of all the blocks.</para>
-                <para> 
-                    Size : total of all the size of object state.
-                </para>
-                <para>
-                    Type : list of scilab object.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">iz</emphasis>
-                </para>
-                <para> Vector of size equal to the number of blocks.</para>
-                <para> That vector is used to store pointers of the working state register (work). If a block needs to allocate memory at initialization (flag 4), the associated pointer is saved here.</para>
-                <para> 
-                    Size : number of blocks.
-                </para>
-                <para>
-                    Type : column vector of real numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">tevts</emphasis>
-                </para>
-                <para> Vector of size equal to the number of activation sources. It contains the scheduled times for programmed activations in evtspt.</para>
-                <para> 
-                    Size : number of activation sources.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">evtspt</emphasis>
-                </para>
-                <para> Vector of size equal to the number of activation sources. It is an event scheduler.</para>
-                <para> 
-                    Size : number of activation sources.
-                </para>
-                <para>
-                    Type : column vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">pointi</emphasis>
-                </para>
-                <para> The number of the next programmed event.</para>
-                <para> 
-                    Size : 1.
-                </para>
-                <para>
-                    Type : integer.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">outtb</emphasis>
-                </para>
-                <para> Scilab list containing all output registers of blocks. Each element of that list contains typed matrix-based data.</para>
-                <para> 
-                    Size : number of regular output ports.
-                </para>
-                <para>
-                    Type : list of scilab matrix.
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="Filecontent_scicos_state">
-        <title>File content</title>
-        <itemizedlist>
-            <listitem>
-                <para> SCI/modules/scicos/macros/scicos_scicos/scicos_state.sci</para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/diagram/CHAPTER b/scilab/modules/xcos/help/en_US/scilab_data_structures/diagram/CHAPTER
deleted file mode 100644 (file)
index 87a5ba3..0000000
+++ /dev/null
@@ -1 +0,0 @@
-title = Diagram
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/diagram/scicos_diagram.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/diagram/scicos_diagram.xml
deleted file mode 100644 (file)
index 35d683e..0000000
+++ /dev/null
@@ -1,113 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Scicos
- * 
- * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
- * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
- * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- *  (at your option) any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * 
- * See the file ./license.txt
- -->
-<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">
-    <refnamediv>
-        <refname>scicos_diagram</refname>
-        <refpurpose>Define a scs_m structure</refpurpose>
-    </refnamediv>
-    <refsection id="Module_scicos_diagram">
-        <title>Module</title>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <link linkend="xcos">xcos</link>
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="diagram_scicos_diagram">
-        <title>diagram</title>
-        <para>
-            Size : 4.
-        </para>
-        <para>
-            Type : scilab list.
-        </para>
-        <para>
-            
-        </para>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <emphasis role="bold">props</emphasis>
-                </para>
-                <para> Diagram properties.</para>
-                <para> This entry contains various information such some main diagram initials values.</para>
-                <para> 
-                    This variable is a tlist of type 
-                    and
-                    contains wpar, title, tol, tf, context,
-                    options and doc.
-                </para>
-                <para>
-                </para>
-                <para> 
-                    Size : 11.
-                </para>
-                <para>
-                    Type : Scilab tlist of type .
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">objs</emphasis>
-                </para>
-                <para> List of objects included in the Xcos diagram.</para>
-                <para>
-                    The objects used in Xcos are <link linkend="scicos_block">block</link>, <link linkend="scicos_link">link</link> and Text.
-                </para>
-                <para> The objects can also be deleted object data structure.</para>
-                <para> Deleted object data structure is marked list('Deleted').</para>
-                <para> 
-                    Size : total number of objects in the diagram.
-                </para>
-                <para>
-                    Type : Scilab tlist of type, or Text.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">version</emphasis>
-                </para>
-                <para> A string that gives the version of the Xcos diagram.</para>
-                <para> This is used to provide compatibility with old diagram.</para>
-                <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>
-                <para> 
-                    Size : 1.
-                </para>
-                <para>
-                    Type : String.
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="Filecontent_scicos_diagram">
-        <title>File content</title>
-        <itemizedlist>
-            <listitem>
-                <para> SCI/modules/scicos/macros/scicos_scicos/scicos_diagram.sci</para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/diagram/scicos_params.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/diagram/scicos_params.xml
deleted file mode 100644 (file)
index 7a9d8b4..0000000
+++ /dev/null
@@ -1,391 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Scicos
- * 
- * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
- * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
- * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- *  (at your option) any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * 
- * See the file ./license.txt
- -->
-<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_params">
-    <refnamediv>
-        <refname>scicos_params</refname>
-        <refpurpose>Define a param structure</refpurpose>
-    </refnamediv>
-    <refsection id="Module_scicos_params">
-        <title>Module</title>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <link linkend="xcos">xcos</link>
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="params_scicos_params">
-        <title>params</title>
-        <para>
-            Size : 11.
-        </para>
-        <para>
-            Type : scilab list.
-        </para>
-        <para>
-            
-        </para>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <emphasis role="bold">wpar</emphasis>
-                </para>
-                <para> This vector is not currently used.</para>
-                <para> It may be used in the future to code window sizes of the editor.</para>
-                <para> 
-                    Size : 6.
-                </para>
-                <para>
-                    Type : column vector or real.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">title</emphasis>
-                </para>
-                <para> Vector of character strings, where the first one is the diagram title and default name of save file name, and the second one is the path of the directory of the file name.</para>
-                <para> 
-                    Size : 2.
-                </para>
-                <para>
-                    Type : row vector of strings.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">tol</emphasis>
-                </para>
-                <para> 
-                    A vector containing simulation parameters including
-                    various tolerances used by the solver: 
-                    
-                    
-                </para>
-                <itemizedlist>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">atol  </emphasis>
-                        </para>
-                        <para>
-                            Integrator absolute tolerance for the numerical solver.
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">rtol  </emphasis>
-                        </para>
-                        <para>
-                            Integrator relative tolerance for the numerical solver.
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">ttol  </emphasis>
-                        </para>
-                        <para>
-                            Tolerance on time.
-                        </para>
-                        <para>
-                            If an integration period is less
-                            than ttol, the numerical solver is not called.
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">deltat</emphasis>
-                        </para>
-                        <para>
-                            Maximum integration time interval.
-                        </para>
-                        <para>
-                            If an integration period is larger than
-                            deltat, the numerical solver is called more than
-                            once in such a way that for each call the integration
-                            period remains below deltat
-                            
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">scale </emphasis>
-                        </para>
-                        <para>
-                            Real-time scaling; the value 0 corresponds to no
-                            real-time scaling.
-                        </para>
-                        <para>
-                            It associates a Scicos simulation time to the real
-                            time in seconds.
-                        </para>
-                        <para>
-                            A value of 1 means that each Scicos unit of time
-                            corresponds to one second.
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">solver</emphasis>
-                        </para>
-                        <para>
-                            Choice of numerical solver.
-                        </para>
-                        <para>
-                            The value 0 implies an ODE solver and 100
-                            implies a DAE solver.
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">hmax  </emphasis>
-                        </para>
-                        <para>
-                            Maximum step size for the numerical solver.
-                        </para>
-                        <para>
-                            0 means no limit.
-                        </para>
-                        <para>
-                        </para>
-                        <para>           
-                        </para>
-                    </listitem>
-                </itemizedlist>
-                <para> 
-                    Size : 7.
-                </para>
-                <para>
-                    Type : column vector of real.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">tf</emphasis>
-                </para>
-                <para> Final time simulation.</para>
-                <para> The simulation stops at this time.</para>
-                <para> The default value is 100000.</para>
-                <para> 
-                    Size : 1.
-                </para>
-                <para>
-                    Type : real.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">context</emphasis>
-                </para>
-                <para> A vector of strings containing Scilab instructions defining Scilab variables to be used inside block's dialog box as symbolic parameters.</para>
-                <para> All valid Scilab instructions can be used and also comments.</para>
-                <para> 
-                    Size : number of lines of the context.
-                </para>
-                <para>
-                    Type : column vector of strings.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">void1</emphasis>
-                </para>
-                <para> unused field.</para>
-                <para> 
-                    Size : -.
-                </para>
-                <para>
-                    Type : -.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">options</emphasis>
-                </para>
-                <para> Scilab object of type scsopt defining graphical properties of the editor such as background color and link color.</para>
-                <para> 
-                    The fields are the following:
-                    
-                    
-                </para>
-                <itemizedlist>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">3D        </emphasis>
-                        </para>
-                        <para>
-                            A list with two entries. The first one is a boolean
-                            indicating whether or not blocks should have 3D aspect.
-                        </para>
-                        <para>
-                            The second entry indicates the color in the current colormap
-                            to be used to create the 3D effect.
-                        </para>
-                        <para>
-                            The default is 33 which corresponds to gray added by
-                            Scicos to the standard colormap, which contains 32 colors.
-                        </para>
-                        <para>
-                            The default value is list(%t,33).
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">Background</emphasis>
-                        </para>
-                        <para>
-                            Vector with two entries: background and
-                            foreground colors.
-                        </para>
-                        <para>
-                            The default value is [8,1].
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">link      </emphasis>
-                        </para>
-                        <para>
-                            Default link colors for regular and activation links.
-                        </para>
-                        <para>
-                            These colors are used only at link construction.
-                        </para>
-                        <para>
-                            Changing them does not affect already constructed links.
-                        </para>
-                        <para>
-                            The default value is [1,5], which corresponds to black and
-                            red if the standard Scilab colormap is used.
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">ID        </emphasis>
-                        </para>
-                        <para>
-                            A list of two vectors including font number and sizes.
-                        </para>
-                        <para>
-                            The default value is [5,1],[4,1].
-                        </para>
-                        <para>
-                            
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <emphasis role="bold">Cmap      </emphasis>
-                        </para>
-                        <para>
-                            An n,3 matrix containing RGB values of colors
-                            to be added to the colormap.
-                        </para>
-                        <para>
-                            The default value is, [0.8,0.8,0.8] i.e., the color gray.
-                        </para>
-                        <para>
-                        </para>
-                        <para>           
-                        </para>
-                    </listitem>
-                </itemizedlist>
-                <para> 
-                    Size : 6.
-                </para>
-                <para>
-                    Type : scilab tlist of type scsopt.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">void2</emphasis>
-                </para>
-                <para> unused field.</para>
-                <para> 
-                    Size : -.
-                </para>
-                <para>
-                    Type : -.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">void3</emphasis>
-                </para>
-                <para> unused field.</para>
-                <para> 
-                    Size : -.
-                </para>
-                <para>
-                    Type : -.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">doc</emphasis>
-                </para>
-                <para> User defined diagram documentation structure.</para>
-                <para> 
-                    Size : 1.
-                </para>
-                <para>
-                    Type : Strings.
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="Filecontent_scicos_params">
-        <title>File content</title>
-        <itemizedlist>
-            <listitem>
-                <para> SCI/modules/scicos/macros/scicos_scicos/scicos_params.sci</para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/links/CHAPTER b/scilab/modules/xcos/help/en_US/scilab_data_structures/links/CHAPTER
deleted file mode 100644 (file)
index 209ea6f..0000000
+++ /dev/null
@@ -1 +0,0 @@
-title = Links
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/links/scicos_link.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/links/scicos_link.xml
deleted file mode 100644 (file)
index a0e4c54..0000000
+++ /dev/null
@@ -1,147 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Scicos
- * 
- * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
- * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
- * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- *  (at your option) any later version.
- * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * 
- * See the file ./license.txt
- -->
-<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_link">
-    <refnamediv>
-        <refname>scicos_link</refname>
-        <refpurpose>Define a link structure</refpurpose>
-    </refnamediv>
-    <refsection id="Module_scicos_link">
-        <title>Module</title>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <link linkend="xcos">xcos</link>
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="link_scicos_link">
-        <title>link</title>
-        <para>
-            Size : 8.
-        </para>
-        <para>
-            Type : scilab list.
-        </para>
-        <para>
-            
-        </para>
-        <itemizedlist>
-            <listitem>
-                <para>
-                    <emphasis role="bold">xx</emphasis>
-                </para>
-                <para> Vector of x coordinates of the link path.</para>
-                <para> A link is defined as a polyline line.</para>
-                <para> 
-                    Size : number of points of the link.
-                </para>
-                <para>
-                    Type : column vector of real numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">yy</emphasis>
-                </para>
-                <para> Vector of y coordinates of the link path.</para>
-                <para> A link is defined as a polyline line.</para>
-                <para> 
-                    Size : number of points of the link.
-                </para>
-                <para>
-                    Type : column vector of real numbers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">id</emphasis>
-                </para>
-                <para> Character string, the link identification.</para>
-                <para> 
-                    Size : 1.
-                </para>
-                <para>
-                    Type : string.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">thick</emphasis>
-                </para>
-                <para> Vector of size two defining line thickness.</para>
-                <para> 
-                    Size : 2.
-                </para>
-                <para>
-                    Type : row vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">ct</emphasis>
-                </para>
-                <para> The first entry of this vector designates the color, and the second, the nature of the link. The second entry is 1 for a regular link, -1 for an activation link, and 2 for an implicit link.</para>
-                <para> 
-                    Size : 2.
-                </para>
-                <para>
-                    Type : row vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">from</emphasis>
-                </para>
-                <para> Vector of size three including the block number, port number, and port type (0 for output, 1 for input) at the origin of the link. Note that the third entry may be 1 if the link is implicit; otherwise it is zero.</para>
-                <para> 
-                    Size : 3.
-                </para>
-                <para>
-                    Type : row vector of integers.
-                </para>
-            </listitem>
-            <listitem>
-                <para>
-                    <emphasis role="bold">to</emphasis>
-                </para>
-                <para> Vector of size three including the block number, port number, and port type (0 for output, 1 for input) at the destination of the link. Note that the third entry may be 1 if the link is implicit; otherwise it is zero.</para>
-                <para> 
-                    Size : 3.
-                </para>
-                <para>
-                    Type : row vector of integers.
-                </para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-    <refsection id="Filecontent_scicos_link">
-        <title>File content</title>
-        <itemizedlist>
-            <listitem>
-                <para> SCI/modules/scicos/macros/scicos_scicos/scicos_link.sci</para>
-            </listitem>
-        </itemizedlist>
-    </refsection>
-</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_block.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_block.xml
new file mode 100644 (file)
index 0000000..c7ad743
--- /dev/null
@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scicos
+ * 
+ * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
+ * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
+ * 
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * 
+ * See the file ./license.txt
+ -->
+<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">
+    <refnamediv>
+        <refname>scicos_block</refname>
+        <refpurpose>Define a block structure</refpurpose>
+    </refnamediv>
+    <refsection id="Module_scicos_block">
+        <title>Module</title>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <link linkend="xcos">xcos</link>
+                </para>
+            </listitem>
+        </itemizedlist>
+    </refsection>
+    <refsection id="block_scicos_block">
+        <title>block</title>
+        <para>
+            Basic  structure that define a xcos block.
+        </para>
+        <para>
+            Type : scilab tlist of type <code>"Block"</code> with fields :
+            <link linkend="scicos_block_graphics">graphics</link>, 
+            <link linkend="scicos_block_model">model</link>, 
+            <link linkend="scicos_block_gui">gui</link> and 
+            <link linkend="scicos_block_doc">doc</link>.
+        </para>
+        <refsect2 id="scicos_block_graphics">
+            <title>graphics</title>
+            <para> Scilab object including graphical information concerning the features of the block.</para>
+            <para>
+                Type : <link linkend="scicos_graphics">graphics</link>.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model">
+            <title>model</title>
+            <para> Scilab list that contains the features of the block used for the compilation.</para>
+            <para>
+                Type : <link linkend="scicos_model">model</link>.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_gui">
+            <title>gui</title>
+            <para> The name of the Scilab GUI function associated with the block.</para>
+            <para> 
+                Size : 1.
+            </para>
+            <para>
+                Type : string.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_doc">
+            <title>doc</title>
+            <para> Field used for documentation of the block
+                Size : 1.
+            </para>
+            <para>
+                Type : list or string.
+            </para>
+        </refsect2>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[ 
+loadXcosLibs();              // load standard library
+
+blk = BIGSOM_f("define");    // new specific block
+tree_show(blk);              // display it
+ ]]></programlisting>
+        <programlisting role="example"><![CDATA[ 
+blk = scicos_block(),
+blk.model.rpar = 1
+ ]]></programlisting>
+    </refsection>
+</refentry>
+
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_cpr.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_cpr.xml
new file mode 100644 (file)
index 0000000..d4dbc46
--- /dev/null
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scicos
+ * 
+ * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
+ * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
+ * 
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * 
+ * See the file ./license.txt
+ -->
+<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_cpr">
+    <refnamediv>
+        <refname>scicos_cpr</refname>
+        <refpurpose>Compiled Scicos structure</refpurpose>
+    </refnamediv>
+    <refsection id="Module_scicos_cpr">
+        <title>Module</title>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <link linkend="xcos">xcos</link>
+                </para>
+            </listitem>
+        </itemizedlist>
+    </refsection>
+    <refsection id="cpr_scicos_cpr">
+        <title>cpr</title>
+        <para>
+            The Scilab object <link linkend="scicos_cpr">cpr</link> contains the result of the compilation. It is an executable representation of the schema and is used either to simulation or to generate code.
+        </para>
+        <para>
+            Type : scilab tlist of type <code>"cpr"</code> with fields :
+            <link linkend="scicos_cpr_state">state</link>, 
+            <link linkend="scicos_cpr_sim">sim</link>, 
+            <link linkend="scicos_cpr_cor">cor</link> and 
+            <link linkend="scicos_cpr_corinv">corinv</link>.
+        </para>
+        <refsect2 id="scicos_cpr_state">
+            <title>state</title>
+            <para>
+                Scilab typed list of type <code>"xcs"</code>. It contains all the states of the model, that is, everything than can evolve during the simulation.
+            </para>
+            <para>
+                Type : <link linkend="scicos_state">state</link>.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim">
+            <title>sim</title>
+            <para>
+                Scilab typed list of type <code>"scs"</code>. It contains static values coming from the result of the compilation. That values does not evolve during the simulation.
+            </para>
+            <para>
+                Type : <link linkend="scicos_sim">sim</link>
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_cor">
+            <title>cor</title>
+            <para>
+                It is a list with same recursive structure as <link linkend="scicos_diagram">scs_m</link>. Each leaf contains the index of associated block in <link linkend="scicos_sim">sim</link> data structure. It can be used to retrieve compiled information of a specific <link linkend="scicos_block">block</link>.
+            </para>
+            <para>
+                Size : number of graphical objects in <link linkend="scicos_diagram">scs_m</link>.
+            </para>
+            <para>
+                Type : scilab list.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_corinv">
+            <title>corinv</title>
+            <para>
+                <code>corinv(i)</code> is the path of <code>i</code> th block defined in <link linkend="scicos_sim">sim</link> data structure in the <link linkend="scicos_diagram">scs_m</link> data structure.
+            </para>
+            <para>
+                Size : number of simulable blocks.
+            </para>
+            <para>
+                Type : scilab list.
+            </para>
+        </refsect2>
+    </refsection>
+</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_diagram.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_diagram.xml
new file mode 100644 (file)
index 0000000..3e11242
--- /dev/null
@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scicos
+ * 
+ * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
+ * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
+ * 
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * 
+ * See the file ./license.txt
+ -->
+<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">
+    <refnamediv>
+        <refname>scicos_diagram</refname>
+        <refpurpose>Define a scs_m structure</refpurpose>
+    </refnamediv>
+    <refsection id="Module_scicos_diagram">
+        <title>Module</title>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <link linkend="xcos">xcos</link>
+                </para>
+            </listitem>
+        </itemizedlist>
+    </refsection>
+    <refsection id="diagram_scicos_diagram">
+        <title>diagram</title>
+        <para>
+            Type : scilab tlist of type <code>"diagram"</code> with fields : 
+            <link linkend="scicos_diagram_props">props</link>, 
+            <link linkend="scicos_diagram_objs">objs</link> and 
+            <link linkend="scicos_diagram_version">version</link>.
+        </para>
+        <refsect2 id="scicos_diagram_props">
+            <title>props</title>
+            <para>Diagram properties.</para>
+            <para>This entry contains various information such some main diagram initials values.</para>
+            <para>
+                Type : <link linkend="scicos_params">params</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_diagram_objs">
+            <title>objs</title>
+            <para> List of objects included in the Xcos diagram.</para>
+            <para>
+                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.
+            </para>
+            <para> 
+                Size : total number of objects in the diagram.
+            </para>
+            <para>
+                Type : list of <link linkend="scicos_block">"Block"</link>, <link linkend="scicos_link">"Link"</link> or <code>"Text"</code>.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_diagram_version">
+            <title>version</title>
+            <para> A string that gives the version of the Xcos diagram. This is used to provide compatibility with old diagram.</para>
+            <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>
+            <para> 
+                Size : 1.
+            </para>
+            <para>
+                Type : String.
+            </para>
+        </refsect2>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[ 
+loadXcosLibs();              // load standard library
+
+scs_m = scicos_diagram();    // new diagram
+tree_show(scs_m);            // display it
+ ]]></programlisting>
+        <programlisting role="example"><![CDATA[ 
+scs_m = scicos_diagram(),
+scs_m.props.title = "My_new_schema"
+ ]]></programlisting>
+    </refsection>
+</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_graphics.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_graphics.xml
new file mode 100644 (file)
index 0000000..e44dfc9
--- /dev/null
@@ -0,0 +1,286 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scicos
+ * 
+ * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
+ * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
+ * 
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * 
+ * See the file ./license.txt
+ -->
+<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_graphics">
+    <refnamediv>
+        <refname>scicos_graphics</refname>
+        <refpurpose>Define an Xcos block graphics structure</refpurpose>
+    </refnamediv>
+    <refsection id="Module_scicos_graphics">
+        <title>Module</title>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <link linkend="xcos">xcos</link>
+                </para>
+            </listitem>
+        </itemizedlist>
+    </refsection>
+    <refsect1 id="graphics_scicos_graphics">
+        <title>graphics</title>
+        <para>
+            Scilab object including graphical information concerning the features of the block. These information are used on the editor to render the block and display values. These values are not propagated to the compiled <link linkend="scicos_cpr">cpr</link> representation.
+        </para>
+        <para>
+            Type : scilab tlist of type <code>"graphics"</code> with fields : 
+            <link linkend="scicos_block_graphics_orig">orig</link>, 
+            <link linkend="scicos_block_graphics_sz">sz</link>, 
+            <link linkend="scicos_block_graphics_flip">flip</link>, 
+            <link linkend="scicos_block_graphics_theta">theta</link>, 
+            <link linkend="scicos_block_graphics_exprs">exprs</link>, 
+            <link linkend="scicos_block_graphics_pin">pin</link>, 
+            <link linkend="scicos_block_graphics_pout">pout</link>, 
+            <link linkend="scicos_block_graphics_pein">pein</link>, 
+            <link linkend="scicos_block_graphics_peout">peout</link>, 
+            <link linkend="scicos_block_graphics_gr_i">gr_i</link>, 
+            <link linkend="scicos_block_graphics_id">id</link>, 
+            <link linkend="scicos_block_graphics_in_implicit">in_implicit</link>, 
+            <link linkend="scicos_block_graphics_out_implicit">out_implicit</link>, 
+            <link linkend="scicos_block_graphics_in_style">in_style</link>, 
+            <link linkend="scicos_block_graphics_out_style">out_style</link>, 
+            <link linkend="scicos_block_graphics_in_label">in_label</link>, 
+            <link linkend="scicos_block_graphics_out_label">out_label</link> and
+            <link linkend="scicos_block_graphics_style">style</link>.
+        </para>
+        <refsect2 id="scicos_block_graphics_orig">
+            <title>orig</title>
+            <para>
+                Vector <code>[xo,yo]</code>, where <varname>xo</varname> is the x coordinate of the block origin and <varname>yo</varname> is the y coordinate of the block origin.
+            </para>
+            <para> 
+                <code>[xo,yo]</code> is the coordinate of down-left point of
+                the block shape.
+            </para>
+            <para> 
+                Size : 2.
+            </para>
+            <para>
+                Type : row vector of real.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_sz">
+            <title>sz</title>
+            <para>
+                Vector <code>[w,h]</code>, where w is the block width and h the block height.
+            </para>
+            <para> 
+                Size : 2.
+            </para>
+            <para>
+                Type : row vector of real.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_flip">
+            <title>flip</title>
+            <para> Set the block orientation. If true the input ports are on the left of the box and output ports are on the right.</para>
+            <para> If false the input ports are on the right of the box and output ports are on the left.</para>
+            <para> 
+                Size : 1.
+            </para>
+            <para>
+                Type : boolean.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_theta">
+            <title>theta</title>
+            <para> Set the angle of the Scicos object.</para>
+            <para> This value is in degree and is included in [-360,360].</para>
+            <para> 
+                Size : 1.
+            </para>
+            <para>
+                Type : real.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_exprs">
+            <title>exprs</title>
+            <para>Strings including formal expressions used in the dialog box of the block.</para>
+            <para> 
+                Size : number of formal expressions.
+            </para>
+            <para>
+                Type : column vector of strings.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_pin">
+            <title>pin</title>
+            <para>
+                Vector. <code>pin(i)</code> is the number of the link connected to the <code>i</code>th regular input port (counting from one), or <code>0</code> if this port is not connected.
+            </para>
+            <para> 
+                Size : number of regular input ports.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_pout">
+            <title>pout</title>
+            <para>
+                Vector. <code>pout(i)</code> is the number of the link connected to the <code>i</code>th regular output port (counting from one), or <code>0</code> if this port is not connected.
+            </para>
+            <para> 
+                Size : number of regular output ports.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_pein">
+            <title>pein</title>
+            <para>
+                Vector. <code>pein(i)</code> is the number of the link connected to the <code>i</code>th event input port (counting from one), or <code>0</code> if this port is not connected.
+            </para>
+            <para> 
+                Size : number of events input ports.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_peout">
+            <title>peout</title>
+            <para>
+                Vector. <code>peout(i)</code> is the number of the link connected to the ith event output port (counting from one), or <code>0</code> if this port is not connected.
+            </para>
+            <para> 
+                Size : number of events output ports.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_gr_i">
+            <title>gr_i</title>
+            <para>Not used</para>
+            <para> 
+                Size : -.
+            </para>
+            <para>
+                Type : column vector of strings.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_id">
+            <title>id</title>
+            <para> A string to ease the identification of the block.</para>
+            <para> 
+                Size : 1.
+            </para>
+            <para>
+                Type : string.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_in_implicit">
+            <title>in_implicit</title>
+            <para>
+                A vector of strings including <code>'E'</code> or <code>'I'</code>.
+            </para>
+            <para>
+                <code>'E'</code> and <code>'I'</code> stand respectively for explicit and implicit port, and this vector indicates the nature of each input port. For regular blocks (not implicit), this vector is empty or contains only <code>"E"</code>.
+            </para>
+            <para> 
+                Size : nul or number of regular input ports.
+            </para>
+            <para>
+                Type : column vector of strings.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_out_implicit">
+            <title>out_implicit</title>
+            <para>
+                A vector of strings including <code>'E'</code> or <code>'I'</code>.
+            </para>
+            <para>
+                <code>'E'</code> and <code>'I'</code> stand respectively for explicit and implicit port, and this vector indicates the nature of each output port. For regular blocks (not implicit), this vector is empty or contains only <code>"E"</code>.
+            </para>
+            <para> 
+                Size : nul or number of regular output ports.
+            </para>
+            <para>
+                Type : column vector of strings.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_in_style">
+            <title>in_style</title>
+            <para>A vector of strings including JGraphX key values style properties.</para>
+            <para>
+                These style can be used to place text or to change port aspect (eg. round, green port). This is set in semicolon separated key=value set. For example <literal>"shape=ellipse;fillColor=green"</literal> for a round and green port
+            </para>
+            <para> 
+                Size : nul or number of regular input ports.
+            </para>
+            <para>
+                Type : column vector of strings.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_out_style">
+            <title>out_style</title>
+            <para> A vector of strings including JGraphX key values style properties.</para>
+            <para>
+                These style can be used to place text or to change port aspect (eg. round, green port). This is set in semicolon separated key=value set. For example <literal>"shape=ellipse;fillColor=green"</literal> for a round and green port
+            </para>
+            <para> 
+                Size : nul or number of regular output ports.
+            </para>
+            <para>
+                Type : column vector of strings.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_in_label">
+            <title>in_label</title>
+            <para> A vector of strings including ports labels.</para>
+            <para>These labels can be used to update text or to trace information.</para>
+            <para> 
+                Size : nul or number of regular input ports.
+            </para>
+            <para>
+                Type : column vector of strings.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_out_label">
+            <title>out_label</title>
+            <para> A vector of strings including ports labels.</para>
+            <para>These labels can be used to update text or to trace information.</para>
+            <para> 
+                Size : nul or number of regular output ports.
+            </para>
+            <para>
+                Type : column vector of strings.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_graphics_style">
+            <title>style</title>
+            <para> A string.</para>
+            <para> A vector of strings including JGraphX key values style properties.</para>
+            <para>
+                These style can be used to place text or to change block aspect (eg. shape, image, text). This is set in semicolon separated key=value set. For example <literal>"shape=ellipse;fillColor=red"</literal> for a round and green block
+            </para>
+            <para> 
+                Size : nul or 1.
+            </para>
+            <para>
+                Type : a string.
+            </para>
+        </refsect2>
+    </refsect1>
+</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_link.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_link.xml
new file mode 100644 (file)
index 0000000..879aae3
--- /dev/null
@@ -0,0 +1,142 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scicos
+ * 
+ * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
+ * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
+ * 
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * 
+ * See the file ./license.txt
+ -->
+<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_link">
+    <refnamediv>
+        <refname>scicos_link</refname>
+        <refpurpose>Define a link structure</refpurpose>
+    </refnamediv>
+    <refsection id="Module_scicos_link">
+        <title>Module</title>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <link linkend="xcos">xcos</link>
+                </para>
+            </listitem>
+        </itemizedlist>
+    </refsection>
+    <refsect1 id="link_scicos_link">
+        <title>link</title>
+        <para>Basic  structure that define a xcos link.</para>
+        <para>
+            Type : scilab tlist of type <code>"Link"</code> with fields :
+            <link linkend="scicos_link_xx">xx</link>, 
+            <link linkend="scicos_link_yy">yy</link>, 
+            <link linkend="scicos_link_id">id</link>, 
+            <link linkend="scicos_link_thick">thick</link>, 
+            <link linkend="scicos_link_ct">ct</link>, 
+            <link linkend="scicos_link_from">from</link> and
+            <link linkend="scicos_link_to">to</link>.
+        </para>
+        <refsect2 id="scicos_link_xx">
+            <title>xx</title>
+            <para> Vector of x coordinates of the link path. A link is defined as a polyline line.</para>
+            <para> 
+                Size : number of points of the link.
+            </para>
+            <para>
+                Type : column vector of real numbers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_link_yy">
+            <title>yy</title>
+            <para> Vector of y coordinates of the link path. A link is defined as a polyline line.</para>
+            <para> 
+                Size : number of points of the link.
+            </para>
+            <para>
+                Type : column vector of real numbers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_link_id">
+            <title>id</title>
+            <para> Character string, the link identification.</para>
+            <para> 
+                Size : 1.
+            </para>
+            <para>
+                Type : string.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_link_thick">
+            <title>thick</title>
+            <para> Vector of size two defining line thickness.</para>
+            <para> 
+                Size : 2.
+            </para>
+            <para>
+                Type : row vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_link_ct">
+            <title>ct</title>
+            <para>
+                The first entry of this vector designates the color, and the second, the nature of the link. The second entry is <code>1</code> for a regular link, <code>-1</code> for an activation link, and <code>2</code> for an implicit link.
+            </para>
+            <para> 
+                Size : 2.
+            </para>
+            <para>
+                Type : row vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_link_from">
+            <title>from</title>
+            <para>
+                Vector of size three including the block number, port number, and port type (<code>0</code> for output, <code>1</code> for input) at the origin of the link. Note that the third entry may be <code>1</code> if the link is implicit; otherwise it is zero.
+            </para>
+            <para> 
+                Size : 3.
+            </para>
+            <para>
+                Type : row vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_link_to">
+            <title>to</title>
+            <para>
+                Vector of size three including the block number, port number, and port type (<code>0</code> for output, <code>1</code> for input) at the destination of the link. Note that the third entry may be <code>0</code> if the link is implicit; otherwise it is one.
+            </para>
+            <para> 
+                Size : 3.
+            </para>
+            <para>
+                Type : row vector of integers.
+            </para>
+        </refsect2>
+    </refsect1>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[ 
+loadXcosLibs();              // load standard library
+
+lnk = scicos_link();    // new specific block
+tree_show(lnk);              // display it
+ ]]></programlisting>
+        <programlisting role="example"><![CDATA[ 
+lnk = scicos_link(),
+lnk.id = "My_label"
+ ]]></programlisting>
+    </refsection>
+</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_model.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_model.xml
new file mode 100644 (file)
index 0000000..e8ab107
--- /dev/null
@@ -0,0 +1,679 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scicos
+ *
+ * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
+ * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * See the file ./license.txt
+ -->
+<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_model">
+    <refnamediv>
+        <refname>scicos_model</refname>
+        <refpurpose>Define a model structure</refpurpose>
+    </refnamediv>
+    <refsection id="Module_scicos_model">
+        <title>Module</title>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <link linkend="xcos">xcos</link>
+                </para>
+            </listitem>
+        </itemizedlist>
+    </refsection>
+    <refsect1 id="model_scicos_model">
+        <title>model</title>
+        <para>
+            Scilab object including simulation information concerning the features of the block. These information are used on the simulator to simulate the block. Most of these values are propagated to the compiled <link linkend="scicos_cpr">cpr</link> representation.
+        </para>
+        <para>
+            Type : scilab tlist of type <code>"model"</code> with fields :
+            <link linkend="scicos_block_model_sim">sim</link>, 
+            <link linkend="scicos_block_model_in">in</link>, 
+            <link linkend="scicos_block_model_in2">in2</link>, 
+            <link linkend="scicos_block_model_intyp">intyp</link>, 
+            <link linkend="scicos_block_model_out">out</link>, 
+            <link linkend="scicos_block_model_out2">out2</link>, 
+            <link linkend="scicos_block_model_outtyp">outtyp</link>, 
+            <link linkend="scicos_block_model_evtin">evtin</link>, 
+            <link linkend="scicos_block_model_evtout">evtout</link>, 
+            <link linkend="scicos_block_model_state">state</link>, 
+            <link linkend="scicos_block_model_dstate">dstate</link>, 
+            <link linkend="scicos_block_model_odstate">odstate</link>, 
+            <link linkend="scicos_block_model_rpar">rpar</link>, 
+            <link linkend="scicos_block_model_ipar">ipar</link>, 
+            <link linkend="scicos_block_model_opar">opar</link>, 
+            <link linkend="scicos_block_model_blocktype">blocktype</link>, 
+            <link linkend="scicos_block_model_firing">firing</link>, 
+            <link linkend="scicos_block_model_dep_ut">dep_ut</link>, 
+            <link linkend="scicos_block_model_label">label</link>, 
+            <link linkend="scicos_block_model_nzcross">nzcross</link>, 
+            <link linkend="scicos_block_model_nmode">nmode</link>, 
+            <link linkend="scicos_block_model_equations">equations</link> and 
+            <link linkend="scicos_block_model_uid">uid</link>.
+        </para>
+        <refsect2 id="scicos_block_model_sim">
+            <title>sim</title>
+            <para>
+                A list containing two elements. The first element is a string containing the name of the computational function (C, Fortran,or Scilab). The second element is an integer specifying the type of the computational function.
+            </para>
+            <para>
+                Currently type <code>4</code> and <code>5</code> are used, but older types continue to work to ensure backward compatibility. For some older case, sim can be a single string and that means that the type is supposed to be <code>0</code>.
+            </para>
+            <para>
+                Size : 2.
+            </para>
+            <para>
+                Type : Scilab list.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_funs">funs</link>   
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_in">
+            <title>in</title>
+            <para>
+                A vector specifying the number and size of the first dimension of regular input ports indexed from top to bottom of the block. If no input port exist <code>in==[]</code>.
+            </para>
+            <para>
+                The size can be negative, equal to zero or positive : 
+            </para>
+            <itemizedlist>
+                <listitem>
+                    <para>If a size is less than zero, the compiler will
+                        try to find the appropriate size.
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>If a size is equal to zero, the compiler will
+                        affect this dimension by added all positive size
+                        found in that vector
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>If a size is greater than zero, then the size is
+                        explicitly given.
+                    </para>
+                </listitem>
+            </itemizedlist>
+            <para>
+                Size : number of regular input ports.
+            </para>
+            <para>
+                Type : column vector of integer numbers.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_inpptr">inpptr</link> , <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_inplnk">inplnk</link> and <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_state">state</link>.<link linkend="scicos_cpr_state_outtb">outtb</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_in2">
+            <title>in2</title>
+            <para>
+                A vector specifying the second dimension of regular input ports indexed from top to bottom of the block. <varname>in</varname> with <varname>in2</varname> formed then the regular input sizes matrix. For compatibility, this dimension can stay empty (<code>[]</code>). That means that the dimensions of input ports will be <code>[in,1]</code>
+            </para>
+            <para>
+                The size can be negative, equal to zero or positive :
+            </para>
+            <itemizedlist>
+                <listitem>
+                    <para>If a size is less than zero, the compiler will
+                        try to find the appropriate size.
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>If a size is equal to zero, the compiler will
+                        affect this dimension by added all positive size
+                        found in that vector.
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>If a size is greater than zero, then the size is
+                        explicitly given.
+                    </para>
+                </listitem>
+            </itemizedlist>
+            <para>
+                Size : number of regular input ports.
+            </para>
+            <para>
+                Type : column vector of integer numbers.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_inpptr">inpptr</link> , <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_inplnk">inplnk</link> and <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_state">state</link>.<link linkend="scicos_cpr_state_outtb">outtb</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_intyp">
+            <title>intyp</title>
+            <para>
+                A vector specifying the types of regular input ports. Its sizes is equal to the sizes of <varname>in</varname>.
+            </para>
+            <para>The types of regular input ports can be : </para>
+            <variablelist>
+                <varlistentry>
+                    <term>1</term>
+                    <listitem>
+                        <para>real matrix,</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>2</term>
+                    <listitem>
+                        <para>complex matrix,</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>3</term>
+                    <listitem>
+                        <para>int32 matrix,</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>4</term>
+                    <listitem>
+                        <para>int16 matrix,</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>5</term>
+                    <listitem>
+                        <para>int8 matrix,</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>6</term>
+                    <listitem>
+                        <para>uint32 matrix,</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>7</term>
+                    <listitem>
+                        <para>uint16 matrix,</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>8</term>
+                    <listitem>
+                        <para>uint8 matrix</para>
+                    </listitem>
+                </varlistentry>
+            </variablelist>
+            <para>
+                Size : number of regular input ports.
+            </para>
+            <para>
+                Type : column vector of integer numbers.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_inpptr">inpptr</link> , <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_inplnk">inplnk</link> and <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_state">state</link>.<link linkend="scicos_cpr_state_outtb">outtb</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_out">
+            <title>out</title>
+            <para>
+                A vector specifying the number and size of the first
+                dimension of regular output ports indexed from top to
+                bottom of the block. If no output port exist <code>out==[]</code>.
+            </para>
+            <para>
+                The size can be negative, equal to zero or positive :
+            </para>
+            <itemizedlist>
+                <listitem>
+                    <para>If a size is less than zero, the compiler will
+                        try to find the appropriate size.
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>If a size is equal to zero, the compiler will
+                        affect this dimension by added all positive size
+                        found in that vector.
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>If a size is greater than zero, then the size is
+                        explicitly given.
+                    </para>
+                </listitem>
+            </itemizedlist>
+            <para>
+                Size : number of regular output ports.
+            </para>
+            <para>
+                Type : column vector of integer numbers.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_outptr">outptr</link> , <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_outlnk">outlnk</link> and <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_state">state</link>.<link linkend="scicos_cpr_state_outtb">outtb</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_out2">
+            <title>out2</title>
+            <para>
+                A vector specifying the second dimension of regular output ports indexed from top to bottom of the block. <varname>out</varname> with <varname>out2</varname> formed then the regular output sizes matrix. For compatibility, this dimension can stay empty (<code>[]</code>). That means that the dimensions of output ports will be <code>out,1</code>
+            </para>
+            <para>
+                That dimension can be negative, equal to zero or positive :
+            </para>
+            <itemizedlist>
+                <listitem>
+                    <para>If a size is less than zero, the compiler will
+                        try to find the appropriate size.
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>If a size is equal to zero, the compiler will
+                        affect this dimension by added all positive size
+                        found in that vector.
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>If a size is greater than zero, then the size is
+                        explicitly given.
+                    </para>
+                </listitem>
+            </itemizedlist>
+            <para>
+                Size : number of regular output ports.
+            </para>
+            <para>
+                Type : column vector of integer numbers.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_outptr">outptr</link> , <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_outlnk">outlnk</link> and <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_state">state</link>.<link linkend="scicos_cpr_state_outtb">outtb</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_outtyp">
+            <title>outtyp</title>
+            <para>
+                A vector specifying the types of regular output ports. Its sizes is equal to the sizes of <varname>out</varname>.
+            </para>
+            <para>The types of regular output ports can be :</para>
+            <variablelist>
+                <varlistentry>
+                    <term>1</term>
+                    <listitem>
+                        <para>real matrix,</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>2</term>
+                    <listitem>
+                        <para>complex matrix,</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>3</term>
+                    <listitem>
+                        <para>int32 matrix,</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>4</term>
+                    <listitem>
+                        <para>int16 matrix,</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>5</term>
+                    <listitem>
+                        <para>int8 matrix,</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>6</term>
+                    <listitem>
+                        <para>uint32 matrix,</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>7</term>
+                    <listitem>
+                        <para>uint16 matrix,</para>
+                    </listitem>
+                </varlistentry>
+                <varlistentry>
+                    <term>8</term>
+                    <listitem>
+                        <para>uint8 matrix</para>
+                    </listitem>
+                </varlistentry>
+            </variablelist>
+            <para>
+                Size : number of regular output ports.
+            </para>
+            <para>
+                Type : column vector of integer numbers.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_outptr">outptr</link> , <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_outlnk">outlnk</link> and <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_state">state</link>.<link linkend="scicos_cpr_state_outtb">outtb</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_evtin">
+            <title>evtin</title>
+            <para>
+                A vector specifying the number and sizes of activation inputs. Currently activation ports can be only of size one. If no event input port exists evtin must be equal to <code>[]</code>.
+            </para>
+            <para>
+                Size : number of input event ports.
+            </para>
+            <para>
+                Type : column vector of integer numbers.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_clkptr">clkptr</link> , <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_state">state</link>.<link linkend="scicos_cpr_state_pointi">pointi</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_evtout">
+            <title>evtout</title>
+            <para>
+                A vector specifying the number and sizes of activation outputs. Currently activation ports can be only of size one. If no event output port exists <varname>evtout</varname> must be equal to <code>[]</code>.
+            </para>
+            <para>
+                Size : number of output event ports.
+            </para>
+            <para>
+                Type : column vector of integer numbers.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_ordptr">ordptr</link> , <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_ordclk">ordclk</link>, <link linkend="scicos_cpr">cpr</link> and <link linkend="scicos_state">state</link>.<link linkend="scicos_cpr_state_evtspt">evtspt</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_state">
+            <title>state</title>
+            <para>
+                Vector containing initial values of continuous-time state. Must be <code>[]</code> if no continuous state.
+            </para>
+            <para>
+                Size : number of continuous-time state.
+            </para>
+            <para>
+                Type : column vector of real numbers.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_state">state</link>.<link linkend="scicos_cpr_state_x">x</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_dstate">
+            <title>dstate</title>
+            <para>
+                Vector containing initial values of discrete-time state. Must be <code>[]</code> if no discrete state.
+            </para>
+            <para>
+                Size : number of discrete-time state.
+            </para>
+            <para>
+                Type : column vector of real numbers.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_state">state</link>.<link linkend="scicos_cpr_state_z">z</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_odstate">
+            <title>odstate</title>
+            <para>
+                List containing initial values of objects state. Must be <code>list()</code> if no objects state. Objects state can be any types of scilab variable.
+            </para>
+            <para>
+                In the computational function case of type <code>4</code> (C blocks)
+                only elements containing matrix of <literal>real</literal>, <literal>complex</literal>, <literal>int32</literal>, <literal>int16</literal> ,<literal>int8</literal> ,<literal>uint32</literal>, <literal>uit16</literal> and <literal>uint8</literal> will be correctly provided for reading or writing.
+            </para>
+            <para>
+                Size : number of objects state.
+            </para>
+            <para>
+                Type : scilab list of scilab objects.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_state">state</link>.<link linkend="scicos_cpr_state_oz">oz</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_rpar">
+            <title>rpar</title>
+            <para>
+                The vector of floating point block parameters. Must be <code>[]</code> if no floating point parameters.
+            </para>
+            <para>
+                Size : number of real parameters.
+            </para>
+            <para>
+                Type : column vector of real numbers.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_rpar">rpar</link> and <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_rpptr">rpptr</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_ipar">
+            <title>ipar</title>
+            <para>
+                The vector of integer block parameters. Must be <code>[]</code> if no integer parameters.
+            </para>
+            <para>
+                Size : number of integer parameters.
+            </para>
+            <para>
+                Type : column vector of integer numbers.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_ipar">ipar</link> and <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_ipptr">ipptr</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_opar">
+            <title>opar</title>
+            <para>
+                List of objects block parameters. Must be <code>list()</code> if no objects parameters. Objects parameters can be any types of scilab variable.
+            </para>
+            <para>
+                In the computational function case of type <code>4</code> (C blocks)
+                only elements containing matrix of <literal>real</literal>, <literal>complex</literal>, <literal>int32</literal>, <literal>int16</literal> ,<literal>int8</literal> ,<literal>uint32</literal>, <literal>uit16</literal> and <literal>uint8</literal> will be correctly provided for reading.
+            </para>
+            <para>
+                Size : number of objects parameters.
+            </para>
+            <para>
+                Type : list of scilab object.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_opar">opar</link> and <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_opptr">opptr</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_blocktype">
+            <title>blocktype</title>
+            <para>
+                Character that can be set to <code>'c'</code> or <code>'d'</code> indifferently for standard blocks. <code>'x'</code> is used if we want to force the computational function to be called during the simulation phase even if the block does not contribute to computation of the state derivative.
+            </para>
+            <para>
+                <code>'l'</code>, <code>'m'</code> and <code>'s'</code> are reserved. Not to be used.
+            </para>
+            <para>
+                Size : 1.
+            </para>
+            <para>
+                Type : Character.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_firing">
+            <title>firing</title>
+            <para>
+                Vector of initial event firing times of size equal to the number of activation output ports (see <varname>evout</varname>). It contains output initial event dates (Events generated before any input event arises). Negative values stands for no initial event on the corresponding port.
+            </para>
+            <para>
+                Size : number of output event ports.
+            </para>
+            <para>
+                Type : column vector of real numbers.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_state">state</link>.<link linkend="scicos_cpr_state_tevts">tevts</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_dep_ut">
+            <title>dep_ut</title>
+            <para>
+                Boolean vector <code>[dep_u, dep_t]</code> where values are :
+            </para>
+            <itemizedlist>
+                <listitem>
+                    <para>
+                        <varname>dep_t</varname>
+                    </para>
+                    <para>
+                        <code>%t</code> if block is always active. Output depends continuously of the time.
+                    </para>
+                    <para>
+                        For instance, the <link linkend="GENSIN_f">GENSIN_f</link> block computes <code>y=sin(t)</code> so <code>dep_ut=[%f %t]</code>.
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>
+                        <varname>dep_u</varname>
+                    </para>
+                    <para>
+                        <code>%t</code> if block has direct feed-through,
+                        i.e., at least one of the outputs depends
+                        directly (not through the states) on one
+                        of the inputs.
+                        In other words, when the computational
+                        function is called with flag <code>1</code>, the value
+                        of an input is used to compute the output.
+                    </para>
+                    <para>
+                        For instance, the <link linkend="SUM_f">SUM_f</link> block computes <code>y=u1+u2</code> so <code>dep_ut=[%t %f]</code>.
+                    </para>
+                </listitem>
+            </itemizedlist>
+            <para>
+                Size : 2.
+            </para>
+            <para>
+                Type : Boolean vector.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_label">
+            <title>label</title>
+            <para>String that defines a label. It can be used to identify a block in order to access or modify its parameters during simulation.</para>
+            <para>
+                Size : 1.
+            </para>
+            <para>
+                Type : string.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_labels">labels</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_nzcross">
+            <title>nzcross</title>
+            <para>Number of zero-crossing surfaces.</para>
+            <para>
+                Size : Number of zero-crossing surfaces.
+            </para>
+            <para>
+                Type : column vector of integer numbers.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_ztyp">ztyp</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_nmode">
+            <title>nmode</title>
+            <para>Length of the mode register. Note that this gives the size of the vector mode and not the total number of modes in which a block can operate in. Suppose a block has 3 modes and each mode can take two values, then the block can have up to 23=8 modes.</para>
+            <para>
+                Size : Number of modes.
+            </para>
+            <para>
+                Type : column vector of integer numbers.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_modptr">modptr</link> .
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_equations">
+            <title>equations</title>
+            <para>Used in case of implicit blocks.</para>
+            <para>
+                Data structure of type modelica which contains modelica code description if any. That list contains four entries : <link linkend="scicos_block_model_equations_model">model</link>, <link linkend="scicos_block_model_equations_inputs">inputs</link>, <link linkend="scicos_block_model_equations_outputs">outputs</link> and <link linkend="scicos_block_model_equations_parameters">parameters</link>.
+            </para>
+            <refsect3 id="scicos_block_model_equations_model">
+                <title>model</title>
+                <para>
+                    a string given the name of the file that contains
+                    the modelica function.
+                </para>
+            </refsect3>
+            <refsect3 id="scicos_block_model_equations_inputs">
+                <title>inputs</title>
+                <para>
+                    a column vector of strings that contains the names of
+                    the modelica variables used as inputs.
+                </para>
+            </refsect3>
+            <refsect3 id="scicos_block_model_equations_outputs">
+                <title>outputs</title>
+                <para>
+                    a column vector of strings that contains the names of
+                    the modelica variables used as outputs.
+                </para>
+            </refsect3>
+            <refsect3 id="scicos_block_model_equations_parameters">
+                <title>parameters</title>
+                <para>
+                    a list with two entries. The first is a vector of strings
+                    for the name of modelica variable names used as parameters
+                    and the second entries is a list that contains the value of
+                    parameters.
+                </para>
+                <para>
+                    Names of modelica states can also be informed with
+                    parameters. In that case a third entry is used to do the
+                    difference between parameters and states.
+                </para>
+                <para>
+                    For i,e :
+                    <code>mo.parameters=list(['C','v'],list(C,v),[0,1])</code>
+                    means that <literal>C</literal> is a parameter(<literal>0</literal>) of value <literal>C</literal>, and <literal>v</literal>
+                    is a state(<literal>1</literal>) with initial value <literal>v</literal>.
+                </para>
+            </refsect3>
+            <para>
+                Size : 5.
+            </para>
+            <para>
+                Type : scilab list.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_block_model_uid">
+            <title>uid</title>
+            <para>Unique identifier string of the block (2^16 per host)</para>
+            <para>This identifier will be only set using the Xcos GUI. To set a specific value at bloc allocation, use the following code:</para>
+            <programlisting role="example">
+                jimport("java.rmi.server.UID");
+                juid =  jnewInstance("java.rmi.server.UID");
+                uid = juid.toString()
+            </programlisting>
+            <para>
+                Size : 1x1.
+            </para>
+            <para>
+                Type : String.
+            </para>
+            <para>
+                Compiled to : <link linkend="scicos_cpr">cpr</link>.<link linkend="scicos_sim">sim</link>.<link linkend="scicos_cpr_sim_uids">uids</link> .
+            </para>
+        </refsect2>
+    </refsect1>
+</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_params.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_params.xml
new file mode 100644 (file)
index 0000000..1d7ea22
--- /dev/null
@@ -0,0 +1,263 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scicos
+ * 
+ * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
+ * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
+ * 
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * 
+ * See the file ./license.txt
+ -->
+<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_params">
+    <refnamediv>
+        <refname>scicos_params</refname>
+        <refpurpose>Define a param structure</refpurpose>
+    </refnamediv>
+    <refsection id="Module_scicos_params">
+        <title>Module</title>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <link linkend="xcos">xcos</link>
+                </para>
+            </listitem>
+        </itemizedlist>
+    </refsection>
+    <refsect1 id="params_scicos_params">
+        <title>params</title>
+        <para>Diagram configuration values. Some of the value are graphical information, others directly configure the simulator.</para>
+        <para>
+            Type : scilab tlist of type <code>"params"</code> with fields :
+            <link linkend="scicos_diagram_params_wpar">wpar</link>, 
+            <link linkend="scicos_diagram_params_title">title</link>, 
+            <link linkend="scicos_diagram_params_tol">tol</link>, 
+            <link linkend="scicos_diagram_params_tf">tf</link>, 
+            <link linkend="scicos_diagram_params_context">context</link>, 
+            <link linkend="scicos_diagram_params_void1">void1</link>, 
+            <link linkend="scicos_diagram_params_options">options</link>, 
+            <link linkend="scicos_diagram_params_void2">void2</link>, 
+            <link linkend="scicos_diagram_params_void3">void3</link> and 
+            <link linkend="scicos_diagram_params_doc">doc</link>.
+        </para>
+        <refsect2 id="scicos_diagram_params_wpar">
+            <title>wpar</title>
+            <para> This vector is not currently used. It may be used in the future to code window sizes of the editor.</para>
+            <para>
+                Type : column vector or real.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_diagram_params_title">
+            <title>title</title>
+            <para> Vector of character strings, where the first one is the diagram title and default name of save file name, and the second one is the path of the directory of the file name.</para>
+            <para> 
+                Size : 2.
+            </para>
+            <para>
+                Type : row vector of strings.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_diagram_params_tol">
+            <title>tol</title>
+            <para> 
+                A vector containing simulation parameters including
+                various tolerances used by the solver. This vector is composed of : <code>[ atol , rtol , ttol , deltat , scale , solver , hmax ]</code> where :
+            </para>
+            <refsect3 id="scicos_diagram_params_tol_atol">
+                <title>(1) atol</title>
+                <para>
+                    Integrator absolute tolerance for the numerical solver.
+                </para>
+            </refsect3>
+            <refsect3 id="scicos_diagram_params_tol_rtol">
+                <title>(2) rtol</title>
+                <para>
+                    Integrator relative tolerance for the numerical solver.
+                </para>
+            </refsect3>
+            <refsect3 id="scicos_diagram_params_tol_ttol">
+                <title>(3) ttol</title>
+                <para>
+                    Tolerance on time.
+                </para>
+                <para>
+                    If an integration period is less
+                    than <varname>ttol</varname>, the numerical solver is not called.
+                </para>
+            </refsect3>
+            <refsect3 id="scicos_diagram_params_tol_deltat">
+                <title>(4) deltat</title>
+                <para>
+                    Maximum integration time interval.
+                </para>
+                <para>
+                    If an integration period is larger than
+                    <code>deltat</code>, the numerical solver is called more than
+                    once in such a way that for each call the integration
+                    period remains below deltat.
+                </para>
+            </refsect3>
+            <refsect3 id="scicos_diagram_params_tol_scale">
+                <title>(5) scale</title>
+                <para>
+                    Real-time scaling; the value <code>0</code> corresponds to no
+                    real-time scaling.
+                </para>
+                <para>
+                    It associates a Scicos simulation time to the real
+                    time in seconds.
+                </para>
+                <para>
+                    A value of <code>1</code> means that each Scicos unit of time
+                    corresponds to one second.
+                    A value of <code>0.5</code> means that each Scicos unit of time
+                    corresponds to 500 milliseconds.
+                </para>
+            </refsect3>
+            <refsect3 id="scicos_diagram_params_tol_solver">
+                <title>(6) solver</title>
+                <para>
+                    Choice of numerical solver.
+                </para>
+                <para>
+                    The value <code>0</code> implies an ODE solver and <code>100</code>
+                    implies a DAE solver. See also : <link linkend="Comparisons">Solvers comparisons</link>
+                </para>
+            </refsect3>
+            <refsect3 id="scicos_diagram_params_tol_hmax">
+                <title>(7) hmax</title>
+                <para>
+                    Maximum step size for the numerical solver.
+                </para>
+                <para>
+                    <code>0</code> means no limit, let the solver use its own time predicate.
+                </para>
+            </refsect3>
+            <para> 
+                Size : 7.
+            </para>
+            <para>
+                Type : column vector of real.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_diagram_params_tf">
+            <title>tf</title>
+            <para> Final time simulation. The simulation stops at this time.</para>
+            <para> 
+                Size : 1.
+            </para>
+            <para>
+                Type : real.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_diagram_params_context">
+            <title>context</title>
+            <para> A vector of strings containing Scilab instructions defining Scilab variables to be used inside block's dialog box as symbolic parameters.</para>
+            <para> All valid Scilab instructions can be used and also comments.</para>
+            <para> 
+                Size : number of lines of the context.
+            </para>
+            <para>
+                Type : column vector of strings.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_diagram_params_void1">
+            <title>void1</title>
+            <para> unused field.</para>
+            <para> 
+                Size : -.
+            </para>
+            <para>
+                Type : -.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_diagram_params_options">
+            <title>options</title>
+            <para>
+                Scilab object of type <code>"scsopt"</code> defining graphical properties of the editor such as background color and link color.
+            </para>
+            <para>
+                Type : scilab tlist of type <code>"scsopt"</code> with fields :
+                <link linkend="scicos_diagram_params_options_3D">3D</link>, 
+                <link linkend="scicos_diagram_params_options_Background">Background</link>, 
+                <link linkend="scicos_diagram_params_options_link">link</link>, 
+                <link linkend="scicos_diagram_params_options_ID">ID</link> and 
+                <link linkend="scicos_diagram_params_options_Cmap">Cmap</link>
+            </para>
+            <refsect3 id="scicos_diagram_params_options_3D">
+                <title>3D</title>
+                <para>Not used.</para>
+            </refsect3>
+            <refsect3 id="scicos_diagram_params_options_Background">
+                <title>Background</title>
+                <para>
+                    Vector with two entries: background and
+                    foreground colors as Scilab colors.
+                </para>
+                <para>
+                    The default value is <code>[8,1]</code>.
+                </para>
+            </refsect3>
+            <refsect3 id="scicos_diagram_params_options_link">
+                <title>link</title>
+                <para>
+                    Not used.
+                </para>
+            </refsect3>
+            <refsect3 id="scicos_diagram_params_options_ID">
+                <title>ID</title>
+                <para>
+                    Not used.
+                </para>
+            </refsect3>
+            <refsect3 id="scicos_diagram_params_options_Cmap">
+                <title>Cmap</title>
+                <para>
+                    Not used.
+                </para>
+            </refsect3>
+        </refsect2>
+        <refsect2 id="scicos_diagram_params_void2">
+            <title>void2</title>
+            <para> unused field.</para>
+            <para> 
+                Size : -.
+            </para>
+            <para>
+                Type : -.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_diagram_params_void3">
+            <title>void3</title>
+            <para> unused field.</para>
+            <para> 
+                Size : -.
+            </para>
+            <para>
+                Type : -.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_diagram_params_doc">
+            <title>doc</title>
+            <para> User defined diagram documentation structure.</para>
+            <para> 
+                Size : 1.
+            </para>
+            <para>
+                Type : Strings.
+            </para>
+        </refsect2>
+    </refsect1>
+</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_sim.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_sim.xml
new file mode 100644 (file)
index 0000000..2748b61
--- /dev/null
@@ -0,0 +1,459 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scicos
+ * 
+ * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
+ * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
+ * 
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * 
+ * See the file ./license.txt
+ -->
+<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_sim">
+    <refnamediv>
+        <refname>scicos_sim</refname>
+        <refpurpose>Define a sim structure</refpurpose>
+    </refnamediv>
+    <refsection id="Module_scicos_sim">
+        <title>Module</title>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <link linkend="xcos">xcos</link>
+                </para>
+            </listitem>
+        </itemizedlist>
+    </refsection>
+    <refsection id="sim_scicos_sim">
+        <title>sim</title>
+        <para>
+            Static arrays coming from the result of the compilation. That arrays does not evolve during the simulation.
+        </para>
+        <para>
+            These information are used both by the simulator and the code generator.
+        </para>
+        <para>
+            Type : scilab tlist of type <code>"scs"</code> with fields :
+            <link linkend="scicos_cpr_sim_funs">funs</link>, 
+            <link linkend="scicos_cpr_sim_xptr">xptr</link>, 
+            <link linkend="scicos_cpr_sim_zptr">zptr</link>, 
+            <link linkend="scicos_cpr_sim_ozptr">ozptr</link>, 
+            <link linkend="scicos_cpr_sim_zcptr">zcptr</link>, 
+            <link linkend="scicos_cpr_sim_inpptr">inpptr</link>, 
+            <link linkend="scicos_cpr_sim_outptr">outptr</link>, 
+            <link linkend="scicos_cpr_sim_inplnk">inplnk</link>, 
+            <link linkend="scicos_cpr_sim_outlnk">outlnk</link>, 
+            <link linkend="scicos_cpr_sim_rpar">rpar</link>, 
+            <link linkend="scicos_cpr_sim_rpptr">rpptr</link>, 
+            <link linkend="scicos_cpr_sim_ipar">ipar</link>, 
+            <link linkend="scicos_cpr_sim_ipptr">ipptr</link>, 
+            <link linkend="scicos_cpr_sim_opar">opar</link>, 
+            <link linkend="scicos_cpr_sim_opptr">opptr</link>, 
+            <link linkend="scicos_cpr_sim_clkptr">clkptr</link>, 
+            <link linkend="scicos_cpr_sim_ordptr">ordptr</link>, 
+            <link linkend="scicos_cpr_sim_execlk">execlk</link>, 
+            <link linkend="scicos_cpr_sim_ordclk">ordclk</link>, 
+            <link linkend="scicos_cpr_sim_cord">cord</link>, 
+            <link linkend="scicos_cpr_sim_oord">oord</link>, 
+            <link linkend="scicos_cpr_sim_zord">zord</link>, 
+            <link linkend="scicos_cpr_sim_critev">critev</link>, 
+            <link linkend="scicos_cpr_sim_nb">nb</link>, 
+            <link linkend="scicos_cpr_sim_ztyp">ztyp</link>, 
+            <link linkend="scicos_cpr_sim_nblk">nblk</link>, 
+            <link linkend="scicos_cpr_sim_ndcblk">ndcblk</link>, 
+            <link linkend="scicos_cpr_sim_subscr">subscr</link>, 
+            <link linkend="scicos_cpr_sim_funtyp">funtyp</link>, 
+            <link linkend="scicos_cpr_sim_iord">iord</link>, 
+            <link linkend="scicos_cpr_sim_labels">labels</link>, 
+            <link linkend="scicos_cpr_sim_modptr">modptr</link> and 
+            <link linkend="scicos_cpr_sim_uids">uids</link>.
+        </para>
+        <refsect2 id="scicos_cpr_sim_funs">
+            <title>funs</title>
+            <para>A list containing names of the computational functions or scilab functions.</para>
+            <para>
+                Size : number of blocks.
+            </para>
+            <para>
+                Type : list of strings and/or scilab function.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_xptr">
+            <title>xptr</title>
+            <para>
+                A vector pointer to the continuous time state register <code>x</code>. The continuous-time state of block <code>i</code> is <code>state.x(sim.xptr(i):sim.xptr(i+1)-1)</code>.
+            </para>
+            <para>
+                Size : number of blocks + 1.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_zptr">
+            <title>zptr</title>
+            <para>
+                A vector pointer to the discrete time state register <code>z</code>. The discrete-time state of block <code>i</code> is <code>state.z(sim.zptr(i):sim.zptr(i+1)-1)</code>.
+            </para>
+            <para>
+                Size : number of blocks + 1.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_ozptr">
+            <title>ozptr</title>
+            <para>
+                A vector pointer to the object discrete state register oz. The object discrete state of block <code>i</code> is <code>state.oz(sim.ozptr(i):sim.ozptr(i+1)-1)</code>.
+            </para>
+            <para>
+                Size : number of blocks + 1.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_zcptr">
+            <title>zcptr</title>
+            <para>A vector pointer to the zero-crossing surfaces register. That vector gives by block the used number of the zero-crossing.</para>
+            <para>
+                Size : number of blocks + 1.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_inpptr">
+            <title>inpptr</title>
+            <para>
+                <code>(sim.inpptr(i+1)-sim.inpptr(i))</code> gives the number of regular input ports of the <code>i</code> block.
+            </para>
+            <para>
+                <code>inpptr(i)</code> points to the beginning of <code>i</code> th block inputs within the indirection table <code>inplnk</code>.
+            </para>
+            <para>
+                Size : number of blocks + 1.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_outptr">
+            <title>outptr</title>
+            <para>
+                <code>(sim.outptr(i+1)-sim.outptr(i))</code> gives the number of regular output ports of the <code>i</code> block.
+            </para>
+            <para>
+                <code>outptr(i)</code> points to the beginning of <code>i</code> th block outputs within the indirection table <code>outlnk</code>.
+            </para>
+            <para>
+                Size : number of blocks + 1.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_inplnk">
+            <title>inplnk</title>
+            <para>
+                <code>(cpr.sim.inplnk(cpr.sim.inpptr(i)-1+j))</code> is the index of the link connected to the <code>j</code> th input port of the <code>i</code> th block where <code>j</code> goes from <code>1</code> to <code>(cpr.sim.inpptr(i+1)-cpr.sim.inpptr(i))</code>.
+            </para>
+            <para>
+                Size : total number of regular input port.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_outlnk">
+            <title>outlnk</title>
+            <para>
+                <code>(cpr.sim.outlnk(cpr.sim.outptr(i)-1+j))</code> is the index of the link connected to the <code>j</code> th output port of the <code>i</code> th block where <code>j</code> goes from <code>1</code> to <code>(cpr.sim.outptr(i+1)-cpr.sim.outptr(i))</code>.
+            </para>
+            <para>
+                Size : total number of regular output port.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_rpar">
+            <title>rpar</title>
+            <para>Vector of real parameters that is obtained by concatenating the real parameters registers of all the blocks.</para>
+            <para>
+                Size : total number of real parameters.
+            </para>
+            <para>
+                Type : column vector of real numbers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_rpptr">
+            <title>rpptr</title>
+            <para>
+                A vector pointer to the real parameters register <code>rpar</code>. The real parameters of block <code>i</code> are <code>sim.rpar(sim.rpptr(i):sim.rpptr(i+1)-1)</code>.
+            </para>
+            <para>
+                Size : number of blocks + 1.
+            </para>
+            <para>
+                Type : column vector of integer.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_ipar">
+            <title>ipar</title>
+            <para>Vector of integer parameters that is obtained by concatenating the integer parameters registers of all the blocks.</para>
+            <para>
+                Size : total number of integer parameters.
+            </para>
+            <para>
+                Type : column vector of integer.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_ipptr">
+            <title>ipptr</title>
+            <para>
+                A vector pointer to the integer parameters register <code>ipar</code>. The integer parameters of block <code>i</code> are <code>sim.ipar(sim.ipptr(i):sim.ipptr(i+1)-1)</code>.
+            </para>
+            <para>
+                Size : number of blocks + 1.
+            </para>
+            <para>
+                Type : column vector of real numbers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_opar">
+            <title>opar</title>
+            <para>List of object parameters that is obtained by concatenating the list of object parameters of all the blocks.</para>
+            <para>
+                Size : total number of object parameters.
+            </para>
+            <para>
+                Type : list of scilab objects.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_opptr">
+            <title>opptr</title>
+            <para>
+                A vector pointer to the object parameters list <code>opar</code>. The object parameters of block <code>i</code> are <code>sim.opar(sim.opptr(i):sim.opptr(i+1)-1)</code>.
+            </para>
+            <para>
+                Size : number of blocks + 1.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_clkptr">
+            <title>clkptr</title>
+            <para>A vector pointer to output activation ports.</para>
+            <para>
+                <code>(cpr.sim.clkptr(i):cpr.sim.clkptr(i+1)-1)</code> gives the number of output event ports of the block <code>i</code>.
+            </para>
+            <para>
+                Size : number of blocks + 1.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_ordptr">
+            <title>ordptr</title>
+            <para>
+                A vector pointer to <varname>ordclk</varname> designating the part of ordclk corresponding to a given activation.
+            </para>
+            <para>
+                <code>(cpr.sim.ordptr(i):cpr.sim.ordptr(i+1)-1)</code> points to the region within <code>ordclk</code> indicates the number of blocks activated by the output event ports numbered <code>i</code>.
+            </para>
+            <para>
+                Size : number of sources of activation + 1.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_execlk">
+            <title>execlk</title>
+            <para>Unused.</para>
+            <para>
+                Size : -
+                Type : matrix of real.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_ordclk">
+            <title>ordclk</title>
+            <para>A matrix associated to blocks activated by output activation ports. The first column contains the block number, and the second, the event code by which the block should be called.</para>
+            <para>
+                Size : total number of blocks summed by source of activations.
+            </para>
+            <para>
+                Type : matrix of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_cord">
+            <title>cord</title>
+            <para>A matrix associated to always active blocks.</para>
+            <para>The first column contains the block number, and the second, the event code by which the block should be called.</para>
+            <para>
+                Size : <varname>ncord</varname>.
+            </para>
+            <para>
+                Type : matrix of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_oord">
+            <title>oord</title>
+            <para>
+                Subset of <varname>cord</varname>. Blocks of that matrix have outputs which affect computation of continuous state derivatives.
+            </para>
+            <para>
+                Size : <varname>noord</varname>.
+            </para>
+            <para>
+                Type : matrix of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_zord">
+            <title>zord</title>
+            <para>
+                Subset of <code>oord</code>. Blocks of that matrix have outputs which affect computation of zero-crossing surfaces.
+            </para>
+            <para>
+                Size : <varname>nzord</varname>.
+            </para>
+            <para>
+                Type : matrix of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_critev">
+            <title>critev</title>
+            <para>
+                A vector of size equal to the number of activations and containing zeros and ones. The value <code>1</code> indicates that the activation is critical in the sense that the continuous-time solver must be cold restarted.
+            </para>
+            <para>
+                Size : number of source of activation.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_nb">
+            <title>nb</title>
+            <para>Number of blocks. Note that the number of blocks may differ from the original number of blocks in the diagram because c_pass2 may duplicate some conditional blocks.</para>
+            <para>
+                Size : 1.
+            </para>
+            <para>
+                Type : integer.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_ztyp">
+            <title>ztyp</title>
+            <para>A vector of size equal to the number of blocks.</para>
+            <para>
+                A <code>1</code> entry indicates that the block may have zero-crossings, even if it does not in the context of the diagram. Usually not used by the simulator.
+            </para>
+            <para>
+                Size : number of blocks.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_nblk">
+            <title>nblk</title>
+            <para>
+                Not used. Set to <varname>nb</varname>.
+            </para>
+            <para>
+                Size : 1
+                Type : integer.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_ndcblk">
+            <title>ndcblk</title>
+            <para>Not used.</para>
+            <para>
+                Size : -
+                Type : integer.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_subscr">
+            <title>subscr</title>
+            <para>Not used.</para>
+            <para>
+                Size : 0
+            </para>
+            <para>
+                Type : empty real.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_funtyp">
+            <title>funtyp</title>
+            <para>
+                A vector of size equal to the number of blocks indicating the type of the computational function of the block. Block type can be <code>0</code> through <code>5</code>.
+            </para>
+            <para>
+                Currently only type <code>4</code> (C language) and type <code>5</code> (Scilab language) computational functions should be used. But older blocks can also be used.
+            </para>
+            <para>
+                Size : number of blocks.
+            </para>
+            <para>
+                Type : column vector of integer.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_iord">
+            <title>iord</title>
+            <para>A matrix associated to blocks that must be activated at the start of the simulation. This includes blocks inheriting from constant blocks and always active blocks.</para>
+            <para>
+                Size : <varname>niord</varname>.
+            </para>
+            <para>
+                Type : matrix of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_labels">
+            <title>labels</title>
+            <para>A string vector of size equal to the number of blocks containing block labels.</para>
+            <para>
+                Size : numbers of blocks.
+            </para>
+            <para>
+                Type : column vector of strings.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_modptr">
+            <title>modptr</title>
+            <para>A vector pointer to the block modes.</para>
+            <para>
+                Size : number of blocks + 1.
+            </para>
+            <para>
+                Type : column vector of integer.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_sim_uids">
+            <title>uids</title>
+            <para>A string vector of size equal to the number of blocks containing block UIDs (each value is a unique block identifier).</para>
+            <para>
+                Size : numbers of blocks.
+            </para>
+            <para>
+                Type : column vector of strings.
+            </para>
+        </refsect2>
+    </refsection>
+</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_state.xml b/scilab/modules/xcos/help/en_US/scilab_data_structures/scicos_state.xml
new file mode 100644 (file)
index 0000000..673a706
--- /dev/null
@@ -0,0 +1,138 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scicos
+ * 
+ * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
+ * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
+ * 
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * 
+ * See the file ./license.txt
+ -->
+<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_state">
+    <refnamediv>
+        <refname>scicos_state</refname>
+        <refpurpose>Define a state structure</refpurpose>
+    </refnamediv>
+    <refsection id="Module_scicos_state">
+        <title>Module</title>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <link linkend="xcos">xcos</link>
+                </para>
+            </listitem>
+        </itemizedlist>
+    </refsection>
+    <refsection id="state_scicos_state">
+        <title>state</title>
+        <para>
+            States of the model, that is, everything than
+            can evolve during the simulation.
+        </para>
+        <para>
+            Type : scilab tlist of type <code>"xcs"</code> with fields :
+            <link linkend="scicos_cpr_state_x">x</link>, 
+            <link linkend="scicos_cpr_state_z">z</link>, 
+            <link linkend="scicos_cpr_state_oz">oz</link>, 
+            <link linkend="scicos_cpr_state_iz">iz</link>, 
+            <link linkend="scicos_cpr_state_tevts">tevts</link>, 
+            <link linkend="scicos_cpr_state_evtspt">evtspt</link>, 
+            <link linkend="scicos_cpr_state_pointi">pointi</link> and 
+            <link linkend="scicos_cpr_state_outtb">outtb</link>.
+        </para>
+        <refsect2 id="scicos_cpr_state_x">
+            <title>x</title>
+            <para> The continuous-time state register, which is obtained by concatenating the continuous-time states of all the blocks.</para>
+            <para> 
+                Size : total of all the size of continuous-time state registers.
+            </para>
+            <para>
+                Type : column vector of real numbers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_state_z">
+            <title>z</title>
+            <para> The discrete-time state register, which is obtained by concatenating the discrete-time states of all the blocks.</para>
+            <para> 
+                Size : total of all the size of discrete-time state registers.
+            </para>
+            <para>
+                Type : column vector of real number.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_state_oz">
+            <title>oz</title>
+            <para> The list of the object discrete-time state, which is obtained by concatenating the object discrete-time states of all the blocks.</para>
+            <para> 
+                Size : total of all the size of object state.
+            </para>
+            <para>
+                Type : list of scilab object.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_state_iz">
+            <title>iz</title>
+            <para> Vector of size equal to the number of blocks.</para>
+            <para> That vector is used to store pointers of the working state register (work). If a block needs to allocate memory at initialization (flag 4), the associated pointer is saved here.</para>
+            <para> 
+                Size : number of blocks.
+            </para>
+            <para>
+                Type : column vector of real numbers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_state_tevts">
+            <title>tevts</title>
+            <para> Vector of size equal to the number of activation sources. It contains the scheduled times for programmed activations in evtspt.</para>
+            <para> 
+                Size : number of activation sources.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_state_evtspt">
+            <title>evtspt</title>
+            <para> Vector of size equal to the number of activation sources. It is an event scheduler.</para>
+            <para> 
+                Size : number of activation sources.
+            </para>
+            <para>
+                Type : column vector of integers.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_state_pointi">
+            <title>pointi</title>
+            <para> The number of the next programmed event.</para>
+            <para> 
+                Size : 1.
+            </para>
+            <para>
+                Type : integer.
+            </para>
+        </refsect2>
+        <refsect2 id="scicos_cpr_state_outtb">
+            <title>outtb</title>
+            <para> Scilab list containing all output registers of blocks. Each element of that list contains typed matrix-based data.</para>
+            <para> 
+                Size : number of regular output ports.
+            </para>
+            <para>
+                Type : list of scilab matrix.
+            </para>
+        </refsect2>
+    </refsection>
+</refentry>
diff --git a/scilab/modules/xcos/help/fr_FR/scilab_data_structures/blocks/CHAPTER b/scilab/modules/xcos/help/fr_FR/scilab_data_structures/blocks/CHAPTER
deleted file mode 100644 (file)
index d1f089b..0000000
+++ /dev/null
@@ -1 +0,0 @@
-title = Blocks
diff --git a/scilab/modules/xcos/help/fr_FR/scilab_data_structures/compilation_simulation/CHAPTER b/scilab/modules/xcos/help/fr_FR/scilab_data_structures/compilation_simulation/CHAPTER
deleted file mode 100644 (file)
index ffdb527..0000000
+++ /dev/null
@@ -1 +0,0 @@
-title = Compilation/Simulation
diff --git a/scilab/modules/xcos/help/fr_FR/scilab_data_structures/diagram/CHAPTER b/scilab/modules/xcos/help/fr_FR/scilab_data_structures/diagram/CHAPTER
deleted file mode 100644 (file)
index 87a5ba3..0000000
+++ /dev/null
@@ -1 +0,0 @@
-title = Diagram
diff --git a/scilab/modules/xcos/help/fr_FR/scilab_data_structures/links/CHAPTER b/scilab/modules/xcos/help/fr_FR/scilab_data_structures/links/CHAPTER
deleted file mode 100644 (file)
index 209ea6f..0000000
+++ /dev/null
@@ -1 +0,0 @@
-title = Links
diff --git a/scilab/modules/xcos/help/ja_JP/scilab_data_structures/blocks/CHAPTER b/scilab/modules/xcos/help/ja_JP/scilab_data_structures/blocks/CHAPTER
deleted file mode 100644 (file)
index d1f089b..0000000
+++ /dev/null
@@ -1 +0,0 @@
-title = Blocks
diff --git a/scilab/modules/xcos/help/ja_JP/scilab_data_structures/compilation_simulation/CHAPTER b/scilab/modules/xcos/help/ja_JP/scilab_data_structures/compilation_simulation/CHAPTER
deleted file mode 100644 (file)
index ffdb527..0000000
+++ /dev/null
@@ -1 +0,0 @@
-title = Compilation/Simulation
diff --git a/scilab/modules/xcos/help/ja_JP/scilab_data_structures/diagram/CHAPTER b/scilab/modules/xcos/help/ja_JP/scilab_data_structures/diagram/CHAPTER
deleted file mode 100644 (file)
index 87a5ba3..0000000
+++ /dev/null
@@ -1 +0,0 @@
-title = Diagram
diff --git a/scilab/modules/xcos/help/ja_JP/scilab_data_structures/links/CHAPTER b/scilab/modules/xcos/help/ja_JP/scilab_data_structures/links/CHAPTER
deleted file mode 100644 (file)
index 209ea6f..0000000
+++ /dev/null
@@ -1 +0,0 @@
-title = Links
diff --git a/scilab/modules/xcos/help/pt_BR/scilab_data_structures/blocks/.empty b/scilab/modules/xcos/help/pt_BR/scilab_data_structures/blocks/.empty
deleted file mode 100644 (file)
index 8b13789..0000000
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/scilab/modules/xcos/help/pt_BR/scilab_data_structures/compilation_simulation/.empty b/scilab/modules/xcos/help/pt_BR/scilab_data_structures/compilation_simulation/.empty
deleted file mode 100644 (file)
index 8b13789..0000000
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/scilab/modules/xcos/help/pt_BR/scilab_data_structures/diagram/.empty b/scilab/modules/xcos/help/pt_BR/scilab_data_structures/diagram/.empty
deleted file mode 100644 (file)
index 8b13789..0000000
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/scilab/modules/xcos/help/pt_BR/scilab_data_structures/links/.empty b/scilab/modules/xcos/help/pt_BR/scilab_data_structures/links/.empty
deleted file mode 100644 (file)
index 8b13789..0000000
+++ /dev/null
@@ -1 +0,0 @@
-