[LON-CAPA-cvs] cvs: loncom /auth localstudentphoto.pm /homework edit.pm /publisher lonpubdir.pm lonretrieve.pm
jms
lon-capa-cvs-allow@mail.lon-capa.org
Mon, 10 Nov 2008 14:11:16 -0000
This is a MIME encoded message
--jms1226326276
Content-Type: text/plain
jms Mon Nov 10 14:11:16 2008 EDT
Modified files:
/loncom/auth localstudentphoto.pm
/loncom/publisher lonretrieve.pm lonpubdir.pm
/loncom/homework edit.pm
Log:
Added/updated POD documentation
--jms1226326276
Content-Type: text/plain
Content-Disposition: attachment; filename="jms-20081110141116.txt"
Index: loncom/auth/localstudentphoto.pm
diff -u loncom/auth/localstudentphoto.pm:1.5 loncom/auth/localstudentphoto.pm:1.6
--- loncom/auth/localstudentphoto.pm:1.5 Mon Nov 10 13:20:24 2008
+++ loncom/auth/localstudentphoto.pm Mon Nov 10 14:11:01 2008
@@ -1,6 +1,6 @@
# The LON-CAPA dummy student photo fetch mechnism
#
-# $Id: localstudentphoto.pm,v 1.5 2008/11/10 13:20:24 jms Exp $
+# $Id: localstudentphoto.pm,v 1.6 2008/11/10 14:11:01 jms Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -26,7 +26,30 @@
#
# 8/24 Guy Albertelli
+=pod
+
+=head1 NAME
+
+Apache::localstudentphoto
+
+=head1 SYNOPSIS
+
+Incoming data: none
+Returns ''
+
+=head1 OVERVIEW
+
+Prevents errors when undefined subroutines are called in this package.
+Will allow new routines added in the future to be called from lond etc.
+without the need for customized versions of local*.pm packages to be
+modified to include the new subroutines immediately.
+
+See I<"Programming Perl"> 3rd ed. pp 296-298.
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=cut
package localstudentphoto;
@@ -91,25 +114,5 @@
1;
__END__
-=pod
-
-=head1 NAME
-
-AUTOLOAD
-
-=head1 SYNOPSIS
-Incoming data: none
-Returns ''
-
-=head1 OVERVIEW
-
-Prevents errors when undefined subroutines are called in this package.
-Will allow new routines added in the future to be called from lond etc.
-without the need for customized versions of local*.pm packages to be
-modified to include the new subroutines immediately.
-
-See I<"Programming Perl"> 3rd ed. pp 296-298.
-
-=cut
Index: loncom/publisher/lonretrieve.pm
diff -u loncom/publisher/lonretrieve.pm:1.34 loncom/publisher/lonretrieve.pm:1.35
--- loncom/publisher/lonretrieve.pm:1.34 Wed Dec 6 22:22:39 2006
+++ loncom/publisher/lonretrieve.pm Mon Nov 10 14:11:08 2008
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Handler to retrieve an old version of a file
#
-# $Id: lonretrieve.pm,v 1.34 2006/12/06 22:22:39 albertel Exp $
+# $Id: lonretrieve.pm,v 1.35 2008/11/10 14:11:08 jms Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -28,6 +28,71 @@
#
###
+=head1 NAME
+
+Apache::lonretrieve - retrieves an old version of a file
+
+=head1 SYNOPSIS
+
+Invoked by /etc/httpd/conf/srm.conf:
+
+ <Location /adm/retrieve>
+ PerlAccessHandler Apache::lonacc
+ SetHandler perl-script
+ PerlHandler Apache::lonretrieve
+ ErrorDocument 403 /adm/login
+ ErrorDocument 404 /adm/notfound.html
+ ErrorDocument 406 /adm/unauthorized.html
+ ErrorDocument 500 /adm/errorhandler
+ </Location>
+
+=head1 INTRODUCTION
+
+This module retrieves an old published version of a file.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 HANDLER SUBROUTINE
+
+This routine is called by Apache and mod_perl.
+
+=over 4
+
+=item *
+
+Get query string for limited number of parameters
+
+=item *
+
+Start page output
+
+=item *
+
+print phase relevant output
+
+=item *
+
+(phase one is to select version; phase two retrieves version)
+
+=back
+
+=head1 OTHER SUBROUTINES
+
+=over 4
+
+=item *
+
+phaseone() : Interface for selecting previous version.
+
+=item *
+
+phasetwo() : Interface for presenting specified version.
+
+=back
+
+=cut
+
package Apache::lonretrieve;
use strict;
@@ -273,67 +338,4 @@
1;
__END__
-=head1 NAME
-
-Apache::lonretrieve - retrieves an old version of a file
-
-=head1 SYNOPSIS
-
-Invoked by /etc/httpd/conf/srm.conf:
-
- <Location /adm/retrieve>
- PerlAccessHandler Apache::lonacc
- SetHandler perl-script
- PerlHandler Apache::lonretrieve
- ErrorDocument 403 /adm/login
- ErrorDocument 404 /adm/notfound.html
- ErrorDocument 406 /adm/unauthorized.html
- ErrorDocument 500 /adm/errorhandler
- </Location>
-
-=head1 INTRODUCTION
-
-This module retrieves an old published version of a file.
-
-This is part of the LearningOnline Network with CAPA project
-described at http://www.lon-capa.org.
-
-=head1 HANDLER SUBROUTINE
-
-This routine is called by Apache and mod_perl.
-
-=over 4
-
-=item *
-
-Get query string for limited number of parameters
-
-=item *
-
-Start page output
-
-=item *
-
-print phase relevant output
-
-=item *
-
-(phase one is to select version; phase two retrieves version)
-
-=back
-
-=head1 OTHER SUBROUTINES
-
-=over 4
-
-=item *
-
-phaseone() : Interface for selecting previous version.
-
-=item *
-
-phasetwo() : Interface for presenting specified version.
-
-=back
-=cut
Index: loncom/publisher/lonpubdir.pm
diff -u loncom/publisher/lonpubdir.pm:1.111 loncom/publisher/lonpubdir.pm:1.112
--- loncom/publisher/lonpubdir.pm:1.111 Mon Nov 10 13:43:51 2008
+++ loncom/publisher/lonpubdir.pm Mon Nov 10 14:11:08 2008
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Construction Space Directory Lister
#
-# $Id: lonpubdir.pm,v 1.111 2008/11/10 13:43:51 jms Exp $
+# $Id: lonpubdir.pm,v 1.112 2008/11/10 14:11:08 jms Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -82,7 +82,7 @@
=back
-=head2 subroutines:
+=head2 OTHER SUBROUTINES:
=head3 startpage($r, $uame, $udom, $thisdisfn)
Index: loncom/homework/edit.pm
diff -u loncom/homework/edit.pm:1.116 loncom/homework/edit.pm:1.117
--- loncom/homework/edit.pm:1.116 Fri Oct 24 16:22:54 2008
+++ loncom/homework/edit.pm Mon Nov 10 14:11:16 2008
@@ -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.117 2008/11/10 14:11:16 jms Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -26,6 +26,123 @@
# 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 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
+
package Apache::edit;
use strict;
@@ -974,119 +1091,4 @@
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
--jms1226326276--