[LON-CAPA-cvs] cvs: rat / lonpage.pm lonpageflip.pm

[jms]

jms		Thu Nov 20 13:11:43 2008 EDT

  Modified files:              
    /rat	lonpage.pm lonpageflip.pm 
  Log:
  Added/created/modified POD documentation
  
Index: rat/lonpage.pm
diff -u rat/lonpage.pm:1.87 rat/lonpage.pm:1.88
--- rat/lonpage.pm:1.87	Fri Nov 30 19:14:14 2007
+++ rat/lonpage.pm	Thu Nov 20 13:11:43 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Page Handler
 #
-# $Id: lonpage.pm,v 1.87 2007/11/30 19:14:14 albertel Exp $
+# $Id: lonpage.pm,v 1.88 2008/11/20 13:11:43 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -27,6 +27,107 @@
 #
 ###
 
+=head1 NAME
+
+Apache::lonpage - Page Handler
+
+=head1 SYNOPSIS
+
+Invoked by /etc/httpd/conf/srm.conf:
+
+ <LocationMatch "^/res/.*\.page$>
+ SetHandler perl-script
+ PerlHandler Apache::lonpage
+ </LocationMatch>
+
+=head1 INTRODUCTION
+
+This module renders a .page resource.
+
+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 *
+
+set document type for header only
+
+=item *
+
+tie db file
+
+=item *
+
+render page
+
+=item *
+
+add to symb list
+
+=item *
+
+page parms
+
+=item *
+
+Get SSI output, post parameters
+
+=item *
+
+SSI cell rendering
+
+=item *
+
+Deal with Applet codebases
+
+=item *
+
+Build page
+
+=item *
+
+send headers
+
+=item *
+
+start body
+
+=item *
+
+start form
+
+=item *
+
+start table
+
+=item *
+
+submit element, etc, render page, untie hash
+
+=back
+
+=head1 OTHER SUBROUTINES
+
+=over 4
+
+=item *
+
+euclid() : Euclid's method for determining the greatest common denominator.
+
+=item *
+
+tracetable() : Build page table.
+
+=back
+
+=cut
+
+
 package Apache::lonpage;
 
 use strict;
@@ -590,105 +691,6 @@
 1;
 __END__
 
-=head1 NAME
-
-Apache::lonpage - Page Handler
-
-=head1 SYNOPSIS
-
-Invoked by /etc/httpd/conf/srm.conf:
-
- <LocationMatch "^/res/.*\.page$>
- SetHandler perl-script
- PerlHandler Apache::lonpage
- </LocationMatch>
-
-=head1 INTRODUCTION
-
-This module renders a .page resource.
-
-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 *
-
-set document type for header only
-
-=item *
-
-tie db file
-
-=item *
-
-render page
-
-=item *
-
-add to symb list
-
-=item *
-
-page parms
-
-=item *
-
-Get SSI output, post parameters
-
-=item *
-
-SSI cell rendering
-
-=item *
-
-Deal with Applet codebases
-
-=item *
-
-Build page
-
-=item *
-
-send headers
-
-=item *
-
-start body
-
-=item *
-
-start form
-
-=item *
-
-start table
-
-=item *
-
-submit element, etc, render page, untie hash
-
-=back
-
-=head1 OTHER SUBROUTINES
-
-=over 4
-
-=item *
-
-euclid() : Euclid's method for determining the greatest common denominator.
-
-=item *
-
-tracetable() : Build page table.
-
-=back
-
-=cut
 
 
 
Index: rat/lonpageflip.pm
diff -u rat/lonpageflip.pm:1.75 rat/lonpageflip.pm:1.76
--- rat/lonpageflip.pm:1.75	Wed Mar 12 02:45:50 2008
+++ rat/lonpageflip.pm	Thu Nov 20 13:11:43 2008
@@ -2,7 +2,7 @@
 #
 # Page flip handler
 #
-# $Id: lonpageflip.pm,v 1.75 2008/03/12 02:45:50 raeburn Exp $
+# $Id: lonpageflip.pm,v 1.76 2008/11/20 13:11:43 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -27,6 +27,48 @@
 # http://www.lon-capa.org/
 #
 
+=pod
+
+=head1 NAME
+
+Apache::lonpageflip
+
+=head1 SYNOPSIS
+
+Deals with forward, backward, and other page flips.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 OVERVIEW
+
+(empty)
+
+=head1 SUBROUTINES
+
+=over cleanup()
+
+=item addrid()
+
+=item fullmove()
+
+=item hash_src()
+
+=item move()
+
+=item get_next_possible_move()
+
+=item navlaunch()
+
+=item first_accessible_resource()
+
+=item handler()
+
+=back
+
+=cut
+
+
 package Apache::lonpageflip;
 
 use strict;