Xcos: doc: update TKSCALE to SEP50 92/3692/4
Clément DAVID [Thu, 31 Mar 2011 07:34:17 +0000 (09:34 +0200)]
add a simple example
fix labels order in the simulation function

Change-Id: Ia62bf6853f55d8e4fad6643c91d056313d97aebb

scilab/modules/xcos/examples/sources_pal/en_US/TKSCALE_en_US.xcos [new file with mode: 0644]
scilab/modules/xcos/help/examples/sources_pal/en_US/TKSCALE_diagram_en_US.png [new file with mode: 0644]
scilab/modules/xcos/help/gui/sources_pal/en_US/TKSCALE_gui.png [new file with mode: 0644]
scilab/modules/xcos/help/images/TKSCALE_gui.gif [deleted file]
scilab/modules/xcos/images/gui/TKSCALE_gui.gif [deleted file]

index c1eb2df..bb6eeed 100644 (file)
@@ -70,6 +70,7 @@ Xcos:
   - Counter
   - RAMP
   - INTRPLBLK_f (english update only)
+  - TKSCALE (english update only)
   - DELAY_f
   - RFILE_f Read from input file
index c5a295d..25eb70c 100644 (file)
@@ -62,11 +62,11 @@ function block=tkscaleblk(block,flag)
       "Position", [0 0 20 200], "SliderStep", [block.rpar(3) 2*block.rpar(3)]);
     // labels
-    labels = string([bounds(1)                  ;..
-                     mean([bounds(1) initial])  ;..
-                     initial                    ;..
+    labels = string([bounds(2)                  ;..
                      mean([bounds(2) initial])  ;..
-                     bounds(2)]);
+                     initial                    ;..
+                     mean([bounds(1) initial])  ;..
+                     bounds(1)]);
     labels = strcat(labels, "<br /><br /><br />");
     uicontrol(f, "Style", "text", "String", labels(1), ..
               "Position", [30  0 50 200]);
diff --git a/scilab/modules/xcos/examples/sources_pal/en_US/TKSCALE_en_US.xcos b/scilab/modules/xcos/examples/sources_pal/en_US/TKSCALE_en_US.xcos
new file mode 100644 (file)
index 0000000..f79406b
Binary files /dev/null and b/scilab/modules/xcos/examples/sources_pal/en_US/TKSCALE_en_US.xcos differ
index 9a7b225..f172d19 100644 (file)
@@ -24,7 +24,7 @@
 <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" version="5.0-subset Scilab" xml:id="TKSCALE">
-    <refpurpose>Adjust constant value with a tk widget</refpurpose>
+    <refpurpose>Adjust value with a graphical widget.</refpurpose>
     <title>Block Screenshot</title>
@@ -41,7 +41,7 @@
-          <link linkend="TKSCALE">Adjust constant value with a tk widget</link>
+          <link linkend="TKSCALE">Adjust value with a graphical widget.</link>
-              <xref linkend="Interfacingfunction_TKSCALE">Interfacing function</xref>
+              <xref linkend="Example_TKSCALE">Example</xref>
-              <xref linkend="Computationalfunction_TKSCALE">Computational function</xref>
+              <xref linkend="Interfacingfunction_TKSCALE">Interfacing function</xref>
@@ -98,7 +98,7 @@
   <refsection id="Description_TKSCALE">
-This source block generates a piecewise constant signal the value of which can be set interactively using a TK widget in the course of the simulation. The output value is the value set by the slider (an integer between Min value and Max value) divided by the Normalization factor. Increasing proportionaly all three block parameters does not change the output range, but it does increase precision.  
+This source block generates a piecewise constant signal the value of which can be set interactively using a widget in the course of the simulation. The output value is the value set by the slider (an integer between Min value and Max value) divided by the Normalization factor. Increasing proportionaly all three block parameters does not change the output range, but it does increase precision.
@@ -108,7 +108,7 @@ This source block generates a piecewise constant signal the value of which can b
-          <imagedata fileref="../../../../images/gui/TKSCALE_gui.gif" align="center" valign="middle"/>
+          <imagedata fileref="../../../gui/sources_pal/en_US/TKSCALE_gui.png" align="center" valign="middle"/>
@@ -185,24 +185,33 @@ This source block generates a piecewise constant signal the value of which can b
+  <refsection id="Example_TKSCALE">
+    <title>Example</title>
+    <para>
+      <link type="scilab" linkend="scilab.xcos/xcos/examples/sources_pal/en_US/TKSCALE_en_US.xcos">
+          Open this example in Xcos
+        </link>
+    </para>
+    <para/>
+    <mediaobject>
+      <imageobject>
+        <imagedata fileref="../../../examples/sources_pal/en_US/TKSCALE_diagram_en_US.png" align="center"/>
+      </imageobject>
+    </mediaobject>
+  </refsection>
   <refsection id="Interfacingfunction_TKSCALE">
     <title>Interfacing function</title>
-        <para> SCI/modules/scicos_blocks/macros/Sources/TKSCALE.sci</para>
-      </listitem>
-    </itemizedlist>
-  </refsection>
-  <refsection id="Computationalfunction_TKSCALE">
-    <title>Computational function</title>
-    <itemizedlist>
-      <listitem>
-        <para> SCI/modules/scicos/macros/scicos_scicos/tkscaleblk.sci (Type 5)</para>
+        <para>
+          <link type="scilab" linkend="scilab.scinotes/scicos_blocks/macros/Sources/TKSCALE.sci">SCI/modules/scicos_blocks/macros/Sources/TKSCALE.sci</link>
+        </para>
   <refsection id="Authors_TKSCALE">
     <para><emphasis role="bold">Ramine Nikoukhah</emphasis> - INRIA</para>
+    <para><emphasis role="bold">Clément DAVID</emphasis> - DIGITEO</para>
diff --git a/scilab/modules/xcos/help/examples/sources_pal/en_US/TKSCALE_diagram_en_US.png b/scilab/modules/xcos/help/examples/sources_pal/en_US/TKSCALE_diagram_en_US.png
new file mode 100644 (file)
index 0000000..d3b41ea
Binary files /dev/null and b/scilab/modules/xcos/help/examples/sources_pal/en_US/TKSCALE_diagram_en_US.png differ
diff --git a/scilab/modules/xcos/help/gui/sources_pal/en_US/TKSCALE_gui.png b/scilab/modules/xcos/help/gui/sources_pal/en_US/TKSCALE_gui.png
new file mode 100644 (file)
index 0000000..5e5eaff
Binary files /dev/null and b/scilab/modules/xcos/help/gui/sources_pal/en_US/TKSCALE_gui.png differ
diff --git a/scilab/modules/xcos/help/images/TKSCALE_gui.gif b/scilab/modules/xcos/help/images/TKSCALE_gui.gif
deleted file mode 100644 (file)
index 0c565a2..0000000
Binary files a/scilab/modules/xcos/help/images/TKSCALE_gui.gif and /dev/null differ
diff --git a/scilab/modules/xcos/images/gui/TKSCALE_gui.gif b/scilab/modules/xcos/images/gui/TKSCALE_gui.gif
deleted file mode 100644 (file)
index 0c565a2..0000000
Binary files a/scilab/modules/xcos/images/gui/TKSCALE_gui.gif and /dev/null differ