--- loncom/homework/edit.pm 2006/07/27 20:47:02 1.103 +++ loncom/homework/edit.pm 2010/11/07 01:57:50 1.132 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # edit mode helpers # -# $Id: edit.pm,v 1.103 2006/07/27 20:47:02 albertel Exp $ +# $Id: edit.pm,v 1.132 2010/11/07 01:57:50 www Exp $ # # Copyright Michigan State University Board of Trustees # @@ -26,6 +26,110 @@ # http://www.lon-capa.org/ # +=pod + +=head1 NAME + +Apache::edit - edit mode helpers + +=head1 SYNOPSIS + +Invoked by many homework and xml related modules. + + &Apache::edit::SUBROUTINENAME(ARGUMENTS); + +=head1 INTRODUCTION + +This module outputs HTML syntax helpful for the rendering of edit +mode interfaces. + +This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + +=head1 SUBROUTINES + +=over 4 + +=item initialize_edit() + +initialize edit (set colordepth to zero) + +=item tag_start($target,$token,$description) + +provide deletion and insertion lists +for the manipulation of a start tag; return a scalar string + +=item tag_end($target,$token,$description) + +ending syntax corresponding to +&tag_start. return a scalar string. + +=item start_table($token) + +start table; update colordepth; return scalar string. + +=item end_table() + +reduce color depth; end table; return scalar string + +=item start_spanning_row() + +start a new table row spanning the 'edit' environment. + +=item start_row() + +start a new table row and element. + +=item end_row() + +end current table element and row. + +=item movebuttons($target,$token) + +move-up and move-down buttons; return scalar string + +=item deletelist($target,$token) + +provide a yes option in an HTML select element; return scalar string + +=item handle_delete($space,$target,$token,$tagstack,$parstack,$parser,$safeeval, +$style) + +respond to a user delete request by passing relevant stack +and array information to various rendering functions; return a scalar string + +=item get_insert_list($token) + +provide an insertion list based on possibilities from lonxml; return a scalar string + +=item insertlist($target,$token) + +api that uses get_insert_list; return a scalar string + +=item handleinsert($token) + +provide an insertion list based on possibilities from lonxml; return a scalar string + +=item get_insert_list($token) + +provide an insertion list based on possibilities from lonxml; return a scalar string + +=item browse($elementname) + +provide a link which will open up the filesystem browser (lonindexer) and, once a file is selected, place the result in the form element $elementname. + +=item search($elementname) + +provide a link which will open up the filesystem searcher (lonsearchcat) and, once a file is selected, place the result in the form element $elementname. + +=item editline(tag,data,description,size) + +Provide a for single-line text entry. This is to be used for text enclosed by tags, not arguements/parameters associated with a tag. + +=back + +=cut + package Apache::edit; use strict; @@ -61,7 +165,7 @@ sub tag_start { if (!$description) { $description="<$tag>"; } } $result.= &start_table($token)."$description - Delete". + ".&mt('Delete?').' '. &deletelist($target,$token) ." ". @@ -90,24 +194,17 @@ sub tag_end { sub start_table { my ($token)=@_; - my $tag = $token->[1]; - my $tagnum; - foreach my $namespace (reverse @Apache::lonxml::namespace) { - my $testtag=$namespace.'::'.$tag; - $tagnum=$Apache::lonxml::insertlist{"$testtag.num"}; - &Apache::lonxml::debug(" $testtag "); - if (defined($tagnum)) { last; } - } - if (!defined ($tagnum)) {$tagnum=$Apache::lonxml::insertlist{"$tag.num"};} - my $color = $Apache::lonxml::insertlist{"$tagnum.color"}; - &Apache::lonxml::debug(" $tagnum -- $color"); + my $tag = &Apache::lonxml::get_tag($token); + + my $color = $Apache::lonxml::insertlist{"$tag.color"}; + &Apache::lonxml::debug(" $tag -- $color"); if (!defined($color)) { $color = $Apache::edit::colorlist[$Apache::edit::colordepth]; } $Apache::edit::colordepth++; push(@Apache::edit::inserttag,$token->[1]); my $result='
'; - $result.=''; + $result.='
'; return $result; } @@ -119,17 +216,23 @@ sub end_table { my ($tagname,$closingtag); if (defined($Apache::edit::inserttag[-2])) { $tagname=$Apache::edit::inserttag[-2]; - } else {$tagname='problem';} + } else { + if ($Apache::lonhomework::parsing_a_task) { + $tagname='Task'; + } else { + $tagname='problem'; + } + } if (defined($Apache::edit::inserttag[-1])) { $closingtag=$Apache::edit::inserttag[-1]; } $result.=&innerinsertlist('edit',$tagname,$closingtag). "
"; - pop(@Apache::edit::inserttag); + my $last = pop(@Apache::edit::inserttag); return $result; } -sub start_spanning_row { return '';} +sub start_spanning_row { return '';} sub start_row { return ''; } sub end_row { return ''; } @@ -146,7 +249,7 @@ sub deletelist { my ($target,$token) = @_; my $result = ""; return $result; } @@ -177,20 +280,21 @@ sub handle_delete { sub get_insert_list { my ($tagname) = @_; my $result=''; - my @tagnums= (); + my @tags= (); #&Apache::lonxml::debug("keys ".join("\n",sort(keys(%Apache::lonxml::insertlist)))); if ($Apache::lonxml::insertlist{"$tagname.which"}) { - push (@tagnums, @{ $Apache::lonxml::insertlist{"$tagname.which"} }); + push (@tags, @{ $Apache::lonxml::insertlist{"$tagname.which"} }); } foreach my $namespace (@Apache::lonxml::namespace) { if ($Apache::lonxml::insertlist{"$namespace".'::'."$tagname.which"}) { - push (@tagnums, @{ $Apache::lonxml::insertlist{"$namespace".'::'."$tagname.which"} }); + push (@tags, @{ $Apache::lonxml::insertlist{"$namespace".'::'."$tagname.which"} }); } } - if (@tagnums) { + if (@tags) { my %options; - foreach my $tagnum (@tagnums) { - my $descrip=$Apache::lonxml::insertlist{"$tagnum.description"}; + foreach my $tag (@tags) { + my $descrip=$Apache::lonxml::insertlist{"$tag.description"}; + my $tagnum =$Apache::lonxml::insertlist{"$tag.num"}; $options{$descrip} ="\n"; } @@ -215,7 +319,7 @@ sub innerinsertlist { if ($target eq 'edit') { my $optionlist= &get_insert_list($tagname); if ($optionlist) { - $result = "Insert: + $result = &mt('Insert:')." " @@ -228,40 +332,32 @@ sub innerinsertlist { sub handle_insert { if ($env{"form.insert_$Apache::lonxml::curdepth"} eq '') { return ''; } - my $result; my $tagnum = $env{"form.insert_$Apache::lonxml::curdepth"}; - my $func=$Apache::lonxml::insertlist{"$tagnum.function"}; - if ($func eq 'default') { - my $newtag=$Apache::lonxml::insertlist{"$tagnum.tag"}; - my $namespace; - if ($newtag =~ /::/) { ($namespace,$newtag) = split(/::/,$newtag); } - $result.="\n<$newtag>\n"; - } else { - if (defined(&$func)) { - { - no strict 'refs'; - $result.=&$func(); - } - } else { - my $newtag=$Apache::lonxml::insertlist{"$tagnum.tag"}; - &Apache::lonxml::error("Unable to insert tag ".$Apache::lonxml::curdepth." ($tagnum) $newtag, func was not defined."); - } - } - return $result; + return &do_insert($tagnum); } sub handle_insertafter { my $tagname=shift; - if ($env{"form.insert_after_$tagname\_$Apache::lonxml::curdepth"} eq '') - { return ''; } - my $result; + if ($env{"form.insert_after_$tagname\_$Apache::lonxml::curdepth"} eq '') { + return ''; + } my $tagnum =$env{"form.insert_after_$tagname\_$Apache::lonxml::curdepth"}; - my $func=$Apache::lonxml::insertlist{"$tagnum.function"}; + return &do_insert($tagnum,1); +} + +sub do_insert { + my ($tagnum,$after) = @_; + my $result; + + my $newtag = $Apache::lonxml::insertlist{"$tagnum.tag"}; + my $func = $Apache::lonxml::insertlist{"$newtag.function"}; if ($func eq 'default') { - my $newtag=$Apache::lonxml::insertlist{"$tagnum.tag"}; my $namespace; if ($newtag =~ /::/) { ($namespace,$newtag) = split(/::/,$newtag); } - $result.="\n<$newtag>\n"; + my $depth = scalar(@Apache::lonxml::depthcounter); + $depth -- if ($after); + my $inset = "\t"x$depth; + $result.="\n$inset<$newtag>"; } else { if (defined(&$func)) { { @@ -269,8 +365,7 @@ sub handle_insertafter { $result.=&$func(); } } else { - my $newtag=$Apache::lonxml::insertlist{"$tagnum.tag"}; - &Apache::lonxml::error("Unable to insert (after) tag $newtag, $func was not defined. ($tagname $tagnum)"); + &Apache::lonxml::error("Unable to insert tag $newtag, $func was not defined. ($tagnum)"); } } return $result; @@ -302,6 +397,31 @@ sub insert_formularesponse { '; } +sub insert_functionplotresponse { + return ' + + + +'; +} + +sub insert_spline { + return ' +'; +} + +sub insert_backgroundplot { + return ' +'; +} + +sub insert_functionplotrule { + return ' +'; +} + + + sub insert_numericalresponse { return ' @@ -333,6 +453,56 @@ sub insert_customresponse_answer { '; } +sub insert_customhint { + return ' + + + + '; +} + +sub insert_customhint_answer { + return ' + + +'; +} + +sub insert_mathresponse { + return ' + + + + + + + + +'; +} + +sub insert_mathresponse_answer { + return ' + + +'; +} + +sub insert_mathhint { + return ' + + + + '; +} + +sub insert_mathhint_answer { + return ' + + +'; +} + sub insert_stringresponse { return ' @@ -447,6 +617,9 @@ sub insert_matchresponse { '; } +sub insert_startpartmarker { return ''; } +sub insert_endpartmarker { return ''; } + sub insert_displayduedate { return ''; } sub insert_displaytitle { return ''; } sub insert_hintpart { @@ -469,6 +642,18 @@ sub insert_numericalhint { '; } +sub insert_reactionhint { + return ' + +'; +} + +sub insert_organichint { + return ' + +'; +} + sub insert_stringhint { return ' @@ -536,7 +721,8 @@ sub element_change_detection { } sub submit_ask_anyway { - return ' onclick="still_ask=true;" '; + my ($extra_action) = @_; + return ' onclick="still_ask=true;'.$extra_action.'" '; } sub textarea_sizes { @@ -556,7 +742,7 @@ sub textarea_sizes { sub editline { my ($tag,$data,$description,$size)=@_; $data=&HTML::Entities::encode($data,'<>&"'); - if ($description) { $description="
".$description."
"; } + if ($description) { $description=$description."
"; } my $change_code = &element_change_detection(); my $result = <<"END"; $description @@ -570,23 +756,27 @@ sub editfield { my ($tag,$data,$description,$minwidth,$minheight,$usehtmlarea)=@_; my ($rows,$cols)=&textarea_sizes(\$data); - if (&Apache::lonhtmlcommon::htmlareabrowser() && - !&Apache::lonhtmlcommon::htmlareablocked()) { + my $textareaclass; + + if (&Apache::lonhtmlcommon::htmlareabrowser() && $usehtmlarea) { $rows+=7; # make room for HTMLarea $minheight+=7; # make room for HTMLarea + $textareaclass = ' class="LC_richDefaultOff"'; } if ($cols > 80) { $cols = 80; } if ($cols < $minwidth ) { $cols = $minwidth; } if ($rows < $minheight) { $rows = $minheight; } - if ($description) { $description="
".$description."
"; } - if ($usehtmlarea) { - &Apache::lonhtmlcommon::add_htmlareafields('homework_edit_'. - $Apache::lonxml::curdepth); - } + if ($description) { $description=$description."
"; } + + # remove typesetting whitespace from between data and the end tag + # to make the edit look prettier + $data =~ s/\n?[ \t]*$//; + return $description."\n".''. ($usehtmlarea?&Apache::lonhtmlcommon::spelllink('lonhomework', 'homework_edit_'.$Apache::lonxml::curdepth):'')."\n"; @@ -595,15 +785,17 @@ sub editfield { sub modifiedfield { my ($endtag,$parser) = @_; my $result; -# foreach my $envkey (sort keys %env) { -# &Apache::lonxml::debug("$envkey ---- $env{$envkey}"); -# } -# &Apache::lonxml::debug("I want homework_edit_$Apache::lonxml::curdepth"); -# &Apache::lonxml::debug($env{"form.homework_edit_$Apache::lonxml::curdepth"}); $result=$env{"form.homework_edit_$Apache::lonxml::curdepth"}; my $bodytext=&Apache::lonxml::get_all_text($endtag,$parser); # textareas throw away intial \n - if ($bodytext=~/^\n/) { $result="\n".$result; } + if ($bodytext=~/^\n/) { + $result="\n".$result; + } + # if there is typesetting whitespace from between the data and the end tag + # restore to keep the source looking pretty + if ($bodytext =~ /(\n?[ \t]*)$/) { + $result .= $1; + } return $result; } @@ -625,6 +817,10 @@ sub get_new_args { $token->[2]->{$arg}=$newvalue; } $rebuild=1; + # add new attributes to the of the attribute seq + if (!grep { $arg eq $_ } (@{ $token->[3] })) { + push(@{ $token->[3] },$arg); + } } elsif (!defined($newvalue) && defined($value)) { delete($token->[2]->{$arg}); $rebuild=1; @@ -639,11 +835,13 @@ sub rebuild_tag { my $result; if ($token->[0] eq 'S') { $result = '<'.$token->[1]; - while (my ($key,$val)= each(%{$token->[2]})) { - $val=~s:^\s+|\s+$::g; - $val=~s:"::g; #" - &Apache::lonxml::debug("setting :$key: to :$val:"); - $result.=' '.$key.'="'.$val.'"'; + foreach my $attribute (@{ $token->[3] }) { + my $value = $token->[2]{$attribute}; + next if ($value eq ''); + $value =~s/^\s+|\s+$//g; + $value =~s/\"//g; + &Apache::lonxml::debug("setting :$attribute: to :$value:"); + $result.=' '.$attribute.'="'.$value.'"'; } if ($token->[4] =~ m:/>$:) { $result.=' />'; @@ -686,15 +884,15 @@ sub checked_arg { $text=$option; $value='value="'.$option.'"'; } - $result.="\n"; + $result.=&element_change_detection().' />'.$text.''."\n"; } return $result; } @@ -707,7 +905,7 @@ sub text_arg { $result=&mt($description).' '; - return ''.$result.''; + return ''.$result.''; } sub select_arg { @@ -715,26 +913,28 @@ sub select_arg { my $result; my $optionlist=""; my $selected=$token->[2]{$name}; - foreach my $option (@$list) { - my ($text,$value); - if ( ref($option) eq 'ARRAY') { - $value='value="'.&HTML::Entities::encode($$option[0]).'"'; - $text=$$option[1]; - $option=$$option[0]; - } else { - $text=$option; - $value='value="'.&HTML::Entities::encode($option,'\'"&<>').'"'; - } - if ( $selected eq $option ) { - $optionlist.="\n"; - } else { - $optionlist.="\n"; - } + if (ref($list) eq 'ARRAY') { + foreach my $option (@{$list}) { + my ($text,$value); + if (ref($option) eq 'ARRAY') { + $value='value="'.&HTML::Entities::encode($option->[0]).'"'; + $text=$option->[1]; + $option=$option->[0]; + } else { + $text=$option; + $value='value="'.&HTML::Entities::encode($option,'\'"&<>').'"'; + } + if ( $selected eq $option ) { + $optionlist.="\n"; + } else { + $optionlist.="\n"; + } + } } - $result.=''.$description.'  '.$optionlist.' - '; + '; return $result; } @@ -744,22 +944,24 @@ sub select_or_text_arg { my $optionlist=""; my $found=0; my $selected=$token->[2]{$name}; - foreach my $option (@$list) { - my ($text,$value); - if ( ref($option) eq 'ARRAY') { - $value='value="'.&HTML::Entities::encode($$option[0]).'"'; - $text=$$option[1]; - $option=$$option[0]; - } else { - $text=$option; - $value='value="'.&HTML::Entities::encode($option,'\'"&<>').'"'; - } - if ( $selected eq $option ) { - $optionlist.="\n"; - $found=1; - } else { - $optionlist.="\n"; - } + if (ref($list) eq 'ARRAY') { + foreach my $option (@{$list}) { + my ($text,$value); + if (ref($option) eq 'ARRAY') { + $value='value="'.&HTML::Entities::encode($option->[0]).'"'; + $text=$option->[1]; + $option=$option->[0]; + } else { + $text=$option; + $value='value="'.&HTML::Entities::encode($option,'\'"&<>').'"'; + } + if ( $selected eq $option ) { + $optionlist.="\n"; + $found=1; + } else { + $optionlist.="\n"; + } + } } $optionlist.="