--- loncom/xml/lonplot.pm 2002/01/30 13:27:51 1.46 +++ loncom/xml/lonplot.pm 2002/02/27 22:17:06 1.52 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Dynamic plot # -# $Id: lonplot.pm,v 1.46 2002/01/30 13:27:51 matthew Exp $ +# $Id: lonplot.pm,v 1.52 2002/02/27 22:17:06 matthew Exp $ # # Copyright Michigan State University Board of Trustees # @@ -29,7 +29,7 @@ # 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 Matthew +# 01/21 02/05 02/06 2/28Matthew package Apache::lonplot; @@ -40,7 +40,7 @@ use Apache::lonxml; use Apache::edit; BEGIN { - &Apache::lonxml::register('Apache::lonplot',('plot')); + &Apache::lonxml::register('Apache::lonplot',('gnuplot')); } ## @@ -113,9 +113,40 @@ my $words_test = sub {$_[0]=~s/\s+/ ## Attribute metadata ## ## ## ################################################################### -my @plot_edit_order = +my @gnuplot_edit_order = qw/bgcolor fgcolor height width font transparent grid border align/; -my %plot_defaults = + +my $gnuplot_help_text = <<"ENDPLOTHELP"; +

+The gnuplot 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 script tag to generate random plots. +

+A gnuplot tag can contain the following sub-tags: +

+
+
Plot Label +
Allows you to place text at a given (x,y) coordinate on the plot. +
Plot Title +
The title of the plot +
Plot Xlabel +
The label on the horizontal axis of the plot +
Plot Ylabel +
The label on the vertical axis of the plot +
Plot Axes +
allows specification of the x and y ranges displayed in the plot +
Plot Key +
Lists the functions displayed in the plot. +
Plot Curve +
Sets the data used in the plot. +
Plot Tics +
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. +
+ENDPLOTHELP + +my %gnuplot_defaults = ( height => { default => 200, @@ -307,6 +338,37 @@ my %axis_defaults = } ); +my $curve_help_text = <<"ENDCURVEHELP"; +The curve tag is where you set the data to be plotted by gnuplot. +There are two ways of entering the information: +
+
Curve Data +
Using a data tag you can specify the numbers used to produce +the plot. +

+By default, two data 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 data tag is +required. Unfortunately, you must make sure the data tags appear +in the order gnuplot expects the data. +

+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 data tags is important. The +first tag will be the X data and the second will be the Y data. +

+
Curve Function +
The function tag allows you to specify the curve to be +plotted as a formula that gnuplot can understand. Be careful using this +tag - 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 function tag. +
+ENDCURVEHELP + my %curve_defaults = ( color => { @@ -339,7 +401,7 @@ my %curve_defaults = ################################################################### my (%plot,%key,%axis,$title,$xlabel,$ylabel,@labels,@curves,%xtics,%ytics); -sub start_plot { +sub start_gnuplot { %plot = (); %key = (); %axis = (); $title = undef; $xlabel = undef; $ylabel = undef; $#labels = -1; $#curves = -1; @@ -351,19 +413,21 @@ sub start_plot { ('title','xlabel','ylabel','key','axis','label','curve', 'xtics','ytics')); push (@Apache::lonxml::namespace,'lonplot'); - if ($target eq 'web') { - my $inside = &Apache::lonxml::get_all_text("/plot",$$parser[-1]); + if ($target eq 'web' || $target eq 'tex') { + my $inside = &Apache::lonxml::get_all_text("/gnuplot",$$parser[-1]); $inside=&Apache::run::evaluate($inside,$safeeval,$$parstack[-1]); &Apache::lonxml::newparser($parser,\$inside); - &get_attributes(\%plot,\%plot_defaults,$parstack,$safeeval, + &get_attributes(\%plot,\%gnuplot_defaults,$parstack,$safeeval, $tagstack->[-1]); } elsif ($target eq 'edit') { - $result .= &Apache::edit::tag_start($target,$token,'Plot'); - $result .= &edit_attributes($target,$token,\%plot_defaults, - \@plot_edit_order); + $result .= &Apache::edit::tag_start($target,$token,'GnuPlot'); + $result .= &make_javascript(); + $result .= &help_win($gnuplot_help_text); + $result .= &edit_attributes($target,$token,\%gnuplot_defaults, + \@gnuplot_edit_order); } elsif ($target eq 'modified') { my $constructtag=&Apache::edit::get_new_args - ($token,$parstack,$safeeval,keys(%plot_defaults)); + ($token,$parstack,$safeeval,keys(%gnuplot_defaults)); if ($constructtag) { $result = &Apache::edit::rebuild_tag($token); } @@ -371,14 +435,13 @@ sub start_plot { return $result; } -sub end_plot { +sub end_gnuplot { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; - pop @Apache::lonxml::namespace; &Apache::lonxml::deregister('Apache::lonplot', ('title','xlabel','ylabel','key','axis','label','curve')); my $result = ''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { &check_inputs(); # Make sure we have all the data we need ## ## Determine filename @@ -386,15 +449,20 @@ sub end_plot { my $filename = $ENV{'user.name'}.'_'.$ENV{'user.domain'}. '_'.time.'_'.$$.int(rand(1000)).'_plot.data'; ## Write the plot description to the file - &write_gnuplot_file($tmpdir,$filename); + &write_gnuplot_file($tmpdir,$filename,$target); ## return image tag for the plot - $result .= <<"ENDIMAGE"; + if ($target eq 'web') { + $result .= <<"ENDIMAGE"; /cgi-bin/plot.gif?$filename + alt = "image should be /cgi-bin/plot.gif?$filename" /> ENDIMAGE + } elsif ($target eq 'tex') { + system "gnuplot $filename"; + $result = "$filename.eps"; + } } elsif ($target eq 'edit') { $result.=&Apache::edit::tag_end($target,$token); } @@ -406,7 +474,7 @@ ENDIMAGE sub start_xtics { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result=''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { &get_attributes(\%xtics,\%tic_defaults,$parstack,$safeeval, $tagstack->[-1]); } elsif ($target eq 'edit') { @@ -426,7 +494,7 @@ sub start_xtics { sub end_xtics { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result = ''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { } elsif ($target eq 'edit') { $result.=&Apache::edit::tag_end($target,$token); } @@ -437,7 +505,7 @@ sub end_xtics { sub start_ytics { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result=''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { &get_attributes(\%ytics,\%tic_defaults,$parstack,$safeeval, $tagstack->[-1]); } elsif ($target eq 'edit') { @@ -457,7 +525,7 @@ sub start_ytics { sub end_ytics { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result = ''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { } elsif ($target eq 'edit') { $result.=&Apache::edit::tag_end($target,$token); } @@ -469,7 +537,7 @@ sub end_ytics { sub start_key { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result=''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { &get_attributes(\%key,\%key_defaults,$parstack,$safeeval, $tagstack->[-1]); } elsif ($target eq 'edit') { @@ -488,7 +556,7 @@ sub start_key { sub end_key { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result = ''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { } elsif ($target eq 'edit') { $result.=&Apache::edit::tag_end($target,$token); } @@ -499,8 +567,9 @@ sub end_key { sub start_title { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result=''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { $title = &Apache::lonxml::get_all_text("/title",$$parser[-1]); + $title =~ s/\n/ /g; if (length($title) > $max_str_len) { $title = substr($title,0,$max_str_len); } @@ -521,7 +590,7 @@ sub start_title { sub end_title { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result = ''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { } elsif ($target eq 'edit') { $result.=&Apache::edit::tag_end($target,$token); } @@ -531,8 +600,9 @@ sub end_title { sub start_xlabel { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result=''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { $xlabel = &Apache::lonxml::get_all_text("/xlabel",$$parser[-1]); + $xlabel =~ s/\n/ /g; if (length($xlabel) > $max_str_len) { $xlabel = substr($xlabel,0,$max_str_len); } @@ -553,7 +623,7 @@ sub start_xlabel { sub end_xlabel { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result = ''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { } elsif ($target eq 'edit') { $result.=&Apache::edit::tag_end($target,$token); } @@ -564,8 +634,9 @@ sub end_xlabel { sub start_ylabel { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result=''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { $ylabel = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]); + $ylabel =~ s/\n/ /g; if (length($ylabel) > $max_str_len) { $ylabel = substr($ylabel,0,$max_str_len); } @@ -586,7 +657,7 @@ sub start_ylabel { sub end_ylabel { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result = ''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { } elsif ($target eq 'edit') { $result.=&Apache::edit::tag_end($target,$token); } @@ -597,11 +668,12 @@ sub end_ylabel { sub start_label { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result=''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { my %label; &get_attributes(\%label,\%label_defaults,$parstack,$safeeval, $tagstack->[-1]); my $text = &Apache::lonxml::get_all_text("/label",$$parser[-1]); + $text =~ s/\n/ /g; $text = substr($text,0,$max_str_len) if (length($text) > $max_str_len); $label{'text'} = $text; push(@labels,\%label); @@ -625,7 +697,7 @@ sub start_label { sub end_label { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result = ''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { } elsif ($target eq 'edit') { $result.=&Apache::edit::tag_end($target,$token); } @@ -638,13 +710,14 @@ sub start_curve { my $result=''; &Apache::lonxml::register('Apache::lonplot',('function','data')); push (@Apache::lonxml::namespace,'curve'); - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { my %curve; &get_attributes(\%curve,\%curve_defaults,$parstack,$safeeval, $tagstack->[-1]); push (@curves,\%curve); } elsif ($target eq 'edit') { $result .= &Apache::edit::tag_start($target,$token,'Curve'); + $result .= &help_win($curve_help_text); $result .= &edit_attributes($target,$token,\%curve_defaults); } elsif ($target eq 'modified') { my $constructtag=&Apache::edit::get_new_args @@ -662,7 +735,7 @@ sub end_curve { my $result = ''; pop @Apache::lonxml::namespace; &Apache::lonxml::deregister('Apache::lonplot',('function','data')); - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { } elsif ($target eq 'edit') { $result.=&Apache::edit::tag_end($target,$token); } @@ -673,7 +746,7 @@ sub end_curve { sub start_function { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result=''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { if (exists($curves[-1]->{'data'})) { &Apache::lonxml::warning('Use of precludes use of . The will be omitted in favor of the declaration.'); delete $curves[-1]->{'data'} ; @@ -697,7 +770,7 @@ sub start_function { sub end_function { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result = ''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { } elsif ($target eq 'edit') { $result .= &Apache::edit::end_table(); } @@ -708,7 +781,7 @@ sub end_function { sub start_data { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result=''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { if (exists($curves[-1]->{'function'})) { &Apache::lonxml::warning('Use of precludes use of .'. '. The will be omitted in favor of '. @@ -721,7 +794,7 @@ sub start_data { $datatext = &Apache::run::run('return "'.$datatext.'"', $safeeval,1); } - $datatext =~ s/\s+/ /g; + $datatext =~ s/\s+/ /g; # Need to do some error checking on the @data array - # make sure it's all numbers and make sure each array # is of the same length. @@ -772,7 +845,7 @@ sub start_data { sub end_data { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result = ''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { } elsif ($target eq 'edit') { $result .= &Apache::edit::end_table(); } @@ -783,7 +856,7 @@ sub end_data { sub start_axis { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result=''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { &get_attributes(\%axis,\%axis_defaults,$parstack,$safeeval, $tagstack->[-1]); } elsif ($target eq 'edit') { @@ -802,7 +875,7 @@ sub start_axis { sub end_axis { my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_; my $result = ''; - if ($target eq 'web') { + if ($target eq 'web' || $target eq 'tex') { } elsif ($target eq 'edit') { $result.=&Apache::edit::tag_end($target,$token); } elsif ($target eq 'modified') { @@ -848,7 +921,7 @@ sub get_attributes{ ##------------------------------------------------------- write_gnuplot_file sub write_gnuplot_file { - my ($tmpdir,$filename)= @_; + my ($tmpdir,$filename,$target)= @_; my $gnuplot_input = ''; my $curve; # Collect all the colors @@ -862,13 +935,18 @@ sub write_gnuplot_file { $plot{'fgcolor'} ); } # set term - $gnuplot_input .= 'set term gif '; - $gnuplot_input .= 'transparent ' if ($plot{'transparent'} eq 'on'); - $gnuplot_input .= $plot{'font'} . ' '; - $gnuplot_input .= 'size '.$plot{'width'}.','.$plot{'height'}.' '; - $gnuplot_input .= "@Colors\n"; - # set output - $gnuplot_input .= "set output\n"; + if ($target eq 'web') { + $gnuplot_input .= 'set term gif '; + $gnuplot_input .= 'transparent ' if ($plot{'transparent'} eq 'on'); + $gnuplot_input .= $plot{'font'} . ' '; + $gnuplot_input .= 'size '.$plot{'width'}.','.$plot{'height'}.' '; + $gnuplot_input .= "@Colors\n"; + # set output + $gnuplot_input .= "set output\n"; + } elsif ($target eq 'tex') { + $gnuplot_input .= "set term postscript eps monochrome\n"; + $gnuplot_input .= "set output \"$filename.eps\"\n"; + } # grid $gnuplot_input .= 'set grid'.$/ if ($plot{'grid'} eq 'on'); # border @@ -962,7 +1040,7 @@ sub write_gnuplot_file { sub check_inputs { ## Note: no inputs, no outputs - this acts only on global variables. ## Make sure we have all the input we need: - if (! %plot) { &set_defaults(\%plot,\%plot_defaults); } + if (! %plot) { &set_defaults(\%plot,\%gnuplot_defaults); } if (! %key ) {} # No key for this plot, thats okay # if (! %axis) { &set_defaults(\%axis,\%axis_defaults); } if (! defined($title )) {} # No title for this plot, thats okay @@ -1018,24 +1096,23 @@ sub edit_attributes { ## ## ################################################################### -#------------------------------------------------ insert_xxxxxxx -sub insert_plot { +sub insert_gnuplot { my $result = ''; # plot attributes - $result .= "{'default'}\"\n"; + $result .= "{'default'}\"\n"; } $result .= ">\n"; - # Add the components + # Add the components (most are commented out for simplicity) # $result .= &insert_key(); # $result .= &insert_axis(); # $result .= &insert_title(); # $result .= &insert_xlabel(); # $result .= &insert_ylabel(); $result .= &insert_curve(); - # close up the - $result .= "\n"; + # close up the + $result .= "\n"; return $result; } @@ -1124,6 +1201,40 @@ sub insert_data { } ##---------------------------------------------------------------------- +# Javascript functions to display help for tags + +sub make_javascript { + my $helpwindowwidth = 400; + my $helpwindowheight = 400; + my $result = ''; + $result.=<<"ENDFUNCTION"; + +ENDFUNCTION + return $result; +} + +sub help_win { + my ($helptext)=@_; + $helptext =~ s/\n/ /g; + $helptext =~ s/\'/\\\'/g; + my $result = ''; + $result.=<<"ENDWIN"; +
+help +
+ENDWIN + return $result; +} +##---------------------------------------------------------------------- 1; __END__