[Plplot-cvs] SF.net SVN: plplot:[12516] trunk/doc/docbook/src/advanced.xml

[<ai...@us...>]

Revision: 12516
          http://sourceforge.net/p/plplot/code/12516
Author:   airwin
Date:     2013-09-23 18:24:27 +0000 (Mon, 23 Sep 2013)
Log Message:
-----------
Add section in advanced.xml concerning the pllegend and plcolorbar
capabilities.

Modified Paths:
--------------
    trunk/doc/docbook/src/advanced.xml

Modified: trunk/doc/docbook/src/advanced.xml
===================================================================
--- trunk/doc/docbook/src/advanced.xml	2013-09-22 10:01:44 UTC (rev 12515)
+++ trunk/doc/docbook/src/advanced.xml	2013-09-23 18:24:27 UTC (rev 12516)
@@ -2767,4 +2767,38 @@
     
   </sect1>
 
+  <sect1 id="legends">
+    <title>Legends and color bars</title>
+    <para>
+      The &pllegend; and &plcolorbar; routines are available in PLplot to
+      provide users with the capability of visually annotating their plots
+      with a legend (a series of patterned boxes, lines, or symbols with
+      associated explanatory UTF-8 text) or a color bar (an annotated
+      subplot representing a continuous range of colours within the main
+      plot and typically identifying certain colours with certain numerical
+      values using an axis). &pllegend; is useful for visually annotating
+      most two-dimensional plots.  See standard examples 4 and 26 for some
+      examples.  &plcolorbar; is especially useful for annotating continous
+      shade plots generated by &plshades;.  See standard example 16 for an
+      example.
+    </para>
+
+    <para>
+      The &pllegend; and &plcolorbar; routines provide the users complete
+      and convenient control of the size and position of the results on the
+      plot and also return size data that makes it straightforward to stack
+      different legend or colorbar results together on the plot (see
+      standard example 33 for an example of this capability).  Furthermore,
+      the &pllegend; and &plcolorbar; routines provide the user with many
+      different style possibilities for the results.  Because of all these
+      features, &pllegend; and &plcolorbar; have an extensive argument list.
+      So we recommend first-time users of &pllegend; and &plcolorbar; use
+      examples 4, 16, and 26 as a tutorial on how to use these PLplot
+      capabilities in a simple way, and for more advanced use we recommend
+      that users study the &pllegend; and &plcolorbar; documentation and
+      also example 33 which attempts to exercise most capabilities of these
+      two PLplot functions.
+    </para>
+  </sect1>
+    
 </chapter>

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.