Revision of help pages for graphic_export (en_US). 46/10946/3
Stanislav KROTER [Fri, 22 Mar 2013 01:15:04 +0000 (07:15 +0600)]
Change-Id: I22d9546ca74b2dba9048909a64176716bce9f4c7

16 files changed:
scilab/modules/graphic_export/help/en_US/driver.xml
scilab/modules/graphic_export/help/en_US/xend.xml
scilab/modules/graphic_export/help/en_US/xinit.xml
scilab/modules/graphic_export/help/en_US/xs2bmp.xml
scilab/modules/graphic_export/help/en_US/xs2emf.xml
scilab/modules/graphic_export/help/en_US/xs2eps.xml
scilab/modules/graphic_export/help/en_US/xs2gif.xml
scilab/modules/graphic_export/help/en_US/xs2jpg.xml
scilab/modules/graphic_export/help/en_US/xs2pdf.xml
scilab/modules/graphic_export/help/en_US/xs2png.xml
scilab/modules/graphic_export/help/en_US/xs2ppm.xml
scilab/modules/graphic_export/help/en_US/xs2ps.xml
scilab/modules/graphic_export/help/en_US/xs2svg.xml
scilab/modules/helptools/images/hist3d_3.png
scilab/modules/helptools/images/hist3d_4.png
scilab/modules/helptools/images/hist3d_5.png

index 420c5b5..1c70e71 100644 (file)
@@ -3,7 +3,7 @@
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) ENPC - Jean-Philippe Chancelier
  * Copyright (C) - Scilab Enterprises - Clement David
- * 
+ *
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
  * you should have received as part of this distribution.  The terms
 <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="driver">
     <refnamediv>
         <refname>driver</refname>
-        <refpurpose>Select a graphics driver</refpurpose>
+        <refpurpose>select a graphics driver</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
         <synopsis>
-            current_driver=driver()
+            current_driver = driver()
             driver(driver_name)
             previous_driver = driver(driver_name)
         </synopsis>
             <varlistentry>
                 <term>driver_name</term>
                 <listitem>
-                    <para>string, driver to be selected (case insensitive).</para>
+                    <para>
+                        a string, driver to be selected (case insensitive).
+                    </para>
                 </listitem>
                 <term>current_driver</term>
                 <listitem>
-                    <para>string, selected driver.</para>
+                    <para>a string, selected driver.</para>
                 </listitem>
                 <term>previous_driver</term>
                 <listitem>
-                    <para>string, driver previously selected.</para>
+                    <para>a string, driver previously selected.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <para>This function provides a switch between the different drivers for export or display.</para>
-            <para>Direct rendering on the screen or off-screen export without any graphical user interface. This is available in the mode scilab-adv-cli (or also called -nw)</para>
-            <para>Used without any input argument, the driver function returns the current graphics driver name.</para>
+            This function provides a switch between the different
+            drivers for export or display.
+        </para>
+        <para>
+            Direct rendering on the screen or off-screen export
+            without any graphical user interface. This is available
+            in the mode <literal>scilab-adv-cli</literal> (or also
+            called <literal>-nw</literal>)
+        </para>
+        <para>
+            Used without any input argument, the <function>driver</function>
+            function returns the current graphics driver name.
         </para>
     </refsection>
     <refsection>
     <refsection>
         <title>Supported bitmap formats</title>
         <para>
-            The selected driver can be one of the following vectorial bitmap:
+            The selected driver can be one of the following vectorial
+            bitmap:
         </para>
         <variablelist>
             <varlistentry>
     <refsection>
         <title>Remark</title>
         <para>
-            To redirect the graphic output to a GIF file (which will be written in the current directory), you can use the following example:
+            To redirect the graphic output to a GIF file (which will be
+            written in the current directory), you can use the
+            following example:
         </para>
-        <programlisting role=""><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 previous_driver = driver('GIF');
 xinit(TMPDIR+'/mygiffile.gif');
 plot3d();
@@ -142,10 +156,12 @@ xend();
 driver(previous_driver); // Bring back the previous behavior of Scilab
  ]]></programlisting>
         <para>
-            For example if one has generated a sequence of GIF files named <literal>img*.gif</literal> it is possible to build an animated GIF file (named anim.gif) by
+            For example if one has generated a sequence of GIF files
+            named <literal>img*.gif</literal> it is possible to build
+            an animated GIF file (named <literal>anim.gif</literal>) by
         </para>
-        <programlisting role="no-scilab-exec"><![CDATA[ 
-convert -delay 10  img*.gif anim.gif  
+        <programlisting role="no-scilab-exec"><![CDATA[
+convert -delay 10  img*.gif anim.gif
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
@@ -166,12 +182,24 @@ convert -delay 10  img*.gif anim.gif
                 <revnumber>5.4.0</revnumber>
                 <revremark>
                     <itemizedlist>
-                        <listitem>Return the previous driver value.</listitem>
-                        <listitem>Enable off-screen. Scilab exports graphics without opening a new window.</listitem>
-                        <listitem>Support of new bitmap formats: PNG, JPEG and BMP.</listitem>
-                        <listitem>Support of new vectorial formats: PDF and SVG.</listitem>
-                        <listitem>The function accepts lower and upper case argument.</listitem>
-                        <listitem>Fig driver is no longer supported.</listitem>
+                        <listitem>
+                            Return the previous driver value.
+                        </listitem>
+                        <listitem>
+                            Enable off-screen. Scilab exports graphics without opening a new window.
+                        </listitem>
+                        <listitem>
+                            Support of new bitmap formats: PNG, JPEG and BMP.
+                        </listitem>
+                        <listitem>
+                            Support of new vectorial formats: PDF and SVG.
+                        </listitem>
+                        <listitem>
+                            The function accepts lower and upper case argument.
+                        </listitem>
+                        <listitem>
+                            Fig driver is no longer supported.
+                        </listitem>
                     </itemizedlist>
                 </revremark>
             </revision>
index 9a95d15..912335e 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="xend">
     <refnamediv>
         <refname>xend</refname>
-        <refpurpose>Close a graphics export session</refpurpose>
+        <refpurpose>close a graphics export session</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xend</literal> is used to close a graphics session. When working on the export of a graphic, <literal>xend</literal> closes the
-            file which was opened by <literal>xinit</literal>.
+            <function>xend</function> is used to close a graphics session. When working on the export of a graphic, <function>xend</function> closes the
+            file which was opened by <function>xinit</function>.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
+current_driver = driver()
 driver("Pos")
 xinit("foo.ps")
 plot2d()
 xend()
-driver("X11")
+driver(current_driver)
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
index e4629c7..ab9a0ab 100644 (file)
@@ -14,7 +14,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="xinit">
     <refnamediv>
         <refname>xinit</refname>
-        <refpurpose>Initialization of a graphics driver</refpurpose>
+        <refpurpose>initialization of a graphics driver</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
@@ -29,7 +29,7 @@
             <varlistentry>
                 <term>FileName</term>
                 <listitem>
-                    <para>string: name of the export file.</para>
+                    <para>a string: name of the export file.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            To export to a file, <literal>FileName</literal> must be specified. It is the name of the file where all the graphics operations are recorded.
+            To export to a file, <varname>FileName</varname> must be 
+            specified. It is the name of the file where all the graphics 
+            operations are recorded.
         </para>
         <para>
-            For screen drivers (X11 or Rec), <literal>xinit</literal> should be called without any argument and it will open an empty graphic window.
+            For screen drivers (X11 or Rec), <function>xinit</function> 
+            should be called without any argument and it will open an 
+            empty graphic window.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
+current_driver = driver()
 driver("Pos")
 xinit(TMPDIR+"/foo.ps")
 plot2d()
 xend()
-driver("X11")
+driver(current_driver)
  ]]></programlisting>
         <programlisting role="example"><![CDATA[ 
+current_driver = driver()
 driver("PNG")
 xinit(TMPDIR+"/foo.png")
 plot3d()
 xend()
-driver("X11")
+driver(current_driver)
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
index aa9cb61..ab8f4cf 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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xs2bmp" xml:lang="en">
     <refnamediv>
         <refname>xs2bmp</refname>
-        <refpurpose>Export graphics to BMP.</refpurpose>
+        <refpurpose>export graphics to BMP</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>xs2bmp(win_num, file_name)
+        <synopsis>
+            xs2bmp(win_num, file_name)
             xs2bmp(fig, file_name)
         </synopsis>
     </refsynopsisdiv>
@@ -27,7 +28,7 @@
             <varlistentry>
                 <term>win_num</term>
                 <listitem>
-                    <para>integer, id of the figure to export.</para>
+                    <para>an integer, id of the figure to export.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
@@ -39,7 +40,7 @@
             <varlistentry>
                 <term>file_name</term>
                 <listitem>
-                    <para>string, name of the exported file.</para>
+                    <para>a string, name of the exported file.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -47,7 +48,7 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xs2bmp</literal> exports the display of a graphic window into a BMP file.
+            <function>xs2bmp</function> exports the display of a graphic window into a BMP file.
         </para>
     </refsection>
     <refsection>
@@ -63,6 +64,12 @@ xs2bmp(0,'foo.bmp');
         <title>See Also</title>
         <simplelist type="inline">
             <member>
+                <link linkend="toprint">toprint</link>
+            </member>
+            <member>
+                <link linkend="printfigure">printfigure</link>
+            </member>
+            <member>
                 <link linkend="xs2gif">xs2gif</link>
             </member>
             <member>
index 57330c1..c29d2ff 100644 (file)
@@ -6,18 +6,19 @@
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
  * you should have received as part of this distribution.  The terms
- * are also available at    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xs2emf" xml:lang="en">
     <refnamediv>
         <refname>xs2emf</refname>
-        <refpurpose>Export graphics to EMF (Only under Windows).</refpurpose>
+        <refpurpose>export graphics to EMF (only under Windows)</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>xs2emf(win_num, file_name [,orientation])
+        <synopsis>
+            xs2emf(win_num, file_name [,orientation])
             xs2emf(fig, file_name [,orientation])
         </synopsis>
     </refsynopsisdiv>
@@ -27,7 +28,9 @@
             <varlistentry>
                 <term>win_num</term>
                 <listitem>
-                    <para>integer, id of the figure to export.</para>
+                    <para>
+                        an integer, ID of the figure to export.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
             <varlistentry>
                 <term>file_name</term>
                 <listitem>
-                    <para>string, name of the exported file.</para>
+                    <para>a string, name of the exported file.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>orientation</term>
                 <listitem>
-                    <para>optional character, with possible values 'portrait' or 'landscape'. The default value is 'portrait'.</para>
+                    <para>
+                        an optional string, with possible values <literal>'portrait'</literal> or <literal>'landscape'</literal>.
+                        The default value is <literal>'portrait'</literal>.
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xs2emf</literal> exports the display of a graphic window into an EMF file.
+            <function>xs2emf</function> exports the display of a graphic window into an EMF file.
         </para>
-        <para>The export file is obtained by creating an EPS file and converting it into EMF
-            format using pstoedit.
+        <para>
+            The export file is obtained by creating an EPS file and 
+            converting it into EMF format using <function>pstoedit</function>.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 if getos() == 'Windows' then
   scf(0);
   plot2d();
@@ -74,6 +81,12 @@ end
         <title>See Also</title>
         <simplelist type="inline">
             <member>
+                <link linkend="toprint">toprint</link>
+            </member>
+            <member>
+                <link linkend="printfigure">printfigure</link>
+            </member>
+            <member>
                 <link linkend="xs2bmp">xs2bmp</link>
             </member>
             <member>
index 7ce9a5d..8afb5a4 100644 (file)
@@ -6,18 +6,19 @@
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
  * you should have received as part of this distribution.  The terms
- * are also available at    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xs2eps" xml:lang="en">
     <refnamediv>
         <refname>xs2eps</refname>
-        <refpurpose>Export graphics to EPS.</refpurpose>
+        <refpurpose>export graphics to EPS</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>xs2eps(win_num, file_name [,orientation])
+        <synopsis>
+            xs2eps(win_num, file_name [,orientation])
             xs2eps(fig, file_name [,orientation])
         </synopsis>
     </refsynopsisdiv>
@@ -27,7 +28,7 @@
             <varlistentry>
                 <term>win_num</term>
                 <listitem>
-                    <para>integer, id of the figure to export.</para>
+                    <para>an integer, ID of the figure to export.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
             <varlistentry>
                 <term>file_name</term>
                 <listitem>
-                    <para>string, name of the exported file.</para>
+                    <para>a string, name of the exported file.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>orientation</term>
                 <listitem>
-                    <para>optional character, with possible values 'portrait' or
-                        'landscape'. The default value is 'portrait'.
+                    <para>
+                        an optional string, with possible values <literal>'portrait'</literal> or
+                        <literal>'landscape'</literal>. The default value is <literal>'portrait'</literal>.
                     </para>
                 </listitem>
             </varlistentry>
@@ -55,8 +57,8 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xs2eps</literal> exports the display of a graphic window
-            into a complete Encapsulated PostScript file.
+            <function>xs2eps</function> exports the display of a 
+            graphic window into a complete Encapsulated PostScript file.
         </para>
     </refsection>
     <refsection>
@@ -72,7 +74,7 @@ xs2eps(gcf(),'foo.eps')
     <refsection role="see also">
         <title>See Also</title>
         <simplelist type="inline">
-            <member>figure_size property</member>
+            <member><literal>figure_size</literal> property</member>
             <member>
                 <link linkend="toprint">toprint</link>
             </member>
index a116246..f93a043 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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xs2gif" xml:lang="en">
     <refnamediv>
         <refname>xs2gif</refname>
-        <refpurpose>Export graphics to GIF.</refpurpose>
+        <refpurpose>export graphics to GIF</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>xs2gif(win_num,file_name)
-            xs2gif(fig,file_name)
+        <synopsis>
+            xs2gif(win_num, file_name)
+            xs2gif(fig, file_name)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
@@ -27,7 +28,7 @@
             <varlistentry>
                 <term>win_num</term>
                 <listitem>
-                    <para>integer, id of the figure to export.</para>
+                    <para>an integer, ID of the figure to export.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
@@ -39,7 +40,7 @@
             <varlistentry>
                 <term>file_name</term>
                 <listitem>
-                    <para>string, name of the exported file.</para>
+                    <para>a string, name of the exported file.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
         <para>
             <literal>xs2gif</literal> exports the display of a graphic window into a GIF file.
         </para>
-        <para>To convert a sequence of "GIF" files to an animated GIF file one can
-            use the "convert" program for ImageMagic
-            (http://www.imagemagick.org/)
+        <para>
+            To convert a sequence of "GIF" files to an animated GIF
+            file one can use the "convert" program for ImageMagic
+            (<ulink url="http://www.imagemagick.org/">http://www.imagemagick.org/</ulink>)
         </para>
-        <para>For example if one has generated a sequence of Gif files named
-            <literal>img*.gif</literal> it is possible to build an animated Gif file
-            (named anim.gif) by
+        <para>
+            For example if one has generated a sequence of Gif files
+            named <literal>img*.gif</literal> it is possible to build
+            an animated Gif file (named anim.gif) by
         </para>
-        <programlisting role=""><![CDATA[ 
-convert -delay 10  img*.gif anim.gif  
- ]]></programlisting>
+        <synopsis>
+            convert -delay 10  img*.gif anim.gif
+        </synopsis>
     </refsection>
     <refsection>
         <title>Examples</title>
@@ -75,6 +78,12 @@ xs2gif(gcf(),'foo.gif');
         <title>See Also</title>
         <simplelist type="inline">
             <member>
+                <link linkend="toprint">toprint</link>
+            </member>
+            <member>
+                <link linkend="printfigure">printfigure</link>
+            </member>
+            <member>
                 <link linkend="xs2bmp">xs2bmp</link>
             </member>
             <member>
index 6161bca..9834fcb 100644 (file)
@@ -6,18 +6,19 @@
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
  * you should have received as part of this distribution.  The terms
- * are also available at    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xs2jpg" xml:lang="en">
     <refnamediv>
         <refname>xs2jpg</refname>
-        <refpurpose>Export graphics to JPG.</refpurpose>
+        <refpurpose>export graphics to JPG</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>xs2jpg(win_num, file_name [, compression_quality])
+        <synopsis>
+            xs2jpg(win_num, file_name [, compression_quality])
             xs2jpg(fig, file_name [, compression_quality])
         </synopsis>
     </refsynopsisdiv>
@@ -27,7 +28,9 @@
             <varlistentry>
                 <term>win_num</term>
                 <listitem>
-                    <para>integer, id of the figure to export.</para>
+                    <para>
+                        an integer, ID of the figure to export.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
             <varlistentry>
                 <term>file_name</term>
                 <listitem>
-                    <para>string, name of the exported file.</para>
+                    <para>a string, name of the exported file.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>compression_quality</term>
                 <listitem>
-                    <para>real, a number between 0 and 1 (best quality). The default compression quality is set to 0.95.</para>
-                    <para>Argument available since Scilab 5.3.2</para>
+                    <para>
+                        a real scalar, a number between 0 and 1 (best quality). The default compression quality is set to 0.95.
+                    </para>
+                    <note>
+                        Argument is available since Scilab 5.3.2.
+                    </note>
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -54,7 +61,7 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xs2jpg</literal> exports the display of a graphic window into a JPG file.
+            <function>xs2jpg</function> exports the display of a graphic window into a JPG file.
         </para>
     </refsection>
     <refsection>
@@ -73,6 +80,12 @@ xs2jpg(gcf(),'foo_1.jpg', 1); // best quality
         <title>See Also</title>
         <simplelist type="inline">
             <member>
+                <link linkend="toprint">toprint</link>
+            </member>
+            <member>
+                <link linkend="printfigure">printfigure</link>
+            </member>
+            <member>
                 <link linkend="xs2bmp">xs2bmp</link>
             </member>
             <member>
index fad0bf8..cdfcdf7 100644 (file)
@@ -17,7 +17,8 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>xs2pdf(win_num, file_name [,orientation])
+        <synopsis>
+            xs2pdf(win_num, file_name [,orientation])
             xs2pdf(fig, file_name [,orientation])
         </synopsis>
     </refsynopsisdiv>
@@ -27,7 +28,7 @@
             <varlistentry>
                 <term>win_num</term>
                 <listitem>
-                    <para>integer, id of the figure to export.</para>
+                    <para>an integer, ID of the figure to export.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
             <varlistentry>
                 <term>file_name</term>
                 <listitem>
-                    <para>string, name of the exported file.</para>
+                    <para>a string, name of the exported file.</para>
                     <para>If the extension is not provided, it is going to be automatically added.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>orientation</term>
                 <listitem>
-                    <para>optional character, with possible values 'portrait' or 'landscape'. The default value is 'portrait'.</para>
+                    <para>an optional string, with possible values <literal>'portrait'</literal> or <literal>'landscape'</literal>. The default value is <literal>'portrait'</literal>.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -54,7 +55,7 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xs2pdf</literal> exports the display of a graphic window into an PDF file.
+            <function>xs2pdf</function> exports the display of a graphic window into an PDF file.
         </para>
     </refsection>
     <refsection>
@@ -72,7 +73,7 @@ xs2pdf(gcf(),filename);
         <title>See Also</title>
         <simplelist type="inline">
             <member>
-                <link linkend="figure_properties">figure_size property</link>
+                <link linkend="figure_properties"><literal>figure_size</literal> property</link>
             </member>
             <member>
                 <link linkend="toprint">toprint</link>
index 3998851..580ed29 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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xs2png" xml:lang="en">
     <refnamediv>
         <refname>xs2png</refname>
-        <refpurpose>Export graphics to PNG.</refpurpose>
+        <refpurpose>export graphics to PNG</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>xs2png(win_num, file_name)
+        <synopsis>
+            xs2png(win_num, file_name)
             xs2png(fig, file_name)
         </synopsis>
     </refsynopsisdiv>
@@ -27,7 +28,7 @@
             <varlistentry>
                 <term>win_num</term>
                 <listitem>
-                    <para>integer, id of the figure to export.</para>
+                    <para>an integer, ID of the figure to export.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
@@ -39,7 +40,7 @@
             <varlistentry>
                 <term>file_name</term>
                 <listitem>
-                    <para>string, name of the exported file.</para>
+                    <para>a string, name of the exported file.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -47,7 +48,7 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xs2png</literal> exports the display of a graphic window into a PNG file.
+            <function>xs2png</function> exports the display of a graphic window into a PNG file.
         </para>
     </refsection>
     <refsection>
@@ -64,6 +65,12 @@ xs2png(gcf(),'foo.png');
         <title>See Also</title>
         <simplelist type="inline">
             <member>
+                <link linkend="toprint">toprint</link>
+            </member>
+            <member>
+                <link linkend="printfigure">printfigure</link>
+            </member>
+            <member>
                 <link linkend="xs2bmp">xs2bmp</link>
             </member>
             <member>
index 74bbd31..201eb9b 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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xs2ppm" xml:lang="en">
     <refnamediv>
         <refname>xs2ppm</refname>
-        <refpurpose>Export graphics to PPM.</refpurpose>
+        <refpurpose>export graphics to PPM</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>xs2ppm(win_num, file_name)
+        <synopsis>
+            xs2ppm(win_num, file_name)
             xs2ppm(fig, file_name)
         </synopsis>
     </refsynopsisdiv>
@@ -27,7 +28,7 @@
             <varlistentry>
                 <term>win_num</term>
                 <listitem>
-                    <para>integer, id of the figure to export.</para>
+                    <para>an integer, ID of the figure to export.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
@@ -39,7 +40,7 @@
             <varlistentry>
                 <term>file_name</term>
                 <listitem>
-                    <para>string, name of the exported file.</para>
+                    <para>a string, name of the exported file.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -47,7 +48,7 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xs2ppm</literal> exports the display of a graphic window into a PPM file.
+            <function>xs2ppm</function> exports the display of a graphic window into a PPM file.
         </para>
     </refsection>
     <refsection>
@@ -64,6 +65,12 @@ xs2ppm(0,filename);
         <title>See Also</title>
         <simplelist type="inline">
             <member>
+                <link linkend="toprint">toprint</link>
+            </member>
+            <member>
+                <link linkend="printfigure">printfigure</link>
+            </member>
+            <member>
                 <link linkend="xs2bmp">xs2bmp</link>
             </member>
             <member>
index f430032..5547b7f 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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xs2ps" xml:lang="en">
     <refnamediv>
         <refname>xs2ps</refname>
-        <refpurpose>Export graphics to PS.</refpurpose>
+        <refpurpose>export graphics to PS</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>xs2ps(win_num, file_name [,orientation])
+        <synopsis>
+            xs2ps(win_num, file_name [,orientation])
             xs2ps(fig, file_name [,orientation])
         </synopsis>
     </refsynopsisdiv>
@@ -27,7 +28,7 @@
             <varlistentry>
                 <term>win_num</term>
                 <listitem>
-                    <para>integer, id of the figure to export.</para>
+                    <para>an integer, ID of the figure to export.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
             <varlistentry>
                 <term>file_name</term>
                 <listitem>
-                    <para>string, name of the exported file.</para>
+                    <para>a string, name of the exported file.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>orientation</term>
                 <listitem>
-                    <para>optional character, with possible values 'portrait' or
-                        'landscape'. The default value is 'portrait'.
+                    <para>
+                        an optional string, with possible values 
+                        <literal>'portrait'</literal> or
+                        <literal>'landscape'</literal>. The default 
+                        value is <literal>'portrait'</literal>.
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xs2ps</literal> exports the display of a graphic window
-            into a PostScript file.
-        </para>
-        <para>Note that the generated Postscript file cannot be direcly printed
-            since it requires a header file. The function <literal>xs2eps</literal>
-            can be used to directly produce an encapsulated Postscript file with a
-            header.
+            <function>xs2ps</function> exports the display of a graphic 
+            window into a PostScript file.
         </para>
+        <note>
+            Note that the generated Postscript file cannot be directly 
+            printed since it requires a header file. The function 
+            <function>xs2eps</function> can be used to directly produce 
+            an encapsulated Postscript file with a header.
+        </note>
     </refsection>
     <refsection>
         <title>Examples</title>
@@ -77,7 +82,9 @@ xs2ps(0,filename);
     <refsection role="see also">
         <title>See Also</title>
         <simplelist type="inline">
-            <member>figure_size property</member>
+            <member>
+                <literal>figure_size</literal> property
+            </member>
             <member>
                 <link linkend="toprint">toprint</link>
             </member>
index 37fd1b6..29ebd05 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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xs2svg" xml:lang="en">
     <refnamediv>
         <refname>xs2svg</refname>
-        <refpurpose>Export graphics to SVG.</refpurpose>
+        <refpurpose>export graphics to SVG</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>xs2svg(win_num, file_name [,orientation])
+        <synopsis>
+            xs2svg(win_num, file_name [,orientation])
             xs2svg(fig, file_name [,orientation])
         </synopsis>
     </refsynopsisdiv>
@@ -27,7 +28,9 @@
             <varlistentry>
                 <term>win_num</term>
                 <listitem>
-                    <para>integer, id of the figure to export.</para>
+                    <para>
+                        an integer, ID of the figure to export.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
             <varlistentry>
                 <term>file_name</term>
                 <listitem>
-                    <para>string, name of the exported file.</para>
+                    <para>a string, name of the exported file.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>orientation</term>
                 <listitem>
-                    <para>optional character, with possible values 'portrait' or
-                        'landscape'. The default value is 'portrait'.
+                    <para>
+                        an optional string, with possible values 
+                        <literal>'portrait'</literal> or
+                        <literal>'landscape'</literal>. The default 
+                        value is <literal>'portrait'</literal>.
                     </para>
                 </listitem>
             </varlistentry>
@@ -55,7 +61,7 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xs2svg</literal> exports the display of a graphic window into a SVG file.
+            <function>xs2svg</function> exports the display of a graphic window into a SVG file.
         </para>
     </refsection>
     <refsection>
index 90d1b56..da12e6a 100644 (file)
Binary files a/scilab/modules/helptools/images/hist3d_3.png and b/scilab/modules/helptools/images/hist3d_3.png differ
index bedc5d4..a2f0f23 100644 (file)
Binary files a/scilab/modules/helptools/images/hist3d_4.png and b/scilab/modules/helptools/images/hist3d_4.png differ
index cd14ddf..ea0eb62 100644 (file)
Binary files a/scilab/modules/helptools/images/hist3d_5.png and b/scilab/modules/helptools/images/hist3d_5.png differ