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

Sun Dec 31 18:03:40 EST 2023

raeburn		Sun Dec 31 23:03:40 2023 EDT

  Modified files:              
    /loncom/interface	loncommon.pm 
  Log:
  - Add POD for two subroutines moved from lonwrapper.pm in rev. 1.1420.
  
  
Index: loncom/interface/loncommon.pm
diff -u loncom/interface/loncommon.pm:1.1424 loncom/interface/loncommon.pm:1.1425

--- loncom/interface/loncommon.pm:1.1424	Tue Nov 28 17:53:15 2023
+++ loncom/interface/loncommon.pm	Sun Dec 31 23:03:40 2023
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common routines
 #
-# $Id: loncommon.pm,v 1.1424 2023/11/28 17:53:15 raeburn Exp $
+# $Id: loncommon.pm,v 1.1425 2023/12/31 23:03:40 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -1764,8 +1764,6 @@
 surrounds everything that comes after the textarea, this routine needs
 to be attached to the <body> for the onload and onresize events.
 
-=back
-
 =cut
 
 sub resize_textarea_js {
@@ -2443,6 +2441,12 @@
 
 =item * &iframe_wrapper_headjs()
 
+emits javascript containing two global vars to facilitate handling of resizing
+by code in iframe_wrapper_resizejs() used when an iframe is present in a page
+with standard LON-CAPA menus.
+
+=cut
+
 #
 # Where iframe is in use, if window.onload() executes before the custom resize function
 # has been defined (jQuery), two global javascript vars (LCnotready and LCresizedef)
@@ -2450,11 +2454,6 @@
 # do not obscure the Functions menu.
 #
 
-=back
-
-=cut
-
-
 sub iframe_wrapper_headjs {
     return <<"ENDJS";
 <script type="text/javascript">
@@ -2472,6 +2471,14 @@
 
 =item * &iframe_wrapper_resizejs()
 
+emits javascript used to handle resizing for a page containing
+an iframe, to ensure that the iframe does not obscure any
+standard LON-CAPA menu items.
+
+=back
+
+=cut
+
 #
 # jQuery to use when iframe is in use and a page resize occurs.
 # This script will ensure that the iframe does not obscure any
@@ -2481,10 +2488,6 @@
 # e.g., by inclusion in second arg passed to &start_page().
 #
 
-=back
-
-=cut
-
 sub iframe_wrapper_resizejs {
     my $offset = 5;
     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['inhibitmenu']);


