--- loncom/publisher/lonpublisher.pm	2001/12/15 18:15:27	1.65
+++ loncom/publisher/lonpublisher.pm	2001/12/17 01:50:54	1.66
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Publication Handler
 #
-# $Id: lonpublisher.pm,v 1.65 2001/12/15 18:15:27 harris41 Exp $
+# $Id: lonpublisher.pm,v 1.66 2001/12/17 01:50:54 harris41 Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -41,7 +41,7 @@
 # 12/05 Gerd Kortemeyer
 # 12/05 Guy Albertelli
 # 12/06,12/07 Gerd Kortemeyer
-# 12/15 Scott Harrison
+# 12/15,12/16 Scott Harrison
 #
 ###
 
@@ -757,7 +757,8 @@ sub phasetwo {
 
 } else {
     $scrout.='<p>Private Publication - did not synchronize database';
-    print $logfile "\nPrivate: Did not ynchronized SQL metadata database";
+    print $logfile "\nPrivate: Did not synchronize data into ".
+	"SQL metadata database";
 }
 # ----------------------------------------------------------- Copy old versions
    
@@ -1058,7 +1059,7 @@ unless ($ENV{'form.phase'} eq 'two') {
       $thisdisfn=~s/^\/home\/$cuname\/public_html\///;
 
       $r->print('<h2>Publishing '.
-        &Apache::lonnet::filedescription($thistype).' <tt>'.
+        &Apache::loncommon::filedescription($thistype).' <tt>'.
         $thisdisfn.'</tt></h2><b>Target:</b> <tt>'.$thisdistarget.'</tt><p>');
    
        if (($cuname ne $ENV{'user.name'}) || ($cudom ne $ENV{'user.domain'})) {
@@ -1091,9 +1092,107 @@ unless ($ENV{'form.phase'} eq 'two') {
 1;
 __END__
 
+=head1 NAME
 
+Apache::lonpublisher - Publication Handler
 
+=head1 SYNOPSIS
 
+Invoked by /etc/httpd/conf/srm.conf:
 
+ <Location /adm/publish>
+ PerlAccessHandler       Apache::lonacc
+ SetHandler perl-script
+ PerlHandler Apache::lonpublisher
+ ErrorDocument     403 /adm/login
+ ErrorDocument     404 /adm/notfound.html
+ ErrorDocument     406 /adm/unauthorized.html
+ ErrorDocument	  500 /adm/errorhandler
+ </Location>
 
+=head1 INTRODUCTION
 
+This module publishes a file.  This involves gathering metadata,
+versioning the file, copying file from construction space to
+publication space, and copying metadata from construction space
+to publication space.
+
+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 *
+
+Check filename
+
+=item *
+
+File is there and owned, init lookup tables
+
+=item *
+
+Start page output
+
+=item *
+
+Individual file
+
+=item *
+
+publish from $thisfn to $thistarget with $thisembstyle
+
+=back
+
+=head1 OTHER SUBROUTINES
+
+=over 4
+
+=item *
+
+metaeval() : Evaluate string with metadata
+
+=item *
+
+metaread() : Read a metadata file
+
+=item *
+
+sqltime() : convert 'time' format into a datetime sql format
+
+=item *
+
+textfield() : form field
+
+=item *
+
+hiddenfield() : form field
+
+=item *
+
+selectbox() : form field
+
+=item *
+
+urlfixup() : fixup URL (Publication Step One)
+
+=item *
+
+publish() : publish (Publication Step One)
+
+=item *
+
+phasetwo() : render second interface showing status of publication steps
+(Publication Step Two)
+
+=back
+
+=cut