scilab/modules/xcos/help/en_US/scilab_data_structures/blocks/scicos_block.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3  * Scicos
   4  *
   5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
   6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  *
  22  * See the file ./license.txt
  23  -->
  24 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="scicos_block">
  25     <refnamediv>
  26         <refname>scicos_block</refname>
  27         <refpurpose>Define a block structure</refpurpose>
  28     </refnamediv>
  29     <refsection id="Module_scicos_block">
  30         <title>Module</title>
  31         <itemizedlist>
  32             <listitem>
  33                 <para>
  34                     <link linkend="xcos">xcos</link>
  35                 </para>
  36             </listitem>
  37         </itemizedlist>
  38     </refsection>
  39     <refsection id="block_scicos_block">
  40         <title>block</title>
  41         <para>
  42             Basic  structure that define a xcos block.
  43         </para>
  44         <para>
  45             That structure includes fields <link linkend="scicos_graphics">graphics</link>, <link linkend="scicos_model">model</link>,
  46
  47             gui and doc.
  48         </para>
  49         <para>
  50         </para>
  51         <para>
  52         </para>
  53         <para>
  54             Size : 5.
  55         </para>
  56         <para>
  57             Type : scilab list.
  58         </para>
  59         <para>
  60
  61         </para>
  62         <itemizedlist>
  63             <listitem>
  64                 <para>
  65                     <emphasis role="bold">graphics</emphasis>
  66                 </para>
  67                 <para> Scilab object including graphical information concerning the features of the block.</para>
  68                 <para>
  69                     Size : 14.
  70                 </para>
  71                 <para>
  72                     Type : scilab list.
  73                 </para>
  74             </listitem>
  75             <listitem>
  76                 <para>
  77                     <emphasis role="bold">model</emphasis>
  78                 </para>
  79                 <para> Scilab list that contains the features of the block used for the compilation.</para>
  80                 <para>
  81                     Size : 23.
  82                 </para>
  83                 <para>
  84                     Type : Scilab list.
  85                 </para>
  86             </listitem>
  87             <listitem>
  88                 <para>
  89                     <emphasis role="bold">gui</emphasis>
  90                 </para>
  91                 <para> The name of the Scilab GUI function associated with the block.</para>
  92                 <para>
  93                     Size : 1.
  94                 </para>
  95                 <para>
  96                     Type : string.
  97                 </para>
  98             </listitem>
  99             <listitem>
 100                 <para>
 101                     <emphasis role="bold">doc</emphasis>
 102                 </para>
 103                 <para> Field used for documentation of the block
 104                     Size : 1.
 105                 </para>
 106                 <para>
 107                     Type : string.
 108                 </para>
 109             </listitem>
 110         </itemizedlist>
 111     </refsection>
 112     <refsection id="Filecontent_scicos_block">
 113         <title>File content</title>
 114         <itemizedlist>
 115             <listitem>
 116                 <para> SCI/modules/scicos/macros/scicos_scicos/scicos_block.sci</para>
 117             </listitem>
 118         </itemizedlist>
 119     </refsection>
 120 </refentry>