--- loncom/homework/edit.pm 2004/09/30 21:47:21 1.87
+++ loncom/homework/edit.pm 2023/03/27 18:41:06 1.157
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# edit mode helpers
#
-# $Id: edit.pm,v 1.87 2004/09/30 21:47:21 albertel Exp $
+# $Id: edit.pm,v 1.157 2023/03/27 18:41:06 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -26,12 +26,120 @@
# 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;
-use Apache::lonnet();
+use Apache::lonnet;
+use Apache::loncommon;
use HTML::Entities();
use Apache::lonlocal;
+use lib '/home/httpd/lib/perl/';
+use LONCAPA qw(:DEFAULT :match);
+
# Global Vars
# default list of colors to use in editing
@@ -54,24 +162,20 @@ sub tag_start {
if ($target eq "edit") {
my $tag=$token->[1];
if (!$description) {
- $description=&Apache::lonxml::description($token);
+ $description=&mt(&Apache::lonxml::description($token));
if (!$description) { $description="<$tag>"; }
}
- $result.= &start_table($token)."
';
+
+ } else {
+ $output = &browse($id, $mode, $titleid, $only);
+ if ($usesearch) {
+ $output .= ' '.&search($id, $mode, $titleid);
+ }
+ }
+ return $output;
}
#----------------------------------------------------- browse
sub browse {
# insert a link to call up the filesystem browser (lonindexer)
- my ($id, $mode, $titleid) = @_;
+ my ($id, $mode, $titleid, $only) = @_;
+ my %lt = &Apache::lonlocal::texthash (
+ se => 'Select',
+ );
my $form = 'lonhomework';
- my $element;
- if (! defined($mode) || $mode eq 'attribute') {
- $element = &Apache::lonnet::escape("$id\_$Apache::lonxml::curdepth");
- } elsif ($mode eq 'textnode') { # for data between ...
- $element = &Apache::lonnet::escape('homework_edit_'.
- $Apache::lonxml::curdepth);
- }
+ my $element = &get_element($id,$mode);
my $titleelement;
if ($titleid) {
- $titleelement=",'','','".&Apache::lonnet::escape("$titleid\_$Apache::lonxml::curdepth")."'";
+ $titleelement=",'$only','','".&escape("$titleid\_$Apache::lonxml::curdepth")."'";
+ } else {
+ $titleelement=",'$only'";
}
- my $result = <<"ENDBUTTON";
-Select
+ return <<"ENDBUTTON";
+$lt{'se'}
ENDBUTTON
- return $result;
}
-#----------------------------------------------------- browse
+#----------------------------------------------------- search
sub search {
# insert a link to call up the filesystem browser (lonindexer)
my ($id, $mode, $titleid) = @_;
my $form = 'lonhomework';
- my $element;
- if (! defined($mode) || $mode eq 'attribute') {
- $element = &Apache::lonnet::escape("$id\_$Apache::lonxml::curdepth");
- } elsif ($mode eq 'textnode') { # for data between ...
- $element = &Apache::lonnet::escape('homework_edit_'.
- $Apache::lonxml::curdepth);
- }
+ my $element = &get_element($id,$mode);
my $titleelement;
if ($titleid) {
- $titleelement=",'".&Apache::lonnet::escape("$titleid\_$Apache::lonxml::curdepth")."'";
+ $titleelement=",'".&escape("$titleid\_$Apache::lonxml::curdepth")."'";
}
+ my $linktext = &mt('Search');
my $result = <<"ENDBUTTON";
-Search
+$linktext
ENDBUTTON
return $result;
}
+sub get_element {
+ my ($id,$mode) = @_;
+ my $element;
+ if (! defined($mode) || $mode eq 'attribute') {
+ $element = &escape("$id\_$Apache::lonxml::curdepth");
+ } elsif ($mode eq 'textnode') { # for data between ...
+ $element = &escape('homework_edit_'.
+ $Apache::lonxml::curdepth);
+ }
+ return $element;
+}
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