Add missing revhistory part
[scilab.git] / scilab / modules / graphics / help / en_US / 2d_plot / scatter.xml
index 8298f31..5eb21ef 100644 (file)
@@ -18,8 +18,8 @@
     <refsynopsisdiv>
         <title>Calling Sequence</title>
         <synopsis>
-          p = scatter(x,y,&lt;s&gt;,&lt;c&gt;,&lt;"fill"&gt;,&lt;marker&gt;,&lt;marker_property,value&gt;)
-          p = scatter(&lt;axes_handle&gt;,...)
+            p = scatter(x,y,&lt;s&gt;,&lt;c&gt;,&lt;"fill"&gt;,&lt;marker&gt;,&lt;marker_property,value&gt;)
+            p = scatter(&lt;axes_handle&gt;,...)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
                         Marker types are specified by strings, see the table below.
                     </para>
                     <para>
-                    <informaltable border="1">
-                        <tr>
-                            <td>
-                                String
-                            </td>
-                            <td>
-                                Marker type
-                            </td>
-                        </tr>
-                        <tr>
-                            <td>
-                                <literal>"."</literal>
-                            </td>
-                            <td>Point</td>
-                        </tr>
-                        <tr>
-                            <td>
-                                <literal>"+"</literal>
-                            </td>
-                            <td>Plus sign</td>
-                        </tr>
-                        <tr>
-                            <td>
-                                <literal>"x"</literal>
-                            </td>
-                            <td>Cross</td>
-                        </tr>
-                        <tr>
-                            <td>
-                                <literal>"circle plus"</literal>
-                            </td>
-                            <td>Circle with plus</td>
-                        </tr>
-                        <tr>
-                            <td>
-                                <literal>"filled diamond"</literal>
-                            </td>
-                            <td>Filled diamond</td>
-                        </tr>
-                        <tr>
-                            <td>
-                                <literal>"d"</literal> or
-                                <literal>"diamond"</literal>
-                            </td>
-                            <td>Diamond</td>
-                        </tr>
-                        <tr>
-                            <td>
-                                <literal>"^"</literal>
-                            </td>
-                            <td>Upward-pointing triangle</td>
-                        </tr>
-                        <tr>
-                            <td>
-                                <literal>"v"</literal>
-                            </td>
-                            <td>Downward-pointing triangle</td>
-                        </tr>
-                        <tr>
-                            <td>
-                                <literal>"diamond plus"</literal>
-                            </td>
-                            <td>Diamond with plus</td>
-                        </tr>
-                        <tr>
-                            <td>
-                                <literal>"o"</literal>
-                            </td>
-                            <td>Circle (default)</td>
-                        </tr>
-                        <tr>
-                            <td>
-                                <literal>"*"</literal>
-                            </td>
-                            <td>Asterisk</td>
-                        </tr>
-                        <tr>
-                            <td>
-                                <literal>"s"</literal> or
-                                <literal>"square"</literal>
-                            </td>
-                            <td>Square</td>
-                        </tr>
-                        <tr>
-                            <td>
-                                <literal>"&gt;"</literal>
-                            </td>
-                            <td>Right-pointing triangle</td>
-                        </tr>
-                        <tr>
-                            <td>
-                                <literal>"&lt;"</literal>
-                            </td>
-                            <td>Left-pointing triangle</td>
-                        </tr>
-                        <tr>
-                            <td>
-                                <literal>"pentagram"</literal> or
-                                <literal>"p"</literal>
-                            </td>
-                            <td>Five-pointed star</td>
-                        </tr>
-                     </informaltable>
+                        <informaltable border="1">
+                            <tr>
+                                <td>
+                                    String
+                                </td>
+                                <td>
+                                    Marker type
+                                </td>
+                            </tr>
+                            <tr>
+                                <td>
+                                    <literal>"."</literal>
+                                </td>
+                                <td>Point</td>
+                            </tr>
+                            <tr>
+                                <td>
+                                    <literal>"+"</literal>
+                                </td>
+                                <td>Plus sign</td>
+                            </tr>
+                            <tr>
+                                <td>
+                                    <literal>"x"</literal>
+                                </td>
+                                <td>Cross</td>
+                            </tr>
+                            <tr>
+                                <td>
+                                    <literal>"circle plus"</literal>
+                                </td>
+                                <td>Circle with plus</td>
+                            </tr>
+                            <tr>
+                                <td>
+                                    <literal>"filled diamond"</literal>
+                                </td>
+                                <td>Filled diamond</td>
+                            </tr>
+                            <tr>
+                                <td>
+                                    <literal>"d"</literal> or
+                                    <literal>"diamond"</literal>
+                                </td>
+                                <td>Diamond</td>
+                            </tr>
+                            <tr>
+                                <td>
+                                    <literal>"^"</literal>
+                                </td>
+                                <td>Upward-pointing triangle</td>
+                            </tr>
+                            <tr>
+                                <td>
+                                    <literal>"v"</literal>
+                                </td>
+                                <td>Downward-pointing triangle</td>
+                            </tr>
+                            <tr>
+                                <td>
+                                    <literal>"diamond plus"</literal>
+                                </td>
+                                <td>Diamond with plus</td>
+                            </tr>
+                            <tr>
+                                <td>
+                                    <literal>"o"</literal>
+                                </td>
+                                <td>Circle (default)</td>
+                            </tr>
+                            <tr>
+                                <td>
+                                    <literal>"*"</literal>
+                                </td>
+                                <td>Asterisk</td>
+                            </tr>
+                            <tr>
+                                <td>
+                                    <literal>"s"</literal> or
+                                    <literal>"square"</literal>
+                                </td>
+                                <td>Square</td>
+                            </tr>
+                            <tr>
+                                <td>
+                                    <literal>"&gt;"</literal>
+                                </td>
+                                <td>Right-pointing triangle</td>
+                            </tr>
+                            <tr>
+                                <td>
+                                    <literal>"&lt;"</literal>
+                                </td>
+                                <td>Left-pointing triangle</td>
+                            </tr>
+                            <tr>
+                                <td>
+                                    <literal>"pentagram"</literal> or
+                                    <literal>"p"</literal>
+                                </td>
+                                <td>Five-pointed star</td>
+                            </tr>
+                        </informaltable>
                     </para>
                 </listitem>
             </varlistentry>
                 <term>&lt;marker_property,value&gt;</term>
                 <listitem>
                     <para>
-                         A sequence of property value pairs can be used to specify type, color and line width of the markers.
+                        A sequence of property value pairs can be used to specify type, color and line width of the markers.
                     </para>
                 </listitem>
             </varlistentry>
@@ -308,12 +308,12 @@ y = exp(-x).*cos(10*x) + 0.2*rand(1,length(x))
 scatter(x,y)
  ]]></programlisting>
         <scilab:image>
-x = linspace(0,2,200)
-y = exp(-x).*cos(10*x) + 0.2*rand(1,length(x))
-scatter(x,y)
+            x = linspace(0,2,200)
+            y = exp(-x).*cos(10*x) + 0.2*rand(1,length(x))
+            scatter(x,y)
         </scilab:image>
         <para>
-           Vary marker size
+            Vary marker size
         </para>
         <programlisting role="example"><![CDATA[
 // x and y initialisation
@@ -325,13 +325,13 @@ s = linspace(1,30,length(x))
 scatter(x,y,s)
  ]]></programlisting>
         <scilab:image>
-x = linspace(0,2,200)
-y = exp(-x).*cos(10*x) + 0.2*rand(1,length(x))
-s = linspace(1,30,length(x))
-scatter(x,y,s)
+            x = linspace(0,2,200)
+            y = exp(-x).*cos(10*x) + 0.2*rand(1,length(x))
+            s = linspace(1,30,length(x))
+            scatter(x,y,s)
         </scilab:image>
         <para>
-           Vary marker size and color
+            Vary marker size and color
         </para>
         <programlisting role="example"><![CDATA[
 // x and y initialisation
@@ -347,15 +347,15 @@ c = x
 scatter(x,y,s,c)
  ]]></programlisting>
         <scilab:image>
-x = linspace(0,2,200)
-y = exp(-x).*cos(10*x) + 0.2*rand(1,length(x))
-s = linspace(1,30,length(x))
-set(gcf(),"color_map",coolcolormap(64))
-c = x
-scatter(x,y,s,c)
+            x = linspace(0,2,200)
+            y = exp(-x).*cos(10*x) + 0.2*rand(1,length(x))
+            s = linspace(1,30,length(x))
+            set(gcf(),"color_map",coolcolormap(64))
+            c = x
+            scatter(x,y,s,c)
         </scilab:image>
         <para>
-           Fill the markers
+            Fill the markers
         </para>
         <programlisting role="example"><![CDATA[
 // x and y initialisation
@@ -371,12 +371,12 @@ c = y
 scatter(x,y,s,c,"fill")
  ]]></programlisting>
         <scilab:image>
-x = linspace(0,2,200)
-y = exp(-x).*cos(10*x) + 0.2*rand(1,length(x))
-s = linspace(1,30,length(x))
-set(gcf(),"color_map",coolcolormap(64))
-c = y
-scatter(x,y,s,c,"fill")
+            x = linspace(0,2,200)
+            y = exp(-x).*cos(10*x) + 0.2*rand(1,length(x))
+            s = linspace(1,30,length(x))
+            set(gcf(),"color_map",coolcolormap(64))
+            c = y
+            scatter(x,y,s,c,"fill")
         </scilab:image>
         <para>
             Specify marker symbol
@@ -389,9 +389,9 @@ y = rand(1,200)
 scatter(x,y,"d")
  ]]></programlisting>
         <scilab:image>
-x = rand(1,200)
-y = rand(1,200)
-scatter(x,y,"d")
+            x = rand(1,200)
+            y = rand(1,200)
+            scatter(x,y,"d")
         </scilab:image>
         <para>
             Change marker color and line width
@@ -406,9 +406,9 @@ scatter(x,y,"markerEdgeColor",[0 .4 .4],...
             "linewidth",1.5)
  ]]></programlisting>
         <scilab:image>
-x = rand(1,200)
-y = rand(1,200)
-scatter(x,y,"markerEdgeColor",[0 .4 .4],...
+            x = rand(1,200)
+            y = rand(1,200)
+            scatter(x,y,"markerEdgeColor",[0 .4 .4],...
             "markerFaceColor",[0 .8 .8],...
             "linewidth",1.5)
         </scilab:image>
@@ -427,12 +427,12 @@ subplot(2,1,2)
 scatter(gca(),x,y,"fill","s")
  ]]></programlisting>
         <scilab:image>
-x = linspace(0,2,100)
-y = exp(-x).*cos(10*x) + 0.2*rand(1,length(x))
-subplot(2,1,1)
-scatter(gca(),x,y)
-subplot(2,1,2)
-scatter(gca(),x,y,"fill","s")
+            x = linspace(0,2,100)
+            y = exp(-x).*cos(10*x) + 0.2*rand(1,length(x))
+            subplot(2,1,1)
+            scatter(gca(),x,y)
+            subplot(2,1,2)
+            scatter(gca(),x,y,"fill","s")
         </scilab:image>
         <para>
             Modify scatter plot after creation
@@ -446,10 +446,10 @@ y = t.*sin(10*%pi*t)
 p = scatter(x,y)
  ]]></programlisting>
         <scilab:image>
-t = linspace(0,25,200)
-x = t.*cos(t)
-y = t.*sin(t)
-p = scatter(x,y,t)
+            t = linspace(0,25,200)
+            x = t.*cos(t)
+            y = t.*sin(t)
+            p = scatter(x,y,t)
         </scilab:image>
         <programlisting role="example"><![CDATA[
 // modify ployline 
@@ -458,16 +458,16 @@ p.mark_foreground = addcolor(name2rgb("darkblue")/255)
 p.mark_background = addcolor(name2rgb("darkcyan")/255)
  ]]></programlisting>
         <scilab:image>
-t = linspace(0,25,200)
-x = t.*cos(t)
-y = t.*sin(t)
-p = scatter(x,y,t)
-p.thickness = 0.5
-p.mark_foreground = addcolor(name2rgb("darkblue")/255)
-p.mark_background = addcolor(name2rgb("darkcyan")/255)
+            t = linspace(0,25,200)
+            x = t.*cos(t)
+            y = t.*sin(t)
+            p = scatter(x,y,t)
+            p.thickness = 0.5
+            p.mark_foreground = addcolor(name2rgb("darkblue")/255)
+            p.mark_background = addcolor(name2rgb("darkcyan")/255)
         </scilab:image>
-      </refsection>
-      <refsection role="see also">
+    </refsection>
+    <refsection role="see also">
         <title>See Also</title>
         <simplelist type="inline">
             <member>
@@ -490,4 +490,15 @@ p.mark_background = addcolor(name2rgb("darkcyan")/255)
             </member>
         </simplelist>
     </refsection>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.6.0</revnumber>
+                <revremark>
+                    Function <function>scatter</function> introduced.
+                </revremark>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>