'; }
my %lastresponse = &Apache::lonnet::str2hash($lastresponse);
+
+
+ return \%lastresponse;
+
+}
+##
+# Removes the names from a foil group that are marked as unused.
+#
+# @param $names - reference to the array of names to filter.
+#
+# @return arrayref
+# @retval reference to the filtered array.
+#
+sub remove_unused {
+ my ($names) = @_;
+ my @result;
+
+ foreach my $name (@{$names}) {
+ if ($Apache::response::foilgroup{$name . '.value'} ne 'unused') {
+ push(@result, $name);
+ }
+ }
+ return \@result;
+}
+##
+# Displays all foils in a survey type problem for HTML rendition.
+# TODO: See if there is any logic in this sub that can be shared
+# with display_foils_html
+#
+# @param $names - ref to array of names of the foils to display.
+# @param $part - Problem part number.
+# @param $showanswer - If true, show the answers.
+# @param $lastresponse - Ref to the last response hash.
+# @param $direction - Display direction of the radiobuttons.
+#
+# @return string
+# @retval HTML required to display the resource in a browser.
+#
+sub display_survey_html {
+ my ($names, $part, $showanswer, $lastresponse, $direction) = @_;
+ my $result;
+
+ # Figure out a few fragments of html that depend onthe
+ # orientation of the radiobuttons:
+ # closing_html - HTML to emit at the end of the resource.
+ # pre_foil - HTML to emit prior to each foil.
+ # post_foil - HTML to emit following each foil.
+ #
+ # The opening HTML is just added to the $result now
+ #
+ # Figuring these outin advance compresses the loop over foils into something
+ # pretty simple:
+ #
+ # NOTE: There's probably a really cool way to do this with style sheets
+ # and picking the selector based on the orientation, if someone wants to puzzle
+ # that out. In that case, probably the whole thing lives in a
and each
+ # foil lives in a
+ #
+
+
+ my ($opening_html, $closing_html, $pre_foil, $post_foil) =
+ &html_direction_fragments($direction);
+
+ $result = $opening_html;
+
+ # Different rendering depending on whether answers are shown:
+ # I played with different factorings but this seems the most concise/clear...
+ # although I don't like the $showanswer conditino inside the loop. Other things I tried
+ # - two loops..much longer code..no gain in clarity.
+ # - Using a visitor patttern passing it the rendering code chunklets and
+ # an anonymous hash reference for state data etc. Very cool but
+ # quite a bit more code and quite a bit less clear.
+
+ my $temp = 0;
+ foreach my $name (@{$names}) {
+ $result .= $pre_foil;
+
+ if ($showanswer) {
+ my $foiltext = $Apache::response::foilgroup{$name . '.text'};
+
+ # Bold the prior response:
+
+ if (defined($lastresponse->{$name})) {
+ $result .= '' . $foiltext . '';
+ } else {
+ $result .= $foiltext;
+ }
+ } else {
+ $result .= &html_radiobutton(
+ $part, $Apache::inputtags::response['-1'], $name, $lastresponse, $temp
+ );
+ }
+
+ $result .= $post_foil;
+ $temp++;
+ }
+
+
+ $result .= $closing_html;
+ return $result;
+
+}
+
+##
+# Generate LaTeX for surveys.
+#
+# @param $names - names of the foils to display.
+# @param $showanswer - flag that is true to display answers.
+# @param $lastresponse - Reference to a hash the indicates the last response.
+# @param $direction - Orientation of foils ('horiztonal' or otherwise).
+# @param $venv - LaTeX name for vertical env.
+#
+# @return string
+# @retval LaTeX rendering of the survey question.
+
+sub latex_survey {
+ my ($names, $showanswer, $lastresponse, $direction, $venv) = @_;
+
+ my $result;
if ($showanswer) {
- foreach my $name (@names) {
- if ( $Apache::response::foilgroup{ $name . '.value' } ne 'unused' )
- {
- if ( ( $direction eq 'horizontal' ) && ( $target ne 'tex' ) ) {
- $result .= "
";
- }
- }
- else {
- $result .= '\vskip 0 mm ';
- }
- }
- }
+ return $result;
+}
+##
+# Figure out the LaTeX environment in which to wrap the LaTeX vertical output.
+#
+# @return string
+# @retval the environment name. The LaTeX should be wrapped a
+# \begin{retval} \end{retval} pair.
+#
+sub latex_vertical_environment {
+ if ($env{'form.pdfFormFields'} eq 'yes'
+ && $Apache::inputtags::status[-1] eq 'CAN_ANSWER') {
+ return 'itemize';
+ } else {
+ return 'enumerate';
}
+}
+
+##
+# Figure out the key html fragments that depend on the rendering direction:
+#
+# @param $direction - 'horizontal' for horizontal direction.
+#
+# @return list
+# @retval (part_start, part_end, foil_start, foil_end)
+# Where:
+# - part_start is the HTML to emit at the start of the part.
+# - part_end is the HTML to emit at the end of the part.
+# - foil_start is the HTML to emit prior to each foil.
+# - foil_end is the HTML to emit after each foil
+#
+sub html_direction_fragments {
+ my $direction = shift;
+ if ($direction eq 'horizontal') {
+ return ('
', '
', '
', '
');
+ } else {
+ return ('', ' ', ' ', '');
+ }
+}
+
+##
+#
+# Displays all the foils of a problem in a format suitable for
+# surveys, surveys for credit, anonymous surveys and anonymous surveys for credit.
+#
+# @param $direction - Display direction of the choices ('horiztonal' or not).
+# @param $target - Rendering target.
+#
+# @return string
+# @retval Text that renders for the selected target.
+#
+sub displayallfoils{
+ my ( $direction, $target ) = @_;
+ my $result;
+ &Apache::lonxml::debug("survey style display");
+
+ my @names;
+
+ if ( $Apache::response::foilgroup{'names'} ) {
+ @names = @{ $Apache::response::foilgroup{'names'} };
+ }
+
+
+ my $id = $Apache::inputtags::response['-1'];
+ my $part = $Apache::inputtags::part;
+
+ my $showanswer = &Apache::response::show_answer();
+ my $lastresponse = &get_last_survey_response($part, $showanswer, $id);
+ my $used_names = &remove_unused(\@names);
+
+
+ if ($target ne 'tex') {
+ $result .= &display_survey_html(
+ $used_names, $part, $showanswer, $lastresponse, $direction
+ );
+ } else {
+
+ my $vertical_env = &latex_vertical_environment();
+ $result .= &latex_survey(
+ $used_names, $showanswer, $lastresponse, $direction, $vertical_env
+ );
- if ( ( $direction eq 'horizontal' ) && ( $target ne 'tex' ) ) {
- $result .= '
';
}
return $result;
}
sub whichfoils {
- my ( $max, $randomize ) = @_;
+ my ($max,$randomize)=@_;
my @truelist;
my @falselist;
- my @whichfalse = ();
- my ( $truecnt, $falsecnt ) = &getfoilcounts();
- my $count = 0;
-
+ my @whichfalse =();
+ my ($truecnt,$falsecnt) = &getfoilcounts();
+ my $count=0;
# we will add in 1 of the true statements
- if ( $max > 0 && ( $falsecnt + 1 ) > $max ) { $count = $max }
- else { $count = $falsecnt + 1; $max = $count; }
- my $answer = int( &Math::Random::random_uniform() * ($count) );
+ if ( $max>0 && ($falsecnt+1)>$max) { $count=$max } else { $count=$falsecnt+1; $max=$count; }
+ my $answer=int(&Math::Random::random_uniform() * ($count));
&Apache::lonxml::debug("Count is $count, $answer is $answer");
my @names;
if ( $Apache::response::foilgroup{'names'} ) {
- @names = @{ $Apache::response::foilgroup{'names'} };
+ @names= @{ $Apache::response::foilgroup{'names'} };
}
- if ( &Apache::response::showallfoils() ) {
- @whichfalse = @names;
- }
- elsif ( $randomize eq 'no' ) {
- &Apache::lonxml::debug("No randomization");
- my $havetrue = 0;
- foreach my $name (@names) {
- if ( $Apache::response::foilgroup{ $name . '.value' } eq 'true' ) {
- if ( !$havetrue ) {
- push( @whichfalse, $name );
- $havetrue++;
- $answer = $#whichfalse;
- }
- }
- elsif (
- $Apache::response::foilgroup{ $name . '.value' } eq 'false' )
- {
- push( @whichfalse, $name );
- }
- elsif (
- $Apache::response::foilgroup{ $name . '.value' } eq 'unused' )
- {
- }
- else {
- &Apache::lonxml::error(
- &HTML::Entities::encode(
-"No valid value assigned ($Apache::response::foilgroup{$name.'.value'}) for foil $name in ",
- '<>&"'
- )
- );
- }
- }
- if ( ( !$havetrue )
- && ( $Apache::lonhomework::type ne 'survey' )
- && ( $Apache::lonhomework::type ne 'surveycred' )
- && ( $Apache::lonhomework::type ne 'anonsurvey' )
- && ( $Apache::lonhomework::type ne 'anonsurveycred' ) )
- {
- &Apache::lonxml::error(
- &mt('There are no true statements available.') . ' ' );
- }
- }
- else {
- my $current = 0;
- &Apache::lonhomework::showhash(%Apache::response::foilgroup);
- my ( %top, %bottom );
-
- #first find out where everyone wants to be
- foreach my $name (@names) {
- $current++;
- if ( $Apache::response::foilgroup{ $name . '.value' } eq 'true' ) {
- push( @truelist, $name );
- if ( $Apache::response::foilgroup{ $name . '.location' } eq
- 'top' )
- {
- $top{$name} = $current;
- }
- elsif ( $Apache::response::foilgroup{ $name . '.location' } eq
- 'bottom' )
- {
- $bottom{$name} = $current;
- }
- }
- elsif (
- $Apache::response::foilgroup{ $name . '.value' } eq 'false' )
- {
- push( @falselist, $name );
- if ( $Apache::response::foilgroup{ $name . '.location' } eq
- 'top' )
- {
- $top{$name} = $current;
- }
- elsif ( $Apache::response::foilgroup{ $name . '.location' } eq
- 'bottom' )
- {
- $bottom{$name} = $current;
- }
- }
- elsif (
- $Apache::response::foilgroup{ $name . '.value' } eq 'unused' )
- {
- }
- else {
- &Apache::lonxml::error(
- &HTML::Entities::encode(
-"No valid value assigned ($Apache::response::foilgroup{$name.'.value'}) for foil $name in ",
- '<>&"'
- )
- );
- }
- }
-
- #pick a true statement
- my $notrue = 0;
- if ( scalar(@truelist) == 0 ) { $notrue = 1; }
- my $whichtrue =
- int( &Math::Random::random_uniform() * ( $#truelist + 1 ) );
- &Apache::lonxml::debug(
- "Max is $max, From $#truelist elms, picking $whichtrue");
- my ( @toplist, @bottomlist );
- my $topcount = 0;
- my $bottomcount = 0;
-
- # assign everyone to either toplist/bottomlist or whichfalse
- # which false is randomized, toplist bottomlist are in order
- while (( ( $#whichfalse + $topcount + $bottomcount ) < $max - 2 )
- && ( $#falselist > -1 ) )
- {
- &Apache::lonxml::debug("Have $#whichfalse max is $max");
- my $afalse =
- int( &Math::Random::random_uniform() * ( $#falselist + 1 ) );
- &Apache::lonxml::debug("From $#falselist elms, picking $afalse");
- $afalse = splice( @falselist, $afalse, 1 );
- &Apache::lonxml::debug("Picked $afalse");
- &Apache::lonhomework::showhash( ( 'names' => \@names ) );
- &Apache::lonhomework::showhash(%top);
- if ( $top{$afalse} ) {
- $toplist[ $top{$afalse} ] = $afalse;
- $topcount++;
- }
- elsif ( $bottom{$afalse} ) {
- $bottomlist[ $bottom{$afalse} ] = $afalse;
- $bottomcount++;
- }
- else {
- push( @whichfalse, $afalse );
- }
- }
- &Apache::lonxml::debug("Answer wants $answer");
- my $truename = $truelist[$whichtrue];
- my $dosplice = 1;
- if ( ($notrue)
- && ( $Apache::lonhomework::type ne 'survey' )
- && ( $Apache::lonhomework::type ne 'surveycred' )
- && ( $Apache::lonhomework::type ne 'anonsurvey' )
- && ( $Apache::lonhomework::type ne 'anonsurveycred' ) )
- {
- $dosplice = 0;
- &Apache::lonxml::error(
- &mt('There are no true statements available.') . ' ' );
- }
-
- #insert the true statement, keeping track of where it wants to be
- if ( $Apache::response::foilgroup{ $truename . '.location' } eq 'top'
- && $dosplice )
- {
- $toplist[ $top{$truename} ] = $truename;
- $answer = -1;
- foreach my $top ( reverse(@toplist) ) {
- if ($top) { $answer++; }
- if ( $top eq $truename ) { last; }
- }
- $dosplice = 0;
- }
- elsif (
- $Apache::response::foilgroup{ $truename . '.location' } eq 'bottom'
- && $dosplice )
- {
- $bottomlist[ $bottom{$truename} ] = $truename;
- $answer = -1;
- foreach my $bot (@bottomlist) {
- if ($bot) { $answer++; }
- if ( $bot eq $truename ) { last; }
- }
- $answer += $topcount + $#whichfalse + 1;
- $dosplice = 0;
- }
- else {
- if ( $topcount > 0 || $bottomcount > 0 ) {
+ if (&Apache::response::showallfoils()) {
+ @whichfalse=@names;
+ } elsif ($randomize eq 'no') {
+ &Apache::lonxml::debug("No randomization");
+ my $havetrue=0;
+ foreach my $name (@names) {
+ if ($Apache::response::foilgroup{$name.'.value'} eq 'true') {
+ if (!$havetrue ) {
+ push(@whichfalse,$name); $havetrue++; $answer=$#whichfalse;
+ }
+ } elsif ($Apache::response::foilgroup{$name.'.value'} eq 'false') {
+ push (@whichfalse,$name);
+ } elsif ($Apache::response::foilgroup{$name.'.value'} eq 'unused') {
+ } else {
+ &Apache::lonxml::error(&HTML::Entities::encode("No valid value assigned ($Apache::response::foilgroup{$name.'.value'}) for foil $name in ",'<>&"'));
+ }
+ }
+ if ((!$havetrue) &&
+ ($Apache::lonhomework::type ne 'survey') &&
+ ($Apache::lonhomework::type ne 'surveycred') &&
+ ($Apache::lonhomework::type ne 'anonsurvey') &&
+ ($Apache::lonhomework::type ne 'anonsurveycred')) {
+ &Apache::lonxml::error(&mt('There are no true statements available.').' ');
+ }
+ } else {
+ my $current=0;
+ &Apache::lonhomework::showhash(%Apache::response::foilgroup);
+ my (%top,%bottom);
+ #first find out where everyone wants to be
+ foreach my $name (@names) {
+ $current++;
+ if ($Apache::response::foilgroup{$name.'.value'} eq 'true') {
+ push (@truelist,$name);
+ if ($Apache::response::foilgroup{$name.'.location'} eq 'top') {
+ $top{$name}=$current;
+ } elsif ($Apache::response::foilgroup{$name.'.location'} eq 'bottom') {
+ $bottom{$name}=$current;
+ }
+ } elsif ($Apache::response::foilgroup{$name.'.value'} eq 'false') {
+ push (@falselist,$name);
+ if ($Apache::response::foilgroup{$name.'.location'} eq 'top') {
+ $top{$name}=$current;
+ } elsif ($Apache::response::foilgroup{$name.'.location'} eq 'bottom') {
+ $bottom{$name}=$current;
+ }
+ } elsif ($Apache::response::foilgroup{$name.'.value'} eq 'unused') {
+ } else {
+ &Apache::lonxml::error(&HTML::Entities::encode("No valid value assigned ($Apache::response::foilgroup{$name.'.value'}) for foil $name in ",'<>&"'));
+ }
+ }
+ #pick a true statement
+ my $notrue=0;
+ if (scalar(@truelist) == 0) { $notrue=1; }
+ my $whichtrue = int(&Math::Random::random_uniform() * ($#truelist+1));
+ &Apache::lonxml::debug("Max is $max, From $#truelist elms, picking $whichtrue");
+ my (@toplist, @bottomlist);
+ my $topcount=0;
+ my $bottomcount=0;
+ # assign everyone to either toplist/bottomlist or whichfalse
+ # which false is randomized, toplist bottomlist are in order
+ while ((($#whichfalse+$topcount+$bottomcount) < $max-2) && ($#falselist > -1)) {
+ &Apache::lonxml::debug("Have $#whichfalse max is $max");
+ my $afalse=int(&Math::Random::random_uniform() * ($#falselist+1));
+ &Apache::lonxml::debug("From $#falselist elms, picking $afalse");
+ $afalse=splice(@falselist,$afalse,1);
+ &Apache::lonxml::debug("Picked $afalse");
+ &Apache::lonhomework::showhash(('names'=>\@names));
+ &Apache::lonhomework::showhash(%top);
+ if ($top{$afalse}) {
+ $toplist[$top{$afalse}]=$afalse;
+ $topcount++;
+ } elsif ($bottom{$afalse}) {
+ $bottomlist[$bottom{$afalse}]=$afalse;
+ $bottomcount++;
+ } else {
+ push (@whichfalse,$afalse);
+ }
+ }
+ &Apache::lonxml::debug("Answer wants $answer");
+ my $truename=$truelist[$whichtrue];
+ my $dosplice=1;
+ if (($notrue) &&
+ ($Apache::lonhomework::type ne 'survey') &&
+ ($Apache::lonhomework::type ne 'surveycred') &&
+ ($Apache::lonhomework::type ne 'anonsurvey') &&
+ ($Apache::lonhomework::type ne 'anonsurveycred')) {
+ $dosplice=0;
+ &Apache::lonxml::error(&mt('There are no true statements available.').' ');
+ }
+ #insert the true statement, keeping track of where it wants to be
+ if ($Apache::response::foilgroup{$truename.'.location'} eq 'top' && $dosplice) {
+ $toplist[$top{$truename}]=$truename;
+ $answer=-1;
+ foreach my $top (reverse(@toplist)) {
+ if ($top) { $answer++;}
+ if ($top eq $truename) { last; }
+ }
+ $dosplice=0;
+ } elsif ($Apache::response::foilgroup{$truename.'.location'} eq 'bottom' && $dosplice) {
+ $bottomlist[$bottom{$truename}]=$truename;
+ $answer=-1;
+ foreach my $bot (@bottomlist) {
+ if ($bot) { $answer++;}
+ if ($bot eq $truename) { last; }
+ }
+ $answer+=$topcount+$#whichfalse+1;
+ $dosplice=0;
+ } else {
+ if ($topcount>0 || $bottomcount>0) {
my $inc = 1;
- if ( ( $bottomcount > 0 )
- && ( $Apache::lonhomework::type ne 'exam' ) )
- {
+ if (($bottomcount > 0) && ($Apache::lonhomework::type ne 'exam')) {
$inc = 2;
}
- $answer = int(
- &Math::Random::random_uniform() * ( $#whichfalse + $inc ) )
- + $topcount;
- }
- }
- &Apache::lonxml::debug("Answer now wants $answer");
+ $answer=int(&Math::Random::random_uniform() * ($#whichfalse+$inc))
+ + $topcount;
+ }
+ }
+ &Apache::lonxml::debug("Answer now wants $answer");
+ #add the top items to the top, bottom items to the bottom
+ for (my $i=0;$i<=$#toplist;$i++) {
+ if ($toplist[$i]) { unshift(@whichfalse,$toplist[$i]) }
+ }
+ for (my $i=0;$i<=$#bottomlist;$i++) {
+ if ($bottomlist[$i]) { push(@whichfalse,$bottomlist[$i]) }
+ }
+ #if the true statement is randomized insert it into the list
+ if ($dosplice) { splice(@whichfalse,$answer,0,$truelist[$whichtrue]); }
+ }
+ &Apache::lonxml::debug("Answer is $answer");
+ return ($answer,@whichfalse);
+}
- #add the top items to the top, bottom items to the bottom
- for ( my $i = 0 ; $i <= $#toplist ; $i++ ) {
- if ( $toplist[$i] ) { unshift( @whichfalse, $toplist[$i] ) }
- }
- for ( my $i = 0 ; $i <= $#bottomlist ; $i++ ) {
- if ( $bottomlist[$i] ) { push( @whichfalse, $bottomlist[$i] ) }
- }
+##
+# Return a list of foil texts given foil names.
+#
+# @param $whichfoils - Reference to a list of foil names.
+#
+# @return array
+# @retval foil texts
+#
+sub get_foil_texts {
+ my ($whichfoils) = @_;
+ my @foil_texts;
- #if the true statement is randomized insert it into the list
- if ($dosplice) {
- splice( @whichfalse, $answer, 0, $truelist[$whichtrue] );
- }
+ foreach my $name (@{$whichfoils}) {
+ push(@foil_texts, $Apache::response::foilgroup{$name . '.text'});
}
- &Apache::lonxml::debug("Answer is $answer");
- return ( $answer, @whichfalse );
+ return @foil_texts;
}
+
##
# Generate the HTML for a single html foil.
# @param $part - The part for which the response is being generated.
@@ -848,33 +889,26 @@ sub get_last_response {
# @param $target - Rendition target...there are several html targets.
# @param $direction - 'horizontal' if layout is horizontal.
# @param $part - Part of the problem that's being displayed.
-# @param $solved - Solution state of the problem.
# @param $show_answer- True if answers should be shown.
#
# @return string
# @retval generated html.
#
sub display_foils_html {
- my ($whichfoils, $target, $direction, $part, $solved, $show_answer) = @_;
+ my ($whichfoils, $target, $direction, $part, $show_answer) = @_;
my $result;
+
# if the answers get shown, we need to label each item as correct or
# incorrect.
- if ($show_answer) {
- my $item_pretext = ' '; # html prior to each item
- my $item_posttext = ''; # html after each item.
- my $finalclose = ''; # html to close off the whole shebang
+ my ($opening_html, $finalclose, $item_pretext, $item_posttext) =
+ &html_direction_fragments($direction);
+ $result .= $opening_html;
- # Horizontal layout is a table with each foil in a cell
- if ($direction eq 'horizontal') {
- $result = '
';
- $item_pretext = '
' . $item_pretext;
- $item_posttext = '
';
- $finalclose = '
';
- }
+ if ($show_answer) {
foreach my $name (@{$whichfoils}) {
@@ -908,25 +942,10 @@ sub display_foils_html {
$result .= "\n"; # make the html a bit more readable.
}
- $result .= $finalclose;
} else {
- $result .= ' '; # end line prior to foilgroup:
-
- # Not showing the answers, we need to generate the HTML appropriate
- # to allowing the student to respond.
-
- my $item_pretext;
- my $item_posttext;
my $lastresponse = &get_last_response($part);
-
- if ( $direction eq 'horizontal' ) {
- $item_pretext = '