Revision of help pages for some obsolete functions from module "graphics" (en_US). 84/9884/1
Stanislav KROTER [Fri, 30 Nov 2012 08:26:12 +0000 (14:26 +0600)]
Change-Id: I7216380094b1107a26e1c858fcc1dc0d825e2c02

scilab/modules/graphics/help/en_US/window_control/xselect.xml
scilab/modules/graphics/help/en_US/xclear.xml
scilab/modules/graphics/help/en_US/xget.xml
scilab/modules/graphics/help/en_US/xset.xml
scilab/modules/graphics/help/en_US/xsetm.xml

index 26371de..0584b42 100644 (file)
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xselect</literal>raises the current graphics window.
+            <function>xselect</function> raises the current graphics window.
             It creates the window if none exists.
         </para>
         <para>
-            Warning: This function is obsolete and will be removed in Scilab 5.4.
-            It has been replaced by the show_window function.
+            <warning>
+                This function is obsolete and will be removed in Scilab 5.4.
+                It has been replaced by the show_window function.
+            </warning>
         </para>
     </refsection>
     <refsection role="see also">
index 5e18de0..db1ce55 100644 (file)
@@ -13,7 +13,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" xmlns:scilab="http://www.scilab.org"  xml:lang="en" xml:id="xclear">
     <refnamediv>
         <refname>xclear</refname>
-        <refpurpose>clears a graphics window</refpurpose>
+        <refpurpose>clears a graphics window. <emphasis role="bold">This function is obsolete.</emphasis></refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
@@ -25,7 +25,7 @@
             <varlistentry>
                 <term>window-id</term>
                 <listitem>
-                    <para>integer scalar or vector</para>
+                    <para>an integer scalar or vector.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            Without any argument, this function clears the current graphic figure by turning its visibility to 'off'.
-            Otherwise it clears the graphics figures whose numbers are included 
-            in the vector <literal>window-id</literal>. For example <literal>xclear(1:3)</literal> clears windows
-            1, 2 and 3.
-            If one of the windows does not 
+            Without any argument, this function clears the current graphic figure
+            by turning its visibility to <literal>'off'</literal>. Otherwise it
+            clears the graphics figures whose numbers are included in the vector
+            <varname>window-id</varname>. For example <code>xclear(1:3)</code>
+            clears windows 1, 2 and 3. If one of the windows does not
             exist, then it is automatically created.
         </para>
         <para>
-            Function <literal>xclear</literal> is obsolete.
-            To clear a figure, please use instead the <literal>clf</literal> function or the <literal>visible</literal> property.
+            <warning>
+                Function <function>xclear</function> is obsolete.
+            </warning>
+            To clear a figure, please use instead the <function>clf</function> function or the <literal>visible</literal> property.
         </para>
     </refsection>
     <refsection>
index d1fd0d2..58ce56f 100644 (file)
@@ -19,7 +19,8 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>[x1]=xget(str,[flag])
+        <synopsis>
+            [x1] = xget(str,[flag])
             xget()
         </synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Description</title>
         <para>
-            <emphasis role="bold">Warning this function is obsolete</emphasis>.
-            Use the Scilab graphic objetcs representation instead (see the <link linkend="set">set</link> and <link linkend="get">get</link> functions as
-            well as the <link linkend="graphics_entities">graphics_entities</link>
-            help page).
+            <warning>
+                This function is obsolete.
+            </warning>.
+            Use the Scilab graphic objects representation instead (see the <link
+            linkend="set">set</link> and <link linkend="get">get</link>
+            functions as well as the <link linkend="graphics_entities">graphics
+            entities</link> help page).
         </para>
-        <para>This function is used to get values from the graphics context on the
-            topic specified by the string <literal>str</literal>. When called with no
-            argument, a choice menu is created showing the current values and changes
-            can be performed through toggle buttons.
+        <para>
+            This function is used to get values from the graphics context on the
+            topic specified by the string <varname>str</varname>. When called
+            with no argument, a choice menu is created showing the current
+            values and changes can be performed through toggle buttons.
         </para>
         <variablelist>
             <varlistentry>
-                <term>str=xget("auto clear")</term>
+                <term>str = xget("auto clear")</term>
                 <listitem>
                     <para>
                         Get the auto clear status (<literal>"on"</literal> or
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>color=xget("background")</term>
+                <term>color = xget("background")</term>
                 <listitem>
-                    <para>Get the background color of the current Axes object.
-                        The result is a colormap index corresponding to the color.
+                    <para>
+                        Get the background color of the current
+                        <literal>Axes</literal> object. The result is a colormap
+                        index corresponding to the color.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>rect=xget("clipping")</term>
+                <term>rect = xget("clipping")</term>
                 <listitem>
-                    <para>Get the clipping zone as a rectangle rect=[x,y,w,h]
-                        (Upper-Left point Width Height).
+                    <para>
+                        Get the clipping zone as a rectangle <literal>rect =
+                        [x,y,w,h]</literal> (Upper-Left point, Width, Height).
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>c=xget("color")</term>
+                <term>c = xget("color")</term>
                 <listitem>
-                    <para>Get the default color for filling, line or text drawing
-                        functions. <literal>c</literal> is an integer projected in the
-                        interval [0,whiteid]. 0 stands for black filling and whiteid for
-                        white. The value of whiteid can be obtained with
-                        <literal>xget("white")</literal>.
+                    <para>
+                        Get the default color for filling, line or text drawing
+                        functions. <literal>c</literal> is an integer projected
+                        in the interval <literal>[0,whiteid]</literal>. 0 stands
+                        for black filling and <literal>whiteid</literal> for
+                        white. The value of <literal>whiteid</literal> can be
+                        obtained with <code>xget("white")</code>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>cmap=xget("colormap")</term>
+                <term>cmap = xget("colormap")</term>
                 <listitem>
-                    <para>Get the colormap used for the current graphics window as a m x
-                        3 RGB matrix.
+                    <para>
+                        Get the colormap used for the current graphics window as
+                        a <literal>m x 3</literal> RGB matrix.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>dash=xget("dashes")</term>
+                <term>dash = xget("dashes")</term>
                 <listitem>
-                    <para>Get the dash style dash=[dash_number] where dash_number is the
-                        id of the dash. This keyword is obsolete, please use
-                        <literal>xget("color")</literal> or <literal>xget("line
-                            style")
-                        </literal>
-                        instead.
+                    <para>
+                        Get the dash style <literal>dash = [dash_number]</literal>
+                        where <literal>dash_number</literal> is the id of the
+                        dash.
+                        <warning>
+                            This keyword is obsolete, please use
+                            <literal>xget("color")</literal> or
+                            <literal>xget("line style")</literal> instead.
+                        </warning>
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>font=xget("font")</term>
+                <term>font = xget("font")</term>
                 <listitem>
-                    <para>Get font=[fontid,fontsize], the default font and the default
-                        size for fonts. size.
+                    <para>
+                        Get <literal>font = [fontid, fontsize]</literal>, the
+                        default font and the default value of font size.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>fontsize=xget("font size")</term>
+                <term>fontsize = xget("font size")</term>
                 <listitem>
-                    <para>Get the default size for fonts size.</para>
+                    <para>Get the default value of font size.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>color=xget("foreground")</term>
+                <term>color = xget("foreground")</term>
                 <listitem>
-                    <para>Get the foreground color of the current Axes object.
-                        The result is a colormap index corresponding to the color.
+                    <para>
+                        Get the foreground color of the current
+                        <literal>Axes</literal> object. The result is a colormap index corresponding to the color.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>str=xget("fpf")</term>
+                <term>str = xget("fpf")</term>
                 <listitem>
-                    <para>Get the floating point format for number display in contour
-                        functions. Note that <literal>str</literal> is <literal>""</literal>
-                        when default format is used.
+                    <para>
+                        Get the floating point format for number display in
+                        contour functions. Note that <literal>str</literal> is <literal>""</literal> when default format is used.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>color=xget("hidden3d")</term>
+                <term>color = xget("hidden3d")</term>
                 <listitem>
-                    <para>Get the color number for hidden faces in plot3d.</para>
+                    <para>
+                        Get the color number for hidden faces in <function>plot3d</function>.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>pat=xget("lastpattern")</term>
+                <term>pat = xget("lastpattern")</term>
                 <listitem>
-                    <para>Get the id of the last available pattern or color, with the
-                        current colormap of the current window. In fact
-                        <literal>pat+1</literal> and <literal>pat+2</literal> are also
-                        available and stand respectively for black and white pattern.
+                    <para>
+                        Get the id of the last available pattern or color, with
+                        the current colormap of the current window. In fact
+                        <literal>pat+1</literal> and <literal>pat+2</literal>
+                        are also available and stand respectively for black and
+                        white pattern.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>type=xget("line mode")</term>
+                <term>type = xget("line mode")</term>
                 <listitem>
-                    <para>Get the line drawing mode. type=1 is absolute mode and type=0
-                        is relative mode. (Warning: the mode type=0 is has bugs)
+                    <para>
+                        Get the line drawing mode. <literal>type = 1</literal>
+                        is absolute mode and <literal>type = 0</literal> is
+                        relative mode.
+                        <warning>
+                            The mode <literal>type = 0</literal> has bugs.
+                        </warning>
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>xget("line style")</term>
                 <listitem>
-                    <para>Get the default line style (1: solid, &gt;1 for dashed
-                        lines).
+                    <para>
+                        Get the default line style (1 for solid line, &gt;1 for
+                        dashed lines).
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>mark=xget("mark")</term>
+                <term>mark = xget("mark")</term>
                 <listitem>
-                    <para>Get the default mark id and the default marks size.
-                        <literal>mark=[markid,marksize]</literal>.
+                    <para>
+                        Get the default mark id and the default mark size.
+                        <literal>mark=[markid, marksize]</literal>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>marksize=xget("mark size")</term>
+                <term>marksize = xget("mark size")</term>
                 <listitem>
-                    <para>Get the default marks size.</para>
+                    <para>Get the default mark size.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>pat=xget("pattern")</term>
+                <term>pat = xget("pattern")</term>
                 <listitem>
-                    <para>Get the current pattern or the current color.
+                    <para>
+                        Get the current pattern or the current color.
                         <literal>pat</literal> is an integer in the range
-                        <literal>[1,last]</literal>. When one uses black and white, 0 is
-                        used for black filling and <literal>last</literal> for white. The
-                        value of <literal>last</literal> can be obtained with
-                        <literal>xget("lastpattern")</literal>.
+                        <literal>[1, last]</literal>. When one uses black and
+                        white, 0 is used for black filling and
+                        <literal>last</literal> for white. The value of
+                        <literal>last</literal> can be obtained with
+                        <code>xget("lastpattern")</code>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>value=xget("thickness")</term>
+                <term>value = xget("thickness")</term>
                 <listitem>
-                    <para>Get the thickness of lines in pixel (0 and 1 have the same
-                        meaning: 1 pixel thick).
+                    <para>
+                        Get the thickness of lines in pixel (0 and 1 have the same meaning: 1 pixel thick).
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>flag=xget("use color")</term>
+                <term>flag = xget("use color")</term>
                 <listitem>
-                    <para>Get the flag 0 (use black and white) or 1 (use colors). See
-                        <literal>xset</literal>.
+                    <para>
+                        Get the flag 0 (use black and white) or 1 (use colors).
+                        See <function>xset</function>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>[x,y]=xget("viewport")</term>
+                <term>[x, y] = xget("viewport")</term>
                 <listitem>
-                    <para>Get the current postion of the visible part of graphics in the
-                        panner.
+                    <para>
+                        Get the current position of the visible part of graphics
+                        in the panner.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>dim=xget("wdim")</term>
+                <term>dim = xget("wdim")</term>
                 <listitem>
-                    <para>Get the width and the height of the current graphics window
-                        dim=[width,height].
+                    <para>
+                        Get the width and the height of the current graphics
+                        window <literal>dim = [width, height]</literal>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>win=xget("window")</term>
+                <term>win = xget("window")</term>
                 <listitem>
                     <para>
                         Get the current window number <literal>win</literal>.
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>pos=xget("wpos");</term>
+                <term>pos = xget("wpos")</term>
                 <listitem>
-                    <para>Get the position of the upper left point of the graphics
-                        window pos=[x,y].
+                    <para>
+                        Get the position of the upper left point of the graphics
+                        window <literal>pos = [x, y]</literal>.
                     </para>
                 </listitem>
             </varlistentry>
                 <link linkend="set">set</link>
             </member>
             <member>
-                <link linkend="graphics_entities">graphics_entities</link>
+                <link linkend="graphics_entities">graphics entities</link>
             </member>
         </simplelist>
     </refsection>
index 6efe2f3..a1bddec 100644 (file)
     <refnamediv>
         <refname>xset</refname>
         <refpurpose>
-            set values of the graphics context.<emphasis role="bold">This function is obsolete.</emphasis>
+            set values of the graphics context. <emphasis role="bold">This function is obsolete.</emphasis>
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>xset(choice-name,x1,x2,x3,x4,x5)
+        <synopsis>
+            xset(choice_name, x1, x2, x3, x4, x5)
             xset()
         </synopsis>
     </refsynopsisdiv>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>choice-name</term>
+                <term>choice_name</term>
                 <listitem>
                     <para>string</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>x1,...,x5</term>
+                <term>x1, ..., x5</term>
                 <listitem>
                     <para>
-                        depending on <literal>choice-name</literal>
+                        depending on <literal>choice_name</literal>.
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            <emphasis role="bold">Warning this function is obsolete.</emphasis>
-            Use the Scilab graphic objects representation
-            instead (see the
+            <warning>
+                This function is obsolete.
+            </warning>
+            Use the Scilab graphic objects representation instead (see the
             <link linkend="set">set</link> and <link linkend="get">get</link>
-            functions as well as the <link linkend="graphics_entities">graphics_entities</link> help
-            page).
+            functions as well as the <link linkend="graphics_entities">graphics
+            entities</link> help page).
         </para>
         <para>
-            <literal>xset</literal> is used to set default values of the current window
-            graphic context.
+            <function>xset</function> is used to set default values of the
+            current window graphic context.
         </para>
-        <para>When called no argument, a choice menu is created showing the current
-            values and changes can be performed through toggle buttons.
+        <para>
+            When called no argument, a choice menu is created showing the
+            current values and changes can be performed through toggle buttons.
         </para>
         <para>
-            Use <literal>xset()</literal> to display or set the current color, mark and
-            fonts used.
+            Use <code>xset()</code> to display or set the current color, mark
+            and fonts used.
         </para>
         <para/>
         <variablelist>
             <varlistentry>
                 <term>xset("auto clear","on"|"off")</term>
                 <listitem>
-                    <para>Switch "on" or "off" the auto clear mode for graphics. When the
-                        auto clear mode is "on", successive plots are not superposed, ie a
-                        <literal>clf()</literal> operation (the graphics window is cleared and the
-                        associated recorded graphics is erased) is performed before each high
-                        level graphics function. Default value is "off".
+                    <para>
+                        Switch <literal>"on"</literal> or <literal>"off"</literal>
+                        the auto clear mode for graphics. When the auto clear
+                        mode is <literal>"on"</literal>, successive plots are
+                        not superposed, i.e. a <code>clf()</code> operation (the
+                        graphics window is cleared and the associated recorded
+                        graphics is erased) is performed before each high
+                        level graphics function. Default value is <literal>"off"</literal>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>xset("background",color)</term>
                 <listitem>
-                    <para>Set the background color of the current Axes object.
-                        The <literal>color</literal> argument is the colormap index of the color to use.
+                    <para>
+                        Set the background color of the current <literal>Axes</literal>
+                        object. The <literal>color</literal> argument is the
+                        colormap index of the color to use.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("clipping",x,y,w,h)</term>
+                <term>xset("clipping", x, y, w, h)</term>
                 <listitem>
-                    <para>Set the clipping zone (the zone of the graphics window where
-                        plots can be drawn) to the rectangle (x,y,w,h) (Upper-Left point Width
-                        Height). This function uses the current coordinates of the plot.
+                    <para>
+                        Set the clipping zone (the zone of the graphics window
+                        where plots can be drawn) to the rectangle
+                        <literal>(x,y,w,h)</literal> (Upper-Left point, Width,
+                        Height). This function uses the current coordinates of
+                        the plot.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>xset("color",value)</term>
                 <listitem>
-                    <para>Set the default color for filling, line or text drawing
-                        functions. <literal>value</literal> is an integer projected in the interval
-                        [0,whiteid]. 0 is used for black filling and whiteid for white. The
-                        value of whiteid can be obtained with <literal>xget("white")</literal>.
+                    <para>
+                        Set the default color for filling, line or text drawing
+                        functions. <literal>value</literal> is an integer
+                        projected in the interval <literal>[0,whiteid]</literal>.
+                        0 is used for black filling and <literal>whiteid</literal> for white. The
+                        value of <literal>whiteid</literal> can be obtained with <code>xget("white")</code>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>xset("colormap",cmap)</term>
                 <listitem>
-                    <para>Set the colormap as a m x 3 matrix. m is the number of colors.
-                        Color number i is given as a 3-uple cmap(i,1), cmap(i,2), cmap(i,3)
-                        corresponding respectively to red, green and blue intensity between 0
-                        and 1.
+                    <para>
+                        Set the colormap as a <literal>m x 3</literal> matrix,
+                        where <literal>m</literal> is the number of colors.
+                        Color number <literal>i</literal> is given as a 3-uple
+                        <literal>cmap(i,1)</literal>, <literal>cmap(i,2)</literal>,
+                        <literal>cmap(i,3)</literal>  corresponding respectively
+                        to red, green and blue intensity between 0 and 1.
                     </para>
                 </listitem>
             </varlistentry>
                 <term>xset("dashes",i)</term>
                 <listitem>
                     <para>
-                        In black and white mode (<literal>xset("use color",0)</literal>), set
-                        the dash style to style i (0 for solid line). In color mode
-                        (<literal>xset("use color",1 )</literal>) this is used to set line, mark and
-                        text color. This keyword is obsolete, please use
-                        <literal>xset('color',i)</literal> or <literal>xset('line style',i)</literal>
-                        instead.
+                        In black and white mode (<code>xset("use color",0)</code>),
+                        set the dash style to style <literal>i</literal> (0 for
+                        solid line). In color mode (<code>xset("use color",1)</code>)
+                        this is used to set line, mark and text color.
+                        <warning>
+                            This keyword is obsolete, please use
+                            <literal>xset('color',i)</literal> or
+                            <literal>xset('line style',i)</literal> instead.
+                        </warning>
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
+                <term>xset("default")</term>
                 <listitem>
-                    <para>Reset the graphics context to default values.</para>
+                    <para>
+                        Reset the graphics context to default values.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("font",fontid,fontsize) : Set the current font and its current</term>
+                <term>xset("font", fontid, fontsize):</term>
                 <listitem>
                     <para>
-                        size. Note that <literal>fontsize</literal> applies to all fonts not
-                        only <literal>fontid</literal> .
+                         Set the current font and its current size. Note that
+                         <literal>fontsize</literal> applies to all fonts not
+                        only <literal>fontid</literal>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("font size",fontsize)</term>
+                <term>xset("font size", fontsize)</term>
                 <listitem>
                     <para>Set the fonts size.</para>
                 </listitem>
             <varlistentry>
                 <term>xset("foreground",color)</term>
                 <listitem>
-                    <para>Set the foreground color of the current Axes object.
-                        The <literal>color</literal> argument is the colormap index of the color to use.
+                    <para>
+                        Set the foreground color of the current <literal>Axes</literal>
+                        object. The <literal>color</literal> argument is the
+                        colormap index of the color to use.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("fpf",string)</term>
+                <term>xset("fpf", string)</term>
                 <listitem>
-                    <para>Set the floating point format for number display in contour
-                        functions. <literal>string</literal> is a string giving the format in C
-                        format syntax (for example <literal>string="%.3f"</literal>). Use
-                        <literal>string=""</literal> to switch back to default format.
+                    <para>
+                        Set the floating point format for number display in
+                        contour functions. <literal>string</literal> is a string
+                        giving the format in C format syntax (for example
+                        <code>string="%.3f"</code>). Use
+                        <code>string=""</code> to switch back to default format.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("hidden3d",colorid) : Set the color number for backward facing faces in</term>
+                <term>xset("hidden3d", colorid): </term>
                 <listitem>
                     <para>
-                        <literal>plot3d</literal>. <literal>colorid=0</literal> zero suppress the
-                        drawing of backward facing faces of 3d objects. This is technically
-                        called 'culling' and speeds up the rendering of closed surfaces.
+                        Set the color number for backward facing faces in
+                        <function>plot3d</function>. <literal>colorid=0</literal>
+                        zero suppress the drawing of backward facing faces of 3d
+                        objects. This is technically called 'culling' and speeds
+                        up the rendering of closed surfaces.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("line mode",type)</term>
+                <term>xset("line mode", type)</term>
                 <listitem>
-                    <para>This function is used to set the line drawing mode. Absolute
-                        mode is set with type=1 and relative mode with type=0. (Warning: the
-                        mode type=0 has bugs)
+                    <para>
+                        This function is used to set the line drawing mode.
+                        Absolute mode is set with <literal>type=1</literal> and
+                        relative mode with type=0.
+                        <warning>The mode type=0 has bugs.</warning>
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("line style",value)</term>
+                <term>xset("line style", value)</term>
                 <listitem>
-                    <para>Set the current line style (1: solid, &gt;1 for dashed
-                        lines).
+                    <para>
+                        Set the current line style (1 for solid, &gt;1 for
+                        dashed lines).
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("mark",markid,marksize)</term>
+                <term>xset("mark", markid, marksize)</term>
                 <listitem>
-                    <para>Set the current mark and the current mark size. Use
-                        <literal>xset()</literal> to see the marks. Note that <literal>marksize</literal>
-                        applies to all marks not only <literal>markid</literal> .
+                    <para>
+                        Set the current mark and the current mark size. Use
+                        <code>xset()</code> to see the marks. Note that
+                        <literal>marksize</literal> applies to all marks not
+                        only <literal>markid</literal>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("mark size",marksize)</term>
+                <term>xset("mark size", marksize)</term>
                 <listitem>
-                    <para>Set the marks size.</para>
+                    <para>Set the mark size.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("pattern",value)</term>
+                <term>xset("pattern", value)</term>
                 <listitem>
-                    <para>Set the current pattern for filling functions. value is an
-                        integer projected in the interval [0,whiteid]. 0 is used for black
-                        filling and whiteid for white. The value of whiteid can be obtained
-                        with <literal>xget("white")</literal>. "pattern" is equivalent to
-                        "color".
+                    <para>
+                        Set the current pattern for filling functions. value is
+                        an integer projected in the interval
+                        <literal>[0,whiteid]</literal>. 0 is used for black
+                        filling and <literal>whiteid</literal> for white. The
+                        value of <literal>whiteid</literal> can be obtained
+                        with <code>xget("white")</code>.
+                        <literal>"pattern"</literal> is equivalent to
+                        <literal>"color"</literal>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("pixmap",flag)</term>
+                <term>xset("pixmap", flag)</term>
                 <listitem>
-                    <para>If flag=0 the graphics are directly displayed on the screen. If
-                        flag=1 the graphics are done on a pixmap and are sent to the graphics
-                        window with the command <literal>xset("wshow")</literal>. The pixmap is
-                        cleared with the command <literal>xset("wwpc")</literal>. Note that the
-                        usual command <literal>clf()</literal> also clears the pixmap.
+                    <para>
+                        If <literal>flag=0</literal> the graphics are directly
+                        displayed on the screen. If <literal>flag=1</literal>
+                        the graphics are done on a pixmap and are sent to the
+                        graphics window with the command
+                        <code>xset("wshow")</code>. The pixmap is cleared with
+                        the command <code>xset("wwpc")</code>. Note that the
+                        usual command <code>clf()</code> also clears the pixmap.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("thickness",value)</term>
+                <term>xset("thickness", value)</term>
                 <listitem>
-                    <para>Set the thickness of lines in pixel (0 and 1 have the same
-                        meaning: 1 pixel thick).
+                    <para>
+                        Set the thickness of lines in pixel (0 and 1 have the
+                        same meaning: 1 pixel thick).
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("use color",flag)</term>
+                <term>xset("use color", flag)</term>
                 <listitem>
                     <para>
-                        If flag=1 then <literal>xset("pattern",.)</literal> or
-                        <literal>xset("dashes",.)</literal> will be used so as to change the default
-                        color for drawing or for filling patterns. If flag=0 then we switch
+                        If <literal>flag=1</literal> then <code>xset("pattern", 1)</code> or
+                        <code>xset("dashes", 1)</code> will be used so as to
+                        change the default color for drawing or for filling
+                        patterns. If <literal>flag=0</literal> then we switch
                         back to the gray and dashes mode.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("viewport",x,y)</term>
+                <term>xset("viewport", x, y)</term>
                 <listitem>
                     <para>Set the position of the panner.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("wdim",width,height)</term>
+                <term>xset("wdim", width, height)</term>
                 <listitem>
-                    <para>Set the width and the height of the current graphics window.
-                        This option is not used by the postscript driver.
+                    <para>
+                        Set the width and the height of the current graphics
+                        window. This option is not used by the postscript
+                        driver.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("wpdim",width,height)</term>
+                <term>xset("wpdim", width, height)</term>
                 <listitem>
-                    <para>Sets the width and the height of the current physical graphic
-                        window (which can be different from the actual size in mode wresize
-                        1). This option is not used by the postscript driver.
+                    <para>
+                        Sets the width and the height of the current physical
+                        graphic window (which can be different from the actual
+                        size in mode <literal>wresize</literal> 1). This option
+                        is not used by the postscript driver.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("window",window-number)</term>
+                <term>xset("window", window_number)</term>
                 <listitem>
                     <para>
-                        Set the current window to the window <literal>window-number</literal>
+                        Set the current window to the window <literal>window_number</literal>
                         and creates the window if it does not exist.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>xset("wpos",x,y)</term>
+                <term>xset("wpos", x, y)</term>
                 <listitem>
-                    <para>Set the position of the upper left point of the graphics
+                    <para>
+                        Set the position of the upper left point of the graphics
                         window.
                     </para>
                 </listitem>
             <varlistentry>
                 <term>xset("wresize",flag)</term>
                 <listitem>
-                    <para>If flag=1 then the graphic is automatically resized to fill the
-                        graphics window.
+                    <para>
+                        If <literal>flag=1</literal> then the graphic is
+                        automatically resized to fill the graphics window.
                     </para>
                     <programlisting role=""><![CDATA[
 xdel();
@@ -299,9 +348,10 @@ xset("wresize",1);
 plot2d();
 xset("wdim",1000,500)
  ]]></programlisting>
-                    <para>If flag=0 the scale of the graphic is left unchanged when the
-                        graphics window is resized. Top left panner or keyboard arrows may be
-                        used to scroll over the graphic.
+                    <para>
+                        If flag=0 the scale of the graphic is left unchanged
+                        when the graphics window is resized. Top left panner or
+                        keyboard arrows may be used to scroll over the graphic.
                     </para>
                     <programlisting role=""><![CDATA[
 xdel();
@@ -315,7 +365,7 @@ xset("wdim",1000,500)
                 <term>xset("wshow")</term>
                 <listitem>
                     <para>
-                        See <literal>xset("pixmap",1)</literal> above.
+                        See <literal>xset("pixmap", 1)</literal> above.
                     </para>
                 </listitem>
             </varlistentry>
@@ -323,7 +373,7 @@ xset("wdim",1000,500)
                 <term>xset("wwpc")</term>
                 <listitem>
                     <para>
-                        See <literal>xset("pixmap",1)</literal> above.
+                        See <literal>xset("pixmap", 1)</literal> above.
                     </para>
                 </listitem>
             </varlistentry>
@@ -348,7 +398,7 @@ xset("wdim",1000,500)
                 <link linkend="set">set</link>
             </member>
             <member>
-                <link linkend="graphics_entities">graphics_entities</link>
+                <link linkend="graphics_entities">graphics entities</link>
             </member>
         </simplelist>
     </refsection>
index e0ff560..b8ae08b 100644 (file)
     <refsection>
         <title>Description</title>
         <para>
-            This function as well as the <link linkend="xset">xset</link> one
-            was strongly linked with the old graphic mode which is no more available.
+            <warning>
+                This function is obsolete. This function as well as the <link
+                linkend="xset">xset</link> one was strongly linked with the old
+                graphic mode which is no more available.
+            </warning>
             The current graphic is much more flexible with respect to parameter
-            setting (see the <link linkend="set">set</link> and <link linkend="get">get</link> functions as well as the <link linkend="graphics_entities">graphics_entities</link> help page). It is
-            possible to start a more convenient property editor using <link linkend="ged">ged</link>.
+            setting (see the <link linkend="set">set</link> and <link
+            linkend="get">get</link> functions as well as the <link
+            linkend="graphics_entities">graphics entities</link> help page). It
+            is possible to start a more convenient property editor using <link
+            linkend="ged">ged</link>.
         </para>
     </refsection>
     <refsection role="see also">
@@ -44,7 +50,7 @@
                 <link linkend="set">set</link>
             </member>
             <member>
-                <link linkend="graphics_entities">graphics_entities</link>
+                <link linkend="graphics_entities">graphics entities</link>
             </member>
         </simplelist>
     </refsection>