--- loncom/homework/randomlabel.pm 2007/05/10 10:27:22 1.86
+++ loncom/homework/randomlabel.pm 2008/12/19 14:28:14 1.94
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# random labelling tool
#
-# $Id: randomlabel.pm,v 1.86 2007/05/10 10:27:22 foxr Exp $
+# $Id: randomlabel.pm,v 1.94 2008/12/19 14:28:14 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -24,35 +24,84 @@
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
-#
-# SYNTAX:
-# <randomlabel bgimg="URL" width="12" height="45" texwidth="50">
-# <labelgroup name="GroupOne" type="image">
-# <location x="123" y="456" />
-# <location x="321" y="654" />
-# <location x="213" y="546" />
-# <label description="TEXT-1">IMG-URL</label>
-# <label description="TEXT-2">IMG-URL</label>
-# <label description="TEXT-3">IMG-URL</label>
-# </labelgroup>
-# <labelgroup name="GroupTwo" type="text">
-# <location x="12" y="45" />
-# <location x="32" y="65" />
-# <location x="21" y="54" />
-# <label>TEXT-1</label>
-# <label>TEXT-2</label>
-# <label>TEXT-3</label>
-# </labelgroup>
-# </randomlabel>
-# ===========================================
-# side effect:
-# location (123,456): $GroupOne[0] = 2 # images give out indexes
-# (321,654): $GroupOne[1] = 1
-# (213,546): $GroupOne[2] = 0
-# location (12,45) : $GroupTwo[0] = "TEXT-3"
-# (32,65) : $GroupTwo[1] = "TEXT-1"
-# (21,54) : $GroupTwo[2] = "TEXT-2"
-# ===========================================
+
+=pod
+
+=head1 NAME
+
+Apache::randomlable.pm
+
+=head1 SYNOPSIS
+
+Interface for producing applet code which
+randomizes the labelling of an image.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+
+=head1 SYNTAX
+
+ <randomlabel bgimg="URL" width="12" height="45" texwidth="50">
+ <labelgroup name="GroupOne" type="image">
+ <location x="123" y="456" />
+ <location x="321" y="654" />
+ <location x="213" y="546" />
+ <label description="TEXT-1">IMG-URL</label>
+ <label description="TEXT-2">IMG-URL</label>
+ <label description="TEXT-3">IMG-URL</label>
+ </labelgroup>
+ <labelgroup name="GroupTwo" type="text">
+ <location x="12" y="45" />
+ <location x="32" y="65" />
+ <location x="21" y="54" />
+ <label>TEXT-1</label>
+ <label>TEXT-2</label>
+ <label>TEXT-3</label>
+ </labelgroup>
+ </randomlabel>
+ ===========================================
+ side effect:
+ location (123,456): $GroupOne[0] = 2 images give out indexes
+ (321,654): $GroupOne[1] = 1
+ (213,546): $GroupOne[2] = 0
+ location (12,45) : $GroupTwo[0] = "TEXT-3"
+ (32,65) : $GroupTwo[1] = "TEXT-1"
+ (21,54) : $GroupTwo[2] = "TEXT-2"
+ ===========================================
+
+
+=head1 NOTABLE SUBROUTINES
+
+=over
+
+=item check_int()
+
+ utility function to do error checking on a integer.
+
+=item extract_tag_sizes()
+
+Parameters:
+ tag - tag potentially containing height/width attributes.
+ def_width - Default width.
+ def_height - Default height.
+ Returns:
+ list containing width/height.
+
+=item get_label_width()
+
+ Utility sub to compute the width of a label.
+
+=item end_labelgroup()
+
+begin to assign labels to locations
+
+=back
+
+=cut
+
+
+
package Apache::randomlabel;
use Apache::lonnet;
use strict;
@@ -61,7 +110,6 @@ use Apache::File();
use Apache::Constants qw(:common :http);
use Image::Magick;
use Apache::lonplot;
-use lib '/home/httpd/lib/perl/';
use LONCAPA;
@@ -70,7 +118,7 @@ my $cgi_id;
my $scale_factor; # image scale factor.
my $label_xscale; # Label scale factor (needed for gnuplot).
my $label_yscale;
-
+my $dirty_width_adjust = 5; # Width adjustment for e.g. gnuplot images.
BEGIN {
&Apache::lonxml::register('Apache::randomlabel',('randomlabel','labelgroup','location','label','bgimg'));
@@ -90,15 +138,8 @@ sub check_int {
return $num;
}
-# Get width/height from an image tag...
-#
-# Parameters:
-# tag - tag potentially containing height/width attributes.
-# def_width - Default width.
-# def_height - Default height.
-# Returns:
-# list containing width/height.
-#
+
+
sub extract_tag_sizes {
my ($tag, $dw, $dh) = @_;
$tag =~ s/\s+/ /g; # Collapse whitespace.
@@ -131,7 +172,7 @@ sub start_randomlabel {
$label_xscale = 1.0; # Assume image size not overridden.
$label_yscale = 1.0;
my $bgimg= &Apache::lonxml::get_param('bgimg',$parstack,$safeeval);
- if ( defined($bgimg) && $bgimg !~ /^http:/ ) {
+ if ( defined($bgimg) && $bgimg !~ /^https?\:/ ) {
$bgimg=&Apache::lonnet::filelocation($Apache::lonxml::pwd[-1],$bgimg);
if (&Apache::lonnet::repcopy($bgimg) ne 'ok') {
$bgimg='/home/httpd/html/adm/lonKaputt/lonlogo_broken.gif';
@@ -147,12 +188,13 @@ sub start_randomlabel {
} elsif ($target eq 'tex' && defined($bgimg)) {
$result.=&make_eps_image($bgimg,$parstack,$safeeval);
} elsif ($target eq 'edit') {
+ my $only = join(',',&Apache::loncommon::filecategorytypes('Pictures'));
$result.=&Apache::edit::tag_start($target,$token);
$Apache::edit::bgimgsrc=
&Apache::lonxml::get_param('bgimg',$parstack,$safeeval);
$Apache::edit::bgimgsrccurdepth=$Apache::lonxml::curdepth;
$result.=&Apache::edit::text_arg('Image:','bgimg',$token,75).' ';
- $result.=&Apache::edit::browse('bgimg').' ';
+ $result.=&Apache::edit::browse('bgimg',undef,undef,$only).' ';
$result.=&Apache::edit::search('bgimg').'<br />'.
&Apache::edit::text_arg('Width(pixel):' ,'width' ,$token,6).
&Apache::edit::text_arg('Height(pixel):','height' ,$token,6).
@@ -164,7 +206,6 @@ sub start_randomlabel {
'height','texwidth');
if ($constructtag) {
$result = &Apache::edit::rebuild_tag($token);
- $result.=&Apache::edit::handle_insert();
}
}
return $result;
@@ -179,7 +220,7 @@ sub end_randomlabel {
$count = $Apache::randomlabel::obj_cnt;
if( $count != 0) { $args{"cgi.$cgi_id.OBJCOUNT"}=$count; }
$result.='<img src="/adm/randomlabel.png?token='.$cgi_id.'" /><br />'."\n";
- &Apache::lonnet::appenv(%args);
+ &Apache::lonnet::appenv(\%args);
} elsif ($target eq 'tex') {
$result='\end{picture}\\\\';
$result.= ' \vskip -'.$height_param.' mm } \\\\ ';
@@ -268,7 +309,8 @@ sub end_bgimg {
&Apache::lonxml::debug("height $height_param");
&Apache::lonxml::debug("Width $width_param");
&Apache::lonxml::debug("Scale factors: $label_xscale $label_yscale");
- my $dirty_width = $width_param + 5;
+ my $dirty_width = $width_param + $dirty_width_adjust;
+ my $x_offset = -$dirty_width_adjust/2.0;
#
# Somewhere here it looks like height_param and
# width_param got backwards...
@@ -276,8 +318,8 @@ sub end_bgimg {
$result .= '\parbox{'.$dirty_width.'mm}{';
$result .= " $src \n";
$result .= '\setlength{\unitlength}{1mm}'."\n";
- $result .= '\begin{picture}('."$height_param,$width_param)";
- $result .= "(0,-$width_param)";
+ $result .= '\begin{picture}('."$width_param,$height_param)";
+ $result .= "($x_offset,-$height_param)";
$result .= "\n";
$Apache::lonxml::debug = 0;
@@ -353,15 +395,13 @@ sub start_labelgroup {
'TeXsize');
if ($constructtag) {
$result = &Apache::edit::rebuild_tag($token);
- $result.=&Apache::edit::handle_insert();
}
}
return $result;
}
-#
-# Utility sub to compute the width of a label.
-#
+
+
sub get_label_width {
my $label = shift;
&Apache::lonxml::debug("image label = $label");
@@ -411,7 +451,8 @@ sub add_vars {
$out=Apache::run::run($code,$safeeval);
}
-# begin to assign labels to locations
+
+
sub end_labelgroup {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $gname = $Apache::randomlabel::groupname;
@@ -539,7 +580,6 @@ sub start_location {
$safeeval,'x','y','value');
if ($constructtag) {
$result = &Apache::edit::rebuild_tag($token);
- $result.=&Apache::edit::handle_insert();
}
}
$Apache::lonxml::debug = 0;
@@ -554,6 +594,14 @@ sub end_location {
}
# <label>$var_abc</label>
+sub insert_label {
+ my ($after) = @_;
+ my $depth = scalar(@Apache::lonxml::depthcounter);
+ $depth-- if ($after);
+ my $inset = "\t"x$depth;
+ return "\n$inset<label></label>";
+}
+
sub start_label {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';