Permalink
Browse files

Document the export changes

Change-Id: Ie6a81524237cc32006c797da01a4d252e0d16889
  • Loading branch information...
1 parent 9bdf678 commit 680c1e89700950ab33520301a31ad59f2f590c8b @sylvestre sylvestre committed with Vincent COUVERT Apr 12, 2012
View
@@ -14,8 +14,14 @@ Graphic capabilities
- 2-D zoom using the mouse wheel,
- new 3-D zoom capabilities,
- rotation available through the mouse right-click.
- SciRenderer is a free and open-source library for 2D and 3D rendering of
- scientific data.
+ SciRenderer is a free and open-source library developed by Scilab Enterprises
+ for 2-D and 3-D rendering of scientific data.
+
+* Improved graphic exports:
+ - Off-screen export (Scilab will not open a window to export with driver).
+ - Support of new bitmap formats: PNG, JPEG and BMP in the driver function.
+ - Support of new vectorial formats: PDF and SVG in the driver function.
+ - Fix many portability issues.
GUI
===
@@ -16,12 +16,12 @@
</info>
<refnamediv>
<refname>driver</refname>
- <refpurpose> select a graphics driver</refpurpose>
+ <refpurpose>Select a graphics driver</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
- <synopsis>driver(driver_name)
- current_driver=driver()
+ <synopsis>current_driver=driver()
+ driver(driver_name)
</synopsis>
</refsynopsisdiv>
<refsection>
@@ -38,56 +38,102 @@
<refsection>
<title>Description</title>
<para>
- This function is used to select a graphics driver, or with no arguments
- to get the current graphics driver name.
- The selected driver can be one of the followings:
+ This function provides a switch between the different drivers.
+ Direct rendering on the screen or off-screen export without any graphical user interface.
+ Use without any input argument, the driver function returns the current graphics driver name.
+ </para>
+ </refsection>
+ <refsection>
+ <title>Screen output</title>
+ <para>
+ To display graphic into a new window instead of off-screen format. This is the default behavior of Scilab.
</para>
<variablelist>
<varlistentry>
- <term>"X11"</term>
+ <term>X11 or Rec</term>
<listitem>
<para>output to the screen of the computer.</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </refsection>
+
+ <refsection>
+ <title>Supported vectorial formats</title>
+ <para>
+ The selected driver can be one of the following vectorial format:
+ </para>
+ <variablelist>
+
<varlistentry>
- <term>"Pos"</term>
+ <term>Pos or ps</term>
<listitem>
<para>output into Postscript format.</para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term>"Rec"</term>
+ <term>PDF</term>
<listitem>
- <para>
- output to the screen of the computer. Same as <literal>X11</literal>.
- </para>
+ <para>output into PDF format.</para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term>"Fig"</term>
+ <term>SVG</term>
<listitem>
- <para>output into XFig format.</para>
+ <para>output into SVG format.</para>
</listitem>
</varlistentry>
+ </variablelist>
+ </refsection>
+
+ <refsection>
+ <title>Supported bitmap formats</title>
+ <para>
+ The selected driver can be one of the following vectorial bitmap:
+ </para>
+ <variablelist>
+
<varlistentry>
- <term>"GIF"</term>
+ <term>GIF</term>
<listitem>
- <para>output into Gif format.</para>
+ <para>output into GIF format.</para>
</listitem>
</varlistentry>
+
<varlistentry>
- <term>"PPM"</term>
+ <term>PNG</term>
<listitem>
- <para>output into PPM format.</para>
+ <para>output into PNG format.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>JPEG or JPG</term>
+ <listitem>
+ <para>output into JPEG format.</para>
+ </listitem>
+ </varlistentry>
+
+
+ <varlistentry>
+ <term>BMP</term>
+ <listitem>
+ <para>output into BMP format.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>PPM</term>
+ <listitem>
+ <para>output into portable pixmap format (PPM) format.</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Remark</title>
- <para>
- To convert "GIF" or "PPM" files to other image format or for building animation one can use the "convert" program for ImageMagic (http://www.imagemagick.org/)
- </para>
<para>
To redirect the graphic output to a GIF file (which will be written in the current directory), you can use the following example:
</para>
@@ -96,13 +142,31 @@ driver('GIF');
xinit('mygiffile.gif');
plot3d();
xend();
-driver('X11');
+driver('X11'); // Bring back the normal 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 anim.gif) by
</para>
- <programlisting role=""><![CDATA[
+ <programlisting role="no-scilab-exec"><![CDATA[
convert -delay 10 img*.gif anim.gif
]]></programlisting>
</refsection>
+ <refsection>
+ <title>History</title>
+ <revhistory>
+ <revision>
+ <revnumber>5.4.0</revnumber>
+ <revremark>
+ <itemizedlist>
+ <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>
+ </revhistory>
+ </refsection>
</refentry>
@@ -16,7 +16,7 @@
</info>
<refnamediv>
<refname>xend</refname>
- <refpurpose> close a graphics session</refpurpose>
+ <refpurpose>Close a graphics export session</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
@@ -25,8 +25,7 @@
<refsection>
<title>Description</title>
<para>
- <literal>xend</literal> is used to close a graphics session. Under the Postscript,
- Xfig or Gif drivers <literal>xend</literal> closes the
+ <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>.
</para>
</refsection>
@@ -40,12 +40,10 @@
<refsection>
<title>Description</title>
<para>
- For the Postscript, Xfig, Gif or PPM driver, <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, <literal>FileName</literal> 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
- opens an empty graphic window.
+ For screen drivers (X11 or Rec), <literal>xinit</literal> should be called without any argument and it will open an empty graphic window.
</para>
</refsection>
<refsection>

0 comments on commit 680c1e8

Please sign in to comment.