Add or format some examples in Xcos 74/9974/3
Sylvestre Ledru [Mon, 10 Dec 2012 11:32:08 +0000 (12:32 +0100)]
Change-Id: If37811486381e262f044d48a049224e504daa2b5

scilab/modules/xcos/help/en_US/batch_functions/lincos.xml
scilab/modules/xcos/help/en_US/batch_functions/steadycos.xml
scilab/modules/xcos/help/en_US/programming_scicos_blocks/utilities_functions/pointer_xproperty.xml
scilab/modules/xcos/help/en_US/programming_scicos_blocks/utilities_functions/scicos_time.xml
scilab/modules/xcos/help/en_US/scilab_utilities_functions/importXcosDiagram.xml
scilab/modules/xcos/help/en_US/scilab_utilities_functions/scicos_debug.xml

index c92cc48..3346429 100644 (file)
 <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="lincos">
     <refnamediv>
         <refname>lincos</refname>
-        <refpurpose>Constructs by linearization a linear state-space model from a general dynamical system described by a xcos diagram</refpurpose>
+        <refpurpose>Constructs by linearization a linear state-space model from a general dynamical system described by a Xcos diagram</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>sys= lincos(scs_m [,x0,u0 [,param] ])</synopsis>
+        <synopsis>sys = lincos(scs_m [,x0,u0 [,param] ])</synopsis>
     </refsynopsisdiv>
     <refsection id="Module_lincos">
         <title>Module</title>
             Construct a linear state-space system by linearizing a model given as a Xcos diagram. The idea is to transform a <link linkend="SUPER_f">sub-diagram</link> to a linear state-space model. The sub-diagram should have <link linkend="IN_f">inputs</link> and <link linkend="OUT_f">outputs</link>.
         </para>
         <para>
-            The output is a Scilab data structure of type continuous-time state-space linear system.  
-        </para>
-        <para>
+            The output is a Scilab data structure of type continuous-time state-space linear system.
         </para>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
         <programlisting role="example"><![CDATA[
 // loading data
 exec("SCI/modules/xcos/tests/unit_tests/PENDULUM_ANIM.sci");
index 283941b..fb8032e 100644 (file)
@@ -45,8 +45,9 @@
         <para>
             This function finds the steady state for a given system described by a xcos diagram or <link linkend="SUPER_f">sub-diagram</link>. The diagram should have <link linkend="IN_f">inputs</link> and <link linkend="OUT_f">outputs</link>.The steady state concern only the continuous-time dynamics.  
         </para>
-        <para>
-        </para>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
         <programlisting role="example"><![CDATA[
 // loading data
 exec("SCI/modules/xcos/tests/unit_tests/PENDULUM_ANIM.sci");
index 2d2540c..df8cfe8 100644 (file)
@@ -48,7 +48,7 @@
         <para>
         </para>
         <programlisting role="example"><![CDATA[ 
-[xprop]=pointer_xproperty
+[xprop]=pointer_xproperty()
  ]]></programlisting>
     </refsection>
     <refsection id="Parameters_pointer_xproperty">
index b07de1b..c47dcb0 100644 (file)
@@ -35,6 +35,9 @@
                 </para>
             </listitem>
         </itemizedlist>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
 t=scicos_time()
  ]]></programlisting>
index da2200e..012d418 100644 (file)
         <itemizedlist>
             <listitem>
                 <para>
-                    <emphasis role="bold">result :</emphasis> The status of the
+                    <emphasis role="bold">result:</emphasis> The status of the
                     operation.
                 </para>
             </listitem>
             <listitem>
                 <para>
-                    <emphasis role="bold">filename :</emphasis> The Xcos file to
+                    <emphasis role="bold">filename:</emphasis> The Xcos file to
                     load.
                 </para>
             </listitem>
index 5efa5eb..e0d3c27 100644 (file)
@@ -50,8 +50,9 @@
         <para>
             One can used it in the "Calc" mode of the Scicos editor or as an instruction in a Scilab block or in an interfacing function.  
         </para>
-        <para>
-        </para>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
 scicos_debug(level)
 level=scicos_debug()