--- loncom/homework/edit.pm 2007/10/03 00:24:48 1.112 +++ loncom/homework/edit.pm 2008/12/10 21:02:01 1.119 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # edit mode helpers # -# $Id: edit.pm,v 1.112 2007/10/03 00:24:48 albertel Exp $ +# $Id: edit.pm,v 1.119 2008/12/10 21:02:01 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -26,6 +26,108 @@ # http://www.lon-capa.org/ # +=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 +163,7 @@ sub tag_start { if (!$description) { $description="<$tag>"; } } $result.= &start_table($token)."$description - Delete". + ".&mt('Delete?').' '. &deletelist($target,$token) ." ". @@ -128,7 +230,7 @@ sub end_table { return $result; } -sub start_spanning_row { return '';} +sub start_spanning_row { return '';} sub start_row { return ''; } sub end_row { return ''; } @@ -145,7 +247,7 @@ sub deletelist { my ($target,$token) = @_; my $result = ""; return $result; } @@ -215,7 +317,7 @@ sub innerinsertlist { if ($target eq 'edit') { my $optionlist= &get_insert_list($tagname); if ($optionlist) { - $result = "Insert: + $result = &mt('Insert:')." " @@ -577,7 +679,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 { @@ -739,15 +842,15 @@ sub checked_arg { $text=$option; $value='value="'.$option.'"'; } - $result.="\n"; + $result.=&element_change_detection().' />'.$text.''."\n"; } return $result; } @@ -760,7 +863,7 @@ sub text_arg { $result=&mt($description).' '; - return ''.$result.''; + return ''.$result.''; } sub select_arg { @@ -779,15 +882,15 @@ sub select_arg { $value='value="'.&HTML::Entities::encode($option,'\'"&<>').'"'; } if ( $selected eq $option ) { - $optionlist.="\n"; + $optionlist.="\n"; } else { - $optionlist.="\n"; + $optionlist.="\n"; } } - $result.=''.$description.'  '.$optionlist.' - '; + '; return $result; } @@ -833,7 +936,7 @@ sub select_or_text_arg { $description=&mt($description); # return (< + $description   - + ENDSELECTORTYPE } @@ -879,7 +982,7 @@ sub entercoords { $data{"imagechoice.$id.formwidth"}=$width.'_'. $Apache::edit::bgimgsrccurdepth; } - &Apache::lonnet::appenv(%data); + &Apache::lonnet::appenv(\%data); my $text="Click Coordinates"; my $result=''.$text.''; return $result; @@ -912,7 +1015,7 @@ sub entercoord { $data{"imagechoice.$id.formwidth"}=$width.'_'. $Apache::edit::bgimgsrccurdepth; } - &Apache::lonnet::appenv(%data); + &Apache::lonnet::appenv(\%data); my $text="Enter Coordinates"; if ($type eq 'polygon') { $text='Create Polygon Data'; } my $result=''.$text.''; @@ -973,119 +1076,4 @@ ENDBUTTON 1; __END__ -=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 HANDLER SUBROUTINE - -There is no handler subroutine. - -=head1 OTHER 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 - -incomplete... - -=cut