[LON-CAPA-cvs] cvs: loncom /interface lonnavmaps.pm
albertel
lon-capa-cvs@mail.lon-capa.org
Thu, 12 Jan 2006 23:35:57 -0000
albertel Thu Jan 12 18:35:57 2006 EDT
Modified files:
/loncom/interface lonnavmaps.pm
Log:
- updating documentation getByUrl doesn't exist but getResourceByUrl does
Index: loncom/interface/lonnavmaps.pm
diff -u loncom/interface/lonnavmaps.pm:1.357 loncom/interface/lonnavmaps.pm:1.358
--- loncom/interface/lonnavmaps.pm:1.357 Thu Dec 29 13:54:30 2005
+++ loncom/interface/lonnavmaps.pm Thu Jan 12 18:35:55 2006
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Navigate Maps Handler
#
-# $Id: lonnavmaps.pm,v 1.357 2005/12/29 18:54:30 albertel Exp $
+# $Id: lonnavmaps.pm,v 1.358 2006/01/12 23:35:55 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -2066,15 +2066,16 @@
=over 4
-=item * C<$navmap-E<gt>getByX>, where X is B<Id>, B<Symb>, B<Url> or B<MapPc>. This provides
+=item * C<$navmap-E<gt>getByX>, where X is B<Id>, B<Symb> or B<MapPc> and getResourceByUrl. This provides
various ways to obtain resource objects, based on various identifiers.
Use this when you want to request information about one object or
a handful of resources you already know the identities of, from some
other source. For more about Ids, Symbs, and MapPcs, see the
Resource documentation. Note that Url should be a B<last resort>,
- not your first choice; it only works when there is only one
+ not your first choice; it only really works when there is only one
instance of the resource in the course, which only applies to
- maps, and even that may change in the future.
+ maps, and even that may change in the future (see the B<getResourceByUrl>
+ documentation for more details.)
=item * C<my @resources = $navmap-E<gt>retrieveResources(args)>. This
retrieves resources matching some criterion and returns them