Revision of help pages for some functions from module "graphics" (en_US). 85/9885/1
Stanislav KROTER [Fri, 30 Nov 2012 08:31:17 +0000 (14:31 +0600)]
Change-Id: Ie47bf3770d5a916ac2dc2160485de7c76dfcdb22

18 files changed:
scilab/modules/graphics/help/en_US/object_editor.xml
scilab/modules/graphics/help/en_US/pixel_drawing_mode.xml
scilab/modules/graphics/help/en_US/square.xml
scilab/modules/graphics/help/en_US/twinkle.xml
scilab/modules/graphics/help/en_US/window_control/havewindow.xml
scilab/modules/graphics/help/en_US/window_control/show_window.xml
scilab/modules/graphics/help/en_US/window_control/winsid.xml
scilab/modules/graphics/help/en_US/xbasr.xml
scilab/modules/graphics/help/en_US/xchange.xml
scilab/modules/graphics/help/en_US/xdel.xml
scilab/modules/graphics/help/en_US/xgetech.xml
scilab/modules/graphics/help/en_US/xgraduate.xml
scilab/modules/graphics/help/en_US/xgrid.xml
scilab/modules/graphics/help/en_US/xname.xml
scilab/modules/graphics/help/en_US/xnumb.xml
scilab/modules/graphics/help/en_US/xpause.xml
scilab/modules/graphics/help/en_US/xsegs.xml
scilab/modules/graphics/help/en_US/xsetech.xml

index 9b89114..899ce12 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:lang="en" xml:id="object_editor">
     <refnamediv>
         <refname>object editor </refname>
-        <refpurpose>description of the graphic object
-            editor capacities
+        <refpurpose>
+            description of the graphic object editor capacities
         </refpurpose>
     </refnamediv>
     <refnamediv xml:id="graphic">
         <refname>graphic </refname>
-        <refpurpose>description of the graphic object editor
-            capacities
+        <refpurpose>
+            description of the graphic object editor capacities
         </refpurpose>
     </refnamediv>
     <refnamediv xml:id="menus">
         <refname>menus</refname>
-        <refpurpose>description of the graphic object editor
-            capacities
+        <refpurpose>
+            description of the graphic object editor capacities
         </refpurpose>
     </refnamediv>
     <refsection>
         <title>Description</title>
-        <para>Scilab graphics allow the
-            user to have interaction with graphics before and after having them
-            drawn. Each graphics window and the
-            drawing it contains are represented by hierchical entities. The hierachy
-            top level is the Figure. Each Figure defines at least one child of type
-            Axes. Each Axes entity contains a set of leaf entities which are the basic
-            graphics objects like Polylines, Rectangles, Arcs, Segs,... It can also
-            contain a Compound type which are recursive sets of entities.
+        <para>
+            Scilab graphics allow the user to have interaction with graphics
+            before and after having them drawn. Each graphics window and the
+            drawing it contains are represented by hierarchical entities. The
+            hierarchy top level is the <literal>Figure</literal>. Each
+            <literal>Figure</literal> defines at least one child of type
+            <literal>Axes</literal>. Each <literal>Axes</literal> entity
+            contains a set of leaf entities which are the basic graphics objects
+            like <literal>Polylines</literal>, <literal>Rectangles</literal>,
+            <literal>Arcs</literal>, <literal>Segs</literal>,... It can also
+            contain a <literal>Compound</literal> type which is recursive sets of entities.
         </para>
-        <para>The main interest of the graphic mode is to make property changes
-            easier. This graphics'mode provides a set of high-level graphing
-            routines (see <link linkend="set">set</link>, <link linkend="get">get</link>) used to control objects'
-            properties such as data, coordinates and scaling, color and appearences
-            without requiring to replay the initial graphics commands.
+        <para>
+            The main interest of the graphic mode is to make property changes
+            easier. This graphics' mode provides a set of high-level graphing
+            routines (see <link linkend="set">set</link>, <link
+            linkend="get">get</link>) used to control objects'
+            properties such as data, coordinates and scaling, color and
+            appearances without requiring to replay the initial graphics
+            commands.
         </para>
-        <para>Graphics entities are associated to Scilab variables of type
-            <literal>handle</literal>. The handle is a unique identifier which is associated
-            to each instance of a created graphical entity. Using this handle, it will
-            be possible to reach entities' properties through "set" and "get"
-            routines. The handles are also used to manipulate graphics objects, to
-            move them, to make copies or delete them.
+        <para>
+            Graphics entities are associated to Scilab variables of type
+            <literal>handle</literal>. The handle is a unique identifier which
+            is associated to each instance of a created graphical entity. Using
+            this handle, it will be possible to reach entities' properties
+            through <function>set</function> and <function>get</function>
+            routines. The handles are also used to manipulate graphics objects,
+            to move them, to make copies or delete them.
         </para>
-        <para>To complete and use the graphics handle capacity at its maximum, a
+        <para>
+            To complete and use the graphics handle capacity at its maximum, a
             graphic object editor has been created too. It is a set of Tcl/Tk
             interfaces available for each kind of graphics objects (see
-            <link linkend="graphics_entities">graphics_entities</link> for more details) that can be enabled for
-            each graphic window. To make it work, select the <literal>Edit</literal> menu in
-            the graphic window. Seven graphics editing operations are available :
+            <link linkend="graphics_entities">graphics entities</link> for more
+            details) that can be enabled for each graphic window. To make it
+            work, select the <literal>Edit</literal> menu in the graphic window.
+            Seven graphics editing operations are available :
         </para>
         <para/>
         <variablelist>
             <varlistentry>
                 <term>Select figure as current: </term>
                 <listitem>
-                    <para>Let this</para>
-                    <para>figure be the current one.</para>
+                    <para>Let this figure be the current one.</para>
                     <para/>
                 </listitem>
             </varlistentry>
@@ -80,8 +89,9 @@
             <varlistentry>
                 <term>Erase figure: </term>
                 <listitem>
-                    <para>Erase the content of the graphics window. Its action corresponds
-                        to <literal>clf</literal> routine.
+                    <para>
+                        Erase the content of the graphics window. Its action
+                        corresponds to <function>clf</function> routine.
                     </para>
                     <para/>
                 </listitem>
             <varlistentry>
                 <term>Copy object: </term>
                 <listitem>
-                    <para>Using the mouse, it allows the user to select a 2D object (like a
-                        curve, a rectangle...) and put it in the clipboard. Thus, by a next
-                        call to <literal>Paste object</literal>, the object is copied in the
+                    <para>
+                        Using the mouse, it allows the user to select a 2D
+                        object (like a curve, a rectangle...) and put it in the
+                        clipboard. Thus, by a next call to <literal>Paste
+                        object</literal>, the object is copied in the
                         selected current axes.
                     </para>
                     <para/>
             <varlistentry>
                 <term>Paste object: </term>
                 <listitem>
-                    <para>Allow the user to paste a previous object put into in the
-                        clipboard inside the selected current axes.
+                    <para>
+                        Allow the user to paste a previous object put into in
+                        the clipboard inside the selected current axes.
                     </para>
                     <para/>
                 </listitem>
             <varlistentry>
                 <term>Move object: </term>
                 <listitem>
-                    <para>Using the mouse, it allows the user to move a 2D object (like a
-                        curve, a rectangle...) inside the selected current axes.
+                    <para>
+                        Using the mouse, it allows the user to move a 2D object
+                        (like a curve, a rectangle...) inside the selected
+                        current axes.
                     </para>
                     <para/>
                 </listitem>
             <varlistentry>
                 <term>Delete object: </term>
                 <listitem>
-                    <para>Using the mouse, it allows the user to pick up a 2D object (like a
-                        curve, a rectangle...) inside the selected current axes and to delete
-                        it instantly.
+                    <para>
+                        Using the mouse, it allows the user to pick up a 2D
+                        object (like a curve, a rectangle...) inside the
+                        selected current axes and to delete it instantly.
                     </para>
                     <para/>
                 </listitem>
             <varlistentry>
                 <term>Figure Properties: </term>
                 <listitem>
-                    <para>Launch the Tcl/Tk interface for the Figure object applied to the
-                        figure handle of the graphics window.
+                    <para>
+                        Launch the Tcl/Tk interface for the
+                        <literal>Figure</literal> object applied to the figure
+                        handle of the graphics window.
                     </para>
                     <para/>
                 </listitem>
             <varlistentry>
                 <term>Current Axes Properties: </term>
                 <listitem>
-                    <para>Launch the Tcl/Tk interface for the Axes object applied to the
-                        current axes handle of the graphics window.
+                    <para>
+                        Launch the Tcl/Tk interface for the
+                        <literal>Axes</literal> object applied to the current
+                        axes handle of the graphics window.
                     </para>
                     <para/>
                 </listitem>
             <varlistentry>
                 <term>Start Entity Picker: </term>
                 <listitem>
-                    <para>Start an event handler on the graphics window to catch the mouse
-                        clicks on graphics objects and launch the corresponding Tcl/Tk
-                        interface. The left mouse-click allows object edition and the right
-                        click performs a move of the selected object. Note that, for now, this
+                    <para>
+                        Start an event handler on the graphics window to catch
+                        the mouse clicks on graphics objects and launch the
+                        corresponding Tcl/Tk interface. The left mouse-click
+                        allows object edition and the right click performs a
+                        move of the selected object. Note that, for now, this
                         feature is applied to 2D objects only.
                     </para>
                     <para/>
             <varlistentry>
                 <term>Stop Entity Picker: </term>
                 <listitem>
-                    <para>Stop the action of the Entity Picker by terminating the event
-                        handler on the graphics window.
+                    <para>
+                        Stop the action of the Entity Picker by terminating the
+                        event handler on the graphics window.
                     </para>
                     <para/>
                 </listitem>
             </varlistentry>
-        </variablelist>
+        </variablelist>        
         <para>
-            Once the graphic interface is enabled (using the <literal>Figure
-                Properties
-            </literal>
-            or <literal>Current Axes Properties</literal> options), two
-            main areas appear :
+            Once the graphic interface is enabled (using the <literal>Figure Properties</literal> or <literal>Current Axes Properties</literal> options), two main areas appear:
         </para>
         <para/>
         <para/>
             <varlistentry>
                 <term>A tree selector: </term>
                 <listitem>
-                    <para>Placed on the left side of the graphical editor, a hierarchical
-                        tree selector specifies which object is currently edited. It can be
-                        used to switch from a graphic object to another provided that they are
+                    <para>
+                        Placed on the left side of the graphical editor, a
+                        hierarchical tree selector specifies which object is
+                        currently edited. It can be used to switch from a
+                        graphic object to another provided that they are
                         in the same graphic window.
                     </para>
                 </listitem>
             <varlistentry>
                 <term>A notebook: </term>
                 <listitem>
-                    <para>The second area represents a notebook composed with different
-                        properties pages (like <literal>Style</literal>, <literal>Data</literal>,
-                        <literal>Clipping</literal>...) depending on the selected graphic object.
-                        Using this editor, man can edit more easily the whole properties set
-                        of each graphic object (like through the <literal>"set"</literal> and
-                        <literal>"get"</literal> commands). Here is an example of the axes' notebook
-                        displaying axes properties:
+                    <para>
+                        The second area represents a notebook composed with
+                        different properties pages (like
+                        <literal>Style</literal>, <literal>Data</literal>,
+                        <literal>Clipping</literal>...) depending on the
+                        selected graphic object. Using this editor, user can
+                        edit more easily the whole properties set of each
+                        graphic object (like through the <function>set</function> and
+                        <function>get</function> routines). Here is an example of the axes' notebook displaying axes properties:
                     </para>
                 </listitem>
             </varlistentry>
             </inlinemediaobject>
         </para>
         <para/>
-        <para>Furthermore, you can legend/annotate your figure using sample
-            primitives given inside the <literal>Insert</literal> menu in the graphic
-            window. Using the mouse and following the instruction in the message
-            subwindow, you can add a:
+        <para>
+            Furthermore, you can legend/annotate your figure using sample
+            primitives given inside the <literal>Insert</literal> menu in the
+            graphic window. Using the mouse and following the instruction in the message subwindow, you can add a:
         </para>
         <para/>
         <variablelist>
             <varlistentry>
                 <term>Line: </term>
                 <listitem>
-                    <para>Draw a line between 2 left mouse clicks. The line lives in the
-                        axes where the first point was selected.
+                    <para>
+                        Draw a line between 2 left mouse clicks. The line lives
+                        in the axes where the first point was selected.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Polyline: </term>
                 <listitem>
-                    <para>Draw a polyline by clicking on the left button to define the line
-                        path and right click at last to complete the drawing. The polyline
-                        lives in the axes where the first point was selected.
+                    <para>
+                        Draw a polyline by clicking on the left button to define
+                        the line path and right click at last to complete the
+                        drawing. The polyline lives in the axes where the first
+                        point was selected.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Arrow: </term>
                 <listitem>
-                    <para>Draw an arrow between 2 left mouse clicks. The arrow lives in the
-                        axes where the first point was selected.
+                    <para>
+                        Draw an arrow between 2 left mouse clicks. The arrow
+                        lives in the axes where the first point was selected.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Double arrow: </term>
                 <listitem>
-                    <para>Draw a double-sided arrow between 2 left mouse clicks. The double
-                        arrow lives in the axes where the first point was selected.
+                    <para>
+                        Draw a double-sided arrow between 2 left mouse clicks.
+                        The double arrow lives in the axes where the first point
+                        was selected.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Text: </term>
                 <listitem>
-                    <para>Open a dialog box to enter the text, then click on the figure
-                        window to place it. The text lives in the axes where the point was
-                        selected.
+                    <para>
+                        Open a dialog box to enter the text, then click on the
+                        figure window to place it. The text lives in the axes
+                        where the point was selected.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Rectangle: </term>
                 <listitem>
-                    <para>Draw a rectangle : 2 left mouse clicks define respectively the
-                        upper left corner and the lower-right corner of the rectangle. The
-                        rectangle lives in the axes where the first point was selected.
+                    <para>
+                        Draw a rectangle: 2 left mouse clicks define
+                        respectively the upper left corner and the lower-right
+                        corner of the rectangle. The rectangle lives in the axes
+                        where the first point was selected.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>Circle: </term>
                 <listitem>
-                    <para>Draw a circle : 2 left mouse clicks define respectively the upper
-                        left corner and the lower-right corner of the bounding-box where the
-                        circle lives. The rectangle lives in the axes where the first point
-                        was selected.
+                    <para>
+                        Draw a circle : 2 left mouse clicks define respectively
+                        the upper left corner and the lower-right corner of the
+                        bounding-box where the circle lives. The rectangle lives
+                        in the axes where the first point was selected.
                     </para>
                 </listitem>
             </varlistentry>
index f78319c..3f7d3e8 100644 (file)
@@ -25,7 +25,7 @@
             
             
             <literal>src</literal> is the incoming color of the pixel.
-            <literal>prv</literal> is the previus color of the pixel (which is already drawn).
+            <literal>prv</literal> is the previous color of the pixel (which is already drawn).
             <literal>res</literal> is the resulting color of the pixel (which will be drawn).
             
             Possible values for <literal>pixel_drawing_mode</literal> are:
index 289d25b..79b6b33 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:lang="en" xml:id="square">
     <refnamediv>
         <refname>square</refname>
-        <refpurpose>set scales for isometric plot (change the size of the window)  </refpurpose>
+        <refpurpose>
+            set scales for isometric plot (change the size of the window)
+        </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>square(xmin,ymin,xmax,ymax)</synopsis>
+        <synopsis>square(xmin, ymin, xmax, ymax)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>xmin,xmax,ymin,ymax</term>
+                <term>xmin, xmax, ymin, ymax</term>
                 <listitem>
-                    <para>four real values</para>
+                    <para>four real values.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>square</literal> is used to have isometric scales on the x and y axes. 
-            The requested values 
-            <literal>xmin, xmax, ymin, ymax</literal> are the boundaries of the graphics frame
-            and <literal>square</literal> changes the graphics window dimensions in order to
-            have an isometric plot. <literal>square</literal> set the current graphics scales 
+            <function>square</function> is used to have isometric scales on the x
+            and y axes. The requested values <literal>xmin</literal>,
+            <literal>xmax</literal>, <literal>ymin</literal>,
+            <literal>ymax</literal> are the boundaries of the graphics frame
+            and <function>square</function> changes the graphics window
+            dimensions in order to have an isometric plot.
+            <function>square</function> sets the current graphics scales
             and can be used in conjunction with graphics routines which request
-            the current graphics scale (for instance <literal>fstrf="x0z"</literal> in <literal>plot2d</literal>).
+            the current graphics scale (for instance <code>strf="x0z"</code> in
+            <function>plot2d</function>).
         </para>
     </refsection>
     <refsection>
index 58480e3..a1917fd 100644 (file)
             <varlistentry>
                 <term>h</term>
                 <listitem>
-                    <para>handle of a graphics entity.</para>
+                    <para>a handle of a graphics entity.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>n</term>
                 <listitem>
-                    <para>integer.</para>
+                    <para>an integer.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -39,9 +39,9 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>twinkle</literal> let the graphics entity given by its handle <literal>h</literal> twinkle. It can be used to
+            <function>twinkle</function> let the graphics entity given by its handle <varname>h</varname> twinkle. It can be used to
             find the graphics object corresponding to a graphics handle in the graphics window. By default the graphics
-            entity twinkles 5 times, but you can change this by using optional argument <literal>n</literal>.
+            entity twinkles 5 times, but you can change this by using optional argument <varname>n</varname>.
         </para>
     </refsection>
     <refsection>
@@ -64,7 +64,7 @@ twinkle(gca())
         <title>See Also</title>
         <simplelist type="inline">
             <member>
-                <link linkend="graphics_entities">graphics_entities</link>
+                <link linkend="graphics_entities">graphics entities</link>
             </member>
         </simplelist>
     </refsection>
index 06c9556..d6361fe 100644 (file)
@@ -22,9 +22,9 @@
     <refsection>
         <title>Description</title>
         <para>
-            returns %t if scilab has it own window and %f if not, i.e.
-            if scilab has been invoked by "scilab -nw". (<literal>nw</literal> stands
-            for "no-window").
+            <code>havewindow()</code> returns <constant>%t</constant> if Scilab
+            has it own window and <constant>%f</constant> if not, i.e.
+            if Scilab has been invoked by <code>scilab -nw</code>. (<literal>nw</literal> stands for "no-window").
         </para>
     </refsection>
 </refentry>
index 08ba4c2..5a58eba 100644 (file)
@@ -33,8 +33,9 @@
     <refsection>
         <title>Description</title>
         <para>
-            With no parameters,<literal>show_window</literal>raises the current graphics window even if
-            it is iconified. Otherwise, raises the specified window by its number or handle.
+            With no parameters, <function>show_window</function>raises the
+            current graphics window even if it is iconified. Otherwise, raises
+            the specified window by its number or handle.
             If no window already exists, one is created.
         </para>
     </refsection>
index 8eea4d5..fb9af90 100644 (file)
@@ -17,7 +17,7 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>x=winsid()</synopsis>
+        <synopsis>x = winsid()</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
@@ -25,7 +25,7 @@
             <varlistentry>
                 <term>x</term>
                 <listitem>
-                    <para>row vector.</para>
+                    <para>a row vector.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>winsid</literal> is used to get the list of graphics windows as a vector
-            of windows numbers.
+            <function>winsid</function> is used to get the list of graphics
+            windows as a vector of windows numbers.
         </para>
     </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="close">xdel</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>
index 513265b..461e75e 100644 (file)
@@ -22,8 +22,8 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xbasr</literal> is used to redraw the content of the graphics
-            window with id <literal>win_num</literal>. It works only with the driver <literal>"Rec"</literal>.
+            <function>xbasr</function> is used to redraw the content of the graphics
+            window with id <varname>win_num</varname>. It works only with the driver <literal>"Rec"</literal>.
         </para>
     </refsection>
     <refsection role="see also">
index 9b01178..908ae8b 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>[x1,y1,rect]=xchange(x,y,dir)</synopsis>
+        <synopsis>[x1, y1, rect] = xchange(x, y, dir)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>x,y</term>
+                <term>x, y</term>
                 <listitem>
-                    <para>two matrices of size (n1,n2) (coordinates of a set of points).</para>
+                    <para>
+                        two matrices of size <literal>(n1, n2)</literal>
+                        (coordinates of a set of points).
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>dir</term>
                 <listitem>
-                    <para>parameter used to specify the conversion type (See "Description" for details)</para>
+                    <para>
+                        a string, parameter used to specify the conversion type
+                        (See "Description" for details).
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>x1,y1</term>
+                <term>x1, y1</term>
                 <listitem>
-                    <para>two matrices of size (n1,n2) (coordinates of the set of points).</para>
+                    <para>
+                        two matrices of size <literal>(n1, n2)</literal>
+                        (coordinates of the set of points).
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            After having used a graphics function, <literal>xchange</literal> computes pixel
-            coordinates from real coordinates and conversely, 
-            according to the value of the parameter <literal>dir</literal>:
-            "f2i" (float to int) means real to pixel and "i2f" (int to float)
-            means pixel to real.
-            <literal>x1</literal> and <literal>y1</literal> are the new coordinates of the set of points 
-            defined by the old coordinates <literal>x</literal> and <literal>y</literal>.
+            After having used a graphics function, <function>xchange</function>
+            computes pixel coordinates from real coordinates and conversely,
+            according to the value of the parameter <varname>dir</varname>:
+            <literal>"f2i"</literal> (float to int) means real to pixel and
+            <literal>"i2f"</literal> (int to float) means pixel to real.
+            <varname>x1</varname> and <varname>y1</varname> are the new
+            coordinates of the set of points defined by the old coordinates
+            <varname>x</varname> and <varname>y</varname>.
         </para>
         <para>
-            <literal>rect</literal> is the coordinates in pixel
-            of the rectangle in which the plot was done: [upper-left point,
-            width, height].
+            <varname>rect</varname> is the coordinates in pixel of the rectangle
+            in which the plot was done: <literal>[upper-left point, width, height]</literal>.
         </para>
     </refsection>
     <refsection>
index 684b073..4003c3a 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>xdel([win-nums])</synopsis>
+        <synopsis>xdel([win_nums])</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>win-nums</term>
+                <term>win_nums</term>
                 <listitem>
-                    <para>integer or integer vector</para>
+                    <para>an integer scalar or vector.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -33,8 +33,9 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xdel</literal> deletes the graphics windows <literal>win-nums</literal> or the current
-            graphics window if no argument is given.
+            <function>xdel</function> deletes the graphics windows
+            <varname>win_nums</varname> or the current graphics window if no
+            argument is given.
         </para>
     </refsection>
     <refsection>
@@ -56,6 +57,9 @@ xdel(); // delete the current figure
             <member>
                 <link linkend="delete">delete</link>
             </member>
+            <member>
+                <link linkend="winsid">winsid</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index 12569e2..b160173 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>[wrect,frect,logflag,arect]=xgetech()</synopsis>
+        <synopsis>[wrect, frect, logflag, arect] = xgetech()</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>wrect,frect</term>
+                <term>wrect, frect</term>
                 <listitem>
                     <para>real vectors.</para>
                 </listitem>
@@ -31,7 +31,7 @@
             <varlistentry>
                 <term>logflag</term>
                 <listitem>
-                    <para>string of size 2 "xy".</para>
+                    <para>string of size 2 <literal>"xy"</literal>.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xgetech</literal> returns the current graphics scale (of the current window). 
-            The rectangle [xmin,ymin,xmax,ymax] given by
-            <literal>frect</literal> is the size of the whole graphics window. 
-            The plotting will be made in the region of the current graphics window specified by <literal>wrect</literal>.
+            <function>xgetech</function> returns the current graphics scale (of
+            the current window). The rectangle <literal>[xmin, ymin, xmax,
+            ymax]</literal> given by <varname>frect</varname> is the size of the
+            whole graphics window. The plotting will be made in the region of
+            the current graphics window specified by <varname>wrect</varname>.
         </para>
         <para>
-            <literal>wrect=[x,y,w,h]</literal> (upper-left point, width, height) describes a region 
-            inside the graphics window. The values in <literal>wrect</literal> are specified using proportion
-            of the width and height of the graphics window:
+            <literal>wrect=[x, y, w, h]</literal> (upper-left point, width,
+            height) describes a region inside the graphics window. The values in
+            <varname>wrect</varname> are specified using proportion of the width
+            and height of the graphics window:
         </para>
         <para>
-            <literal>wrect=[0 0 1 1]</literal> means that the whole graphics window is used.
+            <literal>wrect=[0, 0, 1, 1]</literal> means that the whole graphics
+            window is used.
         </para>
         <para>
-            <literal>wrect=[0.5 0 0.5 1]</literal> means that the graphics region is the right 
-            half of the graphics window.
+            <literal>wrect=[0.5, 0, 0.5, 1]</literal> means that the graphics
+            region is the right half of the graphics window.
         </para>
         <para>
-            <literal>logflag</literal> is a string of size 2 "xy", where x and y can be "n" or "l". 
-            "n" stands for normal (linear) scale and "l" stands for logscale. x stands for the x-axis and y stands
-            for the y-axis.
+            <literal>logflag</literal> is a string of size 2
+            <literal>"xy"</literal>, where <literal>x</literal> and
+            <literal>y</literal> can be <literal>"n"</literal> or
+            <literal>"l"</literal>. <literal>"n"</literal> stands for normal (linear) scale and <literal>"l"</literal> stands for logscale.
+            <literal>x</literal> stands for the x-axis and <literal>y</literal>
+            stands for the y-axis.
         </para>
         <para>
-            <literal>arect=[x_left, x_right,y_up,y_down]</literal> gives the frame size
-            inside the subwindow. The graphic frame is specified (like <literal>wrect</literal>) 
-            using proportion of the width or height of the current graphic subwindow. 
-            Default value is <literal>1/8*[1,1,1,1]</literal>. If <literal>arect</literal> is not given, 
-            current value remains unchanged.
+            <literal>arect = [x_left, x_right, y_up, y_down]</literal> gives the
+            frame size inside the subwindow. The graphic frame is specified
+            (like <varname>wrect</varname>) using proportion of the width or
+            height of the current graphic subwindow. Default value is
+            <literal>1/8*[1,1,1,1]</literal>. If <varname>arect</varname> is not
+            given, current value remains unchanged.
         </para>
     </refsection>
     <refsection>
index 98b1d6f..9ac2056 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>[xi,xa,np1,np2,kMinr,kMaxr,ar]=xgraduate(xmi,xma)</synopsis>
+        <synopsis>
+            [xi, xa, np1, np2, kMinr, kMaxr, ar] = xgraduate(xmi, xma)
+        </synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>xmi,xma</term>
+                <term>xmi, xma</term>
                 <listitem>
-                    <para>real scalars</para>
+                    <para>real scalars.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>xi, xa, kMinr, kMaxr, ar</term>
                 <listitem>
-                    <para>real scalars</para>
+                    <para>real scalars.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>np1,np2</term>
+                <term>np1, np2</term>
                 <listitem>
-                    <para>integer</para>
+                    <para>integers.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xgraduate</literal> returns the axis graduations which are used by the plot
-            routines (with pretty print flag enabled). It returns an interval <literal>[xi,xa]</literal> which contains the
+            <function>xgraduate</function> returns the axis graduations which are
+            used by the plot routines (with pretty print flag enabled). It
+            returns an interval <literal>[xi, xa]</literal> which contains the
             given interval <literal>[xmi,xma]</literal> and such that
-        </para>
-        <para>
-            <literal>xi= kMinr*10^ar</literal>, <literal>xa=kMaxr*10^ar</literal> and the interval can 
-            be divided into <literal>np2</literal> intervals and each interval is divided in
-            <literal>np1</literal> sub-intervals.
+            <code>xi= kMinr*10^ar</code>, <code>xa=kMaxr*10^ar</code>
+            and the interval can be divided into <varname>np2</varname> intervals
+            and each interval is divided in <varname>np1</varname> sub-intervals.
         </para>
     </refsection>
     <refsection>
index ef1eea2..adeccb1 100644 (file)
@@ -25,7 +25,7 @@
             <varlistentry>
                 <term>style</term>
                 <listitem>
-                    <para>integer</para>
+                    <para>an integer.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -33,9 +33,9 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xgrid</literal> adds a grid on a 2D plot. <literal>style</literal> is the dash id
-            or the color id to use for the grid plotting. Use <literal>xset()</literal> for the
-            meaning of id.
+            <function>xgrid</function> adds a grid on a 2D plot.
+            <varname>style</varname> is the dash id or the color id to use for
+            the grid plotting. Use <code>xset()</code> for the meaning of id.
         </para>
     </refsection>
     <refsection>
@@ -43,7 +43,7 @@
         <programlisting role="example"><![CDATA[ 
 x=[0:0.1:2*%pi]';
 plot2d(sin(x))
-xgrid(2)
+xgrid(5)
  ]]></programlisting>
         <scilab:image>
             x=[0:0.1:2*%pi]';
index 40a9708..de60021 100644 (file)
@@ -33,7 +33,7 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xname</literal> changes the name of the current graphics window.
+            <function>xname</function> changes the name of the current graphics window.
         </para>
     </refsection>
     <refsection>
index 087e775..107c9f2 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>xnumb(x,y,nums,[box,angle])</synopsis>
+        <synopsis>xnumb(x, y, nums, [box, angle])</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>x,y,nums</term>
+                <term>x, y, nums</term>
                 <listitem>
                     <para>vectors of same size.</para>
                 </listitem>
             <varlistentry>
                 <term>box</term>
                 <listitem>
-                    <para>integer value.</para>
+                    <para>an integer value.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>angle</term>
                 <listitem>
                     <para>
-                        optional vector of same size as <literal>x</literal>
+                        an optional vector of same size as <varname>x</varname>
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xnumb</literal> draws the value of <literal>nums(i)</literal>
-            at position <literal>x(i),y(i)</literal> in the current scale.
-            If <literal>box</literal> is 1, a box is drawn around the numbers. 
-            If <literal>angle</literal> is given, it gives the direction for string drawing.
+            <function>xnumb</function> draws the value of <literal>nums(i)</literal>
+            at position <literal>x(i), y(i)</literal> in the current scale.
+            If <varname>box</varname> is 1, a box is drawn around the numbers.
+            If <varname>angle</varname> is given, it gives the direction for string drawing.
         </para>
     </refsection>
     <refsection>
index c77ad9a..aff43fe 100644 (file)
         <synopsis>xpause(microsecs)</synopsis>
     </refsynopsisdiv>
     <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>microsecs</term>
+                <listitem>
+                    <para>an integer, the number of microseconds.</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
         <title>Description</title>
         <para>
-            <literal>xpause</literal> suspends the current process for the number of microseconds
-            specified by the argument. The actual suspension time may
-            be longer because of other activities in
-            the system, or because of the time spent in processing the
-            call.
+            <function>xpause</function> suspends the current process for the
+            number of microseconds specified by the argument
+            <varname>microsecs</varname>. The actual suspension time may
+            be longer because of other activities in the system, or because of
+            the time spent in processing the call.
         </para>
     </refsection>
     <refsection>
@@ -39,7 +50,7 @@ f=gcf();f.pixmap='on';
 for h=0:0.1:1
   hsv=[h*ones(32,1) linspace(0,1,32)' 0.7*ones(32,1)];
   f.color_map=hsv2rgb(hsv);
-  show_pixmap()
+  drawnow()
   xpause(100000)
 end
  ]]></programlisting>
index dc77f1e..ca4a074 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:lang="en" xml:id="xsegs">
     <refnamediv>
         <refname>xsegs</refname>
-        <refpurpose>draw unconnected
-            segments
+        <refpurpose>
+            draw unconnected segments
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
         <synopsis>
-            xsegs(xv,yv,[style])
-            xsegs(xv,yv,zv,[style])
+            xsegs(xv, yv, [style])
+            xsegs(xv, yv, zv,[style])
         </synopsis>
     </refsynopsisdiv>
     <refsection>
@@ -32,7 +32,8 @@
                 <term>xv, yv, zv</term>
                 <listitem>
                     <para>
-                        matrices of the same size. If <literal>zv</literal> is not specified, a zero vector is used.
+                        matrices of the same size. If <varname>zv</varname> is
+                        not specified, a zero vector is used.
                     </para>
                 </listitem>
             </varlistentry>
                 <term>style</term>
                 <listitem>
                     <para>
-                        vector or scalar. If <literal>style</literal> is a positive scalar,
-                        it gives the color to use for all segments. If <literal>style</literal> is
-                        a negative scalar, then current color is used. If <literal>style</literal>
-                        is a vector, then <literal>style(i)</literal> gives the color to use for
-                        segment <literal>i</literal>.
+                        vector or scalar. If <varname>style</varname> is a
+                        positive scalar, it gives the color to use for all
+                        segments. If <varname>style</varname> is a negative
+                        scalar, then current color is used. If <varname>style</varname>
+                        is a vector, then <literal>style(i)</literal> gives the
+                        color to use for segment <literal>i</literal>.
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xsegs</literal> draws a set of unconnected segments given by
-            <literal>xv</literal>, <literal>yv</literal> and <literal>zv</literal>.
-            If <literal>xv</literal>, <literal>yv</literal> and <literal>zv</literal> are matrices they are considered as vectors by
-            concatenating their columns. The coordinates of the two points defining a
-            segment are given by two consecutive values of <literal>xv</literal>, <literal>yv</literal> and
-            <literal>zv</literal>:
+            <function>xsegs</function> draws a set of unconnected segments given
+            by <varname>xv</varname>, <varname>yv</varname> and
+            <varname>zv</varname>. If <varname>xv</varname>,
+            <varname>yv</varname> and <varname>zv</varname> are matrices they
+            are considered as vectors by concatenating their columns. The
+            coordinates of the two points defining a segment are given by two
+            consecutive values of <varname>xv</varname>, <varname>yv</varname>
+            and <varname>zv</varname>:
         </para>
         <para>
             <literal>(xv(i),yv(i),zv(i))--&gt;(xv(i+1),yv(i+1),zv(i+1))</literal>.
         </para>
-        <para>For instance, using matrices of size (2,n), the segments can be defined
-            by:
+        <para>
+            For instance, using matrices of size <literal>(2,n)</literal>, the
+            segments can be defined by:
         </para>
         <programlisting role="no-scilab-exec"><![CDATA[ 
 xv=[xi_1 xi_2 ...; xf_1 xf_2...]
@@ -78,7 +83,6 @@ zv=[zi_1 zi_2 ...; zf_1 zf_2...]
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[
-
 // 2D example
 x=2*%pi*(0:9)/10;
 xv=[sin(x);9*sin(x)];
@@ -94,7 +98,6 @@ xsegs(xv,yv,1:10)
             xsegs(xv,yv,1:10)
         </scilab:image>
         <programlisting role="example"><![CDATA[
-
 // 2D example
 plot2d([-10,10],[-10,10],[-1,-1],"022")
 xsegs([9, -9],[9 , -9]) // Draw the line from X(9,9) to Y(-9, -9)
index f0a5522..03e7b4f 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:lang="en" xml:id="xsetech">
     <refnamediv>
         <refname>xsetech</refname>
-        <refpurpose>set the sub-window of a graphics window for plotting</refpurpose>
+        <refpurpose>
+            set the sub-window of a graphics window for plotting
+        </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>xsetech(wrect,[frect,logflag])
-            xsetech(wrect=[...],frect=[..],logflag="..", arect=[...])
+        <synopsis>
+            xsetech(wrect, [frect, logflag])
+            xsetech(wrect=[...], frect=[..], logflag="..", arect=[...])
             xsetech()
         </synopsis>
     </refsynopsisdiv>
             <varlistentry>
                 <term>wrect</term>
                 <listitem>
-                    <para>vector of size 4, defining the sub-window to use.</para>
+                    <para>
+                        a vector of size 4, defining the sub-window to use.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>frect</term>
                 <listitem>
-                    <para>vector of size 4.</para>
+                    <para>
+                        a vector of size 4.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>logflag</term>
                 <listitem>
-                    <para>string of size 2 "xy", where x and y can be "n" or "l". "n" stands for  normal and "l" stands for logscale. x stands for the x-axis and y stands for the y-axis.</para>
+                    <para>
+                        a string of size 2 <literal>"xy"</literal>, where
+                        <literal>x</literal> and <literal>y</literal> can be
+                        <literal>"n"</literal> or <literal>"l"</literal>.
+                        <literal>"n"</literal> stands for  normal and "l" stands
+                        for logscale. <literal>x</literal> stands for the x-axis
+                        and <literal>y</literal> stands for the y-axis.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>arect</term>
                 <listitem>
-                    <para>vector of size 4.</para>
+                    <para>a vector of size 4.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xsetech</literal> is mainly used to set the sub-window of the graphics
-            window which will be used for plotting. The sub-window is specified
-            with the parameter <literal>wrect=[x,y,w,h]</literal> (upper-left point, width,
-            height).  The values in <literal>wrect</literal> are specified using proportion of
+            <function>xsetech</function> is mainly used to set the sub-window of
+            the graphics window which will be used for plotting. The sub-window
+            is specified with the parameter <literal>wrect=[x,y,w,h]</literal>
+            (upper-left point, width, height). The values in
+            <varname>wrect</varname> are specified using proportion of
             the width or height of the current graphic window. For instance
-            <literal>wrect=[0,0,1,1]</literal> means that the whole graphics window will be
-            used, and <literal>wrect=[0.5,0,0.5,1]</literal> means that the graphics region
-            will be the right half of the graphics window.
+            <literal>wrect=[0, 0, 1, 1]</literal> means that the whole graphics
+            window will be used, and <literal>wrect=[0.5, 0, 0.5, 1]</literal>
+            means that the graphics region will be the right half of the
+            graphics window.
         </para>
         <para>
-            <literal>xsetech</literal> also set the current graphics scales for 2D plotting and
-            can be used in conjunction with graphics routines which request the
-            current graphics scale (for instance <literal>strf="x0z"</literal>
-            or<literal>frameflag=0</literal> in <literal>plot2d</literal>).
+            <function>xsetech</function> also set the current graphics scales
+            for 2D plotting and can be used in conjunction with graphics
+            routines which request the current graphics scale (for instance
+            <literal>strf="x0z"</literal> or <literal>frameflag=0</literal> in
+            <function>plot2d</function>).
         </para>
         <para>
-            <literal>frect=[xmin,ymin,xmax,ymax]</literal> is used to set the graphics scale
-            and is just like the <literal>rect</literal> argument of <literal>plot2d</literal>. If
-            <literal>frect</literal> is not given the current value of the graphic scale
-            remains unchanged. the default value of <literal>rect</literal> is <literal>[0,0,1,1]</literal>
+            <literal>frect=[xmin, ymin, xmax, ymax]</literal> is used to set the
+            graphics scale and is just like the <varname>rect</varname> argument
+            of <function>plot2d</function>. If <varname>frect</varname> is not
+            given the current value of the graphic scale remains unchanged. the
+            default value of <varname>rect</varname> is <literal>[0,0,1,1]</literal>
             (at window creation, when switching back to default value with
-            <literal>xset('default')</literal> or when clearing graphic recorded events
-            <literal>clf()</literal>).
+            <code>xset('default')</code> or when clearing graphic recorded
+            events <code>clf()</code>).
         </para>
         <para>
-            <literal>arect=[x_left, x_right,y_up,y_down]</literal> is used to set the graphic
-            frame inside the subwindow. The graphic frame is specified (like
-            <literal>wrect</literal>) using proportion of the width or height of the current
-            graphic subwindow.  Default value is <literal>1/8*[1,1,1,1]</literal>. If
-            <literal>arect</literal> is not given, current value remains unchanged.
+            <literal>arect=[x_left, x_right,y_up,y_down]</literal> is used to
+            set the graphic frame inside the sub-window. The graphic frame is
+            specified (like <varname>wrect</varname>) using proportion of the
+            width or height of the current graphic sub-window.  Default value is
+            <literal>1/8*[1,1,1,1]</literal>. If <varname>arect</varname> is not
+            given, current value remains unchanged.
         </para>
     </refsection>
     <refsection>
 exec('SCI/modules/graphics/demos/xsetechfig.sce');
 
 // Here xsetech is used to split the graphics window in two parts 
-// first xsetech is used to set the first sub-window 
+// first xsetech is used to set the first sub-window
 // and the graphics scale 
 xsetech([0,0,1.0,0.5],[-5,-3,5,3])
 // we call plot2d with the "001" option to use the graphics scale 
 // set by xsetech 
 plot2d([1:10]',[1:10]',1,"001"," ")
-// then xsetech is used to set the second sub-window 
+// then xsetech is used to set the second sub-window
 xsetech([0,0.5,1.0,0.5])
 // the graphics scale is set by xsetech to [0,0,1,1] by default 
 // and we change it with the use of the rect argument in plot2d 
@@ -117,7 +136,7 @@ xsetech([0.5,0.5,0.5,0.5]);
 grayplot()
 xsetech([0,0.5,0.5,0.5]);
 histplot()
-// back to default values for the sub-window 
+// back to default values for the sub-window
 xsetech([0,0,1,1])
  ]]></programlisting>
         <scilab:image>