[LON-CAPA-cvs] cvs: loncom /interface lonhtmlcommon.pm

[albertel]

albertel		Mon Feb 16 17:32:19 2004 EDT

  Modified files:              
    /loncom/interface	lonhtmlcommon.pm 
  Log:
  - add POD for inline progress windows
  
  
Index: loncom/interface/lonhtmlcommon.pm
diff -u loncom/interface/lonhtmlcommon.pm:1.49 loncom/interface/lonhtmlcommon.pm:1.50
--- loncom/interface/lonhtmlcommon.pm:1.49	Mon Feb 16 17:28:55 2004
+++ loncom/interface/lonhtmlcommon.pm	Mon Feb 16 17:32:19 2004
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common html routines
 #
-# $Id: lonhtmlcommon.pm,v 1.49 2004/02/16 22:28:55 albertel Exp $
+# $Id: lonhtmlcommon.pm,v 1.50 2004/02/16 22:32:19 albertel Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -556,6 +556,13 @@
 =item $heading A description (usually 1 line) of the process being initiated.
 
 =item $number_to_do The total number of items being processed.
+
+=item $type Either 'popup' or 'inline' (popup is assumed if nothing is
+       specified)
+
+=item $formname Only useful in the inline case, if a form already exists, this needs to be used and specfiy the name of the form, otherwise the Progress line will be created in a new form of it's own
+
+=item $inputname Only useful in the inline case, if a form and an input of type text exists, use this to specify the name of the input field 
 
 =back