Bug #13285 fixed - There was no appropriate example of the syntax for scifunc_block_m GUI 29/14529/2
Vladislav TRUBKIN [Thu, 15 May 2014 10:02:27 +0000 (12:02 +0200)]
   on the help page.

Change-Id: I317278335f928d40def9832bea55c139dc4cc76e

scilab/CHANGES_5.5.X
scilab/modules/xcos/help/en_US/palettes/Userdefinedfunctions_pal/scifunc_block_m.xml

index 13b5d4c..c2fb1a8 100644 (file)
@@ -42,6 +42,9 @@ Xcos Bug Fixes
 
 * Bug #12751 fixed - cdummy_ entry point was not found when using Code Generation.
 
+* Bug #13285 fixed - There was no appropriate example of the syntax for scifunc_block_m GUI
+                     on the help page.
+
 * Bug #13385 fixed - TOWS_c and FROMWSB Xcos blocs needed better examples on how
                      to get or write a Scilab variable.
                      
index d2a8780..7aa1a6c 100644 (file)
                 <para>
                     <emphasis role="bold">input ports sizes</emphasis>
                 </para>
-                <para> a scalar. Number of regular input ports</para>
-                <para> Properties : Type 'vec' of size -1 </para>
+                <para> a matrix. Number of regular input ports </para>
+                <para> Properties : Type 'mat' of size [-1 2] </para>
+                <para> Example : [1,1] for one input of size 1x1; [1,1;2,3] for two inputs of size 1x1 and 2x3 </para>      
             </listitem>
             <listitem>
                 <para>
                     <emphasis role="bold">output port sizes</emphasis>
                 </para>
-                <para> a scalar. Number of regular output ports</para>
-                <para> Properties : Type 'vec' of size -1 </para>
+                <para> a matrix. Number of regular output ports </para>
+                <para> Properties : Type 'mat' of size [-2 2] </para>
+                <para> Example : [1,1] for one output of size 1x1; [1,1;2,3] for two outputs of size 1x1 and 2x3 </para>
             </listitem>
             <listitem>
                 <para>
                     <emphasis role="bold">input event ports sizes</emphasis>
                 </para>
-                <para> a scalar. Number of input event ports</para>
+                <para> a column vector. Number of input event ports </para>
                 <para> Properties : Type 'vec' of size -1 </para>
+                <para> Example : [1] for one input event port; [1;1] for two input event ports </para>
             </listitem>
             <listitem>
                 <para>
                     <emphasis role="bold">output events ports sizes</emphasis>
                 </para>
-                <para> a scalar. Number of output event ports</para>
+                <para> a column vector. Number of output event ports</para>
                 <para> Properties : Type 'vec' of size -1 </para>
+                <para> Example : [1] for one output event port; [1;1] for two output event ports </para>
             </listitem>
             <listitem>
                 <para>
                     <emphasis role="bold">initial continuous state</emphasis>
                 </para>
-                <para> a column vector.</para>
+                <para> a column vector. </para>
                 <para> Properties : Type 'vec' of size -1 </para>
+                <para> Example : [0;0] for two initial continuous states </para>
             </listitem>
             <listitem>
                 <para>
                     <emphasis role="bold">initial discrete state</emphasis>
                 </para>
-                <para> a column vector.</para>
+                <para> a column vector. </para>
                 <para> Properties : Type 'vec' of size -1 </para>
+                <para> Example : [0;0] for two initial discrete states </para>
             </listitem>
             <listitem>
                 <para>
                     <emphasis role="bold">System parameters vector</emphasis>
                 </para>
-                <para>
-                    a string: c or d (<emphasis role="bold">CBB</emphasis> or<emphasis role="bold">    DBB</emphasis> ), other types are not supported.
-                </para>
+                <para> a column vector. </para>
                 <para> Properties : Type 'vec' of size -1 </para>
+                <para> Example : [0.5;1.5;2.5] for three parameters </para>
             </listitem>
             <listitem>
                 <para>
                     <emphasis role="bold">initial firing vector </emphasis>
                 </para>
-                <para> vector. Size of this vector corresponds to the number of event outputs. The value of the i-th entry specifies the time of the preprogrammed event firing on the i-th output event port. If less than zero, no event is preprogrammed.</para>
-                <para> Properties : Type 'vec' of size sum(%4) </para>
+                <para> a column vector. Size of this vector corresponds to the number of event outputs. The value of the i-th entry specifies the time of the preprogrammed event firing on the i-th output event port. If less than zero, no event is preprogrammed. </para>
+                <para> Properties : Type 'vec' of size sum(Number of output event ports) </para>
+                <para> Example : [1;2] 1 and 2 are the preprogrammed events firing that correspond to the first output event port and to the second output event port respectively </para>
             </listitem>
             <listitem>
                 <para>
                     <emphasis role="bold">is block always active </emphasis>
                 </para>
-                <para> other dialogues are opened consecutively where used may input Scilab code associated with the computations needed (block initialization, outputs, continuous and discrete state, output events date, block ending)</para>
                 <para> Properties : Type 'vec' of size 1</para>
+                <para> Example : 1 the block is always active; 0 the block is not always active </para>
+            </listitem>
+            <listitem>
+                <para> Other dialogues are opened consecutively where the user may write Scilab code associated with the computations needed (block initialization, outputs, continuous and discrete state, output events date, block ending). </para>
             </listitem>
         </itemizedlist>
     </refsection>