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

[raeburn]

raeburn		Sun Oct 23 14:35:32 2016 EDT

  Modified files:              
    /loncom/interface	lonblockingmenu.pm 
  Log:
  - Document &interval_details() routine.
  
  
Index: loncom/interface/lonblockingmenu.pm
diff -u loncom/interface/lonblockingmenu.pm:1.21 loncom/interface/lonblockingmenu.pm:1.22
--- loncom/interface/lonblockingmenu.pm:1.21	Sat Oct 22 02:03:31 2016
+++ loncom/interface/lonblockingmenu.pm	Sun Oct 23 14:35:32 2016
@@ -2,7 +2,7 @@
 # Routines for configuring blocking of access to collaborative functions, 
 # and specific resources during an exam
 #
-# $Id: lonblockingmenu.pm,v 1.21 2016/10/22 02:03:31 raeburn Exp $
+# $Id: lonblockingmenu.pm,v 1.22 2016/10/23 14:35:32 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -344,6 +344,31 @@
 
 =item &interval_details()
 
+Creates name/scope of current interval and expandable/collapsible
+showing which interval parameters apply to the current folder/resource 
+
+Inputs: 6
+
+    - $item - course, map url, or resource symb
+
+    - $type - course, map, or resource
+
+    - $url  - url of item (null if item is course).
+
+    - $navmap - navmaps object
+
+    - $intervals - Reference to hash of parameters for timed intervals
+
+    - $parmcount - unique ID for current element.
+
+
+Outputs: 2 
+
+   - $itemname - name/scope of interval (timer) parameter
+
+   - $iteminfo - Expandable/collapsible block showing which interval
+                 (timer) parameters affect the current folder or resource.
+
 
 =item &trigger_details_toggle()