Revision of help pages for some obsolete functions from module "graphics" (en_US).
[scilab.git] / scilab / modules / graphics / help / en_US / xset.xml
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>