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

[raeburn]

raeburn		Mon Jul 10 13:01:40 2017 EDT

  Modified files:              
    /loncom/interface	lonnavmaps.pm 
  Log:
  - Update documentation
  
  
Index: loncom/interface/lonnavmaps.pm
diff -u loncom/interface/lonnavmaps.pm:1.531 loncom/interface/lonnavmaps.pm:1.532
--- loncom/interface/lonnavmaps.pm:1.531	Fri Jul  7 17:04:40 2017
+++ loncom/interface/lonnavmaps.pm	Mon Jul 10 13:01:39 2017
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Navigate Maps Handler
 #
-# $Id: lonnavmaps.pm,v 1.531 2017/07/07 17:04:40 raeburn Exp $
+# $Id: lonnavmaps.pm,v 1.532 2017/07/10 13:01:39 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -51,9 +51,16 @@
 X<lonnavmaps, overview> When a user enters a course, LON-CAPA examines the
 course structure and caches it in what is often referred to as the
 "big hash" X<big hash>. You can see it if you are logged into
-LON-CAPA, in a course, by going to /adm/test. (You may need to
-tweak the /home/httpd/lonTabs/htpasswd file to view it.) The
-content of the hash will be under the heading "Big Hash".
+LON-CAPA, in a course, by going to /adm/test. The content of 
+the hash will be under the heading "Big Hash".
+
+Access to /adm/test is controlled by a domain configuration, 
+which a Domain Coordinator will set for a server's default domain
+via: Main Menu > Set domain configuration > Display (Access to 
+server status pages checked), and entering a username:domain
+or IP address in the "Show user environment" row. Users with
+an unexpired domain coordinator role in the server's domain
+automatically receive access to /adm/test.
 
 Big Hash contains, among other things, how resources are related
 to each other (next/previous), what resources are maps, which 
@@ -77,11 +84,18 @@
 rendering navmaps, and last but not least, provides the navmaps
 view for when the user clicks the NAV button.
 
-B<Note>: Apache::lonnavmaps I<only> works for the "currently
-logged in user"; if you want things like "due dates for another
-student" lonnavmaps can not directly retrieve information like
-that. You need the EXT function. This module can still help,
-because many things, such as the course structure, are constant
+B<Note>: Apache::lonnavmaps by default will show information 
+for the "currently logged in user".  However, if information
+about resources is needed for a different user, e.g., a bubblesheet
+exam which uses randomorder, or randompick needs to be printed or 
+graded for named user(s) or specific CODEs, then the username,
+domain, or CODE can be passed as arguments when creating a new 
+navmap object.
+
+Note if you want things like "due dates for another student,
+you would use the EXT function instead of lonnavmaps.
+That said, the lonnavmaps module can still help, because many
+things, such as the course structure, are usually constant
 between users, and Apache::lonnavmaps can help by providing
 symbs for the EXT call.
 
@@ -91,7 +105,9 @@
 is the key to accessing the Big Hash information, covers the use
 of the Iterator (which provides the logic for traversing the 
 somewhat-complicated Big Hash data structure), documents the
-Apache::lonnavmaps::Resource objects that are returned by 
+Apache::lonnavmaps::Resource objects that are returned singularly
+by: getBySymb(), getById(), getByMapPc(), and getResourceByUrl()
+(can also be as an array), or in an array by retrieveResources().
 
 =head1 Subroutine: render