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

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

Revision: 9156
          http://plplot.svn.sourceforge.net/plplot/?rev=9156&view=rev
Author:   airwin
Date:     2008-12-16 23:01:56 +0000 (Tue, 16 Dec 2008)

Log Message:
-----------
Correct and extend the plspage and plgpage documentation.

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

Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml	2008-12-16 22:27:09 UTC (rev 9155)
+++ trunk/doc/docbook/src/api.xml	2008-12-16 23:01:56 UTC (rev 9156)
@@ -4306,7 +4306,7 @@
     </para>
 
     <para>
-      Gets the current page configuration. The parameters are expressed
+      Gets the current page configuration. The length and offset values are expressed
       in units that are specific to the current driver. For instance:
       screen drivers will usually interpret them as number of pixels,
       whereas printer drivers will usually use mm.
@@ -4320,7 +4320,7 @@
 	</term>
 	<listitem>
 	  <para>
-	    Pointer to number of pixels in x.
+	    Pointer to number of pixels/inch (DPI), x.
 	  </para>
 	</listitem>
       </varlistentry>
@@ -4331,7 +4331,7 @@
 	</term>
 	<listitem>
 	  <para>
-	    Pointer to number of pixels in y.
+	    Pointer to number of pixels/inch (DPI) in y.
 	  </para>
 	</listitem>
       </varlistentry>
@@ -12054,10 +12054,15 @@
     </para>
 
     <para>
-      Sets the page configuration (optional).  Not all parameters are
+      Sets the page configuration (optional).  If an individual parameter
+      is zero then that parameter value is not updated.  Not all parameters are
       recognized by all drivers and the interpretation is device-dependent.
       The X-window driver uses the length and offset parameters to determine
-      the window size and location.  This routine, if used, must be called
+      the window size and location.  The length and offset values are expressed
+      in units that are specific to the current driver. For instance:
+      screen drivers will usually interpret them as number of pixels,
+      whereas printer drivers will usually use mm.
+      This routine, if used, must be called
       before initializing PLplot.
     </para>
 


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