--- loncom/homework/edit.pm	2008/10/24 16:22:54	1.116
+++ loncom/homework/edit.pm	2008/11/18 19:14:28	1.118
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA 
 # edit mode helpers
 #
-# $Id: edit.pm,v 1.116 2008/10/24 16:22:54 bisitz Exp $
+# $Id: edit.pm,v 1.118 2008/11/18 19:14:28 jms 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 <input type="text" ../> 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;
@@ -974,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 <input type="text" ../> 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