plplot-cvs — For PLplot svn commit messages

[Plplot-cvs] SF.net SVN: plplot:[12514] trunk/src/pllegend.c

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

Revision: 12514
          http://sourceforge.net/p/plplot/code/12514
Author:   airwin
Date:     2013-09-22 05:46:07 +0000 (Sun, 22 Sep 2013)
Log Message:
-----------
Implement sanity check that plcolorbar caller does not specify NULL
array pointers for one of the label_opts or labels arrays when
n_labels > 0.

Modified Paths:
--------------
    trunk/src/pllegend.c

Modified: trunk/src/pllegend.c
===================================================================
--- trunk/src/pllegend.c	2013-09-22 02:20:12 UTC (rev 12513)
+++ trunk/src/pllegend.c	2013-09-22 05:46:07 UTC (rev 12514)
@@ -1659,6 +1659,13 @@
         return;
     }
 
+    // Sanity check for NULL label arrays.
+    if ( n_labels > 0 && ( label_opts == NULL || labels == NULL ) )
+    {
+        plabort( "plcolorbar: label_opts and labels arrays must be defined when n_labels > 0." );
+        return;
+    }
+
     if ( n_axes < 1 )
     {
         plabort( "plcolorbar: At least one axis must be specified" );

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

[Plplot-cvs] SF.net SVN: plplot:[12513] trunk/drivers/cairo.c

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

Revision: 12513
          http://sourceforge.net/p/plplot/code/12513
Author:   airwin
Date:     2013-09-22 02:20:12 +0000 (Sun, 22 Sep 2013)
Log Message:
-----------
Style a previous commit.

Modified Paths:
--------------
    trunk/drivers/cairo.c

Modified: trunk/drivers/cairo.c
===================================================================
--- trunk/drivers/cairo.c	2013-09-22 02:19:29 UTC (rev 12512)
+++ trunk/drivers/cairo.c	2013-09-22 02:20:12 UTC (rev 12513)
@@ -1922,10 +1922,10 @@
     {
         // X Windows setup
         aStream->XDisplay = NULL;
-	if (pls->FileName != NULL) 
-	  aStream->XDisplay = XOpenDisplay( pls->FileName );
-	else
-	  aStream->XDisplay = XOpenDisplay( NULL );
+        if ( pls->FileName != NULL )
+            aStream->XDisplay = XOpenDisplay( pls->FileName );
+        else
+            aStream->XDisplay = XOpenDisplay( NULL );
         if ( aStream->XDisplay == NULL )
         {
             plexit( "Failed to open X Windows display\n" );

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

[Plplot-cvs] SF.net SVN: plplot:[12512] trunk

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

Revision: 12512
          http://sourceforge.net/p/plplot/code/12512
Author:   airwin
Date:     2013-09-22 02:19:29 +0000 (Sun, 22 Sep 2013)
Log Message:
-----------
Style a previous commit.

Modified Paths:
--------------
    trunk/bindings/d/plplot.d
    trunk/examples/d/x16d.d

Modified: trunk/bindings/d/plplot.d
===================================================================
--- trunk/bindings/d/plplot.d	2013-09-22 02:17:11 UTC (rev 12511)
+++ trunk/bindings/d/plplot.d	2013-09-22 02:19:29 UTC (rev 12512)
@@ -159,40 +159,41 @@
 
 // Routine for drawing continous colour legends
 void plcolorbar( PLFLT *p_colorbar_width, PLFLT *p_colorbar_height,
-              PLINT opt, PLINT position, PLFLT x, PLFLT y,
-              PLFLT x_length, PLFLT y_length,
-              PLINT bg_color, PLINT bb_color, PLINT bb_style,
-              PLFLT low_cap_color, PLFLT high_cap_color,
-              PLINT cont_color, PLFLT cont_width,
-              PLINT[] label_opts, string[] label,
-              string[] axis_opts,
-              PLFLT[] ticks, PLINT[] sub_ticks,
-              PLFLT[][] values )
+                 PLINT opt, PLINT position, PLFLT x, PLFLT y,
+                 PLFLT x_length, PLFLT y_length,
+                 PLINT bg_color, PLINT bb_color, PLINT bb_style,
+                 PLFLT low_cap_color, PLFLT high_cap_color,
+                 PLINT cont_color, PLFLT cont_width,
+                 PLINT[] label_opts, string[] label,
+                 string[] axis_opts,
+                 PLFLT[] ticks, PLINT[] sub_ticks,
+                 PLFLT[][] values )
 {
-    PLINT n_labels = cast(PLINT) label_opts.length;
-    PLINT n_axes = cast(PLINT) axis_opts.length;
+    PLINT   n_labels = cast(PLINT) label_opts.length;
+    PLINT   n_axes   = cast(PLINT) axis_opts.length;
     PLINT[] n_values = new PLINT[values.length];
-    for (size_t i=0; i<values.length;i++) {
+    for ( size_t i = 0; i < values.length; i++ )
+    {
         n_values[i] = cast(PLINT) values[i].length;
     }
-    immutable( char ) * *labelz    = array( map!toStringz( label ) ).ptr;
-    immutable( char ) * *axis_optsz    = array( map!toStringz( axis_opts ) ).ptr;
+    immutable( char ) * *labelz     = array( map!toStringz( label ) ).ptr;
+    immutable( char ) * *axis_optsz = array( map!toStringz( axis_opts ) ).ptr;
     assert( n_labels == label.length, "plcolorbar(): Arrays must be of same length!" );
     assert( n_labels == label_opts.length, "plcolorbar(): Arrays must be of same length!" );
     assert( n_axes == axis_opts.length, "plcolorbar(): Arrays must be of same length!" );
     assert( n_axes == ticks.length, "plcolorbar(): Arrays must be of same length!" );
     assert( n_axes == sub_ticks.length, "plcolorbar(): Arrays must be of same length!" );
 
-    c_plcolorbar(p_colorbar_width, p_colorbar_height,
-              opt, position, x, y,
-              x_length, y_length,
-              bg_color, bb_color, bb_style,
-              low_cap_color, high_cap_color,
-              cont_color, cont_width,
-              n_labels, label_opts.ptr, labelz,
-              n_axes, axis_optsz,
-              ticks.ptr, sub_ticks.ptr,
-              n_values.ptr, convert_array(values) );
+    c_plcolorbar( p_colorbar_width, p_colorbar_height,
+        opt, position, x, y,
+        x_length, y_length,
+        bg_color, bb_color, bb_style,
+        low_cap_color, high_cap_color,
+        cont_color, cont_width,
+        n_labels, label_opts.ptr, labelz,
+        n_axes, axis_optsz,
+        ticks.ptr, sub_ticks.ptr,
+        n_values.ptr, convert_array( values ) );
 }
 
 // Draws a contour plot from data in f(nx,ny).  Is just a front-end to
@@ -1452,7 +1453,7 @@
 //alias c_plscmap1l plscmap1l;
 //alias c_plscmap1la plscmap1la;
 alias c_plscmap1n      plscmap1n;
-alias c_plscmap1_range      plscmap1_range;
+alias c_plscmap1_range plscmap1_range;
 alias c_plscol0        plscol0;
 alias c_plscol0a       plscol0a;
 alias c_plscolbg       plscolbg;
@@ -1814,23 +1815,23 @@
 const PL_LEGEND_ROW_MAJOR    = 128;
 
 // Flags for plcolorbar
-const PL_COLORBAR_LABEL_LEFT   = 1;
-const PL_COLORBAR_LABEL_RIGHT  = 2;
-const PL_COLORBAR_LABEL_TOP    = 4;
-const PL_COLORBAR_LABEL_BOTTOM = 8;
-const PL_COLORBAR_IMAGE        = 16;
-const PL_COLORBAR_SHADE        = 32;
-const PL_COLORBAR_GRADIENT     = 64;
+const PL_COLORBAR_LABEL_LEFT    = 1;
+const PL_COLORBAR_LABEL_RIGHT   = 2;
+const PL_COLORBAR_LABEL_TOP     = 4;
+const PL_COLORBAR_LABEL_BOTTOM  = 8;
+const PL_COLORBAR_IMAGE         = 16;
+const PL_COLORBAR_SHADE         = 32;
+const PL_COLORBAR_GRADIENT      = 64;
 const PL_COLORBAR_CAP_NONE      = 128;
-const PL_COLORBAR_CAP_LOW      = 256;
-const PL_COLORBAR_CAP_HIGH     = 512;
-const PL_COLORBAR_SHADE_LABEL  = 1024;
-const PL_COLORBAR_ORIENT_RIGHT = 2048;
-const PL_COLORBAR_ORIENT_TOP   = 4096;
-const PL_COLORBAR_ORIENT_LEFT  = 8192;
+const PL_COLORBAR_CAP_LOW       = 256;
+const PL_COLORBAR_CAP_HIGH      = 512;
+const PL_COLORBAR_SHADE_LABEL   = 1024;
+const PL_COLORBAR_ORIENT_RIGHT  = 2048;
+const PL_COLORBAR_ORIENT_TOP    = 4096;
+const PL_COLORBAR_ORIENT_LEFT   = 8192;
 const PL_COLORBAR_ORIENT_BOTTOM = 16384;
-const PL_COLORBAR_BACKGROUND   = 32768;
-const PL_COLORBAR_BOUNDING_BOX = 65536;
+const PL_COLORBAR_BACKGROUND    = 32768;
+const PL_COLORBAR_BOUNDING_BOX  = 65536;
 
 
 // Routine for drawing discrete line, symbol, or cmap0 legends
@@ -1851,15 +1852,15 @@
 
 // Routine for drawing continous colour legends
 void c_plcolorbar( PLFLT *p_colorbar_width, PLFLT *p_colorbar_height,
-              PLINT opt, PLINT position, PLFLT x, PLFLT y,
-              PLFLT x_length, PLFLT y_length,
-              PLINT bg_color, PLINT bb_color, PLINT bb_style,
-              PLFLT low_cap_color, PLFLT high_cap_color,
-              PLINT cont_color, PLFLT cont_width,
-              PLINT n_labels, const PLINT *label_opts, const char **label,
-              PLINT n_axes, const char ** axis_opts,
-              const PLFLT *ticks, const PLINT *sub_ticks,
-              const PLINT *n_values, const PLFLT **values );
+                   PLINT opt, PLINT position, PLFLT x, PLFLT y,
+                   PLFLT x_length, PLFLT y_length,
+                   PLINT bg_color, PLINT bb_color, PLINT bb_style,
+                   PLFLT low_cap_color, PLFLT high_cap_color,
+                   PLINT cont_color, PLFLT cont_width,
+                   PLINT n_labels, const PLINT *label_opts, const char **label,
+                   PLINT n_axes, const char ** axis_opts,
+                   const PLFLT *ticks, const PLINT *sub_ticks,
+                   const PLINT *n_values, const PLFLT **values );
 
 // Sets position of the light source
 void c_pllightsource( PLFLT x, PLFLT y, PLFLT z );

Modified: trunk/examples/d/x16d.d
===================================================================
--- trunk/examples/d/x16d.d	2013-09-22 02:17:11 UTC (rev 12511)
+++ trunk/examples/d/x16d.d	2013-09-22 02:19:29 UTC (rev 12512)
@@ -189,26 +189,27 @@
     }
 
     // Plot using identity transform
-    PLFLT fill_width = 2., cont_width = 0.;
-    PLFLT colorbar_width, colorbar_height;
-    PLINT cont_color = 0;
+    PLFLT     fill_width = 2., cont_width = 0.;
+    PLFLT     colorbar_width, colorbar_height;
+    PLINT     cont_color = 0;
 
-    const int NUM_AXES = 1;
-    string[] axis_opts = [
+    const int NUM_AXES  = 1;
+    string[]  axis_opts = [
         "bcvtm",
     ];
     PLFLT[] values[NUM_AXES];
-    for (size_t i = 0; i<NUM_AXES;i++) {
-      values[i] = new PLFLT[ns];
+    for ( size_t i = 0; i < NUM_AXES; i++ )
+    {
+        values[i] = new PLFLT[ns];
     }
-    PLFLT[]      axis_ticks = [
+    PLFLT[] axis_ticks = [
         0.0,
     ];
-    PLINT[]      axis_subticks = [
+    PLINT[] axis_subticks = [
         0,
     ];
     const int NUM_LABELS = 1;
-    PLINT      label_opts[] = [
+    PLINT label_opts[] = [
         PL_COLORBAR_LABEL_BOTTOM,
     ];
     string[] labels = [
@@ -233,7 +234,7 @@
         plsmaj( 0.0, 0.5 );
         plsmin( 0.0, 0.5 );
 
-        values[0]     = shedge;
+        values[0] = shedge;
         plcolorbar( &colorbar_width, &colorbar_height,
             PL_COLORBAR_SHADE | PL_COLORBAR_SHADE_LABEL, 0,
             0.005, 0.0, 0.0375, 0.875, 0, 1, 1, 0.0, 0.0,
@@ -279,7 +280,7 @@
         plsmaj( 0.0, 0.5 );
         plsmin( 0.0, 0.5 );
 
-        values[0]     = shedge;
+        values[0] = shedge;
         plcolorbar( &colorbar_width, &colorbar_height,
             PL_COLORBAR_SHADE | PL_COLORBAR_SHADE_LABEL, 0,
             0.005, 0.0, 0.0375, 0.875, 0, 1, 1, 0.0, 0.0,
@@ -327,7 +328,7 @@
         plsmaj( 0.0, 0.5 );
         plsmin( 0.0, 0.5 );
 
-        values[0]     = shedge;
+        values[0] = shedge;
         plcolorbar( &colorbar_width, &colorbar_height,
             PL_COLORBAR_SHADE | PL_COLORBAR_SHADE_LABEL, 0,
             0.005, 0.0, 0.0375, 0.875, 0, 1, 1, 0.0, 0.0,
@@ -376,7 +377,7 @@
         plsmaj( 0.0, 0.5 );
         plsmin( 0.0, 0.5 );
 
-        values[0]     = shedge;
+        values[0] = shedge;
         plcolorbar( &colorbar_width, &colorbar_height,
             PL_COLORBAR_SHADE | PL_COLORBAR_SHADE_LABEL, 0,
             0.005, 0.0, 0.0375, 0.875, 0, 1, 1, 0.0, 0.0,
@@ -472,7 +473,7 @@
         plsmaj( 0.0, 0.5 );
         plsmin( 0.0, 0.5 );
 
-        values[0]     = shedge;
+        values[0] = shedge;
         plcolorbar( &colorbar_width, &colorbar_height,
             PL_COLORBAR_SHADE | PL_COLORBAR_SHADE_LABEL, 0,
             0.005, 0.0, 0.0375, 0.875, 0, 1, 1, 0.0, 0.0,

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

[Plplot-cvs] SF.net SVN: plplot:[12511] trunk/src/pllegend.c

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

Revision: 12511
          http://sourceforge.net/p/plplot/code/12511
Author:   airwin
Date:     2013-09-22 02:17:11 +0000 (Sun, 22 Sep 2013)
Log Message:
-----------
Implement sanity check that pllegend caller does not specify NULL
array pointers for one of the box, line, or symbol arrays when
opt_array contains the relevant bit which would force the array to be
used.

Modified Paths:
--------------
    trunk/src/pllegend.c

Modified: trunk/src/pllegend.c
===================================================================
--- trunk/src/pllegend.c	2013-09-21 21:19:22 UTC (rev 12510)
+++ trunk/src/pllegend.c	2013-09-22 02:17:11 UTC (rev 12511)
@@ -576,10 +576,10 @@
           legend_width, legend_height, legend_width_ac, legend_height_ac;
     PLFLT x_legend_position, y_legend_position, xsign, ysign;
 
-    //PLINT some_boxes = 0, some_lines = 0;
     PLINT some_symbols       = 0;
     PLINT max_symbol_numbers = 0;
-    PLINT irow = 0, icolumn = 0;
+    PLINT irow       = 0, icolumn = 0;
+    int   some_boxes = 0, some_lines = 0;
 
     // Default nrow, ncolumn.
     nrow    = MAX( nrow, 1 );
@@ -663,17 +663,37 @@
 
     for ( i = 0; i < nlegend; i++ )
     {
-        //if ( opt_array[i] & PL_LEGEND_COLOR_BOX )
-        //    some_boxes = 1;
-        //if ( opt_array[i] & PL_LEGEND_LINE )
-        //    some_lines = 1;
+        if ( opt_array[i] & PL_LEGEND_COLOR_BOX )
+            some_boxes = 1;
+        if ( opt_array[i] & PL_LEGEND_LINE )
+            some_lines = 1;
         if ( opt_array[i] & PL_LEGEND_SYMBOL )
         {
-            max_symbol_numbers = MAX( max_symbol_numbers, symbol_numbers[i] );
-            some_symbols       = 1;
+            if ( symbol_numbers != NULL )
+                max_symbol_numbers = MAX( max_symbol_numbers, symbol_numbers[i] );
+            some_symbols = 1;
         }
     }
 
+    // Sanity checks on NULL arrays:
+    if ( some_boxes && ( box_colors == NULL || box_patterns == NULL || box_scales == NULL || box_line_widths == NULL ) )
+    {
+        plabort( "pllegend: all box_* arrays must be defined when the PL_LEGEND_COLOR_BOX bit is set." );
+        return;
+    }
+
+    if ( some_lines && ( line_colors == NULL || line_styles == NULL || line_widths == NULL ) )
+    {
+        plabort( "pllegend: all line_* arrays must be defined when the PL_LEGEND_LINE bit is set." );
+        return;
+    }
+
+    if ( some_symbols && ( symbol_colors == NULL || symbol_scales == NULL || symbol_numbers == NULL ) )
+    {
+        plabort( "pllegend: all symbol_* arrays must be defined when the PL_LEGEND_SYMBOL bit is set." );
+        return;
+    }
+
     // Get character height and width in normalized subpage coordinates.
     character_height = get_character_or_symbol_height( TRUE );
     character_width  = character_height;

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

[Plplot-cvs] SF.net SVN: plplot:[12510] trunk/README.release

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

Revision: 12510
          http://sourceforge.net/p/plplot/code/12510
Author:   airwin
Date:     2013-09-21 21:19:22 +0000 (Sat, 21 Sep 2013)
Log Message:
-----------
Note added concerning recent breakthroughs for the Cygwin platform.

Modified Paths:
--------------
    trunk/README.release

Modified: trunk/README.release
===================================================================
--- trunk/README.release	2013-09-18 19:12:42 UTC (rev 12509)
+++ trunk/README.release	2013-09-21 21:19:22 UTC (rev 12510)
@@ -32,6 +32,7 @@
 1.1 The format for map data used by plmap has changed
 1.2 Python support for Numeric has been dropped
 1.3 Non-integer line widths allowed
+1.4 Improvements to the build system for the Cygwin case
 
 2. Changes relative to PLplot 5.8.0 (the previous stable release)
 
@@ -93,6 +94,7 @@
 2.53 The format for map data used by plmap has changed
 2.54 Python support for Numeric has been dropped
 2.55 Non-integer line widths allowed
+2.56 Improvements to the build system for the Cygwin case
 
 OFFICIAL NOTICES FOR USERS
 
@@ -495,6 +497,25 @@
 support this to take advantage of fine line widths. This is an API change 
 from previous releases.
 
+1.4 Improvements to the build system for the Cygwin case
+
+The Cygwin platform provides a full-featured Unix environment on
+Windows.  CMake has recently been changed (at the request of Cygwin
+developers) to emphasize the Unix aspects of the Cygwin platform and
+deemphasize the Windows aspects of that platform.  It was argued this
+change would tend to make CMake builds of software much more reliable
+on Cygwin, and after some small but important changes to our
+CMake-based build system to adjust for these recent CMake changes for
+Cygwin, we have indeed confirmed that prediction for the PLplot case.
+There are still some Cygwin platform issues left which are being
+discussed on our Wiki at http://www.miscdebris.net/plplot_wiki/, but
+some fundamental breakthroughs have also been made for the Cygwin case
+that should interest all our Windows users.  For example, for the
+first time ever we have been able to build our cairo and qt device
+drivers on the Cygwin platform giving our Windows users convenient
+access to the many high-quality PLplot devices that are available with
+these two different device drivers.
+
 2. Changes relative to PLplot 5.8.0 (the previous stable release)
 
 2.1 All autotools-related files have now been removed
@@ -1345,3 +1366,21 @@
 support this to take advantage of fine line widths. This is an API change 
 from previous releases.
 
+2.56 Improvements to the build system for the Cygwin case
+
+The Cygwin platform provides a full-featured Unix environment on
+Windows.  CMake has recently been changed (at the request of Cygwin
+developers) to emphasize the Unix aspects of the Cygwin platform and
+deemphasize the Windows aspects of that platform.  It was argued this
+change would tend to make CMake builds of software much more reliable
+on Cygwin, and after some small but important changes to our
+CMake-based build system to adjust for these recent CMake changes for
+Cygwin, we have indeed confirmed that prediction for the PLplot case.
+There are still some Cygwin platform issues left which are being
+discussed on our Wiki at http://www.miscdebris.net/plplot_wiki/, but
+some fundamental breakthroughs have also been made for the Cygwin case
+that should interest all our Windows users.  For example, for the
+first time ever we have been able to build our cairo and qt device
+drivers on the Cygwin platform giving our Windows users convenient
+access to the many high-quality PLplot devices that are available with
+these two different device drivers.

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

[Plplot-cvs] SF.net SVN: plplot:[12509] trunk/src/plctrl.c

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

Revision: 12509
          http://sourceforge.net/p/plplot/code/12509
Author:   airwin
Date:     2013-09-18 19:12:42 +0000 (Wed, 18 Sep 2013)
Log Message:
-----------
In doxygen documentation of plcol1, use the correct (col1 rather than
icol1) parameter name.

Modified Paths:
--------------
    trunk/src/plctrl.c

Modified: trunk/src/plctrl.c
===================================================================
--- trunk/src/plctrl.c	2013-09-18 18:51:03 UTC (rev 12508)
+++ trunk/src/plctrl.c	2013-09-18 19:12:42 UTC (rev 12509)
@@ -7,7 +7,7 @@
 // Copyright (C) 2004  Joao Cardoso
 // Copyright (C) 2004  Rafael Laboissiere
 // Copyright (C) 2008  Hazen Babcock
-// Copyright (C) 2009  Alan W. Irwin
+// Copyright (C) 2009-2013  Alan W. Irwin
 // Copyright (C) 2011  Hezekiah M. Carty
 //
 // This file is part of PLplot.
@@ -170,7 +170,7 @@
 //
 //! Set color, map 1.  Argument is a float between 0. and 1.
 //!
-//! @param icol1 The index of the color map 1 color to use as the current
+//! @param col1 The index of the color map 1 color to use as the current
 //! color. (0.0 - 1.0)
 
 void

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

[Plplot-cvs] SF.net SVN: plplot:[12508] trunk/src

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

Revision: 12508
          http://sourceforge.net/p/plplot/code/12508
Author:   airwin
Date:     2013-09-18 18:51:03 +0000 (Wed, 18 Sep 2013)
Log Message:
-----------
Update doxygen documentation of PL_UNUSED function parameters to
eliminate doxygen warning messages concerning such parameters and to
produce reasonable looking doxygen results for those parameters.

Modified Paths:
--------------
    trunk/src/pdfutils.c
    trunk/src/plargs.c
    trunk/src/plot3d.c

Modified: trunk/src/pdfutils.c
===================================================================
--- trunk/src/pdfutils.c	2013-09-18 07:26:10 UTC (rev 12507)
+++ trunk/src/pdfutils.c	2013-09-18 18:51:03 UTC (rev 12508)
@@ -1122,8 +1122,7 @@
 //!
 //! @param f The [][] to the storage.
 //! @param nx Size of the grid in x.
-//! @param ny Size of the grid in y (not used).
-//!
+//! @param PL_UNUSED( ny) Not used.
 //--------------------------------------------------------------------------
 
 void

Modified: trunk/src/plargs.c
===================================================================
--- trunk/src/plargs.c	2013-09-18 07:26:10 UTC (rev 12507)
+++ trunk/src/plargs.c	2013-09-18 18:51:03 UTC (rev 12508)
@@ -1543,9 +1543,9 @@
 //! Performs appropriate action for option "h":
 //! Issues help message
 //!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 2.
 //!
@@ -1566,9 +1566,9 @@
 //! Performs appropriate action for option "v":
 //! Issues version message
 //!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 2.
 //!
@@ -1589,9 +1589,9 @@
 //! Performs appropriate action for option "verbose":
 //! Turn on verbosity flag
 //!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -1610,9 +1610,9 @@
 //! Performs appropriate action for option "debug":
 //! Turn on debugging flag
 //!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -1632,9 +1632,9 @@
 //! Performs appropriate action for option "hack":
 //! Enables driver-specific hack(s)
 //!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -1653,9 +1653,9 @@
 //! Performs appropriate action for option "dev":
 //! Sets output device keyword
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg The name of the output device.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -1674,9 +1674,9 @@
 //! Performs appropriate action for option "o":
 //! Sets output file name
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg The file family name.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -1695,9 +1695,9 @@
 //! Performs appropriate action for option "mar":
 //! Sets relative margin width
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Plot margin width.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -1716,9 +1716,9 @@
 //! Performs appropriate action for option "a":
 //! Sets plot aspect ratio on page
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Plot aspect ratio.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -1737,9 +1737,9 @@
 //! Performs appropriate action for option "jx":
 //! Sets relative justification in x
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Plot relative justification in x(?)
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -1758,9 +1758,9 @@
 //! Performs appropriate action for option "jy":
 //! Sets relative justification in y
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Plot relative justification in y(?)
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -1779,9 +1779,9 @@
 //! Performs appropriate action for option "ori":
 //! Sets orientation
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Plot orientation.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -1800,9 +1800,9 @@
 //! Performs appropriate action for option "freeaspect":
 //! Allow aspect ratio to adjust to orientation swaps.
 //!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -1835,9 +1835,9 @@
 //! bit of code from  ps.c that has to do with pls->portrait to the
 //! appropriate driver file.
 //!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -1856,9 +1856,9 @@
 //! Performs appropriate action for option "width":
 //! Sets pen width
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Plot pen width.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -1893,9 +1893,9 @@
 //! -bg ff0000 (set background to red with an alpha value of 1.0)
 //! -bg ff0000_0.1 (set background to red with an alpha value of 0.1
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Background RGB color in hex.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -1976,9 +1976,9 @@
 //! Performs appropriate action for option "ncol0":
 //! Sets number of colors to allocate in cmap 0 (upper bound).
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Number of color map 0 colors.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -1997,9 +1997,9 @@
 //! Performs appropriate action for option "ncol1":
 //! Sets number of colors to allocate in cmap 1 (upper bound).
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Number of color map 1 colors.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2018,9 +2018,9 @@
 //! Performs appropriate action for option "wplt":
 //! Sets (zoom) window into plot (e.g. "0,0,0.5,0.5")
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Zoom setting.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2065,9 +2065,9 @@
 //! Get driver specific options in the form <option[=value]>[,option[=value]]*
 //! If "value" is not specified, it defaults to "1".
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg The driver specific option.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2155,9 +2155,9 @@
 //! Performs appropriate action for option "fam":
 //! Enables family output files
 //!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2185,9 +2185,9 @@
 //! Note case of the trailing suffix doesn't matter.
 //! If no suffix, defaults to MB.
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Family size setting.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2243,9 +2243,9 @@
 //! Performs appropriate action for option "fbeg":
 //! Starts with the specified family member number.
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Number of the first plot.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2265,9 +2265,9 @@
 //! Performs appropriate action for option "finc":
 //! Specify increment between family members.
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Amount to increment the plot number between plots.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2287,9 +2287,9 @@
 //! Performs appropriate action for option "fflen":
 //! Specify minimum field length for family member number.
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Size of the family number field (e.g. "1", "01", "001" ?)
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2309,9 +2309,9 @@
 //! Performs appropriate action for option "np":
 //! Disables pause between pages
 //!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2330,9 +2330,9 @@
 //! Performs appropriate action for option "nopixmap":
 //! Disables use of pixmaps in X drivers
 //!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2351,9 +2351,9 @@
 //! Performs appropriate action for option "db":
 //! Double buffer X output (update only done on eop or Expose)
 //!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2372,9 +2372,9 @@
 //! Performs appropriate action for option "bufmax":
 //! Sets size of data buffer for tk driver
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Size of the data buffer for the tk driver.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2393,9 +2393,9 @@
 //! Performs appropriate action for option "server_name":
 //! Sets main window name of server (Tcl/TK driver only)
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg The name of the main window.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2414,9 +2414,9 @@
 //! Performs appropriate action for option "plserver":
 //! Sets name to use when invoking server (Tcl/TK driver only)
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Name of Tcl/TK server (?).
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2435,9 +2435,9 @@
 //! Performs appropriate action for option "plwindow":
 //! Sets PLplot window name
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Name of the window.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2460,9 +2460,9 @@
 //! Performs appropriate action for option "auto_path":
 //! Sets additional directories to autoload
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Additional directories to add the the load path (?).
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2481,9 +2481,9 @@
 //! Performs appropriate action for option "px":
 //! Set packing in x
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg X packing (?).
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2502,9 +2502,9 @@
 //! Performs appropriate action for option "py":
 //! Set packing in y
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Y packing (?).
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2527,9 +2527,9 @@
 //! -XOFF+YOFF, and -XOFF-YOFF.  Some examples are the following:
 //! -geometry 400x300, -geometry -100+200, and -geometry 400x300-100+200.
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Plot geometry descriptor.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2620,9 +2620,9 @@
 //
 //! File name for plserver tk_file option
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Tk file name.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2650,9 +2650,9 @@
 //!   e.g., "-dpi 1200"
 //! Will set both X and Y dpi to 1200 dpi
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg DPI descriptor string.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2698,9 +2698,9 @@
 //
 //! Sets device compression
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Device compression (?).
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2727,9 +2727,9 @@
 //
 //! Sets color table 0 based on a cmap0.pal file.
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Name of color map 0 .pal file.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2747,9 +2747,9 @@
 //
 //! Sets color table 1 based on a cmap1.pal file.
 //!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
 //! @param opt_arg Name of a color map 1 .pal file.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2767,9 +2767,9 @@
 //
 //! Make PLplot portable to all LC_NUMERIC locales.
 //!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!
@@ -2801,9 +2801,9 @@
 //! self-intersecting, use the even-odd fill rule rather than the
 //! default nonzero fill rule.
 //!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
 //!
 //! returns 0.
 //!

Modified: trunk/src/plot3d.c
===================================================================
--- trunk/src/plot3d.c	2013-09-18 07:26:10 UTC (rev 12507)
+++ trunk/src/plot3d.c	2013-09-18 18:51:03 UTC (rev 12508)
@@ -957,13 +957,11 @@
 //! or any bitwise OR'd combination, e.g. "MAG_COLOR | DRAW_LINEX"
 //! @param clevel z values at which to draw contours
 //! @param nlevel Number of values in clevels
-//! @param ixstart Index of first x coordinate to include in plot
-//! @param ixn Number of x coordinates to include in plot
-//! @param indexymin Array which specifies the min y index for each x
-//! index in range ixstart, ixn.
-//! @param indexymax Array which specifies the max y index for each x
-//! coordinate (following the convention that the upper range limit is one more
-//! than actual index limit) for an x index range of ixstart, ixn.
+//! @param PL_UNUSED( ixstart ) Not used.
+//! @param PL_UNUSED( ixn ) Not used.
+//! @param PL_UNUSED( indexymin ) Not used.
+//! @param PL_UNUSED( indexymax ) Not used.
+//!
 //--------------------------------------------------------------------------
 
 void

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

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

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

Revision: 12507
          http://sourceforge.net/p/plplot/code/12507
Author:   airwin
Date:     2013-09-18 07:26:10 +0000 (Wed, 18 Sep 2013)
Log Message:
-----------
Update API documentation of pllegend and plcolorbar consistent with
the corresponding doxygen documentation of the same functions.  I plan
no further changes in this API documentation at the present time.

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

Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml	2013-09-18 07:23:49 UTC (rev 12506)
+++ trunk/doc/docbook/src/api.xml	2013-09-18 07:26:10 UTC (rev 12507)
@@ -3,7 +3,7 @@
     api.xml: "The Common API for PLplot" chapter
 
 Copyright (C) 1994  Geoffrey Furnish and Maurice LeBrun
-Copyright (C) 1999-2011  Alan W. Irwin
+Copyright (C) 1999-2013  Alan W. Irwin
 Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004  Rafael Laboissiere
 Copyright (C) 2003  Joao Cardoso
 Copyright (C) 2004, 2007  Andrew Ross
@@ -649,6 +649,23 @@
 		  <literal>t</literal>: Draws major ticks.
 		</para>
 	      </listitem>
+	      <listitem>
+		<para>
+		  <literal>u</literal>: Exactly like "b" except don't draw edge line.
+		</para>
+	      </listitem>
+	      <listitem>
+		<para>
+		  <literal>w</literal>: Exactly like "c" except don't draw edge line.
+		</para>
+	      </listitem>
+	      <listitem>
+		<para>
+		  <literal>x</literal>: Exactly like "t" (including the side effect of
+		  the numerical labels for the major ticks) except exclude drawing the
+		  major and minor tick marks.
+		</para>
+	      </listitem>
 	    </itemizedlist>
 	  </para>
 	</listitem>
@@ -1082,6 +1099,13 @@
 		  <literal>w</literal>: Exactly like "c" except don't draw edge line.
 		</para>
 	      </listitem>
+	      <listitem>
+		<para>
+		  <literal>x</literal>: Exactly like "t" (including the side effect of
+		  the numerical labels for the major ticks) except exclude drawing the
+		  major and minor tick marks.
+		</para>
+	      </listitem>
 	    </itemizedlist>
 	  </para>
 	</listitem>
@@ -1843,6 +1867,458 @@
 
   </sect1>
 
+  <sect1 id="plcolorbar" renderas="sect3">
+    <title>
+      <function>plcolorbar</function>: Plot color bar for image, shade or gradient plots
+    </title>
+
+    <para>
+      <funcsynopsis>
+	<funcprototype>
+	  <funcdef>
+	    <function>plcolorbar</function>
+	  </funcdef>
+	  <paramdef><parameter>p_colorbar_width</parameter></paramdef>
+	  <paramdef><parameter>p_colorbar_height</parameter></paramdef>
+	  <paramdef><parameter>opt</parameter></paramdef>
+	  <paramdef><parameter>position</parameter></paramdef>
+	  <paramdef><parameter>x</parameter></paramdef>
+	  <paramdef><parameter>y</parameter></paramdef>
+	  <paramdef><parameter>x_length</parameter></paramdef>
+	  <paramdef><parameter>y_length</parameter></paramdef>
+	  <paramdef><parameter>bg_color</parameter></paramdef>
+	  <paramdef><parameter>bb_color</parameter></paramdef>
+	  <paramdef><parameter>bb_style</parameter></paramdef>
+	  <paramdef><parameter>low_cap_color</parameter></paramdef>
+	  <paramdef><parameter>high_cap_color</parameter></paramdef>
+	  <paramdef><parameter>cont_color</parameter></paramdef>
+	  <paramdef><parameter>cont_width</parameter></paramdef>
+	  <paramdef><parameter>n_labels</parameter></paramdef>
+	  <paramdef><parameter>label_opts</parameter></paramdef>
+	  <paramdef><parameter>labels</parameter></paramdef>
+	  <paramdef><parameter>naxes</parameter></paramdef>
+	  <paramdef><parameter>axis_opts</parameter></paramdef>
+	  <paramdef><parameter>ticks</parameter></paramdef>
+	  <paramdef><parameter>sub_ticks</parameter></paramdef>
+	  <paramdef><parameter>n_values</parameter></paramdef>
+	  <paramdef><parameter>values</parameter></paramdef>
+	</funcprototype>
+      </funcsynopsis>
+    </para>
+
+    <para>
+      Routine for creating a continuous color bar for image, shade, or gradient plots.
+      (See &pllegend; for similar functionality for creating legends with discrete elements).
+      The arguments of plcolorbar provide control over the location
+      and size of the color bar as well as the location and characteristics of
+      the elements (most of which are optional) within that color bar.  The
+      resulting color bar is clipped at the boundaries of the current subpage.
+      (N.B. the adopted coordinate system used for some of the parameters is
+      defined in the documentation of the
+      <literal><parameter>position</parameter></literal> parameter.)
+    </para>
+    <variablelist>
+      <varlistentry>
+	<term>
+	  <parameter>p_colorbar_width</parameter>
+	  (<literal>PLFLT *</literal>, output)
+	</term>
+	<listitem>
+	  <para>
+	    Pointer to a location which contains (after the call) the
+	    labelled and decorated color bar width in adopted coordinates.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>p_colorbar_height</parameter>
+	  (<literal>PLFLT *</literal>, output)
+	</term>
+	<listitem>
+	  <para>
+	    Pointer to a location which contains (after the call) the
+	    labelled and decorated color bar height in adopted coordinates.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>opt</parameter>
+	  (<literal>PLINT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    <literal><parameter>opt</parameter></literal> contains
+	    bits controlling the overall color bar.  The orientation (direction of
+	    the maximum value) of the color bar is specified with
+	    <literal>PL_ORIENT_RIGHT</literal>, <literal>PL_ORIENT_TOP</literal>,
+	    <literal>PL_ORIENT_LEFT</literal>, or
+	    <literal>PL_ORIENT_BOTTOM</literal>.  If none of those bits are
+	    specified, the default orientation is toward the top, i.e., a vertical
+	    color bar. If the <literal>PL_COLORBAR_BACKGROUND</literal> bit is
+	    set, plot a (semi-transparent) background for the color bar. If the
+	    <literal>PL_COLORBAR_BOUNDING_BOX</literal> bit is set, plot a
+	    bounding box for the color bar. The type of color bar must be
+	    specified with one of <literal>PL_COLORBAR_IMAGE</literal>,
+	    <literal>PL_COLORBAR_SHADE</literal>, or
+	    <literal>PL_COLORBAR_GRADIENT</literal>. If more than one of those
+	    bits is set only the first one in the above list is honored. The
+	    position of the (optional) label/title can be specified with
+	    <literal>PL_LABEL_RIGHT</literal>, <literal>PL_LABEL_TOP</literal>,
+	    <literal>PL_LABEL_LEFT</literal>, or
+	    <literal>PL_LABEL_BOTTOM</literal>.  If no label position bit is set
+	    then no label will be drawn. If more than one of this list of bits is
+	    specified, only the first one on the list is honored. End-caps for the
+	    color bar can added with <literal>PL_COLORBAR_CAP_LOW</literal> and
+	    <literal>PL_COLORBAR_CAP_HIGH</literal>. If a particular color bar cap
+	    option is not specified then no cap will be drawn for that end. As a
+	    special case for <literal>PL_COLORBAR_SHADE</literal>, the option
+	    <literal>PL_COLORBAR_SHADE_LABEL</literal> can be specified. If this
+	    option is provided then any tick marks and tick labels will be placed
+	    at the breaks between shaded segments. TODO: This should be expanded
+	    to support custom placement of tick marks and tick labels at custom
+	    value locations for any color bar type.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>position</parameter>
+	  (<literal>PLINT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    <literal><parameter>position</parameter></literal>
+	    contains bits which control the overall position of the
+	    color bar and the definition of the adopted coordinates used for
+	    positions just like what is done for the position argument for
+	    &pllegend;. However, note that the defaults for the position bits
+	    (see below) are different than the &pllegend; case. The combination of
+	    the <literal>PL_POSITION_LEFT</literal>,
+	    <literal>PL_POSITION_RIGHT</literal>,
+	    <literal>PL_POSITION_TOP</literal>,
+	    <literal>PL_POSITION_BOTTOM</literal>,
+	    <literal>PL_POSITION_INSIDE</literal>, and
+	    <literal>PL_POSITION_OUTSIDE</literal> bits specifies one of the 16
+	    possible standard positions (the 4 corners and centers of the 4 sides
+	    for both the inside and outside cases) of the color bar relative to
+	    the adopted coordinate system. The corner positions are specified by
+	    the appropriate combination of two of the
+	    <literal>PL_POSITION_LEFT</literal>,
+	    <literal>PL_POSITION_RIGHT</literal>,
+	    <literal>PL_POSITION_TOP</literal>, and
+	    <literal>PL_POSITION_BOTTOM</literal> bits while the sides are
+	    specified by a single value of one of those bits.  The adopted
+	    coordinates are normalized viewport coordinates if the
+	    <literal>PL_POSITION_VIEWPORT</literal> bit is set or normalized
+	    subpage coordinates if the <literal>PL_POSITION_SUBPAGE</literal> bit
+	    is set. Default position bits: If none of
+	    <literal>PL_POSITION_LEFT</literal>,
+	    <literal>PL_POSITION_RIGHT</literal>,
+	    <literal>PL_POSITION_TOP</literal>, or
+	    <literal>PL_POSITION_BOTTOM</literal> are set, then use
+	    <literal>PL_POSITION_RIGHT</literal>. If neither of
+	    <literal>PL_POSITION_INSIDE</literal> or
+	    <literal>PL_POSITION_OUTSIDE</literal> is set, use
+	    <literal>PL_POSITION_OUTSIDE</literal>. If neither of
+	    <literal>PL_POSITION_VIEWPORT</literal> or
+	    <literal>PL_POSITION_SUBPAGE</literal> is set, use
+	    <literal>PL_POSITION_VIEWPORT</literal>.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>x</parameter>
+	  (<literal> PLFLT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    X offset of the color bar position in adopted coordinates from the
+	    specified standard position of the color bar. For positive x, the
+	    direction of motion away from the standard position is inward/outward
+	    from the standard corner positions or standard left or right positions
+	    if the
+	    <literal>PL_POSITION_INSIDE</literal>/<literal>PL_POSITION_OUTSIDE</literal>
+	    bit is set in <literal><parameter>position</parameter></literal>.  For
+	    the standard top or bottom positions, the direction of motion is
+	    toward positive X.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>y</parameter>
+	  (<literal>PLFLT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    Y offset of the color bar position in adopted coordinates from the
+	    specified standard position of the color bar. For positive y, the
+	    direction of motion away from the standard position is inward/outward
+	    from the standard corner positions or standard top or bottom positions
+	    if the
+	    <literal>PL_POSITION_INSIDE</literal>/<literal>PL_POSITION_OUTSIDE</literal>
+	    bit is set in <literal><parameter>position</parameter></literal>.  For
+	    the standard left or right positions, the direction of motion is
+	    toward positive Y.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>x_length</parameter>
+	  (<literal> PLFLT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    Length of the body of the color bar in the X direction in
+	    adopted coordinates.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>y_length</parameter>
+	  (<literal>PLFLT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    Length of the body of the color bar in the Y direction in adopted
+	    coordinates.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>bg_color</parameter>
+	  (<literal>PLINT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+            The cmap0 color of the background for the color bar
+	    (<literal>PL_COLORBAR_BACKGROUND</literal>).
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>bb_color</parameter>
+	  (<literal>PLINT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    The cmap0 color of the bounding-box line for the color bar
+	    (<literal>PL_COLORBAR_BOUNDING_BOX</literal>).
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>bb_style</parameter>
+	  (<literal>PLINT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    The &pllsty; style number for the bounding-box line for the color bar
+	    (<literal>PL_COLORBAR_BACKGROUND</literal>).
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>low_cap_color</parameter>
+	  (<literal>PLFLT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    The cmap1 color of the low-end color bar cap, if it is drawn
+	    (<literal>PL_COLORBAR_CAP_LOW</literal>).
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>high_cap_color</parameter>
+	  (<literal>PLFLT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    The cmap1 color of the high-end color bar cap, if it is drawn 
+	    (<literal>PL_COLORBAR_CAP_HIGH</literal>).
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>cont_color</parameter>
+	  (<literal>PLINT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    The cmap0 contour color for <literal>PL_COLORBAR_SHADE</literal>
+	    plots. This is passed directly to &plshades;, so it will be
+	    interpreted according to the design of &plshades;.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>cont_width</parameter>
+	  (<literal>PLFLT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    Contour width for <literal>PL_COLORBAR_SHADE</literal>
+	    plots. This is passed directly to &plshades;, so it will be
+	    interpreted according to the design of &plshades;.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>n_labels</parameter>
+	  (<literal>PLINT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    Number of labels to place around the color bar.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>label_opts</parameter>
+	  (<literal>const PLINT *</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    Options for each of <parameter>n_labels</parameter> labels.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>labels</parameter>
+	  (<literal>const char *const *</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    <parameter>n_labels</parameter> text labels for the color bar. No
+	    label is drawn if no label position is specified with one of the
+	    <literal>PL_COLORBAR_LABEL_RIGHT</literal>,
+	    <literal>PL_COLORBAR_LABEL_TOP</literal>,
+	    <literal>PL_COLORBAR_LABEL_LEFT</literal>, or
+	    <literal>PL_COLORBAR_LABEL_BOTTOM</literal> bits in the corresponding
+	    label_opts field.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>n_axes</parameter>
+	  (<literal>PLINT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    Number of axis definitions provided. This value must be greater than
+	    0. It is typically 1 (numerical axis labels are provided for one of
+	    the long edges of the color bar), but it can be larger if multiple
+	    numerical axis labels for the long edges of the color bar are desired.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>axis_opts</parameter>
+	  (<literal>const char *const *</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    An array of n_axes axis options (interpreted as for &plbox;) for the
+	    color bar's axis definitions.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>ticks</parameter>
+	  (<literal>PLFLT *</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    An array of n_axes values of the spacing of the major tick marks
+	    (interpreted as for &plbox;) for the color bar's axis definitions.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>sub_ticks</parameter>
+	  (<literal>PLINT *</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    An array of n_axes values of the number of subticks (interpreted as
+	    for &plbox;) for the color bar's axis definitions.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>n_values</parameter>
+	  (<literal>PLINT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    An array containing the number of elements in each of the
+	    <literal><parameter>n_axes</parameter></literal> rows of the
+	    two-dimensional <literal><parameter>values</parameter></literal> array.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>values</parameter>
+	  (<literal>PLFLT *const *</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    A two-dimensional array containing the numeric values for the data
+	    range represented by the color bar. For a row index of
+	    <literal><parameter>i_axis</parameter></literal> (where 0 &lt;
+	    <literal><parameter>i_axis</parameter></literal> &lt;
+	    <literal><parameter>n_axes</parameter></literal>), the number of
+	    elements in the row is specified by
+	    <literal><parameter>n_values</parameter></literal>[<literal><parameter>i_axis</parameter></literal>]. For <literal>PL_COLORBAR_IMAGE</literal> and
+	    <literal>PL_COLORBAR_GRADIENT</literal> the number of elements is 2,
+	    and the corresponding row elements of the
+	    <literal><parameter>values</parameter></literal> array are the minimum
+	    and maximum value represented by the colorbar.  For
+	    <literal>PL_COLORBAR_SHADE</literal>, the number and values of the
+	    elements of a row of the
+	    <literal><parameter>values</parameter></literal> array is interpreted
+	    the same as the <literal><parameter>nlevel</parameter></literal> and
+	    <literal><parameter>clevel</parameter></literal> arguments of
+	    &plshades;.
+	  </para>
+	</listitem>
+      </varlistentry>
+    </variablelist>
+
+    <para>
+      Redacted form: <function>plcolorbar(p_legend_width, p_legend_height, 
+      opt, position, x, y, x_length, y_length, bg_color,
+      bb_color, bb_style, low_cap_color, high_cap_color, cont_color, cont_width, label_opts, labels, axis_opts, ticks, sub_ticks, values)</function>
+    </para>
+
+    <para>
+      This function is used in examples 16 and 33.
+    </para>
+
+  </sect1>
+
   <sect1 id="plcont" renderas="sect3">
     <title>
       <function>plcont</function>: Contour plot
@@ -6375,12 +6851,13 @@
     <para>
       Routine for creating a discrete plot legend with a plotted
       filled box, line, and/or line of symbols for each annotated legend
-      entry.  The arguments of pllegend provide control over the location
-      and size of the legend as well as the location and characteristics of
-      the elements (most of which are optional) within that legend.  The
-      resulting legend is clipped at the boundaries of the current subpage.
-      (N.B. the adopted coordinate system used for some of the parameters is
-      defined in the documentation of the
+      entry.  (See &plcolorbar; for similar functionality for creating
+      continuous color bars.)  The arguments of pllegend provide control
+      over the location and size of the legend as well as the location and
+      characteristics of the elements (most of which are optional) within
+      that legend.  The resulting legend is clipped at the boundaries of the
+      current subpage.  (N.B. the adopted coordinate system used for some of
+      the parameters is defined in the documentation of the
       <literal><parameter>position</parameter></literal> parameter.)
     </para>
     <variablelist>
@@ -6454,22 +6931,32 @@
 	<listitem>
 	  <para>
 	    <literal><parameter>position</parameter></literal>
-	    contains bits controlling the overall position of the legend and the
-	    definition of the adopted coordinates used for positions. The
-	    combination of the <literal>PL_POSITION_LEFT</literal>,
+	    contains bits which control the overall position of the legend and the
+	    definition of the adopted coordinates used for positions just like
+	    what is done for the position argument for &plcolorbar;. However,
+	    note that the defaults for the position bits (see below) are
+	    different than the &plcolorbar; case.  The combination of the
+	    <literal>PL_POSITION_LEFT</literal>,
 	    <literal>PL_POSITION_RIGHT</literal>,
 	    <literal>PL_POSITION_TOP</literal>,
 	    <literal>PL_POSITION_BOTTOM</literal>,
 	    <literal>PL_POSITION_INSIDE</literal>, and
 	    <literal>PL_POSITION_OUTSIDE</literal> bits specifies one of the 16
-	    possible standard positions (the 4 corners and 4 side centers for both
-	    the inside and outside cases) of the legend relative to the adopted
-	    coordinate system. The adopted coordinates are normalized viewport
-	    coordinates if the <literal>PL_POSITION_VIEWPORT</literal> bit is set
-	    or normalized subpage coordinates if the
-	    <literal>PL_POSITION_SUBPAGE</literal> bit is set. Default position
-	    bits: If none of <literal>PL_POSITION_LEFT</literal>,
+	    possible standard positions (the 4 corners and centers of the 4 sides
+	    for both the inside and outside cases) of the legend relative to the
+	    adopted coordinate system. The corner positions are specified by the
+	    appropriate combination of two of the
+	    <literal>PL_POSITION_LEFT</literal>,
 	    <literal>PL_POSITION_RIGHT</literal>,
+	    <literal>PL_POSITION_TOP</literal>, and
+	    <literal>PL_POSITION_BOTTOM</literal> bits while the sides are
+	    specified by a single value of one of those bits.  The adopted
+	    coordinates are normalized viewport coordinates if the
+	    <literal>PL_POSITION_VIEWPORT</literal> bit is set or normalized
+	    subpage coordinates if the <literal>PL_POSITION_SUBPAGE</literal> bit
+	    is set. Default position bits: If none of
+	    <literal>PL_POSITION_LEFT</literal>,
+	    <literal>PL_POSITION_RIGHT</literal>,
 	    <literal>PL_POSITION_TOP</literal>, or
 	    <literal>PL_POSITION_BOTTOM</literal> are set, then use the
 	    combination of <literal>PL_POSITION_RIGHT</literal> and
@@ -6493,12 +6980,12 @@
 	    X offset of the legend position in adopted coordinates
 	    from the specified standard position of the legend. For positive x,
 	    the direction of motion away from the standard position is
-	    inward/outward from the standard corner positions or standard left or
-	    right positions if the
+	    inward/outward from the standard corner positions or
+	    standard left or right positions if the
 	    <literal>PL_POSITION_INSIDE</literal>/<literal>PL_POSITION_OUTSIDE</literal>
 	    bit is set in <literal><parameter>position</parameter></literal>.  For
-	    the standard top or bottom positions, the direction of motion is toward
-	    positive X.
+	    the standard top or bottom positions, the direction of motion is
+	    toward positive X.
 	  </para>
 	</listitem>
       </varlistentry>
@@ -6541,7 +7028,7 @@
 	</term>
 	<listitem>
 	  <para>
-	    The cmap0 index of the background color for the legend
+	    The cmap0 color of the background for the legend
 	    (<literal>PL_LEGEND_BACKGROUND</literal>).
 	  </para>
 	</listitem>
@@ -6553,7 +7040,7 @@
 	</term>
 	<listitem>
 	  <para>
-	    The cmap0 index of the color of the bounding-box line for the legend
+	    The cmap0 color of the bounding-box line for the legend
 	    (<literal>PL_LEGEND_BOUNDING_BOX</literal>).
 	  </para>
 	</listitem>
@@ -6565,7 +7052,7 @@
 	</term>
 	<listitem>
 	  <para>
-	    The cmap0 index of the background color for the legend
+	    The pllsty style number for the bounding-box line for the legend
 	    (<literal>PL_LEGEND_BACKGROUND</literal>).
 	  </para>
 	</listitem>
@@ -6696,14 +7183,14 @@
 	</term>
 	<listitem>
 	  <para>
-	    Array of nlegend text colors (cmap0 indices).
+	    Array of nlegend cmap0 text colors.
 	  </para>
 	</listitem>
       </varlistentry>
       <varlistentry>
 	<term>
 	  <parameter>text</parameter>
-	  (<literal>const char **</literal>, input)
+	  (<literal>const char *const *</literal>, input)
 	</term>
 	<listitem>
 	  <para>
@@ -6718,7 +7205,7 @@
 	</term>
 	<listitem>
 	  <para>
-	    Array of nlegend colors (cmap0 indices) for the discrete colored boxes
+	    Array of nlegend cmap0 colors for the discrete colored boxes
 	    (<parameter>PL_LEGEND_COLOR_BOX</parameter>).
 	  </para>
 	</listitem>
@@ -6767,7 +7254,7 @@
 	</term>
 	<listitem>
 	  <para>
-	    Array of nlegend line colors (cmap0 indices)
+	    Array of nlegend cmap0 line colors
 	    (<parameter>PL_LEGEND_LINE</parameter>).
 	  </para>
 	</listitem>
@@ -6803,7 +7290,7 @@
 	</term>
 	<listitem>
 	  <para>
-	    Array of nlegend symbol colors (cmap0 indices) 
+	    Array of nlegend cmap0 symbol colors 
 	    (<parameter>PL_LEGEND_SYMBOL</parameter>).
 	  </para>
 	</listitem>
@@ -6835,7 +7322,7 @@
       <varlistentry>
 	<term>
 	  <parameter>symbols</parameter>
-	  (<literal>const char **</literal>, input)
+	  (<literal>const char *const *</literal>, input)
 	</term>
 	<listitem>
 	  <para>
@@ -6862,7 +7349,7 @@
     </para>
 
     <para>
-      This function is used in examples 4 and 26.
+      This function is used in examples 4, 26, and 33.
     </para>
 
   </sect1>

Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in	2013-09-18 07:23:49 UTC (rev 12506)
+++ trunk/doc/docbook/src/plplotdoc.xml.in	2013-09-18 07:26:10 UTC (rev 12507)
@@ -92,6 +92,7 @@
 <!ENTITY plClearOpts '<link linkend="plClearOpts"><function>plClearOpts</function></link>'>
 <!ENTITY plcol0 '<link linkend="plcol0"><function>plcol0</function></link>'>
 <!ENTITY plcol1 '<link linkend="plcol1"><function>plcol1</function></link>'>
+<!ENTITY plcolorbar '<link linkend="plcolorbar"><function>plcolorbar</function></link>'>
 <!ENTITY plcon0 '<link linkend="plcon0"><function>plcon0</function></link>'>
 <!ENTITY plcon1 '<link linkend="plcon1"><function>plcon1</function></link>'>
 <!ENTITY plcon2 '<link linkend="plcon2"><function>plcon2</function></link>'>
@@ -149,6 +150,7 @@
 <!ENTITY plinit '<link linkend="plinit"><function>plinit</function></link>'>
 <!ENTITY pljoin '<link linkend="pljoin"><function>pljoin</function></link>'>
 <!ENTITY pllab '<link linkend="pllab"><function>pllab</function></link>'>
+<!ENTITY pllegend '<link linkend="pllegend"><function>pllegend</function></link>'>
 <!ENTITY pllightsource '<link linkend="pllightsource"><function>pllightsource</function></link>'>
 <!ENTITY plline '<link linkend="plline"><function>plline</function></link>'>
 <!ENTITY plline3 '<link linkend="plline3"><function>plline3</function></link>'>

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

[Plplot-cvs] SF.net SVN: plplot:[12506] trunk/src/pllegend.c

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

Revision: 12506
          http://sourceforge.net/p/plplot/code/12506
Author:   airwin
Date:     2013-09-18 07:23:49 +0000 (Wed, 18 Sep 2013)
Log Message:
-----------
Update doxgyen documentation of pllegend and plcolorbar and associated
internal functions.  I plan no further changes in this documentation
at the present time.

Modified Paths:
--------------
    trunk/src/pllegend.c

Modified: trunk/src/pllegend.c
===================================================================
--- trunk/src/pllegend.c	2013-09-13 04:19:42 UTC (rev 12505)
+++ trunk/src/pllegend.c	2013-09-18 07:23:49 UTC (rev 12506)
@@ -2,8 +2,8 @@
 // All routines that help to create a discrete legend (pllegend) or
 // a continuous legend (plcolorbar).
 //
-// Copyright (C) 2010-2011  Hezekiah M. Carty
-// Copyright (C) 2010-2011  Alan W. Irwin
+// Copyright (C) 2010-2013  Hezekiah M. Carty
+// Copyright (C) 2010-2013  Alan W. Irwin
 //
 // This file is part of PLplot.
 //
@@ -421,17 +421,21 @@
 //! @param position This variable contains bits which control the
 //! overall position of the legend and the definition of the adopted
 //! coordinates used for positions just like what is done for the
-//! position argument for plcolorbar.  Note, however, that the defaults
-//! for the position bits (see below) are different than the plcolorbar
-//! case.  The combination of the PL_POSITION_LEFT, PL_POSITION_RIGHT,
-//! PL_POSITION_TOP, PL_POSITION_BOTTOM, PL_POSITION_INSIDE, and
-//! PL_POSITION_OUTSIDE bits specifies one of the 16 possible standard
-//! positions (the 4 corners and 4 side centers for both the inside
-//! and outside cases) of the legend relative to the adopted
-//! coordinate system.  The adopted coordinates are normalized
-//! viewport coordinates if the PL_POSITION_VIEWPORT bit is set or
-//! normalized subpage coordinates if the PL_POSITION_SUBPAGE bit is
-//! set.  Default position bits: If none of PL_POSITION_LEFT,
+//! position argument for plcolorbar.  However, note that the
+//! defaults for the position bits (see below) are different than the
+//! plcolorbar case.  The combination of the PL_POSITION_LEFT,
+//! PL_POSITION_RIGHT, PL_POSITION_TOP, PL_POSITION_BOTTOM,
+//! PL_POSITION_INSIDE, and PL_POSITION_OUTSIDE bits specifies one of
+//! the 16 possible standard positions (the 4 corners and 4 centers of
+//! the sides for both the inside and outside cases) of the legend
+//! relative to the adopted coordinate system.  The corner positions
+//! are specified by the appropriate combination of two of the
+//! PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP, and
+//! PL_POSITION_BOTTOM bits while the sides are specified by a single
+//! value of one of those bits.  The adopted coordinates are
+//! normalized viewport coordinates if the PL_POSITION_VIEWPORT bit is
+//! set or normalized subpage coordinates if the PL_POSITION_SUBPAGE
+//! bit is set.  Default position bits: If none of PL_POSITION_LEFT,
 //! PL_POSITION_RIGHT, PL_POSITION_TOP, or PL_POSITION_BOTTOM are set,
 //! then the combination of PL_POSITION_RIGHT and PL_POSITION_TOP.  If
 //! neither of PL_POSITION_INSIDE or PL_POSITION_OUTSIDE is set, use
@@ -454,9 +458,9 @@
 //! @param plot_width Horizontal width in adopted coordinates of the
 //! plot area (where colored boxes, lines, and/or symbols are drawn in
 //! the legend).
-//! @param bg_color The cmap0 index of the background color for the legend
+//! @param bg_color The cmap0 color of the background for the legend
 //! (PL_LEGEND_BACKGROUND).
-//! @param bb_color The cmap0 index of the color of the bounding-box
+//! @param bb_color The cmap0 color of the bounding-box
 //! line for the legend (PL_LEGEND_BOUNDING_BOX).
 //! @param bb_style The pllsty style number for the bounding-box line
 //! for the legend (PL_LEGEND_BOUNDING_BOX).
@@ -492,12 +496,12 @@
 //! 0., 0.5, or 1. corresponding to a text that is left justified,
 //! centred, or right justified within the text area, but other values
 //! are allowed as well.
-//! @param text_colors Array of nlegend text colors (cmap0 indices).
+//! @param text_colors Array of nlegend cmap0 text colors.
 //! @param text Array of nlegend pointers to null-terminated text
 //! annotation strings.  Like other PLplot strings specified by the
 //! user, the string must be UTF-8 (including its ascii subset) and
 //! may include any of the PLplot text escapes.
-//! @param box_colors Array of nlegend colors (cmap0 indices) for
+//! @param box_colors Array of nlegend cmap0 colors for
 //! the discrete colored boxes (PL_LEGEND_COLOR_BOX).
 //! @param box_patterns Array of nlegend patterns (plpsty indices)
 //! for the discrete colored boxes (PL_LEGEND_COLOR_BOX).
@@ -506,13 +510,13 @@
 //! (PL_LEGEND_COLOR_BOX).
 //! @param box_line_widths Array of nlegend line widths for the
 //! patterns specified by box_patterns (PL_LEGEND_COLOR_BOX).
-//! @param line_colors Array of nlegend line colors (cmap0 indices)
+//! @param line_colors Array of nlegend cmap0 line colors
 //! (PL_LEGEND_LINE).
 //! @param line_styles Array of nlegend line styles (pllsty indices)
 //! (PL_LEGEND_LINE).
 //! @param line_widths Array of nlegend line widths (PL_LEGEND_LINE).
-//! @param symbol_colors Array of nlegend symbol colors (cmap0
-//! indices) (PL_LEGEND_SYMBOL).
+//! @param symbol_colors Array of nlegend cmap0 symbol colors
+//! (PL_LEGEND_SYMBOL).
 //! @param symbol_scales Array of nlegend scale values for the
 //! symbol height (PL_LEGEND_SYMBOL).
 //! @param symbol_numbers Array of nlegend numbers of symbols to be
@@ -939,7 +943,7 @@
 //! inscribing the triangle.
 //! @param ymax Maximum world Y coordinate of rectangle
 //! inscribing the triangle.
-//! @param color Color (color palette 1) used to fill the end cap.
+//! @param color The cmap1 color used to fill the end cap.
 //!
 
 static void
@@ -1100,7 +1104,6 @@
 //! decorated box + label.  If if_bb is FALSE draw the label.
 //! @param opt Can contain the same control bits as the opt argument
 //! for plcolorbar.  However, the only bits that are relevant here are
-//! PL_COLORBAR_CAP_LOW, PL_COLORBAR_CAP_HIGH,
 //! PL_COLORBAR_ORIENT_(RIGHT|TOP|LEFT|BOTTOM), and
 //! PL_COLORBAR_LABEL_(RIGHT|TOP|LEFT|BOTTOM).  For full documentation
 //! of these bits, see the documentation of opt for plcolorbar.
@@ -1375,15 +1378,15 @@
 //! (after the call) the labelled and decorated color bar height in
 //! adopted coordinates.
 //! @param opt This variable contains bits which control the overall
-//! color bar.  The orientation (direction of the maximum value) of the
-//! color bar is specified with PL_COLORBAR_ORIENT_(RIGHT, TOP, LEFT,
-//! BOTTOM).  If none of those bits are specified, the default
+//! color bar.  The orientation (direction of the maximum value) of
+//! the color bar is specified with PL_COLORBAR_ORIENT_(RIGHT, TOP,
+//! LEFT, BOTTOM).  If none of those bits are specified, the default
 //! orientation is toward the top, i.e., a vertical color bar.  If the
 //! PL_COLORBAR_BACKGROUND bit is set, plot a (semi-transparent)
 //! background for the color bar.  If the PL_COLORBAR_BOUNDING_BOX bit
-//! is set, plot a bounding box for the color bar.  The type of
-//! color bar must be specified with one of PL_COLORBAR_IMAGE,
-//! PL_COLORBAR_SHADE or PL_COLORBAR_GRADIENT.  If more than one of
+//! is set, plot a bounding box for the color bar.  The type of color
+//! bar must be specified with one of PL_COLORBAR_IMAGE,
+//! PL_COLORBAR_SHADE, or PL_COLORBAR_GRADIENT.  If more than one of
 //! those bits is set only the first one in the above list is honored.
 //! The position of the (optional) label/title can be specified with
 //! PL_COLORBAR_LABEL_(RIGHT|TOP|LEFT|BOTTOM).  If no label position
@@ -1391,84 +1394,106 @@
 //! list of bits is specified, only the first one on the list is
 //! honored.  End-caps for the color bar can added with
 //! PL_COLORBAR_CAP_LOW and PL_COLORBAR_CAP_HIGH.  If a particular
-//! color bar cap option is not specified then no cap will be drawn for
-//! that end.  As a special case for PL_COLORBAR_SHADE, the option
+//! color bar cap option is not specified then no cap will be drawn
+//! for that end.  As a special case for PL_COLORBAR_SHADE, the option
 //! PL_COLORBAR_SHADE_LABEL can be specified.  If this option is
 //! provided then any tick marks and tick labels will be placed at the
 //! breaks between shaded segments.  TODO: This should be expanded to
 //! support custom placement of tick marks and tick labels at custom
 //! value locations for any color bar type.
 //! @param position This variable contains bits which control the
-//! overall position of the legend and the definition of the adopted
-//! coordinates used for positions just like what is done for the
-//! position argument for pllegend.  Note, however, that the defaults
-//! for the position bits (see below) are different than the pllegend
-//! case.  The combination of the PL_POSITION_LEFT, PL_POSITION_RIGHT,
-//! PL_POSITION_TOP, PL_POSITION_BOTTOM, PL_POSITION_INSIDE, and
-//! PL_POSITION_OUTSIDE bits specifies one of the 16 possible standard
-//! positions (the 4 corners and 4 side centers for both the inside
-//! and outside cases) of the legend relative to the adopted
-//! coordinate system.  The adopted coordinates are normalized
-//! viewport coordinates if the PL_POSITION_VIEWPORT bit is set or
-//! normalized subpage coordinates if the PL_POSITION_SUBPAGE bit is
-//! set.  Default position bits: If none of PL_POSITION_LEFT,
+//! overall position of the color bar and the definition of the
+//! adopted coordinates used for positions just like what is done for
+//! the position argument for pllegend.  However, note that the
+//! defaults for the position bits (see below) are different than the
+//! pllegend case.  The combination of the PL_POSITION_LEFT,
+//! PL_POSITION_RIGHT, PL_POSITION_TOP, PL_POSITION_BOTTOM,
+//! PL_POSITION_INSIDE, and PL_POSITION_OUTSIDE bits specifies one of
+//! the 16 possible standard positions (the 4 corners and centers of
+//! the 4 sides for both the inside and outside cases) of the color
+//! bar relative to the adopted coordinate system.  The corner
+//! positions are specified by the appropriate combination of two of
+//! the PL_POSITION_LEFT, PL_POSITION_RIGHT, PL_POSITION_TOP, and
+//! PL_POSITION_BOTTOM bits while the sides are specified by a single
+//! value of one of those bits.  The adopted coordinates are
+//! normalized viewport coordinates if the PL_POSITION_VIEWPORT bit is
+//! set or normalized subpage coordinates if the PL_POSITION_SUBPAGE
+//! bit is set.  Default position bits: If none of PL_POSITION_LEFT,
 //! PL_POSITION_RIGHT, PL_POSITION_TOP, or PL_POSITION_BOTTOM are set,
 //! then use PL_POSITION_RIGHT.  If neither of PL_POSITION_INSIDE or
 //! PL_POSITION_OUTSIDE is set, use PL_POSITION_OUTSIDE.  If neither
 //! of PL_POSITION_VIEWPORT or PL_POSITION_SUBPAGE is set, use
 //! PL_POSITION_VIEWPORT.
-//! @param x X offset of the legend position in adopted coordinates
-//! from the specified standard position of the legend.  For positive
+//! @param x X offset of the color bar position in adopted coordinates
+//! from the specified standard position of the color bar.  For positive
 //! x, the direction of motion away from the standard position is
 //! inward/outward from the standard corner positions or standard left
 //! or right positions if the PL_POSITION_INSIDE/PL_POSITION_OUTSIDE
 //! bit is set in position.  For the standard top or bottom positions,
 //! the direction of motion for positive x is toward positive X.
-//! @param y Y offset of the legend position in adopted coordinates
-//! from the specified standard position of the legend.  For positive
+//! @param y Y offset of the color bar position in adopted coordinates
+//! from the specified standard position of the color bar.  For positive
 //! y, the direction of motion away from the standard position is
 //! inward/outward from the standard corner positions or standard top
 //! or bottom positions if the PL_POSITION_INSIDE/PL_POSITION_OUTSIDE
 //! bit is set in position.  For the standard left or right positions,
 //! the direction of motion for positive y is toward positive Y.
-//! @param bg_color The cmap0 index of the background color for the color bar
+//! @param x_length Length of the body of the color bar in the X
+//! direction in adopted coordinates.
+//! @param y_length Length of the body of the color bar in the Y
+//! direction in adopted coordinates.
+//! @param bg_color The cmap0 color of the background for the color bar
 //! (PL_COLORBAR_BACKGROUND).
-//! @param bb_color The cmap0 index of the color of the bounding-box
+//! @param bb_color The cmap0 color of the bounding-box
 //! line for the color bar (PL_COLORBAR_BOUNDING_BOX).
 //! @param bb_style The pllsty style number for the bounding-box line
 //! for the color bar (PL_COLORBAR_BOUNDING_BOX).
-//! @param x_length Length of the body of the color bar in the X
-//! direction in adopted coordinates.
-//! @param y_length Length of the body of the color bar in the Y
-//! direction in adopted coordinates.
-//! @param low_cap_color Color of the low-end color bar cap, if it is drawn.
-//! @param high_cap_color Color of the high-end color bar cap, if it is drawn.
-//! @param cont_color Contour color for PL_COLORBAR_SHADE plots.  This is
-//! passed directly to plshades, so it will be interpreted according to the
-//! design of plshades.
+//! @param low_cap_color The cmap1 color of the low-end color bar cap, if it is drawn (PL_COLORBAR_CAP_LOW).
+//! @param high_cap_color The cmap1 color of the high-end color bar cap, if it is drawn (PL_COLORBAR_CAP_HIGH).
+//! @param cont_color The cmap0 contour color for PL_COLORBAR_SHADE
+//! plots.  This value is passed directly to plshades, so it will be
+//! interpreted according to the design of plshades.
 //! @param cont_width Contour width for PL_COLORBAR_SHADE plots.  This is
 //! passed directly to plshades, so it will be interpreted according to the
 //! design of plshades.
-//! @param n_labels Number of labels to place around the color bar
-//! @param label_opts Options for each label.  n_label total values.
-//! @param labels Text labels for the color bar. No label is drawn if no
-//! label position is specified with one of the
-//! PL_COLORBAR_LABEL_(RIGHT|TOP|LEFT|BOTTOM) bits in the corresponding
-//! label_opts field.
-//! @param n_axes Number of axis definitions provided.  Must be >= 1.
-//! @param axis_opts Axis options for the color bar's major axis, as for plbox.
-//! n_axes values in the array.
-//! @param ticks Spacing of major ticks, as for plbox.  n_axes values in the
-//! array.
-//! @param sub_ticks Number of subticks, as for plbox.  n_axes values in the
-//! array.
-//! @param n_values Number of elements in each values array.
-//! @param values Numeric values for the data range represented by the
-//! color bar.  For PL_COLORBAR_SHADE, this should include one value per break
-//! between segments.  For PL_COLORBAR_IMAGE and PL_COLORBAR_GRADIENT this
-//! includes two values, one for the maximum value on the scale and one for the
-//! minimum value.  The first entry will be used to render the color bar
-//! contents.  All other entries will be used only for axis rendering.
+//! @param n_labels Number of labels to place around the color bar.
+//! @param label_opts An array of n_labels opt values to help calculate the
+//! combined opt value for each of the labels.  For each
+//! different label the combined opt value is the bitwise OR of the
+//! overall opt value and the relevant label_opts array element.  The
+//! only bits that are relevant in a combined opt value for a label
+//! are PL_COLORBAR_ORIENT_(RIGHT|TOP|LEFT|BOTTOM) and
+//! PL_COLORBAR_LABEL_(RIGHT|TOP|LEFT|BOTTOM) (which are documented in
+//! the documentation of the overall opt value).
+//! @param labels n_labels text labels for the color bar. No label is
+//! drawn if no label position is specified with one of the
+//! PL_COLORBAR_LABEL_(RIGHT|TOP|LEFT|BOTTOM) bits in the bitwise OR
+//! of the opt value with the relevant label_opts array element.
+//! @param n_axes Number of axis definitions provided.  This value
+//! must be greater than 0.  It is typically 1 (numerical axis labels
+//! are provided for one of the long edges of the color bar), but it
+//! can be larger if multiple numerical axis labels for the long edges
+//! of the color bar are desired.
+//! @param axis_opts An array of n_axes axis options (interpreted as for
+//! plbox) for the color bar's axis definitions.
+//! @param ticks An array of n_axes values of the spacing of the major
+//! tick marks (interpreted as for plbox) for the color bar's axis
+//! definitions.
+//! @param sub_ticks An array of n_axes values of the number of
+//! subticks (interpreted as for plbox) for the color bar's axis
+//! definitions.
+//! @param n_values An array containing the number of elements in each of the
+//! n_axes rows of the two-dimensional values array.
+//! @param values A two-dimensional array containing the numeric
+//! values for the data range represented by the color bar.  For a row
+//! index of i_axis (where 0 < i_axis < n_axes), the number of
+//! elements in the row is specified by n_values[i_axis].  For
+//! PL_COLORBAR_IMAGE and PL_COLORBAR_GRADIENT the number of elements
+//! is 2, and the corresponding row elements of the values array are
+//! the minimum and maximum value represented by the colorbar.  For
+//! PL_COLORBAR_SHADE, the number and values of the elements of a
+//! row of the values array is interpreted the same
+//! as the nlevel and clevel arguments of plshades.
 //!
 
 void

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

[Plplot-cvs] SF.net SVN: plplot:[12505] trunk/bindings/ada/plplot.adb

[<jb...@us...>]

Revision: 12505
          http://sourceforge.net/p/plplot/code/12505
Author:   jbauck
Date:     2013-09-13 04:19:42 +0000 (Fri, 13 Sep 2013)
Log Message:
-----------
Test. Ignore.

Modified Paths:
--------------
    trunk/bindings/ada/plplot.adb

Modified: trunk/bindings/ada/plplot.adb
===================================================================
--- trunk/bindings/ada/plplot.adb	2013-09-09 22:32:36 UTC (rev 12504)
+++ trunk/bindings/ada/plplot.adb	2013-09-13 04:19:42 UTC (rev 12505)
@@ -1,6 +1,6 @@
 -- $Id$
 
--- Thick Ada binding to PLplot
+-- Thick Ada binding to PLplot 
 
 -- Copyright (C) 2006-2011 Jerry Bauck
 

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

[Plplot-cvs] SF.net SVN: plplot:[12504] trunk/drivers/cairo.c

[<and...@us...>]

Revision: 12504
          http://sourceforge.net/p/plplot/code/12504
Author:   andrewross
Date:     2013-09-09 22:32:36 +0000 (Mon, 09 Sep 2013)
Log Message:
-----------

Modify xcairo driver to honour the -display option to set the display. 

Also exit if opening the display fails since continuing will lead to a crash anyway.

Modified Paths:
--------------
    trunk/drivers/cairo.c

Modified: trunk/drivers/cairo.c
===================================================================
--- trunk/drivers/cairo.c	2013-09-09 14:41:12 UTC (rev 12503)
+++ trunk/drivers/cairo.c	2013-09-09 22:32:36 UTC (rev 12504)
@@ -1922,10 +1922,13 @@
     {
         // X Windows setup
         aStream->XDisplay = NULL;
-        aStream->XDisplay = XOpenDisplay( NULL );
+	if (pls->FileName != NULL) 
+	  aStream->XDisplay = XOpenDisplay( pls->FileName );
+	else
+	  aStream->XDisplay = XOpenDisplay( NULL );
         if ( aStream->XDisplay == NULL )
         {
-            printf( "Failed to open X Windows display\n" );
+            plexit( "Failed to open X Windows display\n" );
             // some sort of error here
         }
         XScreen    = DefaultScreen( aStream->XDisplay );

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

[Plplot-cvs] SF.net SVN: plplot:[12503] trunk

[<and...@us...>]

Revision: 12503
          http://sourceforge.net/p/plplot/code/12503
Author:   andrewross
Date:     2013-09-09 14:41:12 +0000 (Mon, 09 Sep 2013)
Log Message:
-----------
Update D bindings for latest version of plcolorbar. Also add plscmap1_range and plgcmap1_range. 

Update example 16 to use plcolorbar as in the C version.

Modified Paths:
--------------
    trunk/bindings/d/plplot.d
    trunk/examples/d/x16d.d

Modified: trunk/bindings/d/plplot.d
===================================================================
--- trunk/bindings/d/plplot.d	2013-09-07 08:29:45 UTC (rev 12502)
+++ trunk/bindings/d/plplot.d	2013-09-09 14:41:12 UTC (rev 12503)
@@ -157,6 +157,44 @@
         toStringz( zopt ), toStringz( zlabel ), ztick, nsubz );
 }
 
+// Routine for drawing continous colour legends
+void plcolorbar( PLFLT *p_colorbar_width, PLFLT *p_colorbar_height,
+              PLINT opt, PLINT position, PLFLT x, PLFLT y,
+              PLFLT x_length, PLFLT y_length,
+              PLINT bg_color, PLINT bb_color, PLINT bb_style,
+              PLFLT low_cap_color, PLFLT high_cap_color,
+              PLINT cont_color, PLFLT cont_width,
+              PLINT[] label_opts, string[] label,
+              string[] axis_opts,
+              PLFLT[] ticks, PLINT[] sub_ticks,
+              PLFLT[][] values )
+{
+    PLINT n_labels = cast(PLINT) label_opts.length;
+    PLINT n_axes = cast(PLINT) axis_opts.length;
+    PLINT[] n_values = new PLINT[values.length];
+    for (size_t i=0; i<values.length;i++) {
+        n_values[i] = cast(PLINT) values[i].length;
+    }
+    immutable( char ) * *labelz    = array( map!toStringz( label ) ).ptr;
+    immutable( char ) * *axis_optsz    = array( map!toStringz( axis_opts ) ).ptr;
+    assert( n_labels == label.length, "plcolorbar(): Arrays must be of same length!" );
+    assert( n_labels == label_opts.length, "plcolorbar(): Arrays must be of same length!" );
+    assert( n_axes == axis_opts.length, "plcolorbar(): Arrays must be of same length!" );
+    assert( n_axes == ticks.length, "plcolorbar(): Arrays must be of same length!" );
+    assert( n_axes == sub_ticks.length, "plcolorbar(): Arrays must be of same length!" );
+
+    c_plcolorbar(p_colorbar_width, p_colorbar_height,
+              opt, position, x, y,
+              x_length, y_length,
+              bg_color, bb_color, bb_style,
+              low_cap_color, high_cap_color,
+              cont_color, cont_width,
+              n_labels, label_opts.ptr, labelz,
+              n_axes, axis_optsz,
+              ticks.ptr, sub_ticks.ptr,
+              n_values.ptr, convert_array(values) );
+}
+
 // Draws a contour plot from data in f(nx,ny).  Is just a front-end to
 // plfcont, with a particular choice for f2eval and f2eval_data.
 //
@@ -1323,6 +1361,7 @@
 alias c_plclear      plclear;
 alias c_plcol0       plcol0;
 alias c_plcol1       plcol1;
+//alias c_plcolorbar   plcolorbar;
 alias c_plconfigtime plconfigtime;
 //alias c_plcont plcont;
 alias c_plcpstrm     plcpstrm;
@@ -1413,6 +1452,7 @@
 //alias c_plscmap1l plscmap1l;
 //alias c_plscmap1la plscmap1la;
 alias c_plscmap1n      plscmap1n;
+alias c_plscmap1_range      plscmap1_range;
 alias c_plscol0        plscol0;
 alias c_plscol0a       plscol0a;
 alias c_plscolbg       plscolbg;
@@ -1559,6 +1599,7 @@
 // Set color, map 1.  Argument is a float between 0. and 1.
 void c_plcol1( PLFLT col1 );
 
+
 // Configure transformation between continuous and broken-down time (and
 // vice versa) for current stream.
 void c_plconfigtime( PLFLT scale, PLFLT offset1, PLFLT offset2, PLINT ccontrol, PLBOOL ifbtime_offset,
@@ -1780,10 +1821,18 @@
 const PL_COLORBAR_IMAGE        = 16;
 const PL_COLORBAR_SHADE        = 32;
 const PL_COLORBAR_GRADIENT     = 64;
-const PL_COLORBAR_CAP_LOW      = 128;
-const PL_COLORBAR_CAP_HIGH     = 256;
-const PL_COLORBAR_SHADE_LABEL  = 512;
+const PL_COLORBAR_CAP_NONE      = 128;
+const PL_COLORBAR_CAP_LOW      = 256;
+const PL_COLORBAR_CAP_HIGH     = 512;
+const PL_COLORBAR_SHADE_LABEL  = 1024;
+const PL_COLORBAR_ORIENT_RIGHT = 2048;
+const PL_COLORBAR_ORIENT_TOP   = 4096;
+const PL_COLORBAR_ORIENT_LEFT  = 8192;
+const PL_COLORBAR_ORIENT_BOTTOM = 16384;
+const PL_COLORBAR_BACKGROUND   = 32768;
+const PL_COLORBAR_BOUNDING_BOX = 65536;
 
+
 // Routine for drawing discrete line, symbol, or cmap0 legends
 void c_pllegend( PLFLT *p_legend_width, PLFLT *p_legend_height,
                  PLINT opt, PLINT position, PLFLT x, PLFLT y, PLFLT plot_width,
@@ -1800,6 +1849,18 @@
                  PLINT *symbol_colors, PLFLT *symbol_scales,
                  PLINT *symbol_numbers, const char **symbols );
 
+// Routine for drawing continous colour legends
+void c_plcolorbar( PLFLT *p_colorbar_width, PLFLT *p_colorbar_height,
+              PLINT opt, PLINT position, PLFLT x, PLFLT y,
+              PLFLT x_length, PLFLT y_length,
+              PLINT bg_color, PLINT bb_color, PLINT bb_style,
+              PLFLT low_cap_color, PLFLT high_cap_color,
+              PLINT cont_color, PLFLT cont_width,
+              PLINT n_labels, const PLINT *label_opts, const char **label,
+              PLINT n_axes, const char ** axis_opts,
+              const PLFLT *ticks, const PLINT *sub_ticks,
+              const PLINT *n_values, const PLFLT **values );
+
 // Sets position of the light source
 void c_pllightsource( PLFLT x, PLFLT y, PLFLT z );
 
@@ -1956,6 +2017,12 @@
 // Set number of colors in cmap 1
 void c_plscmap1n( PLINT ncol1 );
 
+// Set the color map 1 range used in continuous plots
+void c_plscmap1_range( PLFLT min_color, PLFLT max_color );
+
+// Get the color map 1 range used in continuous plots
+void c_plgcmap1_range( PLFLT *min_color, PLFLT *max_color );
+
 // Set a given color from color map 0 by 8 bit RGB value
 void c_plscol0( PLINT icol0, PLINT r, PLINT g, PLINT b );
 

Modified: trunk/examples/d/x16d.d
===================================================================
--- trunk/examples/d/x16d.d	2013-09-07 08:29:45 UTC (rev 12502)
+++ trunk/examples/d/x16d.d	2013-09-09 14:41:12 UTC (rev 12503)
@@ -22,6 +22,9 @@
                   // anyway, and cannot be reproduced by any
                   // front end other than the C one.
 
+// For now, don't show the colorbars while we are working out the API.
+int colorbar = 1;
+
 extern ( C ) {
 // Transformation function
 PLFLT[] tr;
@@ -186,8 +189,33 @@
     }
 
     // Plot using identity transform
-    PLINT fill_width = 2, cont_color = 0, cont_width = 0;
+    PLFLT fill_width = 2., cont_width = 0.;
+    PLFLT colorbar_width, colorbar_height;
+    PLINT cont_color = 0;
 
+    const int NUM_AXES = 1;
+    string[] axis_opts = [
+        "bcvtm",
+    ];
+    PLFLT[] values[NUM_AXES];
+    for (size_t i = 0; i<NUM_AXES;i++) {
+      values[i] = new PLFLT[ns];
+    }
+    PLFLT[]      axis_ticks = [
+        0.0,
+    ];
+    PLINT[]      axis_subticks = [
+        0,
+    ];
+    const int NUM_LABELS = 1;
+    PLINT      label_opts[] = [
+        PL_COLORBAR_LABEL_BOTTOM,
+    ];
+    string[] labels = [
+        "Magnitude",
+    ];
+
+
     pladv( 0 );
     plvpor( 0.1, 0.9, 0.1, 0.9 );
     plwind( -1.0, 1.0, -1.0, 1.0 );
@@ -197,6 +225,30 @@
     plshades( z, null, -1., 1., -1., 1., shedge, fill_width,
         cont_color, cont_width, 1 );
 
+    if ( colorbar )
+    {
+        // Smaller text
+        plschr( 0.0, 0.75 );
+        // Small ticks on the vertical axis
+        plsmaj( 0.0, 0.5 );
+        plsmin( 0.0, 0.5 );
+
+        values[0]     = shedge;
+        plcolorbar( &colorbar_width, &colorbar_height,
+            PL_COLORBAR_SHADE | PL_COLORBAR_SHADE_LABEL, 0,
+            0.005, 0.0, 0.0375, 0.875, 0, 1, 1, 0.0, 0.0,
+            cont_color, cont_width,
+            label_opts, labels,
+            axis_opts,
+            axis_ticks, axis_subticks,
+            values );
+
+        // Reset text and tick sizes
+        plschr( 0.0, 1.0 );
+        plsmaj( 0.0, 1.0 );
+        plsmin( 0.0, 1.0 );
+    }
+
     plcol0( 1 );
     plbox( "bcnst", 0.0, 0, "bcnstv", 0.0, 0 );
     plcol0( 2 );
@@ -219,7 +271,31 @@
 
     plshades( z, null, -1., 1., -1., 1., shedge, fill_width,
         cont_color, cont_width, 1, cgrid1 );
+    if ( colorbar )
+    {
+        // Smaller text
+        plschr( 0.0, 0.75 );
+        // Small ticks on the vertical axis
+        plsmaj( 0.0, 0.5 );
+        plsmin( 0.0, 0.5 );
 
+        values[0]     = shedge;
+        plcolorbar( &colorbar_width, &colorbar_height,
+            PL_COLORBAR_SHADE | PL_COLORBAR_SHADE_LABEL, 0,
+            0.005, 0.0, 0.0375, 0.875, 0, 1, 1, 0.0, 0.0,
+            cont_color, cont_width,
+            label_opts, labels,
+            axis_opts,
+            axis_ticks, axis_subticks,
+            values );
+
+        // Reset text and tick sizes
+        plschr( 0.0, 1.0 );
+        plsmaj( 0.0, 1.0 );
+        plsmin( 0.0, 1.0 );
+    }
+
+
     plcol0( 1 );
     plbox( "bcnst", 0.0, 0, "bcnstv", 0.0, 0 );
     plcol0( 2 );
@@ -243,6 +319,30 @@
     plshades( z, null, -1., 1., -1., 1., shedge, fill_width,
         cont_color, cont_width, 0, cgrid2 );
 
+    if ( colorbar )
+    {
+        // Smaller text
+        plschr( 0.0, 0.75 );
+        // Small ticks on the vertical axis
+        plsmaj( 0.0, 0.5 );
+        plsmin( 0.0, 0.5 );
+
+        values[0]     = shedge;
+        plcolorbar( &colorbar_width, &colorbar_height,
+            PL_COLORBAR_SHADE | PL_COLORBAR_SHADE_LABEL, 0,
+            0.005, 0.0, 0.0375, 0.875, 0, 1, 1, 0.0, 0.0,
+            cont_color, cont_width,
+            label_opts, labels,
+            axis_opts,
+            axis_ticks, axis_subticks,
+            values );
+
+        // Reset text and tick sizes
+        plschr( 0.0, 1.0 );
+        plsmaj( 0.0, 1.0 );
+        plsmin( 0.0, 1.0 );
+    }
+
     plcol0( 1 );
     plbox( "bcnst", 0.0, 0, "bcnstv", 0.0, 0 );
     plcol0( 2 );
@@ -268,6 +368,30 @@
     plshades( z, null, -1., 1., -1., 1., shedge, fill_width,
         2, 3, 0, cgrid2 );
 
+    if ( colorbar )
+    {
+        // Smaller text
+        plschr( 0.0, 0.75 );
+        // Small ticks on the vertical axis
+        plsmaj( 0.0, 0.5 );
+        plsmin( 0.0, 0.5 );
+
+        values[0]     = shedge;
+        plcolorbar( &colorbar_width, &colorbar_height,
+            PL_COLORBAR_SHADE | PL_COLORBAR_SHADE_LABEL, 0,
+            0.005, 0.0, 0.0375, 0.875, 0, 1, 1, 0.0, 0.0,
+            2, 3.,
+            label_opts, labels,
+            axis_opts,
+            axis_ticks, axis_subticks,
+            values );
+
+        // Reset text and tick sizes
+        plschr( 0.0, 1.0 );
+        plsmaj( 0.0, 1.0 );
+        plsmin( 0.0, 1.0 );
+    }
+
     plcol0( 1 );
     plbox( "bcnst", 0.0, 0, "bcnstv", 0.0, 0 );
     plcol0( 2 );
@@ -340,6 +464,30 @@
     plshades( z, null, -1., 1., -1., 1., shedge, fill_width,
         cont_color, cont_width, 0, cgrid2 );
 
+    if ( colorbar )
+    {
+        // Smaller text
+        plschr( 0.0, 0.75 );
+        // Small ticks on the vertical axis
+        plsmaj( 0.0, 0.5 );
+        plsmin( 0.0, 0.5 );
+
+        values[0]     = shedge;
+        plcolorbar( &colorbar_width, &colorbar_height,
+            PL_COLORBAR_SHADE | PL_COLORBAR_SHADE_LABEL, 0,
+            0.005, 0.0, 0.0375, 0.875, 0, 1, 1, 0.0, 0.0,
+            cont_color, cont_width,
+            label_opts, labels,
+            axis_opts,
+            axis_ticks, axis_subticks,
+            values );
+
+        // Reset text and tick sizes
+        plschr( 0.0, 1.0 );
+        plsmaj( 0.0, 1.0 );
+        plsmin( 0.0, 1.0 );
+    }
+
     // Now we can draw the perimeter.  (If do before, shade stuff may overlap.)
     PLFLT[PERIMETERPTS] px, py;
     for ( int i = 0; i < PERIMETERPTS; i++ )

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

[Plplot-cvs] SF.net SVN: plplot:[12502] trunk

[<arj...@us...>]

Revision: 12502
          http://sourceforge.net/p/plplot/code/12502
Author:   arjenmarkus
Date:     2013-09-07 08:29:45 +0000 (Sat, 07 Sep 2013)
Log Message:
-----------
Rearrange the order of including header files to avoid a conflict between the Windows header and the X11 header - the latter defines the macro Status which the first uses as an argument name.

Furthermore, because of the routine cairo_win32_surface_create is missing from the cairo library, we can not build the wincairo device. For now this is turned off under Cygwin.

Modified Paths:
--------------
    trunk/cmake/modules/cairo.cmake
    trunk/drivers/cairo.c

Modified: trunk/cmake/modules/cairo.cmake
===================================================================
--- trunk/cmake/modules/cairo.cmake	2013-08-30 19:13:41 UTC (rev 12501)
+++ trunk/cmake/modules/cairo.cmake	2013-09-07 08:29:45 UTC (rev 12502)
@@ -36,7 +36,7 @@
 # cairo_LINK_FLAGS	  - list of full path names of libraries and
 # 			    linker flags for dynamic cairo device driver.
 # cairo_RPATH	       	  - RPATH directory list for cairo device driver.
-# 			    current assumption is the list only has one 
+# 			    current assumption is the list only has one
 #			    element corresponding to the pkg-config libdir
 #			    variable for pangocairo.
 # DRIVERS_LINK_FLAGS	  - list of device LINK_FLAGS for case
@@ -55,13 +55,13 @@
     OR PLD_pngcairo
     OR PLD_pscairo
     OR PLD_epscairo
-    OR PLD_svgcairo 
+    OR PLD_svgcairo
     OR PLD_xcairo
     OR PLD_extcairo
     OR PLD_wincairo
     )
   if(NOT PKG_CONFIG_EXECUTABLE)
-    message(STATUS 
+    message(STATUS
       "WARNING: pkg-config not found. Setting cairo drivers to OFF."
       )
     set(PLD_memcairo OFF CACHE BOOL "Enable memcairo device" FORCE)
@@ -80,7 +80,7 @@
   OR PLD_pngcairo
   OR PLD_pscairo
   OR PLD_epscairo
-  OR PLD_svgcairo 
+  OR PLD_svgcairo
   OR PLD_xcairo
   OR PLD_extcairo
   OR PLD_wincairo
@@ -92,7 +92,7 @@
     OR PLD_pngcairo
     OR PLD_pscairo
     OR PLD_epscairo
-    OR PLD_svgcairo 
+    OR PLD_svgcairo
     OR PLD_xcairo
     OR PLD_extcairo
     OR PLD_wincairo
@@ -101,13 +101,13 @@
     pangocairo
     includedir
     linkdir
-    linkflags 
+    linkflags
     cflags
     version
     _CAIRO
     )
   if(linkflags)
-    # Check that the pangocairo library version is recent 
+    # Check that the pangocairo library version is recent
     # enough to efficiently handle text clipping.
     # If it is not then we print a warning.
     transform_version(NUMERICAL_PANGOCAIRO_MINIMUM_VERSION "1.20.5")
@@ -119,12 +119,12 @@
     filter_rpath(cairo_RPATH)
     if(PLD_xcairo AND X11_COMPILE_FLAGS)
       # Blank-delimited required.
-      string(REGEX REPLACE ";" " " 
+      string(REGEX REPLACE ";" " "
 	cairo_COMPILE_FLAGS "${cflags} ${X11_COMPILE_FLAGS}"
 	)
       set(cairo_LINK_FLAGS ${linkflags} ${X11_LIBRARIES})
     else(PLD_xcairo AND X11_COMPILE_FLAGS)
-      message(STATUS 
+      message(STATUS
 	"WARNING: X windows not found. Setting xcairo driver to OFF."
 	)
       # Blank-delimited required.
@@ -133,7 +133,7 @@
       string(REGEX REPLACE ";" " " cairo_COMPILE_FLAGS "${cflags}")
       set(cairo_LINK_FLAGS ${linkflags})
     endif(PLD_xcairo AND X11_COMPILE_FLAGS)
-    
+
     #message("cairo_COMPILE_FLAGS = ${cairo_COMPILE_FLAGS}")
     #message("cairo_LINK_FLAGS = ${cairo_LINK_FLAGS}")
 
@@ -165,7 +165,7 @@
   OR PLD_pngcairo
   OR PLD_pscairo
   OR PLD_epscairo
-  OR PLD_svgcairo 
+  OR PLD_svgcairo
   OR PLD_xcairo
   OR PLD_extcairo
   OR PLD_wincairo
@@ -180,8 +180,15 @@
 endif(NOT PLD_extcairo)
 
 if(NOT WIN32_OR_CYGWIN)
-  message(STATUS 
+  message(STATUS
     "Not a Windows platform so setting wincairo driver to OFF."
     )
   set(PLD_wincairo OFF CACHE BOOL "Enable wincairo device" FORCE)
+else(NOT WIN32_OR_CYGWIN)
+  if(CYGWIN)
+    message(STATUS
+      "Cygwin does not currently provide support for the wincairo driver - turning this OFF."
+      )
+    set(PLD_wincairo OFF CACHE BOOL "Enable wincairo device" FORCE)
+  endif(CYGWIN)
 endif(NOT WIN32_OR_CYGWIN)

Modified: trunk/drivers/cairo.c
===================================================================
--- trunk/drivers/cairo.c	2013-08-30 19:13:41 UTC (rev 12501)
+++ trunk/drivers/cairo.c	2013-09-07 08:29:45 UTC (rev 12502)
@@ -41,6 +41,9 @@
 #include "drivers.h"
 
 // Driver-dependent includes
+#if defined ( PLD_wincairo )
+#include <windows.h>
+#endif
 #if defined ( PLD_xcairo )
 #include <cairo-xlib.h>
 #include <X11/X.h>
@@ -58,10 +61,8 @@
 #if defined ( PLD_svgcairo )
 #include <cairo-svg.h>
 #endif
-#if defined ( PLD_wincairo )
-#include <windows.h>
-#endif
 
+
 //--------------------------------------------------------------------------
 // Constants & global (to this file) variables
 //--------------------------------------------------------------------------

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

[Plplot-cvs] SF.net SVN: plplot:[12501] trunk/doc/docbook/src/CMakeLists.txt

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

Revision: 12501
          http://sourceforge.net/p/plplot/code/12501
Author:   airwin
Date:     2013-08-30 19:13:41 +0000 (Fri, 30 Aug 2013)
Log Message:
-----------
CMake code fixups.

Move creation of jadetex.cfg from a place that is always executed
to the appropriate Boolean block.

Do not remove info directory that is initially created at cmake time.
This solves a bug when the info target is reinvoked at make time after
a change to the docbook source.

Specifically ignore environment variable DESTDIR when xmlto --with-fop
is invoked.  This works around a bug in xmlto which (on Debian at
least) craps out when DESTDIR is specified.

Tested by: Alan W. Irwin <ai...@us...> using the
-DBUILD_DOC=ON -DBUILD_DOX_DOC=ON cmake options and the install
target invoked in the following ways:

make -j4 install
make DESTDIR=whatever -j4 install

Modified Paths:
--------------
    trunk/doc/docbook/src/CMakeLists.txt

Modified: trunk/doc/docbook/src/CMakeLists.txt
===================================================================
--- trunk/doc/docbook/src/CMakeLists.txt	2013-08-30 16:41:29 UTC (rev 12500)
+++ trunk/doc/docbook/src/CMakeLists.txt	2013-08-30 19:13:41 UTC (rev 12501)
@@ -71,13 +71,6 @@
   ${CMAKE_CURRENT_SOURCE_DIR}/math.ent
   )
 
-execute_process(
-  COMMAND
-  ${CMAKE_COMMAND} -E copy_if_different 
-  ${CMAKE_CURRENT_SOURCE_DIR}/jadetex.cfg
-  ${CMAKE_CURRENT_BINARY_DIR}/jadetex.cfg
-  )
-
 if(
     PREBUILT_DOC
     AND EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/static_built_files
@@ -247,7 +240,6 @@
 	-E chdir ${INFO_TMPDIR} ls |cat > ${CMAKE_CURRENT_BINARY_DIR}/${INFO_MANIFEST}
 	COMMAND mv
 	${INFO_TMPDIR}/* ${CMAKE_CURRENT_BINARY_DIR}
-	COMMAND rmdir ${INFO_TMPDIR}
 	DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}.texi
 	)
 
@@ -398,13 +390,16 @@
 
 	add_custom_command(
 	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.ps.gz
-	  COMMAND ${XMLTO} -vv --with-fop -x ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT} ps ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
+	  # xmlto --with-fop is currently (at least on Debian) craps out
+          # if DESTDIR is specified so make sure it is NOT specified.
+	  COMMAND env DESTDIR= ${XMLTO} -vv --with-fop -x ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT} ps ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
 	  COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-print.ps ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.ps
 	  COMMAND ${GZIP} -f ${BASE}.ps
 	  DEPENDS
 	  ${SOURCE_FILES} 
 	  ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
 	  ${CMAKE_CURRENT_SOURCE_DIR}/inline-print_xsl.ent
+	  VERBATIM
 	  )
 	add_custom_target(
 	  ps_target ALL 
@@ -425,12 +420,15 @@
 
 	add_custom_command(
 	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.pdf
-	  COMMAND ${XMLTO} -vv --with-fop -x ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT} pdf ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
+	  # xmlto --with-fop is currently (at least on Debian) craps out
+          # if DESTDIR is specified so make sure it is NOT specified.
+	  COMMAND env DESTDIR= ${XMLTO} -vv --with-fop -x ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT} pdf ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
 	  COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-print.pdf ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.pdf
 	  DEPENDS
 	  ${SOURCE_FILES} 
 	  ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
 	  ${CMAKE_CURRENT_SOURCE_DIR}/inline-print_xsl.ent
+          VERBATIM
 	  )
 	add_custom_target(
 	  pdf_target ALL 
@@ -519,6 +517,13 @@
 	  ${CMAKE_CURRENT_BINARY_DIR}/pdftex.map
 	  )
 
+	execute_process(
+	  COMMAND
+	  ${CMAKE_COMMAND} -E copy_if_different 
+	  ${CMAKE_CURRENT_SOURCE_DIR}/jadetex.cfg
+	  ${CMAKE_CURRENT_BINARY_DIR}/jadetex.cfg
+	  )
+
 	# Custom commands for building print version of documentation
 	add_custom_command(
 	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.jadetex

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

[Plplot-cvs] SF.net SVN: plplot:[12500] trunk/doc/docbook/src/CMakeLists.txt

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

Revision: 12500
          http://sourceforge.net/p/plplot/code/12500
Author:   airwin
Date:     2013-08-30 16:41:29 +0000 (Fri, 30 Aug 2013)
Log Message:
-----------
install(CODE ... changes.

Attempt to deal with issues found recently by Orion Poplawski on Fedora.
Suppress warnings about setting policy and change from undocumented to
documented form of the file(INSTALL ... signature.

Modified Paths:
--------------
    trunk/doc/docbook/src/CMakeLists.txt

Modified: trunk/doc/docbook/src/CMakeLists.txt
===================================================================
--- trunk/doc/docbook/src/CMakeLists.txt	2013-08-28 01:05:27 UTC (rev 12499)
+++ trunk/doc/docbook/src/CMakeLists.txt	2013-08-30 16:41:29 UTC (rev 12500)
@@ -682,6 +682,9 @@
   install(CODE "
 # Suppress empty element warning.
 cmake_policy(SET CMP0007 NEW)
+# Suppress warning about setting the above policy!
+cmake_policy(SET CMP0011 NEW)
+
 file(READ ${CMAKE_CURRENT_BINARY_DIR}/${INFO_MANIFEST} INFO_FILES)
 # Convert to list with trailing empty element
 string(REGEX REPLACE \"\n\" \";\" INFO_FILES \"\${INFO_FILES}\")
@@ -689,7 +692,7 @@
 list(REMOVE_ITEM INFO_FILES \"\")
 foreach(file \${INFO_FILES})
   # INSTALL_DESTINATION signature automatically honors DESTDIR.
-  file(INSTALL DESTINATION ${INFO_DIR} TYPE FILE FILES \"\${file}\")
+  file(INSTALL \"${CMAKE_CURRENT_BINARY_DIR}/\${file}\" DESTINATION ${INFO_DIR})
 endforeach (file \"\${INFO_FILES}\")
 "
     )
@@ -699,6 +702,8 @@
   install(CODE "
 # Suppress empty element warning.
 cmake_policy(SET CMP0007 NEW)
+# Suppress warning about setting the above policy!
+cmake_policy(SET CMP0011 NEW)
 file(READ ${CMAKE_CURRENT_BINARY_DIR}/${MAN_MANIFEST} MAN_FILES)
 # Convert to list with trailing empty element
 string(REGEX REPLACE \"\n\" \";\" MAN_FILES \"\${MAN_FILES}\")
@@ -706,7 +711,7 @@
 list(REMOVE_ITEM MAN_FILES \"\")
 foreach(file \${MAN_FILES})
   # INSTALL_DESTINATION signature automatically honors DESTDIR.
-  file(INSTALL DESTINATION ${MAN_DIR}/man3 TYPE FILE FILES \"\${file}\")
+  file(INSTALL \"${CMAKE_CURRENT_BINARY_DIR}/\${file}\" DESTINATION ${MAN_DIR}/man3)
 endforeach (file \"\${MAN_FILES}\")
 "
     )
@@ -717,6 +722,8 @@
   install(CODE "
 # Suppress empty element warning.
 cmake_policy(SET CMP0007 NEW)
+# Suppress warning about setting the above policy!
+cmake_policy(SET CMP0011 NEW)
 file(READ ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST} HTML_FILES)
 # Convert to list with trailing empty element
 string(REGEX REPLACE \"\n\" \";\" HTML_FILES \"\${HTML_FILES}\")
@@ -724,7 +731,7 @@
 list(REMOVE_ITEM HTML_FILES \"\")
 foreach(file \${HTML_FILES})
   # INSTALL_DESTINATION signature automatically honors DESTDIR.
-  file(INSTALL DESTINATION ${DOC_DIR}/html TYPE FILE FILES \"\${file}\")
+  file(INSTALL \"${CMAKE_CURRENT_BINARY_DIR}/\${file}\" DESTINATION ${DOC_DIR}/html)
 endforeach (file \"\${HTML_FILES}\")
 "
     )

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

[Plplot-cvs] SF.net SVN: plplot:[12499] trunk/src/pllegend.c

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

Revision: 12499
          http://sourceforge.net/p/plplot/code/12499
Author:   airwin
Date:     2013-08-28 01:05:27 +0000 (Wed, 28 Aug 2013)
Log Message:
-----------
Systematic commentary (including special doxygen commentary) changes
to replace the word "colorbar" by "color bar". 

Modified Paths:
--------------
    trunk/src/pllegend.c

Modified: trunk/src/pllegend.c
===================================================================
--- trunk/src/pllegend.c	2013-08-27 23:03:51 UTC (rev 12498)
+++ trunk/src/pllegend.c	2013-08-28 01:05:27 UTC (rev 12499)
@@ -1009,7 +1009,7 @@
 }
 
 //--------------------------------------------------------------------------
-//! Draw box (when if_bb FALSE) around colorbar with possible tick
+//! Draw box (when if_bb FALSE) around color bar with possible tick
 //! marks, numerical labels of those tick marks, and exponent
 //! decorations of that box or else (when if_bb TRUE) calculate
 //! bounding box of that decorated box.
@@ -1022,7 +1022,7 @@
 //! PL_COLORBAR_ORIENT_(RIGHT|TOP|LEFT|BOTTOM).  For full
 //! documentation of these bits, see the documentation of opt for
 //! plcolorbar.
-//! @param axis_opts Axis options for the colorbar's major axis, as
+//! @param axis_opts Axis options for the color bar's major axis, as
 //! for plcolorbar.
 //! @param if_edge If if_edge is TRUE (FALSE) do (do not) draw the edge of
 //! the colorbox.
@@ -1071,7 +1071,7 @@
         remove_characters( local_axis_opts, "TtXx" );
     }
 
-    // Draw the outline for the entire colorbar, tick marks, tick labels.
+    // Draw the outline for the entire color bar, tick marks, tick labels.
 
     if ( if_edge )
         edge_string = "bc";
@@ -1092,7 +1092,7 @@
 
 //--------------------------------------------------------------------------
 //! Draw label (when if_bb FALSE) with appropriate position relative to the
-//! "inner" bounding-box of the decorated box around the colorbar
+//! "inner" bounding-box of the decorated box around the color bar
 //! or else (when if_bb TRUE) calculate combined bounding box of that label
 //! + decorated box.
 //!
@@ -1104,7 +1104,7 @@
 //! PL_COLORBAR_ORIENT_(RIGHT|TOP|LEFT|BOTTOM), and
 //! PL_COLORBAR_LABEL_(RIGHT|TOP|LEFT|BOTTOM).  For full documentation
 //! of these bits, see the documentation of opt for plcolorbar.
-//! @param label Text label for the colorbar.  No label is drawn if no
+//! @param label Text label for the color bar.  No label is drawn if no
 //! label position is specified with one of the
 //! PL_COLORBAR_LABEL_(RIGHT|TOP|LEFT|BOTTOM) bits in opt.
 
@@ -1305,7 +1305,7 @@
 }
 
 //--------------------------------------------------------------------------
-//! Calculate important positional limits for colorbar as a function
+//! Calculate important positional limits for color bar as a function
 //! of the current bounding box limits and prior bounding-box height.
 //! plvpor(0, prior_bb_width, 0, prior_bb_height) is called before
 //! each bounding-box calculation and this calculate_limits call,
@@ -1369,33 +1369,35 @@
 //! Plot color bar for image, shade or gradient plots.
 //!
 //! @param p_colorbar_width Pointer to a location which contains
-//! (after the call) the labelled and decorated colorbar width in
+//! (after the call) the labelled and decorated color bar width in
 //! adopted coordinates.
 //! @param p_colorbar_height Pointer to a location which contains
-//! (after the call) the labelled and decorated colorbar height in
+//! (after the call) the labelled and decorated color bar height in
 //! adopted coordinates.
 //! @param opt This variable contains bits which control the overall
-//! colorbar.  The orientation (direction of the maximum value) of the
-//! colorbar is specified with PL_COLORBAR_ORIENT_(RIGHT, TOP, LEFT,
+//! color bar.  The orientation (direction of the maximum value) of the
+//! color bar is specified with PL_COLORBAR_ORIENT_(RIGHT, TOP, LEFT,
 //! BOTTOM).  If none of those bits are specified, the default
-//! orientation is toward the top, i.e., a vertical colorbar.  The
-//! type of colorbar must be specified with one of PL_COLORBAR_IMAGE,
+//! orientation is toward the top, i.e., a vertical color bar.  If the
+//! PL_COLORBAR_BACKGROUND bit is set, plot a (semi-transparent)
+//! background for the color bar.  If the PL_COLORBAR_BOUNDING_BOX bit
+//! is set, plot a bounding box for the color bar.  The type of
+//! color bar must be specified with one of PL_COLORBAR_IMAGE,
 //! PL_COLORBAR_SHADE or PL_COLORBAR_GRADIENT.  If more than one of
 //! those bits is set only the first one in the above list is honored.
 //! The position of the (optional) label/title can be specified with
 //! PL_COLORBAR_LABEL_(RIGHT|TOP|LEFT|BOTTOM).  If no label position
 //! bit is set then no label will be drawn.  If more than one of this
 //! list of bits is specified, only the first one on the list is
-//! honored.  End-caps for the colorbar can added with
+//! honored.  End-caps for the color bar can added with
 //! PL_COLORBAR_CAP_LOW and PL_COLORBAR_CAP_HIGH.  If a particular
-//! colorbar cap option is not specified then no cap will be drawn for
+//! color bar cap option is not specified then no cap will be drawn for
 //! that end.  As a special case for PL_COLORBAR_SHADE, the option
 //! PL_COLORBAR_SHADE_LABEL can be specified.  If this option is
 //! provided then any tick marks and tick labels will be placed at the
-//! breaks between shaded segments.
-//! TODO: This should be expanded to support custom placement of tick
-//! marks and tick labels at custom value locations for any colorbar
-//! type.
+//! breaks between shaded segments.  TODO: This should be expanded to
+//! support custom placement of tick marks and tick labels at custom
+//! value locations for any color bar type.
 //! @param position This variable contains bits which control the
 //! overall position of the legend and the definition of the adopted
 //! coordinates used for positions just like what is done for the
@@ -1429,15 +1431,15 @@
 //! or bottom positions if the PL_POSITION_INSIDE/PL_POSITION_OUTSIDE
 //! bit is set in position.  For the standard left or right positions,
 //! the direction of motion for positive y is toward positive Y.
-//! @param bg_color The cmap0 index of the background color for the colorbar
+//! @param bg_color The cmap0 index of the background color for the color bar
 //! (PL_COLORBAR_BACKGROUND).
 //! @param bb_color The cmap0 index of the color of the bounding-box
-//! line for the colorbar (PL_COLORBAR_BOUNDING_BOX).
+//! line for the color bar (PL_COLORBAR_BOUNDING_BOX).
 //! @param bb_style The pllsty style number for the bounding-box line
-//! for the colorbar (PL_COLORBAR_BOUNDING_BOX).
-//! @param x_length Length of the body of the colorbar in the X
+//! for the color bar (PL_COLORBAR_BOUNDING_BOX).
+//! @param x_length Length of the body of the color bar in the X
 //! direction in adopted coordinates.
-//! @param y_length Length of the body of the colorbar in the Y
+//! @param y_length Length of the body of the color bar in the Y
 //! direction in adopted coordinates.
 //! @param low_cap_color Color of the low-end color bar cap, if it is drawn.
 //! @param high_cap_color Color of the high-end color bar cap, if it is drawn.
@@ -1447,14 +1449,14 @@
 //! @param cont_width Contour width for PL_COLORBAR_SHADE plots.  This is
 //! passed directly to plshades, so it will be interpreted according to the
 //! design of plshades.
-//! @param n_labels Number of labels to place around the colorbar
+//! @param n_labels Number of labels to place around the color bar
 //! @param label_opts Options for each label.  n_label total values.
-//! @param labels Text labels for the colorbar. No label is drawn if no
+//! @param labels Text labels for the color bar. No label is drawn if no
 //! label position is specified with one of the
 //! PL_COLORBAR_LABEL_(RIGHT|TOP|LEFT|BOTTOM) bits in the corresponding
 //! label_opts field.
 //! @param n_axes Number of axis definitions provided.  Must be >= 1.
-//! @param axis_opts Axis options for the colorbar's major axis, as for plbox.
+//! @param axis_opts Axis options for the color bar's major axis, as for plbox.
 //! n_axes values in the array.
 //! @param ticks Spacing of major ticks, as for plbox.  n_axes values in the
 //! array.
@@ -1462,10 +1464,10 @@
 //! array.
 //! @param n_values Number of elements in each values array.
 //! @param values Numeric values for the data range represented by the
-//! colorbar.  For PL_COLORBAR_SHADE, this should include one value per break
+//! color bar.  For PL_COLORBAR_SHADE, this should include one value per break
 //! between segments.  For PL_COLORBAR_IMAGE and PL_COLORBAR_GRADIENT this
 //! includes two values, one for the maximum value on the scale and one for the
-//! minimum value.  The first entry will be used to render the colorbar
+//! minimum value.  The first entry will be used to render the color bar
 //! contents.  All other entries will be used only for axis rendering.
 //!
 
@@ -1489,7 +1491,7 @@
     // coordinates and mm.
     PLFLT cap_extent, cap_extent_mm;
 
-    // The colorbar cap is an equilateral triangle with cap_angle
+    // The color bar cap is an equilateral triangle with cap_angle
     // the angle (in degrees) of the unequal angle pointing in the
     // direction of the orientation of the cap.  In other words,
     // cap_angle completely controls the shape of the triangle, but
@@ -1525,16 +1527,16 @@
     // Normalized subpage coordinates of top left of the bounding box.
     PLFLT plot_x_subpage_bb, plot_y_subpage_bb;
 
-    // colorbar width and height in normalized subpage coordinates.
-    // No suffix refers to bonding box of undecorated colorbar, d
-    // suffix refers to bounding box of decorated colorbar, and l
+    // color bar width and height in normalized subpage coordinates.
+    // No suffix refers to bonding box of undecorated color bar, d
+    // suffix refers to bounding box of decorated color bar, and l
     // suffix refers to bounding box of labelled and decorated
-    // colorbar.
+    // color bar.
     PLFLT colorbar_width, colorbar_height,
           colorbar_width_d, colorbar_height_d,
           colorbar_width_l, colorbar_height_l;
 
-    // ac suffix refers to latest colorbar_width (d or l suffix) converted to
+    // ac suffix refers to latest color bar_width (d or l suffix) converted to
     // adopted coordinates.
     // mm suffix refers to colorbar_width and colorbar_height (with no suffix)
     // converted from normalized subpage coordinates to mm.
@@ -1542,19 +1544,19 @@
           colorbar_width_mm, colorbar_height_mm;
 
     // Change in normalized subpage coordinates of the top left of
-    // undecorated colorbar.  (The omd suffix refers to original
-    // colorbar minus decorated colorbar, and the dml suffix refers to
-    // decorated colorbar minus labelled and decorated colorbar.)
+    // undecorated color bar.  (The omd suffix refers to original
+    // color bar minus decorated color bar, and the dml suffix refers to
+    // decorated color bar minus labelled and decorated color bar.)
     PLFLT dx_subpage_omd, dy_subpage_omd, dx_subpage_dml, dy_subpage_dml;
     PLFLT dx_subpage_omd_accu = 0.0, dy_subpage_omd_accu = 0.0, dx_subpage_dml_accu = 0.0, dy_subpage_dml_accu = 0.0;
     // Normalized subpage coordinates of the top left of undecorated
-    // colorbar,
+    // color bar,
     PLFLT plot_x_subpage, plot_y_subpage;
 
-    // Position of the undecorated colorbar in normalized subpage coordinates.
+    // Position of the undecorated color bar in normalized subpage coordinates.
     PLFLT vx_min = 0.0, vx_max = 0.0, vy_min = 0.0, vy_max = 0.0;
 
-    // World coordinate limits describing undecorated colorbar.
+    // World coordinate limits describing undecorated color bar.
     PLFLT wx_min = 0.0, wx_max = 0.0, wy_min = 0.0, wy_max = 0.0;
 
     // The data to plot
@@ -1664,7 +1666,7 @@
     // Assumes that the colors array is sorted from smallest to largest.
     plgcmap1_range( &min_color, &max_color );
 
-    // Width and height of the undecorated colorbar in normalized
+    // Width and height of the undecorated color bar in normalized
     // subpage coordinates and mm.
     colorbar_width = adopted_to_subpage_x( x_length ) -
                      adopted_to_subpage_x( 0. );
@@ -1693,7 +1695,7 @@
         max_value = values[i][ n_values[i] - 1 ];
         max_abs   = MAX( fabs( min_value ), fabs( max_value ) );
 
-        // Specify the proper window ranges for colorbar depending on
+        // Specify the proper window ranges for color bar depending on
         // orientation.
         if ( opt & PL_COLORBAR_ORIENT_RIGHT )
         {
@@ -1814,22 +1816,22 @@
     }
 
     // Normalized subpage coordinates (top-left corner) for undecorated
-    // colorbar
+    // color bar
     plot_x_subpage = plot_x_subpage_bb + dx_subpage_omd_accu + dx_subpage_dml_accu;
     plot_y_subpage = plot_y_subpage_bb + dy_subpage_omd_accu + dy_subpage_dml_accu;
 
-    // Coordinates of bounding box for decorated colorbar (without overall label).
+    // Coordinates of bounding box for decorated color bar (without overall label).
     label_vpor_xmin = plot_x_subpage_bb + dx_subpage_dml_accu;
     label_vpor_xmax = label_vpor_xmin + colorbar_width_d;
     label_vpor_ymax = plot_y_subpage_bb + dy_subpage_dml_accu;
     label_vpor_ymin = label_vpor_ymax - colorbar_height_d;
 
     // Return bounding box width and height in adopted coordinates for
-    // labelled and decorated colorbar.
+    // labelled and decorated color bar.
     *p_colorbar_width  = colorbar_width_ac;
     *p_colorbar_height = colorbar_height_ac;
 
-    // Specify the proper viewport ranges for colorbar depending on
+    // Specify the proper viewport ranges for color bar depending on
     // orientation.
     if ( opt & PL_COLORBAR_ORIENT_RIGHT )
     {
@@ -1888,7 +1890,7 @@
         plcol0( col0_save );
     }
 
-    // Viewport and world coordinate ranges for colorbar.
+    // Viewport and world coordinate ranges for color bar.
     plvpor( vx_min, vx_max, vy_min, vy_max );
     plwind( wx_min, wx_max, wy_min, wy_max );
 
@@ -2223,7 +2225,7 @@
         max_value = values[i][ n_values[i] - 1 ];
         max_abs   = MAX( fabs( min_value ), fabs( max_value ) );
 
-        // Specify the proper window ranges for colorbar depending on
+        // Specify the proper window ranges for color bar depending on
         // orientation.
         if ( opt & PL_COLORBAR_ORIENT_RIGHT )
         {

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

[Plplot-cvs] SF.net SVN: plplot:[12498] trunk/src/pllegend.c

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

Revision: 12498
          http://sourceforge.net/p/plplot/code/12498
Author:   airwin
Date:     2013-08-27 23:03:51 +0000 (Tue, 27 Aug 2013)
Log Message:
-----------
Add doxygen documentation of plcolorbar arguments that were previously
undocumented.  This change should finalize the plcolorbar API
documentation in preparation for copying it to the DocBook API
chapter.  In addition, this change and a few other minor doxygen
changes eliminated the last of the argument inconsistency warnings
previously generated for pllegend.c by doxygen.

Modified Paths:
--------------
    trunk/src/pllegend.c

Modified: trunk/src/pllegend.c
===================================================================
--- trunk/src/pllegend.c	2013-08-24 22:39:23 UTC (rev 12497)
+++ trunk/src/pllegend.c	2013-08-27 23:03:51 UTC (rev 12498)
@@ -1014,8 +1014,8 @@
 //! decorations of that box or else (when if_bb TRUE) calculate
 //! bounding box of that decorated box.
 //!
-//! @param If if_bb is TRUE evaluate bounding box of decorated box.
-//! If if_bb is FALSE draw the decorated box.
+//! @param if_bb If if_bb is TRUE evaluate bounding box of decorated
+//! box.  If if_bb is FALSE draw the decorated box.
 //! @param opt Can contain the same control bits as the opt argument
 //! for plcolorbar.  However, the only bits that are relevant here are
 //! PL_COLORBAR_SHADE, PL_COLORBAR_SHADE_LABEL, and
@@ -1104,8 +1104,6 @@
 //! PL_COLORBAR_ORIENT_(RIGHT|TOP|LEFT|BOTTOM), and
 //! PL_COLORBAR_LABEL_(RIGHT|TOP|LEFT|BOTTOM).  For full documentation
 //! of these bits, see the documentation of opt for plcolorbar.
-//! @param cap_extent Extent of cap in normalized subpage coordinates
-//! in either X or Y direction as appropriate.
 //! @param label Text label for the colorbar.  No label is drawn if no
 //! label position is specified with one of the
 //! PL_COLORBAR_LABEL_(RIGHT|TOP|LEFT|BOTTOM) bits in opt.
@@ -1370,6 +1368,12 @@
 //--------------------------------------------------------------------------
 //! Plot color bar for image, shade or gradient plots.
 //!
+//! @param p_colorbar_width Pointer to a location which contains
+//! (after the call) the labelled and decorated colorbar width in
+//! adopted coordinates.
+//! @param p_colorbar_height Pointer to a location which contains
+//! (after the call) the labelled and decorated colorbar height in
+//! adopted coordinates.
 //! @param opt This variable contains bits which control the overall
 //! colorbar.  The orientation (direction of the maximum value) of the
 //! colorbar is specified with PL_COLORBAR_ORIENT_(RIGHT, TOP, LEFT,
@@ -1425,6 +1429,12 @@
 //! or bottom positions if the PL_POSITION_INSIDE/PL_POSITION_OUTSIDE
 //! bit is set in position.  For the standard left or right positions,
 //! the direction of motion for positive y is toward positive Y.
+//! @param bg_color The cmap0 index of the background color for the colorbar
+//! (PL_COLORBAR_BACKGROUND).
+//! @param bb_color The cmap0 index of the color of the bounding-box
+//! line for the colorbar (PL_COLORBAR_BOUNDING_BOX).
+//! @param bb_style The pllsty style number for the bounding-box line
+//! for the colorbar (PL_COLORBAR_BOUNDING_BOX).
 //! @param x_length Length of the body of the colorbar in the X
 //! direction in adopted coordinates.
 //! @param y_length Length of the body of the colorbar in the Y

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

[Plplot-cvs] SF.net SVN: plplot:[12497] trunk/doc/docbook/README.developers

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

Revision: 12497
          http://sourceforge.net/p/plplot/code/12497
Author:   airwin
Date:     2013-08-24 22:39:23 +0000 (Sat, 24 Aug 2013)
Log Message:
-----------
Update these developer directions based on the current xmlto backend
tools that are being used.  Also include some plans about further
changes once we allow UTF-8 strings in our documentation.

Modified Paths:
--------------
    trunk/doc/docbook/README.developers

Modified: trunk/doc/docbook/README.developers
===================================================================
--- trunk/doc/docbook/README.developers	2013-08-24 22:36:57 UTC (rev 12496)
+++ trunk/doc/docbook/README.developers	2013-08-24 22:39:23 UTC (rev 12497)
@@ -12,7 +12,7 @@
 (README.developers) instructions for building the documentation from the
 DocBook source files in this directory. The documentation that is built
 includes man pages of the API as well as complete versions of the
-documentation in html, dvi, postscript, pdf, and info form.
+documentation in HTML, dvi, PostScript, PDF, and info form.
 
 Configuring and Building
 ========================
@@ -21,14 +21,17 @@
 the documentation from the DocBook source so you can immediately see and
 evaluate the results of your efforts.
 
-Here is how.  Simply add the cmake option -DBUILD_DOC=ON to your normal
-cmake command-line options for the PLplot build.  The resulting cmake step
-looks for all the tools required for the documentation build and turns off
-the documentation build and gives WARNING messages if any of those required
-tools are missing.  Those messages should be sufficient for you to figure
-out what DocBook/XML related tools you need to install in order to build the
-documentation.  N.B. As far as we know, the complete set of required tools
-is only available on Linux so you will need a Linux system to do a
+Here is how.  Simply add the cmake option -DBUILD_DOC=ON to your
+normal cmake command-line options for the PLplot build.  The resulting
+cmake step looks for all the tools required for the documentation
+build and turns off the documentation build and gives WARNING messages
+if any of those required tools are missing.  Furthermore, at run-time
+xmlto (used below) checks for required backend tools.  So cmake
+messages with the -DBUILD_DOC=ON option _and_ run time messages from
+xmlto should be sufficient for you to figure out what DocBook/XML
+related tools you need to install in order to build the documentation.
+N.B. As far as we know, the complete set of required tools is only
+available on Linux so you will need a Linux system to do a
 documentation build.
 
 The DocBook Back-end Tool Chains
@@ -57,27 +60,103 @@
 db2x_xsltproc limitations.  db2x_xsltproc and db2x_texixml are from
 the docbook2x package.
 
-3. web pages.
+3. Our HTML and print(dvi, PostScript, and PDF) results are all generated
+with xmlto using respectively no special options and the html subcommand,
+the experimental --with-dblatex option and dvi subcommand, and
+the experiemtnal --with-fop option and the ps and pdf subcommands.
 
-Our web pages are generated with openjade.
+N.B. for the dvi results to work as of this date (2013-08) it is
+necessary to apply the dblatex patch given at
+http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=720624
 
-4. dvi file
+The backend tools that the xmlto convenience script selects are
+all XML/XSL as opposed to the previous set of SGML/DSSSL backend
+tools used to create the HTML and print results.  For more information
+see "Further notes on the backend tools" below.
 
-Our dvi file is generated by
 
-openjade --> jadetex
+Further notes on the backend tools
+==================================
 
+Note from AWI on the project he just completed (as of 2013-08) to use
+xmlto (a shell script that gives convenient access to a wide variety
+of XML/XSL DocBook backend tools) as the DocBook backend generator for
+HTML and print (dvi, PostScript, and PDF) forms of our documentation.
+(The man and info forms of our documentation are already prepared
+using XML/XSL DocBook backend tools.)
 
-5. PostScript file
+One immediate advantage of xmlto is that it detects
+(at run time) whether all the software components it needs are installed
+so this substantantially reduces the testing for DocBook backend components
+required of our build system.
 
-Our PostScript file is generated from the above dvi file
-using dvips.
+The use of the old/deprecated SGML/DSSSL backend tools for HTML and
+print are still available (as of 2013-08) if the developer
+specifies the PLplot cmake option -DDOCBOOK_XML_BACKEND=OFF along with
+-DBUILD_DOC=ON.  However, the HTML results from that option are not
+very good (the Greek characters in the table giving Roman-Greek
+equivalents are gibberish) presumably because bit-rot has set in for
+the SGML/DSSSL tools in the decade since there has been any upstream
+development for those tools.  So at the start of the next release
+cycle the plan is to drop use of the SGML/DSSSL backend tools
+altogether.
 
+The only limitation of the current xmlto backend results that I am
+aware of is the representation of S̅(f̲r̲e̲q̲) is not done very well in
+HTML (an empty string is used rather than S̅(f̲r̲e̲q̲)) or the print
+results (S(freq) is used rather S̅(f̲r̲e̲q̲)).  Note that overlining and
+underlining do not work at all for modern PLplot device drivers such
+as cairo and qt so a much higher priority should be given to fixing
+those issues rather than fixing the issue of representing overlining
+and underlining in the generation of the documentation!  Furthermore,
+instead of using special tricks for dealing with the representation of
+overlining/underlining (as was done for the SGML/DSSSL backend tools),
+the correct thing to do in the long term (i.e., after the use of
+SGML/DSSSL backend tools is completely removed since SGML is not
+compatible with UTF-8) is to make the tool chain used to convert our
+DocBook documentation to various formats completely UTF-8 aware so
+that, for example, UTF-8 glyphs for underlining overlining as well
+as UTF-8 strings such as occur in our unicode examples
+23, 24, and 26 could be included directly in the DocBook source of
+our documentation.
 
-6. pdf file
+As if this date (2013-08) it appears to me the best UTF-8 way forward
+for html is the current html method (which should be transparent
+to UTF-8 strings although I haven't tested that in detail with
+truly exotic UTF-8 strings).  And the best UTF-8 way forward for
+print results is the experimental --backend=xetex option for the
+dblatex command.  
 
-openjade --> pdfjadetex
+To demonstrate the UTF-8 power of xelatex try the xelatex command on
+the example given at http://en.wikipedia.org/wiki/XeTeX.  All those
+non-Western glyphs _and_ scripts seem to come out fine in the
+resulting pdf and conversion to an equivalent PostScript result with
+pdf2ps seemed to preserve all those glyph and script results as well.
+Furthermore, I recently tried
 
+dblatex --backend=xetex -o plplotdoc.xetex.pdf --pdf plplotdoc-print.xml
+
+and the resulting plplotdoc.xetex.pdf document looked good (both Greek
+table and function API) with the default style.  Although currently
+unnecessary from my perspective, it looks like the dblatex -p option
+is what you should use to style such results further if anyone feels
+the need.  (Note that the --backend=xetex dblatex option is not
+accessible from the xmlto --with-dblatex command.)
+
+The only drawback of this xetex approach that I can determine at the
+present time is you can only produce PDF with it.  PostScript could
+then be generated using pdf2ps, but there is absolutely no way to
+produce dvi results using xelatex or the --backend=xetex option for
+the dblatex command.  So if we do start inserting general UTF-8
+strings into our DocBook source (say a table of Math symbols or
+comments concerning our multilingual Peace flag example), we would
+have to complete drop dvi, but I think that is an acceptable price to
+pay for the huge range of glyphs that are available with UTF-8.  So I
+believe that dropping dvi and moving to the above command to generate
+our PDF documentation is something we should consider for the near
+future (when the possibility of using of the SGML backend tools is
+completely removed from our build system).
+
 Validation
 ==========
 
@@ -96,6 +175,15 @@
 files in doc/docbook/src, and you don't really feel it is necessary to check
 every change by doing a complete documentation build.
 
+In addition, the xmlto commands used to build the HTML and print
+part of the documentation automatically include a validation step
+with xmllint.  It turns out that xmllint is more sensitive than onsgmls
+to DocBook XML errors.  On the other hand, onsgmls handles any
+errors it finds with ease while xmllint tends to segfault when there
+is a validation error.  So use "make validate"
+first to detect any obvious validation errors using onsgmls to avoid
+situations where xmlto's call to xmllint will segfault.
+
 Testing the documentation that has been built.
 ==============================================
 

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

[Plplot-cvs] SF.net SVN: plplot:[12496] trunk/doc/docbook/NEWS

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

Revision: 12496
          http://sourceforge.net/p/plplot/code/12496
Author:   airwin
Date:     2013-08-24 22:36:57 +0000 (Sat, 24 Aug 2013)
Log Message:
-----------
Substantial update (including some history that has not been mentioned
before as well as recent events) of news for PLplot's documentation
project.

Modified Paths:
--------------
    trunk/doc/docbook/NEWS

Modified: trunk/doc/docbook/NEWS
===================================================================
--- trunk/doc/docbook/NEWS	2013-08-24 05:34:58 UTC (rev 12495)
+++ trunk/doc/docbook/NEWS	2013-08-24 22:36:57 UTC (rev 12496)
@@ -1,9 +1,50 @@
-This file gives an overview of changes to the cvs of the plplot
-documentation project. For some background about that project see README.
-Alan W. Irwin (AWI) and Rafael Laboissiere (RL) have been the principal
-contributors to this project so far.
+This file gives an overview of changes to the form (not content) of
+the PLplot documentation project. For some background about that
+project see README.  Alan W. Irwin (AWI), Rafael Laboissiere (RL), and
+Andrew Ross (AR) have been the principal contributors to this project
+so far.
 
-2001 February 8: (Just prior to release of 5.0.2) After those fateful words,
+2013-08-24: AWI implemented using XML/XSL backend tools to generate
+our HTML and print (dvi, PostScript, and PDF) documentation results.
+Use of the old SGML/DSSSL backend
+tools for this task is now deprecated and will be removed
+(probably in the next release cycle).  For more details on this
+change see README.developers.
+
+2007-03-30: AWI converted the whole PLplot project (including its
+documentation source tree) from CVS to subversion.  The conversion
+included all of our CVS history (commit messages, tags, and branches)
+in the new subversion repository.
+
+2006-11-04: RL retired from working on PLplot development including
+the documentation project.
+
+2006-07-28: AR and AWI started implementing support for the
+documentation build using our CMake-based build system which was just
+being developed at that time for all of PLplot as a replacement for
+our previous autotools-based build system.  This overall project (and
+especially the documentation build part of this project) went fairly
+quickly thanks to years of effort on RL's part improving the
+autotools-based build system so that is was modular, (fairly) easy to
+understand, and implemented accurate dependencies.
+
+2004-04-29: RL moved the build system from using in-house docbook2x
+version 0.7.0 to upstream docbook2x version 0.8.2 for generating the
+info form of our documentation.
+
+2003-03-12: RL implemented onsgmls validation of our DocBook source
+files.
+
+2003-02-17: RL enforced the use of openjade (as opposed to the
+deprecated jade) as an SGM/DSSSL backend tool.
+
+2003-02-12: RL integrated the special autotools build of the
+documentation into the overall autotools build of PLplot (which
+historically became available much later than the special autotools
+build of the documentation that RL originally implemented).
+
+2001 February 8: (Just prior to release of 5.0.2) After the fateful words:
+"this marks the end of AWI's work on the API documentation",
 AWI worked harder than ever on documentation (some of it with an API
 component).  A large source of the additional documentation was all the
 files in the doc directory which were from the 1994 latex effort or even
@@ -19,6 +60,15 @@
 part of the document (including the Bibliography and all the API chapters)
 was put at the back of the document.
 
+2000 December 04: RL finished the XML man backend.
+
+2000 November 30: RL implemented the XML/XSL info backend.  The html and
+print backends continue to be SGML/DSSSL.
+
+2000 November 17: RL finished conversion of DocBook SGML to DocBook XML.
+This change did not affect the backend tools which were still SGML/DSSSL
+at this stage.
+
 2000 November 15: AWI finished documenting the previously undocumented API
 functions by lifting the comments from the code source.  Those comments
 usually did not include anything about the meaning of the function

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

[Plplot-cvs] SF.net SVN: plplot:[12495] trunk

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

Revision: 12495
          http://sourceforge.net/p/plplot/code/12495
Author:   airwin
Date:     2013-08-24 05:34:58 +0000 (Sat, 24 Aug 2013)
Log Message:
-----------
For default -DDOCBOOK_XML_BACKEND=ON case, implement a dvi build.

N.B. This dvi build only works if the patch given at
http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=720624 is applied
to /usr/share/pyshared/dbtexmf/dblatex/unient.py to fix a bug
in the dblatex package.

Use different inline-print_???.ent files depending on whether
-DDOCBOOK_XML_BACKEND=ON or OFF.

Modified Paths:
--------------
    trunk/cmake/modules/docbook.cmake
    trunk/doc/docbook/src/CMakeLists.txt

Added Paths:
-----------
    trunk/doc/docbook/src/inline-print_dsl.ent
    trunk/doc/docbook/src/inline-print_xsl.ent

Removed Paths:
-------------
    trunk/doc/docbook/src/inline-print.ent

Modified: trunk/cmake/modules/docbook.cmake
===================================================================
--- trunk/cmake/modules/docbook.cmake	2013-08-21 22:10:51 UTC (rev 12494)
+++ trunk/cmake/modules/docbook.cmake	2013-08-24 05:34:58 UTC (rev 12495)
@@ -119,13 +119,7 @@
       set(BUILD_HTML ON)
       if(GZIP)
 	set(BUILD_PRINT ON)
-	option(BUILD_DVI "BUILD dvi form of documentation" OFF)
-	if(NOT BUILD_DVI)
-	  message(STATUS
-	    "WARNING: Not building dvi documentation - "
-	    "Bugs in xmlto for this case."
-	    )
-	endif(NOT BUILD_DVI)
+	option(BUILD_DVI "BUILD dvi form of documentation" ON)
       else(GZIP)
 	set(BUILD_PRINT OFF)
 	message(STATUS

Modified: trunk/doc/docbook/src/CMakeLists.txt
===================================================================
--- trunk/doc/docbook/src/CMakeLists.txt	2013-08-21 22:10:51 UTC (rev 12494)
+++ trunk/doc/docbook/src/CMakeLists.txt	2013-08-24 05:34:58 UTC (rev 12495)
@@ -27,7 +27,13 @@
 set(MANVOL "3plplot")
 
 foreach(suffix info html print)
-  set(inline_entities ${CMAKE_CURRENT_SOURCE_DIR}/inline-${suffix}.ent)
+  if(suffix STREQUAL "print" AND DOCBOOK_XML_BACKEND)
+    set(inline_entities ${CMAKE_CURRENT_SOURCE_DIR}/inline-${suffix}_xsl.ent)
+  elseif(suffix STREQUAL "print" AND NOT DOCBOOK_XML_BACKEND)
+    set(inline_entities ${CMAKE_CURRENT_SOURCE_DIR}/inline-${suffix}_dsl.ent)
+  else(suffix STREQUAL "print" AND DOCBOOK_XML_BACKEND)
+    set(inline_entities ${CMAKE_CURRENT_SOURCE_DIR}/inline-${suffix}.ent)
+  endif(suffix STREQUAL "print" AND DOCBOOK_XML_BACKEND)
   configure_file(
     ${CMAKE_CURRENT_SOURCE_DIR}/${PLPLOTDOC}.xml.in
     ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-${suffix}.xml
@@ -359,6 +365,37 @@
 	  @ONLY
 	  )
 
+	if(BUILD_DVI)
+	  add_custom_command(
+	    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.dvi
+	    # Drop -x ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT} option
+            # since it doesn't appear to work with --with-dblatex
+	    COMMAND ${XMLTO} -vv --with-dblatex dvi ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
+	    COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-print.dvi ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.dvi
+	    DEPENDS
+	    ${SOURCE_FILES} 
+	    ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
+	    ${CMAKE_CURRENT_SOURCE_DIR}/inline-print_xsl.ent
+	    )
+	  add_custom_target(
+	    dvi_target ALL 
+	    DEPENDS 
+	    ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.dvi
+	    )
+	  # These files used for more than one target.  Therefore must
+	  # use target dependencies rather than file dependencies to build
+	  # them.  Otherwise, parallel builds won't work.
+	  add_dependencies(dvi_target
+	    docbook_plplot-symbols_txt
+	    docbook_plplot-structs_txt
+	    )
+
+	  file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
+	    "${BASE}.ps.gz\n"
+	    )
+
+	endif(BUILD_DVI)
+
 	add_custom_command(
 	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.ps.gz
 	  COMMAND ${XMLTO} -vv --with-fop -x ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT} ps ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
@@ -367,7 +404,7 @@
 	  DEPENDS
 	  ${SOURCE_FILES} 
 	  ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
-	  ${CMAKE_CURRENT_SOURCE_DIR}/inline-print.ent
+	  ${CMAKE_CURRENT_SOURCE_DIR}/inline-print_xsl.ent
 	  )
 	add_custom_target(
 	  ps_target ALL 
@@ -393,7 +430,7 @@
 	  DEPENDS
 	  ${SOURCE_FILES} 
 	  ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
-	  ${CMAKE_CURRENT_SOURCE_DIR}/inline-print.ent
+	  ${CMAKE_CURRENT_SOURCE_DIR}/inline-print_xsl.ent
 	  )
 	add_custom_target(
 	  pdf_target ALL 
@@ -415,6 +452,9 @@
 	  print ALL 
 	  )
 	add_dependencies(print ps_target pdf_target)
+	if(BUILD_DVI)
+	  add_dependencies(print dvi_target)
+	endif(BUILD_DVI)
       endif(BUILD_PRINT)
     else(DOCBOOK_XML_BACKEND)
       if(BUILD_HTML)
@@ -490,7 +530,7 @@
 	  ${SOURCE_FILES}
 	  ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
 	  ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT}
-	  ${CMAKE_CURRENT_SOURCE_DIR}/inline-print.ent
+	  ${CMAKE_CURRENT_SOURCE_DIR}/inline-print_xsl.ent
 	  )
 
 	# Following approach used in our ABS, use shell commands to recurse

Deleted: trunk/doc/docbook/src/inline-print.ent
===================================================================
--- trunk/doc/docbook/src/inline-print.ent	2013-08-21 22:10:51 UTC (rev 12494)
+++ trunk/doc/docbook/src/inline-print.ent	2013-08-24 05:34:58 UTC (rev 12495)
@@ -1 +0,0 @@
-<!ENTITY over-under "&#1025;">

Copied: trunk/doc/docbook/src/inline-print_dsl.ent (from rev 12492, trunk/doc/docbook/src/inline-print.ent)
===================================================================
--- trunk/doc/docbook/src/inline-print_dsl.ent	                        (rev 0)
+++ trunk/doc/docbook/src/inline-print_dsl.ent	2013-08-24 05:34:58 UTC (rev 12495)
@@ -0,0 +1 @@
+<!ENTITY over-under "&#1025;">

Added: trunk/doc/docbook/src/inline-print_xsl.ent
===================================================================
--- trunk/doc/docbook/src/inline-print_xsl.ent	                        (rev 0)
+++ trunk/doc/docbook/src/inline-print_xsl.ent	2013-08-24 05:34:58 UTC (rev 12495)
@@ -0,0 +1 @@
+<!ENTITY over-under "S(freq)">

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

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

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

Revision: 12494
          http://sourceforge.net/p/plplot/code/12494
Author:   airwin
Date:     2013-08-21 22:10:51 +0000 (Wed, 21 Aug 2013)
Log Message:
-----------
Implement XSL configuration method for print results for the default
-DDOCBOOK_XML_BACKEND=ON case.  Use this configuration method to
establish ansi style for funcsynopsis for pdf and ps results.

Tested by Alan W. Irwin <ai...@us...> using
the -DBUILD_DOC=ON cmake option and the pdf_target target.

Modified Paths:
--------------
    trunk/doc/docbook/src/CMakeLists.txt

Added Paths:
-----------
    trunk/doc/docbook/src/plplotdoc-print.xsl.in

Modified: trunk/doc/docbook/src/CMakeLists.txt
===================================================================
--- trunk/doc/docbook/src/CMakeLists.txt	2013-08-21 21:18:36 UTC (rev 12493)
+++ trunk/doc/docbook/src/CMakeLists.txt	2013-08-21 22:10:51 UTC (rev 12494)
@@ -350,9 +350,18 @@
 	)
 
       if(BUILD_PRINT)
+	# Custom commands for building html version of documentation
+	set(STYLESHEET_PRINT ${PLPLOTDOC}-print.xsl)
+	set(STYLESHEET_PRINT_IN ${STYLESHEET_PRINT}.in)
+	configure_file(
+	  ${CMAKE_CURRENT_SOURCE_DIR}/${STYLESHEET_PRINT_IN}
+	  ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT}
+	  @ONLY
+	  )
+
 	add_custom_command(
 	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.ps.gz
-	  COMMAND ${XMLTO} -vv --with-fop ps ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
+	  COMMAND ${XMLTO} -vv --with-fop -x ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT} ps ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
 	  COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-print.ps ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.ps
 	  COMMAND ${GZIP} -f ${BASE}.ps
 	  DEPENDS
@@ -379,7 +388,7 @@
 
 	add_custom_command(
 	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.pdf
-	  COMMAND ${XMLTO} -vv --with-fop pdf ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
+	  COMMAND ${XMLTO} -vv --with-fop -x ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT} pdf ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
 	  COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-print.pdf ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.pdf
 	  DEPENDS
 	  ${SOURCE_FILES} 

Added: trunk/doc/docbook/src/plplotdoc-print.xsl.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc-print.xsl.in	                        (rev 0)
+++ trunk/doc/docbook/src/plplotdoc-print.xsl.in	2013-08-21 22:10:51 UTC (rev 12494)
@@ -0,0 +1,54 @@
+<?xml version='1.0'?>
+<!--
+    plplotdoc-print.xsl.in: XSL customization for the HTML PLplot docs
+
+    Copyright (C) 2013 Alan W. Irwin
+
+    Redistribution and use in source (XML DocBook) and "compiled" forms
+    (HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
+    modification, are permitted provided that the following conditions are
+    met:
+
+       1. Redistributions of source code (XML DocBook) must retain the
+          above copyright notice, this list of conditions and the following
+          disclaimer as the first lines of this file unmodified.
+
+       2. Redistributions in compiled form (transformed to other DTDs,
+          converted to HTML, PDF, PostScript, and other formats) must
+          reproduce the above copyright notice, this list of conditions and
+          the following disclaimer in the documentation and/or other
+          materials provided with the distribution.
+
+    Important: THIS DOCUMENTATION IS PROVIDED BY THE PLPLOT PROJECT "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+    THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+    PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE PLPLOT PROJECT BE LIABLE
+    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+    BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+    OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION,
+    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+-->
+<!--
+These ideas for customizing the PLplot html documentation are adapted
+from 
+http://www.sagehill.net/docbookxsl/CustomMethods.html#CustomizationLayer
+http://www.sagehill.net/docbookxsl/SettingParams.html
+http://www.sagehill.net/docbookxsl/Chunking.html#ChunkFilenames
+http://www.sagehill.net/docbookxsl/UsingCSS.html
+http://www.sagehill.net/docbookxsl/Parameters.html
+http://docbook.sourceforge.net/release/xsl/current/doc/html/
+....
+-->
+<xsl:stylesheet  
+    xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 
+    xmlns:fo="http://www.w3.org/1999/XSL/Format"
+    version="1.0"> 
+
+<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/fo/docbook.xsl"/>
+
+<xsl:param name="funcsynopsis.style" select="'ansi'"/>
+
+</xsl:stylesheet> 

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

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

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

Revision: 12493
          http://sourceforge.net/p/plplot/code/12493
Author:   airwin
Date:     2013-08-21 21:18:36 +0000 (Wed, 21 Aug 2013)
Log Message:
-----------
Change funcsynopsis style to ansi and configure widths of the
resulting html table to auto (which gives nice looking spacing for the
arguments).  These changes make the new XML/XSL backend tools produce
the html form of the API chapter with a style comparable to what was
produced with the deprecated SGML/DSSSL backend tools.

Make some progress toward the goal of representing the overlined "S" and
underlined "freq" in S(freq) correctly represented in html.  However,
the final step of inserting the correct form of html needs additional
XSLT expertise that I currently don't have as mentioned in the
/plplotdoc-html.xsl.in comments.  So the result validates
fine but is currently rendered as a blank.

So aside from this one overline/underline issue (which appears just
before the Table of Greek letters), the complete html
results for the new XML/XSL backend tools are better (Table of Greek
letters) or similar (API chapter) to what they were before for the
deprecated SGML/DSSSL backend tools.

Tested by Alan W. Irwin <ai...@us...> using
the -DBUILD_DOC=ON cmake option and the "html" target.

Modified Paths:
--------------
    trunk/doc/docbook/src/plplotdoc-html.xsl.in
    trunk/doc/docbook/src/stylesheet.css.xsl.in

Modified: trunk/doc/docbook/src/plplotdoc-html.xsl.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc-html.xsl.in	2013-08-20 19:10:05 UTC (rev 12492)
+++ trunk/doc/docbook/src/plplotdoc-html.xsl.in	2013-08-21 21:18:36 UTC (rev 12493)
@@ -35,16 +35,40 @@
 These ideas for customizing the PLplot html documentation are adapted
 from 
 http://www.sagehill.net/docbookxsl/CustomMethods.html#CustomizationLayer
+http://www.sagehill.net/docbookxsl/SettingParams.html
 http://www.sagehill.net/docbookxsl/Chunking.html#ChunkFilenames
+http://www.sagehill.net/docbookxsl/UsingCSS.html
+http://www.sagehill.net/docbookxsl/Parameters.html
+http://docbook.sourceforge.net/release/xsl/current/doc/html/
 ....
 -->
 <xsl:stylesheet  
-    xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
+    xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 
+    xmlns:fo="http://www.w3.org/1999/XSL/Format"
+    version="1.0"> 
 
 <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"/>
 
 <xsl:param name="chunk.quietly" select="1"/>
 <xsl:param name="use.id.as.filename" select="1"/>
 <xsl:param name="html.stylesheet" select="'stylesheet.css'"/>
+<xsl:param name="funcsynopsis.style" select="'ansi'"/>
 
+<!-- For this case (anchor tag with a name attribute of
+"over-under") we want the html result to be 
+
+<span class="overline">S</span>(<span class="underline">freq</span>)
+
+which the configured stylesheet.css will overline and underline
+as specified.  However (AWI comment), don't know how to produce
+that html yet from xslt so we do essentially nothing for this case
+at the moment.
+--> 
+<xsl:template match="anchor[@name = 'over-under']">
+  <fo:block xsl:use-attribute-sets="normal.para.spacing">
+    <xsl:call-template name="anchor"/>
+    <xsl:apply-templates/>
+  </fo:block>
+</xsl:template>
+
 </xsl:stylesheet> 

Modified: trunk/doc/docbook/src/stylesheet.css.xsl.in
===================================================================
--- trunk/doc/docbook/src/stylesheet.css.xsl.in	2013-08-20 19:10:05 UTC (rev 12492)
+++ trunk/doc/docbook/src/stylesheet.css.xsl.in	2013-08-21 21:18:36 UTC (rev 12493)
@@ -1,7 +1,7 @@
 /*
     HTML Cascade Style Sheet file for the PLplot documentation in Docbook
 
-    Copyright (C) 2004  Rafael Laboissiere
+    Copyright (C) 2013  Alan W. Irwin
 
     Redistribution and use in source (XML DocBook) and "compiled" forms
     (HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
@@ -35,7 +35,7 @@
 SPAN.overline  { text-decoration: overline  }
 
 TABLE.funcprototype-table {
-  width: 90%;
+  width: auto;
   margin-top: 5px;
   margin-bottom: 5px;
   margin-left: 5%;
@@ -46,7 +46,7 @@
 }
 
 .variablelist {
-  width: 90%;
+  width: auto;
   margin-top: 5px;
   margin-bottom: 5px;
   margin-left: 5%;
@@ -57,7 +57,7 @@
 }
 
 .verbatim {
-  width: 90%;
+  width: auto;
   margin-top: 5px;
   margin-bottom: 5px;
   margin-left: 5%;

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

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

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

Revision: 12492
          http://sourceforge.net/p/plplot/code/12492
Author:   airwin
Date:     2013-08-20 19:10:05 +0000 (Tue, 20 Aug 2013)
Log Message:
-----------
Make stylesheet.css configurable with a separate template file for
the -DDOCBOOK_XML_BACKEND=OFF and (default) -DDOCBOOK_XML_BACKEND=ON
cases.  The -DDOCBOOK_XML_BACKEND=OFF case is untested but should work
since the changes are pretty trivial.  The -DDOCBOOK_XML_BACKEND=ON
case has been tested and shows the desired coloured output for
the TABLE.funcprototype-table and .variablelist parts of the
api documentation that occurs in the many links from the API chapter.

Tested by Alan W. Irwin <ai...@us...> using the
scripts/generate_website.sh scripts.

Modified Paths:
--------------
    trunk/doc/docbook/src/CMakeLists.txt
    trunk/doc/docbook/src/plplotdoc-html.xsl.in

Added Paths:
-----------
    trunk/doc/docbook/src/stylesheet.css.dsssl.in
    trunk/doc/docbook/src/stylesheet.css.xsl.in

Removed Paths:
-------------
    trunk/doc/docbook/src/stylesheet.css

Modified: trunk/doc/docbook/src/CMakeLists.txt
===================================================================
--- trunk/doc/docbook/src/CMakeLists.txt	2013-08-20 17:16:26 UTC (rev 12491)
+++ trunk/doc/docbook/src/CMakeLists.txt	2013-08-20 19:10:05 UTC (rev 12492)
@@ -305,6 +305,12 @@
 	  ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_HTML}
 	  @ONLY
 	  )
+
+	configure_file(
+	  ${CMAKE_CURRENT_SOURCE_DIR}/stylesheet.css.xsl.in
+	  ${CMAKE_CURRENT_BINARY_DIR}/stylesheet.css
+	  )
+
 	set(HTML_TMPDIR ${CMAKE_CURRENT_BINARY_DIR}/html)
 	add_custom_command(
 	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
@@ -410,6 +416,12 @@
 	  ${CMAKE_CURRENT_SOURCE_DIR}/${STYLESHEET_HTML_IN}
 	  ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_HTML}
 	  )
+
+	configure_file(
+	  ${CMAKE_CURRENT_SOURCE_DIR}/stylesheet.css.dsssl.in
+	  ${CMAKE_CURRENT_BINARY_DIR}/stylesheet.css
+	  )
+
 	add_custom_command(
 	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
 	  COMMAND ${OPENJADE} -b utf-8
@@ -652,7 +664,7 @@
 endif(BUILD_MAN OR PREBUILT_DOC)
 
 if(BUILD_HTML OR PREBUILT_DOC)
-  install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST} stylesheet.css DESTINATION ${DOC_DIR}/html )
+  install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST} ${CMAKE_CURRENT_BINARY_DIR}/stylesheet.css DESTINATION ${DOC_DIR}/html )
   install(CODE "
 # Suppress empty element warning.
 cmake_policy(SET CMP0007 NEW)
@@ -713,10 +725,12 @@
     COMMAND rm -rf ${BASE_HTML}
     COMMAND mkdir ${BASE_HTML}
     COMMAND cp `cat ${HTML_MANIFEST}` ${BASE_HTML}
-    COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/stylesheet.css ${BASE_HTML}
+    COMMAND cp ${CMAKE_CURRENT_BINARY_DIR}/stylesheet.css ${BASE_HTML}
     COMMAND tar cfz ${HTML_TARBALL} ${BASE_HTML}
     COMMAND rm -rf ${BASE_HTML}
-    DEPENDS ${HTML_MANIFEST} ${CMAKE_CURRENT_SOURCE_DIR}/stylesheet.css
+    DEPENDS
+    ${HTML_MANIFEST}
+    ${CMAKE_CURRENT_BINARY_DIR}/stylesheet.css
     )
 
   set(tarball_list

Modified: trunk/doc/docbook/src/plplotdoc-html.xsl.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc-html.xsl.in	2013-08-20 17:16:26 UTC (rev 12491)
+++ trunk/doc/docbook/src/plplotdoc-html.xsl.in	2013-08-20 19:10:05 UTC (rev 12492)
@@ -45,5 +45,6 @@
 
 <xsl:param name="chunk.quietly" select="1"/>
 <xsl:param name="use.id.as.filename" select="1"/>
+<xsl:param name="html.stylesheet" select="'stylesheet.css'"/>
 
 </xsl:stylesheet> 

Deleted: trunk/doc/docbook/src/stylesheet.css
===================================================================
--- trunk/doc/docbook/src/stylesheet.css	2013-08-20 17:16:26 UTC (rev 12491)
+++ trunk/doc/docbook/src/stylesheet.css	2013-08-20 19:10:05 UTC (rev 12492)
@@ -1,68 +0,0 @@
-/*
-    HTML Cascade Style Sheet file for the PLplot documentation in Docbook
-
-    Copyright (C) 2004  Rafael Laboissiere
-
-    Redistribution and use in source (XML DocBook) and "compiled" forms
-    (HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
-    modification, are permitted provided that the following conditions are
-    met:
-
-       1. Redistributions of source code (XML DocBook) must retain the
-          above copyright notice, this list of conditions and the following
-          disclaimer as the first lines of this file unmodified.
-
-       2. Redistributions in compiled form (transformed to other DTDs,
-          converted to HTML, PDF, PostScript, and other formats) must
-          reproduce the above copyright notice, this list of conditions and
-          the following disclaimer in the documentation and/or other
-          materials provided with the distribution.
-
-    Important: THIS DOCUMENTATION IS PROVIDED BY THE PLPLOT PROJECT "AS IS"
-    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
-    THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-    PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE PLPLOT PROJECT BE LIABLE
-    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
-    BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
-    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
-    OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION,
-    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-*/
-
-SPAN.underline { text-decoration: underline }
-SPAN.overline  { text-decoration: overline  }
-
-TABLE.funcprototype {
-  width: 90%;
-  margin-top: 5px;
-  margin-bottom: 5px;
-  margin-left: 5%;
-  margin-right: 5%;
-  border: solid 1px;
-  background: #D6E8FF;
-  padding: 5px;
-}
-
-TABLE.variablelist {
-  width: 90%;
-  margin-top: 5px;
-  margin-bottom: 5px;
-  margin-left: 5%;
-  margin-right: 5%;
-  border: solid 1px;
-  background: #FFF0D0;
-  padding: 5px;
-}
-
-.verbatim {
-  width: 90%;
-  margin-top: 5px;
-  margin-bottom: 5px;
-  margin-left: 5%;
-  margin-right: 5%;
-  border: solid 1px;
-  background: #E0FFE0;
-  padding: 5px;
-}

Copied: trunk/doc/docbook/src/stylesheet.css.dsssl.in (from rev 12482, trunk/doc/docbook/src/stylesheet.css)
===================================================================
--- trunk/doc/docbook/src/stylesheet.css.dsssl.in	                        (rev 0)
+++ trunk/doc/docbook/src/stylesheet.css.dsssl.in	2013-08-20 19:10:05 UTC (rev 12492)
@@ -0,0 +1,68 @@
+/*
+    HTML Cascade Style Sheet file for the PLplot documentation in Docbook
+
+    Copyright (C) 2004  Rafael Laboissiere
+
+    Redistribution and use in source (XML DocBook) and "compiled" forms
+    (HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
+    modification, are permitted provided that the following conditions are
+    met:
+
+       1. Redistributions of source code (XML DocBook) must retain the
+          above copyright notice, this list of conditions and the following
+          disclaimer as the first lines of this file unmodified.
+
+       2. Redistributions in compiled form (transformed to other DTDs,
+          converted to HTML, PDF, PostScript, and other formats) must
+          reproduce the above copyright notice, this list of conditions and
+          the following disclaimer in the documentation and/or other
+          materials provided with the distribution.
+
+    Important: THIS DOCUMENTATION IS PROVIDED BY THE PLPLOT PROJECT "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+    THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+    PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE PLPLOT PROJECT BE LIABLE
+    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+    BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+    OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION,
+    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+SPAN.underline { text-decoration: underline }
+SPAN.overline  { text-decoration: overline  }
+
+TABLE.funcprototype {
+  width: 90%;
+  margin-top: 5px;
+  margin-bottom: 5px;
+  margin-left: 5%;
+  margin-right: 5%;
+  border: solid 1px;
+  background: #D6E8FF;
+  padding: 5px;
+}
+
+TABLE.variablelist {
+  width: 90%;
+  margin-top: 5px;
+  margin-bottom: 5px;
+  margin-left: 5%;
+  margin-right: 5%;
+  border: solid 1px;
+  background: #FFF0D0;
+  padding: 5px;
+}
+
+.verbatim {
+  width: 90%;
+  margin-top: 5px;
+  margin-bottom: 5px;
+  margin-left: 5%;
+  margin-right: 5%;
+  border: solid 1px;
+  background: #E0FFE0;
+  padding: 5px;
+}

Added: trunk/doc/docbook/src/stylesheet.css.xsl.in
===================================================================
--- trunk/doc/docbook/src/stylesheet.css.xsl.in	                        (rev 0)
+++ trunk/doc/docbook/src/stylesheet.css.xsl.in	2013-08-20 19:10:05 UTC (rev 12492)
@@ -0,0 +1,68 @@
+/*
+    HTML Cascade Style Sheet file for the PLplot documentation in Docbook
+
+    Copyright (C) 2004  Rafael Laboissiere
+
+    Redistribution and use in source (XML DocBook) and "compiled" forms
+    (HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
+    modification, are permitted provided that the following conditions are
+    met:
+
+       1. Redistributions of source code (XML DocBook) must retain the
+          above copyright notice, this list of conditions and the following
+          disclaimer as the first lines of this file unmodified.
+
+       2. Redistributions in compiled form (transformed to other DTDs,
+          converted to HTML, PDF, PostScript, and other formats) must
+          reproduce the above copyright notice, this list of conditions and
+          the following disclaimer in the documentation and/or other
+          materials provided with the distribution.
+
+    Important: THIS DOCUMENTATION IS PROVIDED BY THE PLPLOT PROJECT "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+    THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+    PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE PLPLOT PROJECT BE LIABLE
+    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+    BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+    OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION,
+    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+SPAN.underline { text-decoration: underline }
+SPAN.overline  { text-decoration: overline  }
+
+TABLE.funcprototype-table {
+  width: 90%;
+  margin-top: 5px;
+  margin-bottom: 5px;
+  margin-left: 5%;
+  margin-right: 5%;
+  border: solid 1px;
+  background: #D6E8FF;
+  padding: 5px;
+}
+
+.variablelist {
+  width: 90%;
+  margin-top: 5px;
+  margin-bottom: 5px;
+  margin-left: 5%;
+  margin-right: 5%;
+  border: solid 1px;
+  background: #FFF0D0;
+  padding: 5px;
+}
+
+.verbatim {
+  width: 90%;
+  margin-top: 5px;
+  margin-bottom: 5px;
+  margin-left: 5%;
+  margin-right: 5%;
+  border: solid 1px;
+  background: #E0FFE0;
+  padding: 5px;
+}

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

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

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

Revision: 12491
          http://sourceforge.net/p/plplot/code/12491
Author:   airwin
Date:     2013-08-20 17:16:26 +0000 (Tue, 20 Aug 2013)
Log Message:
-----------
Initial XSL customization of docbook html backend output following
ideas in http://www.sagehill.net/docbookxsl.

The meaningful (rather than numerical) HTML chunk filenames are now
(quietly) formed from the DocBook id using the chunk.quietly and
use.id.as.filename parameters.

Modified Paths:
--------------
    trunk/doc/docbook/src/CMakeLists.txt

Added Paths:
-----------
    trunk/doc/docbook/src/plplotdoc-html.xsl.in

Modified: trunk/doc/docbook/src/CMakeLists.txt
===================================================================
--- trunk/doc/docbook/src/CMakeLists.txt	2013-08-20 02:41:28 UTC (rev 12490)
+++ trunk/doc/docbook/src/CMakeLists.txt	2013-08-20 17:16:26 UTC (rev 12491)
@@ -297,11 +297,19 @@
 
     if(DOCBOOK_XML_BACKEND)
       if(BUILD_HTML)
+	# Custom commands for building html version of documentation
+	set(STYLESHEET_HTML ${PLPLOTDOC}-html.xsl)
+	set(STYLESHEET_HTML_IN ${STYLESHEET_HTML}.in)
+	configure_file(
+	  ${CMAKE_CURRENT_SOURCE_DIR}/${STYLESHEET_HTML_IN}
+	  ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_HTML}
+	  @ONLY
+	  )
 	set(HTML_TMPDIR ${CMAKE_CURRENT_BINARY_DIR}/html)
 	add_custom_command(
 	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
 	  COMMAND ${CMAKE_COMMAND} -E remove_directory ${HTML_TMPDIR}
-	  COMMAND ${XMLTO} -vv -o ${HTML_TMPDIR} html ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-html.xml
+	  COMMAND ${XMLTO} -vv -x ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_HTML} -o ${HTML_TMPDIR} html ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-html.xml
 	  COMMAND ${CMAKE_COMMAND}
 	  -E chdir ${HTML_TMPDIR} ls |cat > ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
 	  COMMAND mv ${HTML_TMPDIR}/* ${CMAKE_CURRENT_BINARY_DIR}
@@ -310,6 +318,7 @@
 	  ${SOURCE_FILES} 
 	  ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-html.xml
 	  ${CMAKE_CURRENT_SOURCE_DIR}/inline-html.ent
+	  ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_HTML}
 	  )
 	add_custom_target(
 	  html ALL
@@ -395,7 +404,6 @@
     else(DOCBOOK_XML_BACKEND)
       if(BUILD_HTML)
 	# Custom commands for building html version of documentation
-
 	set(STYLESHEET_HTML ${PLPLOTDOC}-html.dsl)
 	set(STYLESHEET_HTML_IN ${STYLESHEET_HTML}.in)
 	configure_file(

Added: trunk/doc/docbook/src/plplotdoc-html.xsl.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc-html.xsl.in	                        (rev 0)
+++ trunk/doc/docbook/src/plplotdoc-html.xsl.in	2013-08-20 17:16:26 UTC (rev 12491)
@@ -0,0 +1,49 @@
+<?xml version='1.0'?>
+<!--
+    plplotdoc-html.xsl.in: XSL customization for the HTML PLplot docs
+
+    Copyright (C) 2013 Alan W. Irwin
+
+    Redistribution and use in source (XML DocBook) and "compiled" forms
+    (HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
+    modification, are permitted provided that the following conditions are
+    met:
+
+       1. Redistributions of source code (XML DocBook) must retain the
+          above copyright notice, this list of conditions and the following
+          disclaimer as the first lines of this file unmodified.
+
+       2. Redistributions in compiled form (transformed to other DTDs,
+          converted to HTML, PDF, PostScript, and other formats) must
+          reproduce the above copyright notice, this list of conditions and
+          the following disclaimer in the documentation and/or other
+          materials provided with the distribution.
+
+    Important: THIS DOCUMENTATION IS PROVIDED BY THE PLPLOT PROJECT "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+    THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+    PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE PLPLOT PROJECT BE LIABLE
+    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+    BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+    OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION,
+    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+-->
+<!--
+These ideas for customizing the PLplot html documentation are adapted
+from 
+http://www.sagehill.net/docbookxsl/CustomMethods.html#CustomizationLayer
+http://www.sagehill.net/docbookxsl/Chunking.html#ChunkFilenames
+....
+-->
+<xsl:stylesheet  
+    xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
+
+<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"/>
+
+<xsl:param name="chunk.quietly" select="1"/>
+<xsl:param name="use.id.as.filename" select="1"/>
+
+</xsl:stylesheet> 

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

[Plplot-cvs] SF.net SVN: plplot:[12490] trunk

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

Revision: 12490
          http://sourceforge.net/p/plplot/code/12490
Author:   airwin
Date:     2013-08-20 02:41:28 +0000 (Tue, 20 Aug 2013)
Log Message:
-----------
Generate (by default) our html, pdf, and ps results from our DocBook
source using XML/XSLT backend tools (i.e., the xmlto script).

Tested by Alan W. Irwin <ai...@us...> using (1) the
-DBUILD_DOC=ON cmake option and the install target in doc/docbook/src,
and (2) using scripts/generate_website.sh (which includes using the
-DBUILD_DOC=ON cmake option and the prebuild_dist www-install-base,
and www-install targets, but which does not test the -DPREBUILT_DOC=ON
case).

ToDo: (1) xmlto does not work correctly to generate dvi results so must explore
other alternatives for that case. (2) Must explore XSLT opportunities to
style present results since the current default style is bland.

Modified Paths:
--------------
    trunk/cmake/modules/docbook.cmake
    trunk/doc/docbook/src/CMakeLists.txt

Modified: trunk/cmake/modules/docbook.cmake
===================================================================
--- trunk/cmake/modules/docbook.cmake	2013-08-19 21:55:31 UTC (rev 12489)
+++ trunk/cmake/modules/docbook.cmake	2013-08-20 02:41:28 UTC (rev 12490)
@@ -64,7 +64,7 @@
 # Check for required programs and perl libraries.
 if(BUILD_DOC)
 
-  option(DOCBOOK_XML_BACKEND "Use DocBook XML/XSLT backend tools to generate our documentation from DocBook source" OFF)
+  option(DOCBOOK_XML_BACKEND "Use DocBook XML/XSLT backend tools to generate our documentation from DocBook source" YES)
 
   # The info backend is implemented only with perl and XML/XSLT regardless of
   # DOCBOOK_XML_BACKEND.
@@ -103,8 +103,46 @@
   endif(PERL_FOUND AND PERL_XML_PARSER AND PERL_XML_DOM)
 
   if(DOCBOOK_XML_BACKEND)
-    message(STATUS "DOCBOOK_XML_BACKEND not implemented yet")
-    option(BUILD_DVI "BUILD dvi form of documentation" OFF)
+    # For this case only use xmlto.  That tool does its own warnings at
+    # run time when components are missing so don't bother with looking
+    # for missing components at cmake time.
+    find_program(XMLTO xmlto)
+    if(NOT XMLTO)
+      message(STATUS "WARNING: xmlto not found")
+    endif(NOT XMLTO)
+    find_program(GZIP gzip)
+    if(NOT GZIP)
+      message(STATUS "WARNING: gzip not found")
+    endif(NOT GZIP)
+
+    if(XMLTO)
+      set(BUILD_HTML ON)
+      if(GZIP)
+	set(BUILD_PRINT ON)
+	option(BUILD_DVI "BUILD dvi form of documentation" OFF)
+	if(NOT BUILD_DVI)
+	  message(STATUS
+	    "WARNING: Not building dvi documentation - "
+	    "Bugs in xmlto for this case."
+	    )
+	endif(NOT BUILD_DVI)
+      else(GZIP)
+	set(BUILD_PRINT OFF)
+	message(STATUS
+	  "WARNING: Not building print documentation - "
+	  "gzip is not installed"
+	  )
+      endif(GZIP)
+    else(XMLTO)
+      set(BUILD_HTML OFF)
+      set(BUILD_PRINT OFF)
+      message(STATUS
+	"WARNING: Not building html or print documentation - "
+	"xmlto script is not installed"
+	)
+    endif(XMLTO)
+
+
   else(DOCBOOK_XML_BACKEND)
     # Deprecated SGML/DSSSL backends to generate html and print documentation.
 

Modified: trunk/doc/docbook/src/CMakeLists.txt
===================================================================
--- trunk/doc/docbook/src/CMakeLists.txt	2013-08-19 21:55:31 UTC (rev 12489)
+++ trunk/doc/docbook/src/CMakeLists.txt	2013-08-20 02:41:28 UTC (rev 12490)
@@ -241,8 +241,8 @@
 	-E chdir ${INFO_TMPDIR} ls |cat > ${CMAKE_CURRENT_BINARY_DIR}/${INFO_MANIFEST}
 	COMMAND mv
 	${INFO_TMPDIR}/* ${CMAKE_CURRENT_BINARY_DIR}
+	COMMAND rmdir ${INFO_TMPDIR}
 	DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}.texi
-	COMMAND rmdir ${INFO_TMPDIR}
 	)
 
       add_custom_target(
@@ -295,208 +295,307 @@
       "${MAN_MANIFEST}\n"
       )
 
-    if(BUILD_HTML)
-      # Custom commands for building html version of documentation
-
-      set(STYLESHEET_HTML ${PLPLOTDOC}-html.dsl)
-      set(STYLESHEET_HTML_IN ${STYLESHEET_HTML}.in)
-      configure_file(
-	${CMAKE_CURRENT_SOURCE_DIR}/${STYLESHEET_HTML_IN}
-	${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_HTML}
+    if(DOCBOOK_XML_BACKEND)
+      if(BUILD_HTML)
+	set(HTML_TMPDIR ${CMAKE_CURRENT_BINARY_DIR}/html)
+	add_custom_command(
+	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
+	  COMMAND ${CMAKE_COMMAND} -E remove_directory ${HTML_TMPDIR}
+	  COMMAND ${XMLTO} -vv -o ${HTML_TMPDIR} html ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-html.xml
+	  COMMAND ${CMAKE_COMMAND}
+	  -E chdir ${HTML_TMPDIR} ls |cat > ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
+	  COMMAND mv ${HTML_TMPDIR}/* ${CMAKE_CURRENT_BINARY_DIR}
+	  COMMAND ${CMAKE_COMMAND} -E remove_directory ${HTML_TMPDIR}
+	  DEPENDS
+	  ${SOURCE_FILES} 
+	  ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-html.xml
+	  ${CMAKE_CURRENT_SOURCE_DIR}/inline-html.ent
+	  )
+	add_custom_target(
+	  html ALL
+	  DEPENDS 
+	  ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
+	  )
+	# These files used for more than one target.  Therefore must
+	# use target dependencies rather than file dependencies to build
+	# them.  Otherwise, parallel builds won't work.
+	add_dependencies(html
+	  docbook_plplot-symbols_txt
+	  docbook_plplot-structs_txt
+	  )
+      else(BUILD_HTML)
+	add_custom_target(
+	  html ALL
+	  COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
+	  COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
+	  )
+      endif(BUILD_HTML)
+      file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
+	"${HTML_MANIFEST}\n"
 	)
-      add_custom_command(
-	OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
-	COMMAND ${OPENJADE} -b utf-8
-	${SGML_CATALOGS} -d ${STYLESHEET_HTML} -t sgml ${XML_DECL} ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-html.xml
-	COMMAND ${PERL_EXECUTABLE}
-	-pi -e 's/&\#13;//g' `cat ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}`
-	DEPENDS
-	${SOURCE_FILES} 
-	${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-html.xml
-	${CMAKE_CURRENT_SOURCE_DIR}/inline-html.ent
-	)
 
-      add_custom_target(
-	html ALL
-	DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
-	)
-      # These files used for more than one target.  Therefore must
-      # use target dependencies rather than file dependencies to build
-      # them.  Otherwise, parallel builds won't work.
-      add_dependencies(html
-	docbook_plplot-symbols_txt
-	docbook_plplot-structs_txt
-	)
-    else(BUILD_HTML)
-      add_custom_target(
-	html ALL
-	COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
-	COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
-	)
-    endif(BUILD_HTML)
-    file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
-      "${HTML_MANIFEST}\n"
-      )
+      if(BUILD_PRINT)
+	add_custom_command(
+	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.ps.gz
+	  COMMAND ${XMLTO} -vv --with-fop ps ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
+	  COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-print.ps ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.ps
+	  COMMAND ${GZIP} -f ${BASE}.ps
+	  DEPENDS
+	  ${SOURCE_FILES} 
+	  ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
+	  ${CMAKE_CURRENT_SOURCE_DIR}/inline-print.ent
+	  )
+	add_custom_target(
+	  ps_target ALL 
+	  DEPENDS 
+	  ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.ps.gz
+	  )
+	# These files used for more than one target.  Therefore must
+	# use target dependencies rather than file dependencies to build
+	# them.  Otherwise, parallel builds won't work.
+	add_dependencies(ps_target
+	  docbook_plplot-symbols_txt
+	  docbook_plplot-structs_txt
+	  )
 
-    if(BUILD_PRINT)
-      set(STYLESHEET_PRINT ${PLPLOTDOC}-print.dsl)
-      set(STYLESHEET_PRINT_IN ${STYLESHEET_PRINT}.in)
+	file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
+	  "${BASE}.ps.gz\n"
+	  )
 
-      configure_file(
-	${CMAKE_CURRENT_SOURCE_DIR}/${STYLESHEET_PRINT_IN}
-	${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT}
-	)
+	add_custom_command(
+	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.pdf
+	  COMMAND ${XMLTO} -vv --with-fop pdf ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
+	  COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-print.pdf ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.pdf
+	  DEPENDS
+	  ${SOURCE_FILES} 
+	  ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
+	  ${CMAKE_CURRENT_SOURCE_DIR}/inline-print.ent
+	  )
+	add_custom_target(
+	  pdf_target ALL 
+	  DEPENDS 
+	  ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.pdf
+	  )
+	# These files used for more than one target.  Therefore must
+	# use target dependencies rather than file dependencies to build
+	# them.  Otherwise, parallel builds won't work.
+	add_dependencies(pdf_target
+	  docbook_plplot-symbols_txt
+	  docbook_plplot-structs_txt
+	  )
 
-      configure_file(
-	${CMAKE_CURRENT_SOURCE_DIR}/pdftex.map.in
-	${CMAKE_CURRENT_BINARY_DIR}/pdftex.map
-	)
+	file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
+	  "${BASE}.pdf\n"
+	  )
+	add_custom_target(
+	  print ALL 
+	  )
+	add_dependencies(print ps_target pdf_target)
+      endif(BUILD_PRINT)
+    else(DOCBOOK_XML_BACKEND)
+      if(BUILD_HTML)
+	# Custom commands for building html version of documentation
 
-      # Custom commands for building print version of documentation
-      add_custom_command(
-	OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.jadetex
-	COMMAND ${OPENJADE} -b utf-8
-	${SGML_CATALOGS} -d ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT} 
-	-t tex -o ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.jadetex 
-	${XML_DECL} ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
-	DEPENDS
-	${SOURCE_FILES}
-	${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
-	${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT}
-	${CMAKE_CURRENT_SOURCE_DIR}/inline-print.ent
-	)
+	set(STYLESHEET_HTML ${PLPLOTDOC}-html.dsl)
+	set(STYLESHEET_HTML_IN ${STYLESHEET_HTML}.in)
+	configure_file(
+	  ${CMAKE_CURRENT_SOURCE_DIR}/${STYLESHEET_HTML_IN}
+	  ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_HTML}
+	  )
+	add_custom_command(
+	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
+	  COMMAND ${OPENJADE} -b utf-8
+	  ${SGML_CATALOGS} -d ${STYLESHEET_HTML} -t sgml ${XML_DECL} ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-html.xml
+	  COMMAND ${PERL_EXECUTABLE}
+	  -pi -e 's/&\#13;//g' `cat ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}`
+	  DEPENDS
+	  ${SOURCE_FILES} 
+	  ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-html.xml
+	  ${CMAKE_CURRENT_SOURCE_DIR}/inline-html.ent
+	  )
 
-      # Following approach used in our ABS, use shell commands to recurse
-      # ${PDFJADETEX} ${BASE}.jadetex five times or until the *.aux file that is
-      # produced doesn't change.
-      add_custom_command(
-	OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.pdf
-	COMMAND ${PDFJADETEX} ${BASE}.jadetex
-	COMMAND 
-	if ! cmp ${BASE}.aux prior-pdf.aux 2>/dev/null \; then 
-	cp -pf ${BASE}.aux prior-pdf.aux \; 
-	${PDFJADETEX} ${BASE}.jadetex \; 
-	fi
-	COMMAND 
-	if ! cmp ${BASE}.aux prior-pdf.aux 2>/dev/null \; then 
-	cp -pf ${BASE}.aux prior-pdf.aux \; 
-	${PDFJADETEX} ${BASE}.jadetex \; 
-	fi
-	COMMAND 
-	if ! cmp ${BASE}.aux prior-pdf.aux 2>/dev/null \; then 
-	cp -pf ${BASE}.aux prior-pdf.aux \; 
-	${PDFJADETEX} ${BASE}.jadetex \; 
-	fi
-	COMMAND 
-	if ! cmp ${BASE}.aux prior-pdf.aux 2>/dev/null \; then 
-	cp -pf ${BASE}.aux prior-pdf.aux \; 
-	${PDFJADETEX} ${BASE}.jadetex \; 
-	fi
-	DEPENDS 
-	${CMAKE_CURRENT_BINARY_DIR}/${BASE}.jadetex 
-	${CMAKE_CURRENT_SOURCE_DIR}/jadetex.cfg 
-	${CMAKE_CURRENT_BINARY_DIR}/pdftex.map
+	add_custom_target(
+	  html ALL
+	  DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
+	  )
+	# These files used for more than one target.  Therefore must
+	# use target dependencies rather than file dependencies to build
+	# them.  Otherwise, parallel builds won't work.
+	add_dependencies(html
+	  docbook_plplot-symbols_txt
+	  docbook_plplot-structs_txt
+	  )
+      else(BUILD_HTML)
+	add_custom_target(
+	  html ALL
+	  COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
+	  COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
+	  )
+      endif(BUILD_HTML)
+      file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
+	"${HTML_MANIFEST}\n"
 	)
 
-      # Following approach used in our ABS, use shell commands to recurse
-      # ${JADETEX} ${BASE}.jadetex five times or until the *.aux file that is
-      # produced doesn't change.
-      add_custom_command(
-	OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.dvi
-	COMMAND ${JADETEX} ${BASE}.jadetex
-	COMMAND 
-	if ! cmp ${BASE}.aux prior-dvi.aux 2>/dev/null \; then 
-	cp -pf ${BASE}.aux prior-dvi.aux \; 
-	${JADETEX} ${BASE}.jadetex \; 
-	fi
-	COMMAND 
-	if ! cmp ${BASE}.aux prior-dvi.aux 2>/dev/null \; then 
-	cp -pf ${BASE}.aux prior-dvi.aux \; 
-	${JADETEX} ${BASE}.jadetex \; 
-	fi
-	COMMAND 
-	if ! cmp ${BASE}.aux prior-dvi.aux 2>/dev/null \; then 
-	cp -pf ${BASE}.aux prior-dvi.aux \; 
-	${JADETEX} ${BASE}.jadetex \; 
-	fi
-	COMMAND 
-	if ! cmp ${BASE}.aux prior-dvi.aux 2>/dev/null \; then 
-	cp -pf ${BASE}.aux prior-dvi.aux \; 
-	${JADETEX} ${BASE}.jadetex \; 
-	fi
-	DEPENDS 
-	${CMAKE_CURRENT_BINARY_DIR}/${BASE}.jadetex 
-	${CMAKE_CURRENT_SOURCE_DIR}/jadetex.cfg 
-	${CMAKE_CURRENT_BINARY_DIR}/pdftex.map
-	)
+      if(BUILD_PRINT)
+	set(STYLESHEET_PRINT ${PLPLOTDOC}-print.dsl)
+	set(STYLESHEET_PRINT_IN ${STYLESHEET_PRINT}.in)
 
-      add_custom_command(
-	OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.ps.gz
-	COMMAND ${DVIPS} ${BASE}.dvi
-	COMMAND ${GZIP} -f ${BASE}.ps
-	DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.dvi 
-	)
+	configure_file(
+	  ${CMAKE_CURRENT_SOURCE_DIR}/${STYLESHEET_PRINT_IN}
+	  ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT}
+	  )
 
-      add_custom_target(
-	dvi_target ALL 
-	DEPENDS 
-	${CMAKE_CURRENT_BINARY_DIR}/${BASE}.dvi
-	)
-      # These files used for more than one target.  Therefore must
-      # use target dependencies rather than file dependencies to build
-      # them.  Otherwise, parallel builds won't work.
-      add_dependencies(dvi_target
-	docbook_plplot-symbols_txt
-	docbook_plplot-structs_txt
-	)
+	configure_file(
+	  ${CMAKE_CURRENT_SOURCE_DIR}/pdftex.map.in
+	  ${CMAKE_CURRENT_BINARY_DIR}/pdftex.map
+	  )
 
-      file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
-	"${BASE}.dvi\n"
-	)
-      add_custom_target(
-	ps_target ALL 
-	DEPENDS 
-	${CMAKE_CURRENT_BINARY_DIR}/${BASE}.ps.gz
-	)
-      # These files used for more than one target.  Therefore must
-      # use target dependencies rather than file dependencies to build
-      # them.  Otherwise, parallel builds won't work.
-      add_dependencies(ps_target
-	docbook_plplot-symbols_txt
-	docbook_plplot-structs_txt
-	)
+	# Custom commands for building print version of documentation
+	add_custom_command(
+	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.jadetex
+	  COMMAND ${OPENJADE} -b utf-8
+	  ${SGML_CATALOGS} -d ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT} 
+	  -t tex -o ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.jadetex 
+	  ${XML_DECL} ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
+	  DEPENDS
+	  ${SOURCE_FILES}
+	  ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
+	  ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT}
+	  ${CMAKE_CURRENT_SOURCE_DIR}/inline-print.ent
+	  )
 
-      # dvi_target must complete before ps_target is executed for parallel builds.
-      add_dependencies(ps_target dvi_target)
+	# Following approach used in our ABS, use shell commands to recurse
+	# ${PDFJADETEX} ${BASE}.jadetex five times or until the *.aux file that is
+	# produced doesn't change.
+	add_custom_command(
+	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.pdf
+	  COMMAND ${PDFJADETEX} ${BASE}.jadetex
+	  COMMAND 
+	  if ! cmp ${BASE}.aux prior-pdf.aux 2>/dev/null \; then 
+	  cp -pf ${BASE}.aux prior-pdf.aux \; 
+	  ${PDFJADETEX} ${BASE}.jadetex \; 
+	  fi
+	  COMMAND 
+	  if ! cmp ${BASE}.aux prior-pdf.aux 2>/dev/null \; then 
+	  cp -pf ${BASE}.aux prior-pdf.aux \; 
+	  ${PDFJADETEX} ${BASE}.jadetex \; 
+	  fi
+	  COMMAND 
+	  if ! cmp ${BASE}.aux prior-pdf.aux 2>/dev/null \; then 
+	  cp -pf ${BASE}.aux prior-pdf.aux \; 
+	  ${PDFJADETEX} ${BASE}.jadetex \; 
+	  fi
+	  COMMAND 
+	  if ! cmp ${BASE}.aux prior-pdf.aux 2>/dev/null \; then 
+	  cp -pf ${BASE}.aux prior-pdf.aux \; 
+	  ${PDFJADETEX} ${BASE}.jadetex \; 
+	  fi
+	  DEPENDS 
+	  ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.jadetex 
+	  ${CMAKE_CURRENT_SOURCE_DIR}/jadetex.cfg 
+	  ${CMAKE_CURRENT_BINARY_DIR}/pdftex.map
+	  )
 
-      file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
-	"${BASE}.ps.gz\n"
-	)
-      add_custom_target(
-	pdf_target ALL 
-	DEPENDS 
-	${CMAKE_CURRENT_BINARY_DIR}/${BASE}.pdf
-	)
-      # These files used for more than one target.  Therefore must
-      # use target dependencies rather than file dependencies to build
-      # them.  Otherwise, parallel builds won't work.
-      add_dependencies(pdf_target
-	docbook_plplot-symbols_txt
-	docbook_plplot-structs_txt
-	)
+	# Following approach used in our ABS, use shell commands to recurse
+	# ${JADETEX} ${BASE}.jadetex five times or until the *.aux file that is
+	# produced doesn't change.
+	add_custom_command(
+	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.dvi
+	  COMMAND ${JADETEX} ${BASE}.jadetex
+	  COMMAND 
+	  if ! cmp ${BASE}.aux prior-dvi.aux 2>/dev/null \; then 
+	  cp -pf ${BASE}.aux prior-dvi.aux \; 
+	  ${JADETEX} ${BASE}.jadetex \; 
+	  fi
+	  COMMAND 
+	  if ! cmp ${BASE}.aux prior-dvi.aux 2>/dev/null \; then 
+	  cp -pf ${BASE}.aux prior-dvi.aux \; 
+	  ${JADETEX} ${BASE}.jadetex \; 
+	  fi
+	  COMMAND 
+	  if ! cmp ${BASE}.aux prior-dvi.aux 2>/dev/null \; then 
+	  cp -pf ${BASE}.aux prior-dvi.aux \; 
+	  ${JADETEX} ${BASE}.jadetex \; 
+	  fi
+	  COMMAND 
+	  if ! cmp ${BASE}.aux prior-dvi.aux 2>/dev/null \; then 
+	  cp -pf ${BASE}.aux prior-dvi.aux \; 
+	  ${JADETEX} ${BASE}.jadetex \; 
+	  fi
+	  DEPENDS 
+	  ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.jadetex 
+	  ${CMAKE_CURRENT_SOURCE_DIR}/jadetex.cfg 
+	  ${CMAKE_CURRENT_BINARY_DIR}/pdftex.map
+	  )
 
-      # dvi_target must complete before pdf_target is executed for parallel builds.
-      add_dependencies(pdf_target dvi_target)
+	add_custom_command(
+	  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.ps.gz
+	  COMMAND ${DVIPS} ${BASE}.dvi
+	  COMMAND ${GZIP} -f ${BASE}.ps
+	  DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.dvi 
+	  )
 
-      file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
-	"${BASE}.pdf\n"
-	)
-      add_custom_target(
-	print ALL 
-	)
-      add_dependencies(print dvi_target ps_target pdf_target)
+	add_custom_target(
+	  dvi_target ALL 
+	  DEPENDS 
+	  ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.dvi
+	  )
+	# These files used for more than one target.  Therefore must
+	# use target dependencies rather than file dependencies to build
+	# them.  Otherwise, parallel builds won't work.
+	add_dependencies(dvi_target
+	  docbook_plplot-symbols_txt
+	  docbook_plplot-structs_txt
+	  )
 
-    endif(BUILD_PRINT)
+	file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
+	  "${BASE}.dvi\n"
+	  )
+	add_custom_target(
+	  ps_target ALL 
+	  DEPENDS 
+	  ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.ps.gz
+	  )
+	# These files used for more than one target.  Therefore must
+	# use target dependencies rather than file dependencies to build
+	# them.  Otherwise, parallel builds won't work.
+	add_dependencies(ps_target
+	  docbook_plplot-symbols_txt
+	  docbook_plplot-structs_txt
+	  )
+
+	# dvi_target must complete before ps_target is executed for parallel builds.
+	add_dependencies(ps_target dvi_target)
+
+	file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
+	  "${BASE}.ps.gz\n"
+	  )
+	add_custom_target(
+	  pdf_target ALL 
+	  DEPENDS 
+	  ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.pdf
+	  )
+	# These files used for more than one target.  Therefore must
+	# use target dependencies rather than file dependencies to build
+	# them.  Otherwise, parallel builds won't work.
+	add_dependencies(pdf_target
+	  docbook_plplot-symbols_txt
+	  docbook_plplot-structs_txt
+	  )
+
+	# dvi_target must complete before pdf_target is executed for parallel builds.
+	add_dependencies(pdf_target dvi_target)
+
+	file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
+	  "${BASE}.pdf\n"
+	  )
+	add_custom_target(
+	  print ALL 
+	  )
+	add_dependencies(print dvi_target ps_target pdf_target)
+
+      endif(BUILD_PRINT)
+    endif(DOCBOOK_XML_BACKEND)
   endif(BUILD_DOC)
 endif(
   PREBUILT_DOC
@@ -582,17 +681,6 @@
   set(RSH_COMMAND ${RSH} ${WWW_USERAT}${WWW_HOST})
 
   add_custom_command(
-    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${HTML_TARBALL}
-    COMMAND rm -rf ${BASE_HTML}
-    COMMAND mkdir ${BASE_HTML}
-    COMMAND cp `cat ${HTML_MANIFEST}` ${BASE_HTML}
-    COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/stylesheet.css ${BASE_HTML}
-    COMMAND tar cfz ${HTML_TARBALL} ${BASE_HTML}
-    COMMAND rm -rf ${BASE_HTML}
-    DEPENDS ${HTML_MANIFEST} ${CMAKE_CURRENT_SOURCE_DIR}/stylesheet.css
-    )
-
-  add_custom_command(
     OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${INFO_TARBALL}
     COMMAND rm -rf ${BASE_INFO}
     COMMAND mkdir ${BASE_INFO}
@@ -613,22 +701,50 @@
     )
 
   add_custom_command(
-    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${TARBALL}
-    COMMAND tar cfz ${TARBALL}
-    ${HTML_TARBALL}
+    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${HTML_TARBALL}
+    COMMAND rm -rf ${BASE_HTML}
+    COMMAND mkdir ${BASE_HTML}
+    COMMAND cp `cat ${HTML_MANIFEST}` ${BASE_HTML}
+    COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/stylesheet.css ${BASE_HTML}
+    COMMAND tar cfz ${HTML_TARBALL} ${BASE_HTML}
+    COMMAND rm -rf ${BASE_HTML}
+    DEPENDS ${HTML_MANIFEST} ${CMAKE_CURRENT_SOURCE_DIR}/stylesheet.css
+    )
+
+  set(tarball_list
     ${INFO_TARBALL}
     ${MAN_TARBALL}
-    ${BASE}.ps.gz
-    ${BASE}.pdf
-    ${BASE}.dvi
-    -C ${CMAKE_CURRENT_SOURCE_DIR}/.. COPYING
-    DEPENDS
+    ${HTML_TARBALL}
+    )
+
+  set(tarball_depends_list
     ${CMAKE_CURRENT_BINARY_DIR}/${HTML_TARBALL}
     ${CMAKE_CURRENT_BINARY_DIR}/${INFO_TARBALL}
     ${CMAKE_CURRENT_BINARY_DIR}/${MAN_TARBALL}
-    ${BASE}.ps.gz
-    ${BASE}.pdf
-    ${BASE}.dvi
+    )
+
+  if(BUILD_PRINT)
+    list(APPEND tarball_list
+      ${BASE}.ps.gz
+      ${BASE}.pdf
+      )
+    list(APPEND tarball_depends_list
+      ${BASE}.ps.gz
+      ${BASE}.pdf
+      )
+    if(BUILD_DVI)
+      list(APPEND tarball_list ${BASE}.dvi)
+      list(APPEND tarball_depends_list ${BASE}.dvi)
+    endif(BUILD_DVI)
+  endif(BUILD_PRINT)
+
+  add_custom_command(
+    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${TARBALL}
+    COMMAND tar cfz ${TARBALL}
+    ${tarball_list}
+    -C ${CMAKE_CURRENT_SOURCE_DIR}/.. COPYING
+    DEPENDS
+    ${tarball_depends_list}
     ${CMAKE_CURRENT_SOURCE_DIR}/../COPYING
     )
 

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