--- loncom/homework/outputtags.pm 2005/12/12 22:10:32 1.45 +++ loncom/homework/outputtags.pm 2016/08/09 23:43:42 1.58 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # tags that create controlled output # -# $Id: outputtags.pm,v 1.45 2005/12/12 22:10:32 albertel Exp $ +# $Id: outputtags.pm,v 1.58 2016/08/09 23:43:42 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -26,6 +26,8 @@ # http://www.lon-capa.org/ # + + package Apache::outputtags; use strict; @@ -36,14 +38,75 @@ use POSIX qw(strftime); BEGIN { &Apache::lonxml::register('Apache::outputtags',('displayduedate','displaytitle','displayweight','displaystudentphoto')); } -# Empties the hash of tags that have already been displayed -# that should only be displayed once. + +################################ utilities ########################### + +# +# Does a simple substitution of a tab when the opening tag can +# be replaced by a fixed string.. and same for the closing tag. +# Parameters: +# $input - String in in which to do the substitutions. +# $tag - name of tag without the <>'s e.g. sub for +# $opening - What to replace <$tag> with +# $closing - What to replace with. +# Returns: +# Input string appropriately substituted. +# +sub substitute_tag { + my ($input, + $tag, + $opening, + $closing) = @_; + + $input =~ s/<$tag>/$opening/gi; + $input =~ s/<\/$tag>/$closing/gi; + + return $input; +} + +# +# Substitutes the simple formatting tags in a string +# Parameters: +# $string - input string. +# Returns +# Result of string after simple substitutions +# Tags we handle are: +# , # +sub substitute_simple_tags_latex { + my ($string) = @_; + + # restore the <>'s: + + $string =~ s/\\ensuremath\{<}/}/>/g; + + + # Substitute the tags: + + $string = &substitute_tag($string, "sub", '\ensuremath{_', '}'); + $string = &substitute_tag($string, 'sup', '\ensuremath{^', '}'); + $string = &substitute_tag($string, 'em', '\em{', '}'); + + + # Escape the remaining <>'s again: + + $string =~ s//\\ensuremath{>}/g; + + + + return $string; +} + +################################ The parser ########################## + sub initialize_outputtags { %Apache::outputtags::showonce=(); } + sub start_displayduedate { my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_; my $result; @@ -69,11 +132,11 @@ sub start_displayduedate { my $style = &Apache::lonxml::get_param('style',$parstack,$safeeval); my $format = &Apache::lonxml::get_param('format', $parstack, $safeeval); if (!$format) { - $format = '%c'; + $format = undef; } if (($status =~ /CAN.*_ANSWER/)) { my $id = $Apache::inputtags::part; - my $date = &Apache::lonnet::EXT("resource.$id.duedate"); + my $date = &Apache::lonhomework::due_date($id); &Apache::lonxml::debug("duedatebox found $date for $id"); # Only show the due date if the current date is @@ -105,8 +168,10 @@ sub start_displayduedate { my $duetext = &Apache::lonnavmaps::timeToHumanString($date, '', $format); if (lc($style) !~ 'plain') { # The due date will be put in a box. - - $result = '\framebox{' + # at the start of the line to ensure it won't overlap + # the 1 col boundary. + + $result = '\vspace{1.0 ex} \framebox{' .&mt('Due').' '.$duetext.'}'; } else { $result = &mt('Due') . ' '.$duetext; @@ -150,6 +215,7 @@ sub start_displaytitle { $result.=&Apache::edit::end_table(); } elsif ($target eq 'tex' and $Apache::lonhomework::type ne 'exam') { $name=&Apache::lonxml::latex_special_symbols($name); + $name = &substitute_simple_tags_latex($name); if (lc($style) !~ 'plain') { $result='\vskip 0 mm\noindent\textbf{'.$name.'}\vskip 0 mm'; } else { @@ -169,7 +235,7 @@ sub end_displaytitle { sub multipart { my ($uri)=@_; if (!defined($uri)) { $uri=$env{'request.uri'}; } - my ($symb)=&Apache::lonxml::whichuser(); + my ($symb)=&Apache::lonnet::whichuser(); my @parts; my $metadata = &Apache::lonnet::metadata($uri,'packages'); @@ -236,7 +302,7 @@ sub end_displayweight { sub start_displaystudentphoto { my ($target,$token,$tagstack,$parstack,$parser,$safeeval)=@_; my $result; - my (undef,undef,$domain,$user) = &Apache::lonxml::whichuser(); + my (undef,undef,$domain,$user) = &Apache::lonnet::whichuser(); if ($target eq 'web' && $user eq $env{'user.name'}) { my $url=&Apache::lonnet::studentphoto($domain,$user,"gif"); my $args; @@ -277,3 +343,47 @@ sub end_displaystudentphoto { 1; __END__ + + +=head1 NAME + +Apache::outputtags; + +=head1 SYNOPSIS + +Handles tags associated with output. Seems to +relate to due dates of the assignment. + +This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + +=head1 SUBROUTINES + +=over + +=item start_displayduedate() + +=item initialize_outputtags() + +Empties the hash of tags that have already been displayed that should only be displayed once. + +=item end_displayduedate() + +=item start_displaytitle() + +=item end_displaytitle() + +=item multipart() + +=item start_displayweight() + +=item end_displayweight() + +=item start_displaystudentphoto() + +=item end_displaystudentphoto() + + +=back + +=cut