[BACK]Return to lonplot.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / xml

Diff for /loncom/xml/lonplot.pm between versions 1.86 and 1.96

version 1.86, 2003/08/26 21:52:46 version 1.96, 2004/05/26 19:44:20
Line 25 Line 25
 #  #
 # http://www.lon-capa.org/  # http://www.lon-capa.org/
 #  #
 # 12/15/01 Matthew  
 # 12/17 12/18 12/19 12/20 12/21 12/27 12/28 12/30 12/31 Matthew  
 # 01/01/02 Matthew  
 # 01/02 01/03 01/04 01/07 01/08 01/09 Matthew  
 # 01/21 02/05 02/06 2/28Matthew  
   
 package Apache::lonplot;  package Apache::lonplot;
   
 use strict;  use strict;
   use warnings FATAL=>'all';
   no warnings 'uninitialized';
 use Apache::File;  use Apache::File;
 use Apache::response;  use Apache::response;
 use Apache::lonxml;  use Apache::lonxml;
Line 113  my $words_test     = sub {$_[0]=~s/\s+/ Line 110  my $words_test     = sub {$_[0]=~s/\s+/
 ###################################################################  ###################################################################
 my @gnuplot_edit_order =   my @gnuplot_edit_order = 
     qw/alttag bgcolor fgcolor height width font transparent grid samples       qw/alttag bgcolor fgcolor height width font transparent grid samples 
     border align texwidth/;      border align texwidth texfont plottype/;
   
 my $gnuplot_help_text = <<"ENDPLOTHELP";  
 <p>  
 The <b>gnuplot</b> tag allows an author to design a plot which can  
 be created on the fly.  This is intended for use in homework problems  
 where each student needs to see a distinct plot.  It can be used in  
 conjunction with a <b>script</b> tag to generate random plots.  
 </p><p>  
 A <b>gnuplot</b> tag can contain the following sub-tags:  
 </p>  
 <dl>  
 <dt> Plot Label  
     <dd> Allows you to place text at a given (x,y) coordinate on the plot.  
 <dt> Plot Title  
     <dd> The title of the plot  
 <dt> Plot Xlabel  
     <dd> The label on the horizontal axis of the plot  
 <dt> Plot Ylabel  
     <dd> The label on the vertical axis of the plot  
 <dt> Plot Axes  
     <dd> allows specification of the x and y ranges displayed in the plot  
 <dt> Plot Key  
     <dd> Lists the functions displayed in the plot.  
 <dt> Plot Curve  
     <dd> Sets the data used in the plot.  
 <dt> Plot Tics  
     <dd> Allows specification of the x and y coordinate 'tics' on the axes.  
 This is mostly used to adjust the grid lines when a grid is displayed.  
 </dl>  
 If you are having trouble with your plot, please read the help  
 available on Plot Curve.  
 ENDPLOTHELP  
   
 my %gnuplot_defaults =   my %gnuplot_defaults = 
     (      (
Line 230  my %gnuplot_defaults = Line 195  my %gnuplot_defaults =
          edit_type   => 'entry',           edit_type   => 'entry',
          size        => '5'           size        => '5'
          },           },
        texfont     => {
            default     => '22',
            test        => $int_test,
            description => 'Font size to use in TeX output (pts):',
            edit_type   => 'choice',
            choices     => [qw/8 10 12 14 16 18 20 22 24 26 28 30 32 34 36/],
            },
        plottype  => {
    default     => 'Cartesian',
    test        => sub {$_[0]=~/^(Polar|Cartesian)$/},
    description => 'Plot type:',
    edit_type   => 'choice',
            choices     => ['Cartesian','Polar']
            },
      );       );
   
 my %key_defaults =   my %key_defaults = 
Line 282  my %label_defaults = Line 261  my %label_defaults =
      }       }
      );       );
   
 my @tic_edit_order = ('location','mirror','start','increment','end');  my @tic_edit_order = ('location','mirror','start','increment','end',
                         'minorfreq');
 my %tic_defaults =  my %tic_defaults =
     (      (
      location => {       location => {
  default => 'border',    default => 'border', 
  test => sub {$_[0]=~/^(border|axis)$/},   test => sub {$_[0]=~/^(border|axis)$/},
  description => 'Location of tick marks',   description => 'Location of major tic marks',
  edit_type   => 'choice',   edit_type   => 'choice',
  choices     => ['border','axis']   choices     => ['border','axis']
  },   },
      mirror => {       mirror => {
  default => 'on',    default => 'on', 
  test => $onoff_test,   test => $onoff_test,
  description => 'mirror ticks on opposite axis?',   description => 'mirror tics on opposite axis?',
  edit_type   => 'onoff'   edit_type   => 'onoff'
  },   },
      start => {       start => {
  default => '-10.0',   default => '-10.0',
  test => $real_test,   test => $real_test,
  description => 'Start ticks at',   description => 'Start major tics at',
  edit_type   => 'entry',   edit_type   => 'entry',
  size        => '10'   size        => '10'
  },   },
      increment => {       increment => {
  default => '1.0',   default => '1.0',
  test => $real_test,   test => $real_test,
  description => 'Place a tick every',   description => 'Place a major tic every',
  edit_type   => 'entry',   edit_type   => 'entry',
  size        => '10'   size        => '10'
  },   },
      end => {       end => {
  default => ' 10.0',   default => ' 10.0',
  test => $real_test,   test => $real_test,
  description => 'Stop ticks at ',   description => 'Stop major tics at ',
  edit_type   => 'entry',   edit_type   => 'entry',
  size        => '10'   size        => '10'
  },   },
        minorfreq => {
    default => '0',
    test => $int_test,
    description => 'Number of minor tics between major tic marks',
    edit_type   => 'entry',
    size        => '10'
    },         
      );       );
   
 my @axis_edit_order = ('color','xmin','xmax','ymin','ymax');  my @axis_edit_order = ('color','xmin','xmax','ymin','ymax');
Line 361  my %axis_defaults = Line 348  my %axis_defaults =
  }   }
      );       );
   
 my $curve_help_text = <<"ENDCURVEHELP";  
 The <b>curve</b> tag is where you set the data to be plotted by gnuplot.  
 There are two ways of entering the information:  
 <dl>  
     <dt> Curve Data  
     <dd> Using a <b>data</b> tag you can specify the numbers used to produce   
 the plot.    
 <p>  
 By default, two <b>data</b> tags will be available in a plot.  The  
 first will specify X coordinates of the data and the second will  
 give the Y coordinates of the data.  When working with a linestyle that   
 requires more than two data sets, inserting another <b>data</b> tag is  
 required.  Unfortunately, you must make sure the <b>data</b> tags appear  
 in the order gnuplot expects the data.  
 </p><p>  
 Specifying the data should usually be done with a perl variable or array,   
 such as \@Xdata and \@Ydata.  You may also specify numerical data seperated   
 by commas.  Again, the order of the <b>data</b> tags is important.  The  
 first tag will be the X data and the second will be the Y data.  
 </p>  
     <dt> Curve Function  
     <dd> The <b>function</b> tag allows you to specify the curve to be   
 plotted as a formula that gnuplot can understand.  <b>Be careful using this  
 tag.</b>  It is surprisingly easy to give gnuplot a function it cannot deal  
 with properly.  Be explicit: 2*sin(2*3.141592*x/4) will work but  
 2sin(2*3.141592x/4) will not.  If you do not receive any errors in the  
 gnuplot data but still do not have an image produced, it is likely there  
 is an error in your <b>function</b> tag.  
 </dl>  
 ENDCURVEHELP  
   
 my @curve_edit_order = ('color','name','linestyle','pointtype','pointsize');  my @curve_edit_order = ('color','name','linestyle','pointtype','pointsize');
   
 my %curve_defaults =   my %curve_defaults = 
Line 449  my %curve_defaults = Line 405  my %curve_defaults =
 my (%plot,%key,%axis,$title,$xlabel,$ylabel,@labels,@curves,%xtics,%ytics);  my (%plot,%key,%axis,$title,$xlabel,$ylabel,@labels,@curves,%xtics,%ytics);
   
 sub start_gnuplot {  sub start_gnuplot {
     %plot    = ();      %key     = ();      %axis   = ();       undef(%plot);   undef(%key);    undef(%axis);
     $title   = undef;   $xlabel  = undef;   $ylabel = undef;      undef($title);  undef($xlabel); undef($ylabel);
     $#labels = -1;      $#curves = -1;      undef(@labels); undef(@curves);
     %xtics    = ();      %ytics    = ();      undef(%xtics);  undef(%ytics);
     #      #
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
     my $result='';      my $result='';
Line 465  sub start_gnuplot { Line 421  sub start_gnuplot {
  $tagstack->[-1]);   $tagstack->[-1]);
     } elsif ($target eq 'edit') {      } elsif ($target eq 'edit') {
  $result .= &Apache::edit::tag_start($target,$token,'GnuPlot');   $result .= &Apache::edit::tag_start($target,$token,'GnuPlot');
  $result .= &make_javascript();  
  $result .= &help_win($gnuplot_help_text);  
  $result .= &edit_attributes($target,$token,\%gnuplot_defaults,   $result .= &edit_attributes($target,$token,\%gnuplot_defaults,
     \@gnuplot_edit_order);      \@gnuplot_edit_order);
     } elsif ($target eq 'modified') {      } elsif ($target eq 'modified') {
Line 488  sub end_gnuplot { Line 442  sub end_gnuplot {
     my $randnumber;      my $randnumber;
     # need to call rand everytime start_script would evaluate, as the      # need to call rand everytime start_script would evaluate, as the
     # safe space rand number generator and the global rand generator       # safe space rand number generator and the global rand generator 
     # are not seperate      # are not separate
     if ($target eq 'web' || $target eq 'tex' || $target eq 'grade' ||      if ($target eq 'web' || $target eq 'tex' || $target eq 'grade' ||
  $target eq 'answer') {   $target eq 'answer') {
       $randnumber=int(rand(1000));        $randnumber=int(rand(1000));
Line 513  sub end_gnuplot { Line 467  sub end_gnuplot {
      alt    = "$plot{'alttag'}" />       alt    = "$plot{'alttag'}" />
 ENDIMAGE  ENDIMAGE
         } elsif ($target eq 'tex') {          } elsif ($target eq 'tex') {
     &Apache::lonnet::ssi("/cgi-bin/plot.gif?file=$filename.data&output=eps");      #might be inside the safe space, register the URL for later
       &Apache::lonxml::register_ssi("/cgi-bin/plot.gif?file=$filename.data&output=eps");
     $result = '\graphicspath{{/home/httpd/perl/tmp/}}\includegraphics[width='.$plot{'texwidth'}.' mm]{'.&Apache::lonnet::unescape($filename).'.eps}';      $result = '\graphicspath{{/home/httpd/perl/tmp/}}\includegraphics[width='.$plot{'texwidth'}.' mm]{'.&Apache::lonnet::unescape($filename).'.eps}';
  }   }
     } elsif ($target eq 'edit') {      } elsif ($target eq 'edit') {
Line 635  sub start_title { Line 589  sub start_title {
     &Apache::edit::start_spanning_row().      &Apache::edit::start_spanning_row().
     &Apache::edit::editline('',$text,'',60);      &Apache::edit::editline('',$text,'',60);
     } elsif ($target eq 'modified') {      } elsif ($target eq 'modified') {
  my $text=$$parser[-1]->get_text("/title");  
  $result.=&Apache::edit::rebuild_tag($token);   $result.=&Apache::edit::rebuild_tag($token);
  $result.=&Apache::edit::modifiedfield($token);   $result.=&Apache::edit::modifiedfield("/title",$parser);
     }      }
     return $result;      return $result;
 }  }
Line 669  sub start_xlabel { Line 622  sub start_xlabel {
     &Apache::edit::start_spanning_row().      &Apache::edit::start_spanning_row().
     &Apache::edit::editline('',$text,'',60);      &Apache::edit::editline('',$text,'',60);
     } elsif ($target eq 'modified') {      } elsif ($target eq 'modified') {
  my $text=$$parser[-1]->get_text("/xlabel");  
  $result.=&Apache::edit::rebuild_tag($token);   $result.=&Apache::edit::rebuild_tag($token);
  $result.=&Apache::edit::modifiedfield($token);   $result.=&Apache::edit::modifiedfield("/xlabel",$parser);
     }      }
     return $result;      return $result;
 }  }
Line 704  sub start_ylabel { Line 656  sub start_ylabel {
     &Apache::edit::start_spanning_row().      &Apache::edit::start_spanning_row().
     &Apache::edit::editline('',$text,'',60);      &Apache::edit::editline('',$text,'',60);
     } elsif ($target eq 'modified') {      } elsif ($target eq 'modified') {
  my $text=$$parser[-1]->get_text("/ylabel");  
  $result.=&Apache::edit::rebuild_tag($token);   $result.=&Apache::edit::rebuild_tag($token);
  $result.=&Apache::edit::modifiedfield($token);   $result.=&Apache::edit::modifiedfield("/ylabel",$parser);
     }      }
     return $result;      return $result;
 }  }
Line 746  sub start_label { Line 697  sub start_label {
  &Apache::edit::get_new_args   &Apache::edit::get_new_args
     ($token,$parstack,$safeeval,keys(%label_defaults));      ($token,$parstack,$safeeval,keys(%label_defaults));
  $result.=&Apache::edit::rebuild_tag($token);   $result.=&Apache::edit::rebuild_tag($token);
  my $text=$$parser[-1]->get_text("/label");   $result.=&Apache::edit::modifiedfield("/label",$parser);
  $result.=&Apache::edit::modifiedfield($token);  
     }      }
     return $result;      return $result;
 }  }
Line 775  sub start_curve { Line 725  sub start_curve {
  push (@curves,\%curve);   push (@curves,\%curve);
     } elsif ($target eq 'edit') {      } elsif ($target eq 'edit') {
  $result .= &Apache::edit::tag_start($target,$token,'Curve');   $result .= &Apache::edit::tag_start($target,$token,'Curve');
  $result .= &help_win($curve_help_text);  
  $result .= &edit_attributes($target,$token,\%curve_defaults,   $result .= &edit_attributes($target,$token,\%curve_defaults,
                                     \@curve_edit_order);                                      \@curve_edit_order);
     } elsif ($target eq 'modified') {      } elsif ($target eq 'modified') {
Line 825  sub start_function { Line 774  sub start_function {
     &Apache::edit::editline('',$text,'',60);      &Apache::edit::editline('',$text,'',60);
     } elsif ($target eq 'modified') {      } elsif ($target eq 'modified') {
  $result.=&Apache::edit::rebuild_tag($token);   $result.=&Apache::edit::rebuild_tag($token);
  my $text=$$parser[-1]->get_text("/function");   $result.=&Apache::edit::modifiedfield("/function",$parser);
  $result.=&Apache::edit::modifiedfield($token);  
     }      }
     return $result;      return $result;
 }  }
Line 868  sub start_data { Line 816  sub start_data {
  my @data;   my @data;
  if ($datatext =~ /,/) { # comma deliminated   if ($datatext =~ /,/) { # comma deliminated
     @data = split /,/,$datatext;      @data = split /,/,$datatext;
  } else { # Assume it's space seperated.   } else { # Assume it's space separated.
     @data = split / /,$datatext;      @data = split / /,$datatext;
  }   }
  for (my $i=0;$i<=$#data;$i++) {   for (my $i=0;$i<=$#data;$i++) {
Line 903  sub start_data { Line 851  sub start_data {
     &Apache::edit::editline('',$text,'',60);      &Apache::edit::editline('',$text,'',60);
     } elsif ($target eq 'modified') {      } elsif ($target eq 'modified') {
  $result.=&Apache::edit::rebuild_tag($token);   $result.=&Apache::edit::rebuild_tag($token);
  my $text=$$parser[-1]->get_text("/data");   $result.=&Apache::edit::modifiedfield("/data",$parser);
  $result.=&Apache::edit::modifiedfield($token);  
     }      }
     return $result;      return $result;
 }  }
Line 970  sub set_defaults { Line 917  sub set_defaults {
 sub get_attributes{  sub get_attributes{
     my ($values,$defaults,$parstack,$safeeval,$tag) = @_;      my ($values,$defaults,$parstack,$safeeval,$tag) = @_;
     foreach my $attr (keys(%{$defaults})) {      foreach my $attr (keys(%{$defaults})) {
  if ($attr eq 'texwidth') {   if ($attr eq 'texwidth' || $attr eq 'texfont') {
     $values->{$attr} =       $values->{$attr} = 
  &Apache::lonxml::get_param($attr,$parstack,$safeeval,undef,1);   &Apache::lonxml::get_param($attr,$parstack,$safeeval,undef,1);
  } else {   } else {
Line 997  sub write_gnuplot_file { Line 944  sub write_gnuplot_file {
     my ($tmpdir,$filename,$target)= @_;      my ($tmpdir,$filename,$target)= @_;
     my $gnuplot_input = '';      my $gnuplot_input = '';
     my $curve;      my $curve;
       my $pt = $plot{'texfont'};
     # Collect all the colors      # Collect all the colors
     my @Colors;      my @Colors;
     push @Colors, $plot{'bgcolor'};      push @Colors, $plot{'bgcolor'};
Line 1017  sub write_gnuplot_file { Line 965  sub write_gnuplot_file {
  # set output   # set output
  $gnuplot_input .= "set output\n";   $gnuplot_input .= "set output\n";
     } elsif ($target eq 'tex') {      } elsif ($target eq 'tex') {
  $gnuplot_input .= "set term postscript eps monochrome solid\n";   $gnuplot_input .= "set term postscript eps monochrome solid \"Helvetica\" $pt \n";
  $gnuplot_input .= "set output \"/home/httpd/perl/tmp/".   $gnuplot_input .= "set output \"/home/httpd/perl/tmp/".
     &Apache::lonnet::unescape($filename).".eps\"\n";      &Apache::lonnet::unescape($filename).".eps\"\n";
     }      }
       # cartesian or polar?
       if (lc($plot{'plottype'}) eq 'polar') {
           $gnuplot_input .= 'set polar'.$/;
       } else {
           # Assume Cartesian
       }
     # grid      # grid
     $gnuplot_input .= 'set grid'.$/ if ($plot{'grid'} eq 'on');      $gnuplot_input .= 'set grid'.$/ if ($plot{'grid'} eq 'on');
     # border      # border
Line 1031  sub write_gnuplot_file { Line 985  sub write_gnuplot_file {
     $gnuplot_input .= "set samples $plot{'samples'}\n";      $gnuplot_input .= "set samples $plot{'samples'}\n";
     # title, xlabel, ylabel      # title, xlabel, ylabel
     # titles      # titles
     $gnuplot_input .= "set title  \"$title\"\n"  if (defined($title)) ;      if ($target eq 'tex') {
     $gnuplot_input .= "set xlabel \"$xlabel\"\n" if (defined($xlabel));          $gnuplot_input .= "set title  \"$title\" font \"Helvetica,".$pt."pt\"\n"  if (defined($title)) ;
     $gnuplot_input .= "set ylabel \"$ylabel\"\n" if (defined($ylabel));          $gnuplot_input .= "set xlabel \"$xlabel\" font \"Helvetica,".$pt."pt\" \n" if (defined($xlabel));
           $gnuplot_input .= "set ylabel \"$ylabel\" font \"Helvetica,".$pt."pt\"\n" if (defined($ylabel));
       } else {
           $gnuplot_input .= "set title  \"$title\"  \n"  if (defined($title)) ;
           $gnuplot_input .= "set xlabel \"$xlabel\" \n" if (defined($xlabel));
           $gnuplot_input .= "set ylabel \"$ylabel\" \n" if (defined($ylabel));
       }
     # tics      # tics
     if (%xtics) {          if (%xtics) {    
  $gnuplot_input .= "set xtics $xtics{'location'} ";   $gnuplot_input .= "set xtics $xtics{'location'} ";
Line 1041  sub write_gnuplot_file { Line 1001  sub write_gnuplot_file {
  $gnuplot_input .= "$xtics{'start'}, ";   $gnuplot_input .= "$xtics{'start'}, ";
  $gnuplot_input .= "$xtics{'increment'}, ";   $gnuplot_input .= "$xtics{'increment'}, ";
  $gnuplot_input .= "$xtics{'end'}\n";   $gnuplot_input .= "$xtics{'end'}\n";
           if ($xtics{'minorfreq'} != 0) {
               $gnuplot_input .= "set mxtics ".$xtics{'minorfreq'}."\n";
           } 
     }      }
     if (%ytics) {          if (%ytics) {    
  $gnuplot_input .= "set ytics $ytics{'location'} ";   $gnuplot_input .= "set ytics $ytics{'location'} ";
Line 1048  sub write_gnuplot_file { Line 1011  sub write_gnuplot_file {
  $gnuplot_input .= "$ytics{'start'}, ";   $gnuplot_input .= "$ytics{'start'}, ";
  $gnuplot_input .= "$ytics{'increment'}, ";   $gnuplot_input .= "$ytics{'increment'}, ";
         $gnuplot_input .= "$ytics{'end'}\n";          $gnuplot_input .= "$ytics{'end'}\n";
           if ($ytics{'minorfreq'} != 0) {
               $gnuplot_input .= "set mytics ".$ytics{'minorfreq'}."\n";
           } 
     }      }
     # axis      # axis
     if (%axis) {      if (%axis) {
Line 1068  sub write_gnuplot_file { Line 1034  sub write_gnuplot_file {
     my $label;      my $label;
     foreach $label (@labels) {      foreach $label (@labels) {
  $gnuplot_input .= 'set label "'.$label->{'text'}.'" at '.   $gnuplot_input .= 'set label "'.$label->{'text'}.'" at '.
     $label->{'xpos'}.','.$label->{'ypos'}.' '.$label->{'justify'}.$/ ;      $label->{'xpos'}.','.$label->{'ypos'}.' '.$label->{'justify'}.' font "Helvetica,'.$pt.'pt"'.$/ ;
     }      }
     if ($target eq 'tex') {      if ($target eq 'tex') {
         $gnuplot_input .="set size 1,".$plot{'height'}/$plot{'width'}*1.38;          $gnuplot_input .="set size 1,".$plot{'height'}/$plot{'width'}*1.38;
Line 1302  sub insert_data { Line 1268  sub insert_data {
 }  }
   
 ##----------------------------------------------------------------------  ##----------------------------------------------------------------------
 # Javascript functions to display help for tags  
   
 sub make_javascript {  
     my $helpwindowwidth  = 400;  
     my $helpwindowheight = 400;  
     my $result = '';  
     $result.=<<"ENDFUNCTION";  
 <script language="JavaScript">  
 function openWin(text)  
 {  
   newWin = open("", "new_W", "width=$helpwindowwidth,height=$helpwindowheight,resizable=1,scrollbars=1");  
   newWin.document.open("text/html", "replace");  
   newWin.document.writeln(text);  
   newWin.document.writeln('<center><a href=\"javascript:window.close()\">close this window</a></center>');  
   newWin.document.close();  
 }  
 </script>  
 ENDFUNCTION  
     return $result;  
 }  
   
 sub help_win {  
     my ($helptext)=@_;  
     $helptext =~ s/\n/ /g;  
     $helptext =~ s/\'/\\\'/g;  
     my $result = '';  
     $result.=<<"ENDWIN";  
 <table width="100%"><tr><td align="right">  
 <a href="javascript:openWin('$helptext')">help</a>  
 </td></tr></table><hr />  
 ENDWIN  
     return $result;  
 }  
 ##----------------------------------------------------------------------  
 1;  1;
 __END__  __END__
   
Removed from v.1.86  
changed lines
  Added in v.1.96

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>