Revision of help pages for rubberbox function: 59/10459/1
Stanislav KROTER [Tue, 12 Feb 2013 16:13:33 +0000 (22:13 +0600)]
1) the example is devided into four independent examples;
2) explanatory text inserted in the figure as a title.

It is more convenient when the help window is maximized (or when you cannot see
the console).

* moved to the interaction category

Change-Id: I950fc5cd9d36f4833f8d267a6eeb3b1680ff248b

scilab/modules/graphics/help/en_US/interaction/rubberbox.xml [moved from scilab/modules/graphics/help/en_US/rubberbox.xml with 81% similarity]
scilab/modules/graphics/help/ja_JP/interaction/rubberbox.xml [moved from scilab/modules/graphics/help/ja_JP/rubberbox.xml with 81% similarity]
scilab/modules/graphics/help/pt_BR/interaction/rubberbox.xml [moved from scilab/modules/graphics/help/pt_BR/rubberbox.xml with 80% similarity]
scilab/modules/graphics/help/ru_RU/interaction/rubberbox.xml [moved from scilab/modules/graphics/help/ru_RU/rubberbox.xml with 81% similarity]

@@ -2,18 +2,18 @@
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) INRIA
- * 
+ *
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
  * you should have received as part of this distribution.  The terms
- * are also available at    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.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:lang="en" xml:id="rubberbox">
     <refnamediv>
         <refname>rubberbox</refname>
-        <refpurpose>Rubberband box for rectangle selection</refpurpose>
+        <refpurpose>rubberband box for rectangle selection</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
@@ -86,7 +86,7 @@
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 clf
 plot2d()
 a = gca();
@@ -95,13 +95,43 @@ x0 = (db(1)*2+db(2))/3;
 dx = (db(2)-db(1))/3;
 y0 = (db(3)+db(4)*2)/3;
 dy = (db(4)-db(3))/3;
-disp("With an initial starting corner:")
+xtitle(msprintf("With an initial starting corner: x0 = %0.2f, y0 = %0.2f",x0,y0))
 r = rubberbox([x0 y0])
-disp("With an initial box:")
+]]></programlisting>
+        <programlisting role="example"><![CDATA[
+clf
+plot2d()
+a = gca();
+db = a.data_bounds;
+x0 = (db(1)*2+db(2))/3;
+dx = (db(2)-db(1))/3;
+y0 = (db(3)+db(4)*2)/3;
+dy = (db(4)-db(3))/3;
+xtitle(msprintf("With an initial box: x0 = %0.2f, y0 = %0.2f, width = %0.2f, height = %0.2f,",x0-dx/4,y0+dy/5,2*dx,dy))
 r = rubberbox([x0-dx/4 y0+dy/5 2*dx dy])
-disp("In press -- drag -- release mode selection:")
+]]></programlisting>
+        <programlisting role="example"><![CDATA[
+clf
+plot2d()
+a = gca();
+db = a.data_bounds;
+x0 = (db(1)*2+db(2))/3;
+dx = (db(2)-db(1))/3;
+y0 = (db(3)+db(4)*2)/3;
+dy = (db(4)-db(3))/3;
+xtitle("In press -- drag -- release mode selection:")
 r = rubberbox(%t)
-disp("In starting click -- drag -- stopping click mode selection:")
+]]></programlisting>
+        <programlisting role="example"><![CDATA[
+clf
+plot2d()
+a = gca();
+db = a.data_bounds;
+x0 = (db(1)*2+db(2))/3;
+dx = (db(2)-db(1))/3;
+y0 = (db(3)+db(4)*2)/3;
+dy = (db(4)-db(3))/3;
+xtitle("In starting click -- drag -- stopping click mode selection:")
 r = rubberbox()
  ]]></programlisting>
     </refsection>
@@ -2,11 +2,11 @@
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) INRIA
- * 
+ *
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
  * you should have received as part of this distribution.  The terms
- * are also available at    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
@@ -75,7 +75,7 @@
     </refsection>
     <refsection>
         <title>例</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 clf
 plot2d()
 a = gca();
@@ -84,13 +84,43 @@ x0 = (db(1)*2+db(2))/3;
 dx = (db(2)-db(1))/3;
 y0 = (db(3)+db(4)*2)/3;
 dy = (db(4)-db(3))/3;
-disp("With an initial starting corner:")
+xtitle(msprintf("With an initial starting corner: x0 = %0.2f, y0 = %0.2f",x0,y0))
 r = rubberbox([x0 y0])
-disp("With an initial box:")
+]]></programlisting>
+        <programlisting role="example"><![CDATA[
+clf
+plot2d()
+a = gca();
+db = a.data_bounds;
+x0 = (db(1)*2+db(2))/3;
+dx = (db(2)-db(1))/3;
+y0 = (db(3)+db(4)*2)/3;
+dy = (db(4)-db(3))/3;
+xtitle(msprintf("With an initial box: x0 = %0.2f, y0 = %0.2f, width = %0.2f, hight = %0.2f,",x0-dx/4,y0+dy/5,2*dx,dy))
 r = rubberbox([x0-dx/4 y0+dy/5 2*dx dy])
-disp("In press -- drag -- release mode selection:")
+]]></programlisting>
+        <programlisting role="example"><![CDATA[
+clf
+plot2d()
+a = gca();
+db = a.data_bounds;
+x0 = (db(1)*2+db(2))/3;
+dx = (db(2)-db(1))/3;
+y0 = (db(3)+db(4)*2)/3;
+dy = (db(4)-db(3))/3;
+xtitle("In press -- drag -- release mode selection:")
 r = rubberbox(%t)
-disp("In starting click -- drag -- stopping click mode selection:")
+]]></programlisting>
+        <programlisting role="example"><![CDATA[
+clf
+plot2d()
+a = gca();
+db = a.data_bounds;
+x0 = (db(1)*2+db(2))/3;
+dx = (db(2)-db(1))/3;
+y0 = (db(3)+db(4)*2)/3;
+dy = (db(4)-db(3))/3;
+xtitle("In starting click -- drag -- stopping click mode selection:")
 r = rubberbox()
  ]]></programlisting>
     </refsection>
@@ -52,7 +52,7 @@
                 <term>final_rect</term>
                 <listitem>
                     <para>um retângulo definido por [x_esquerdo, y_topo, largura,
-                        altura] 
+                        altura]
                     </para>
                 </listitem>
             </varlistentry>
@@ -77,7 +77,7 @@
     </refsection>
     <refsection>
         <title>Exemplos</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 clf
 plot2d()
 a = gca();
@@ -86,15 +86,45 @@ x0 = (db(1)*2+db(2))/3;
 dx = (db(2)-db(1))/3;
 y0 = (db(3)+db(4)*2)/3;
 dy = (db(4)-db(3))/3;
-disp("With an initial starting corner:")
+xtitle(msprintf("With an initial starting corner: x0 = %0.2f, y0 = %0.2f",x0,y0))
 r = rubberbox([x0 y0])
-disp("With an initial box:")
+]]></programlisting>
+        <programlisting role="example"><![CDATA[
+clf
+plot2d()
+a = gca();
+db = a.data_bounds;
+x0 = (db(1)*2+db(2))/3;
+dx = (db(2)-db(1))/3;
+y0 = (db(3)+db(4)*2)/3;
+dy = (db(4)-db(3))/3;
+xtitle(msprintf("With an initial box: x0 = %0.2f, y0 = %0.2f, width = %0.2f, height = %0.2f,",x0-dx/4,y0+dy/5,2*dx,dy))
 r = rubberbox([x0-dx/4 y0+dy/5 2*dx dy])
-disp("In press -- drag -- release mode selection:")
+]]></programlisting>
+        <programlisting role="example"><![CDATA[
+clf
+plot2d()
+a = gca();
+db = a.data_bounds;
+x0 = (db(1)*2+db(2))/3;
+dx = (db(2)-db(1))/3;
+y0 = (db(3)+db(4)*2)/3;
+dy = (db(4)-db(3))/3;
+xtitle("In press -- drag -- release mode selection:")
 r = rubberbox(%t)
-disp("In starting click -- drag -- stopping click mode selection:")
+]]></programlisting>
+        <programlisting role="example"><![CDATA[
+clf
+plot2d()
+a = gca();
+db = a.data_bounds;
+x0 = (db(1)*2+db(2))/3;
+dx = (db(2)-db(1))/3;
+y0 = (db(3)+db(4)*2)/3;
+dy = (db(4)-db(3))/3;
+xtitle("In starting click -- drag -- stopping click mode selection:")
 r = rubberbox()
- ]]></programlisting>
+]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>Ver Também</title>
@@ -2,11 +2,11 @@
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) INRIA
- * 
+ *
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
  * you should have received as part of this distribution.  The terms
- * are also available at    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
@@ -38,8 +38,8 @@
                         в виде <literal>[x_min, y_max, width, height]</literal>,
                         где <literal>x_min</literal> и <literal>y_max</literal>
                         - координаты начального угла, <literal>width</literal> -
-                        ширина и <literal>height</literal> - высота; с двумя
-                        элементами ширина и высота предполагаются нулевыми.
+                        ширина и <literal>height</literal> - высота; если элементов два, то
+                        ширина и высота предполагаются нулевыми.
                     </para>
                 </listitem>
             </varlistentry>
@@ -64,9 +64,7 @@
                 <listitem>
                     <para>
                         прямоугольник, определяемый как <literal>[x_min, y_max,
-                            width, height]
-                        </literal>
-                        ,где <literal>x_min</literal> и
+                        width, height]</literal>, где <literal>x_min</literal> и
                         <literal>y_max</literal> - координаты начального угла,
                         <literal>width</literal> - ширина и
                         <literal>height</literal> - высота.
@@ -96,7 +94,7 @@
     </refsection>
     <refsection>
         <title>Примеры</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 clf
 plot2d()
 a = gca();
@@ -105,15 +103,45 @@ x0 = (db(1)*2+db(2))/3;
 dx = (db(2)-db(1))/3;
 y0 = (db(3)+db(4)*2)/3;
 dy = (db(4)-db(3))/3;
-disp("With an initial starting corner:")
+xtitle(msprintf("С исходным начальным углом: x0 = %0.2f, y0 = %0.2f",x0,y0))
 r = rubberbox([x0 y0])
-disp("With an initial box:")
+]]></programlisting>
+        <programlisting role="example"><![CDATA[
+clf
+plot2d()
+a = gca();
+db = a.data_bounds;
+x0 = (db(1)*2+db(2))/3;
+dx = (db(2)-db(1))/3;
+y0 = (db(3)+db(4)*2)/3;
+dy = (db(4)-db(3))/3;
+xtitle(msprintf("С исходной рамкой: x0 = %0.2f, y0 = %0.2f, width = %0.2f, height = %0.2f,",x0-dx/4,y0+dy/5,2*dx,dy))
 r = rubberbox([x0-dx/4 y0+dy/5 2*dx dy])
-disp("In press -- drag -- release mode selection:")
+]]></programlisting>
+        <programlisting role="example"><![CDATA[
+clf
+plot2d()
+a = gca();
+db = a.data_bounds;
+x0 = (db(1)*2+db(2))/3;
+dx = (db(2)-db(1))/3;
+y0 = (db(3)+db(4)*2)/3;
+dy = (db(4)-db(3))/3;
+xtitle("Режим выбора: нажать -- тащить -- отпустить")
 r = rubberbox(%t)
-disp("In starting click -- drag -- stopping click mode selection:")
+]]></programlisting>
+        <programlisting role="example"><![CDATA[
+clf
+plot2d()
+a = gca();
+db = a.data_bounds;
+x0 = (db(1)*2+db(2))/3;
+dx = (db(2)-db(1))/3;
+y0 = (db(3)+db(4)*2)/3;
+dy = (db(4)-db(3))/3;
+xtitle("Режим выбора: щёлкнуть -- тащить -- щёлкнуть")
 r = rubberbox()
- ]]></programlisting>
+]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>Смотрите также</title>