loncom/interface/lonnavmaps.pm - diff

Return to lonnavmaps.pm CVS log

Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonnavmaps.pm between versions 1.531 and 1.532

version 1.531, 2017/07/07 17:04:40	version 1.532, 2017/07/10 13:01:39
Line 51 described at http://www.lon-capa.org.	Line 51 described at http://www.lon-capa.org.
X<lonnavmaps, overview> When a user enters a course, LON-CAPA examines the	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	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	"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	LON-CAPA, in a course, by going to /adm/test. The content of
tweak the /home/httpd/lonTabs/htpasswd file to view it.) The	the hash will be under the heading "Big Hash".
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	Big Hash contains, among other things, how resources are related
to each other (next/previous), what resources are maps, which	to each other (next/previous), what resources are maps, which
Line 77 Apache::lonnavmaps also provides fairly	Line 84 Apache::lonnavmaps also provides fairly
rendering navmaps, and last but not least, provides the navmaps	rendering navmaps, and last but not least, provides the navmaps
view for when the user clicks the NAV button.	view for when the user clicks the NAV button.

B<Note>: Apache::lonnavmaps I<only> works for the "currently	B<Note>: Apache::lonnavmaps by default will show information
logged in user"; if you want things like "due dates for another	for the "currently logged in user". However, if information
student" lonnavmaps can not directly retrieve information like	about resources is needed for a different user, e.g., a bubblesheet
that. You need the EXT function. This module can still help,	exam which uses randomorder, or randompick needs to be printed or
because many things, such as the course structure, are constant	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	between users, and Apache::lonnavmaps can help by providing
symbs for the EXT call.	symbs for the EXT call.

Line 91 all, then documents the Apache::lonnavma	Line 105 all, then documents the Apache::lonnavma
is the key to accessing the Big Hash information, covers the use	is the key to accessing the Big Hash information, covers the use
of the Iterator (which provides the logic for traversing the	of the Iterator (which provides the logic for traversing the
somewhat-complicated Big Hash data structure), documents 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	=head1 Subroutine: render

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.531
changed lines
	Added in v.1.532