--- rat/lonratedt.pm	2002/12/06 12:58:11	1.42
+++ rat/lonratedt.pm	2003/07/25 04:14:32	1.46
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Edit Handler for RAT Maps
 #
-# $Id: lonratedt.pm,v 1.42 2002/12/06 12:58:11 www Exp $
+# $Id: lonratedt.pm,v 1.46 2003/07/25 04:14:32 bowersj2 Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -32,6 +32,141 @@
 
 package Apache::lonratedt;
 
+=pod
+
+=head1 NAME
+
+Apache::lonratedt: advanced resource assembly tool
+
+=head1 SYNOPSIS
+
+lonratedt provides the routines and the handler for the Advanced
+    Resource Assembly Tool (RAT), and ties the various pieces together
+    with Javascript.
+
+=head1 OVERVIEW
+
+=head2 Map Representation
+
+=begin latex
+
+%
+\begin{figure}
+\begin{center}\includegraphics[%
+  width=0.55\paperwidth,bb = 0 0 200 100, draft, type=eps]{Map_Example}\end{center}
+
+
+\caption{\label{Map_In_Advanced_Editor}Example of a Map in the Advanced Editor}
+\end{figure}
+%
+\begin{figure}
+\begin{lyxcode}
+<map>
+
+~~<resource~id=\char`\"{}1\char`\"{}
+
+~~~~src=\char`\"{}/res/msu/korte/phy231welcome.html\char`\"{}
+
+~~~~type=\char`\"{}start\char`\"{}
+
+~~~~title=\char`\"{}Start\char`\"{}>
+
+~~~~</resource>
+
+~~<resource~id=\char`\"{}2\char`\"{}
+
+~~~~src=\char`\"{}\char`\"{}~type=\char`\"{}finish\char`\"{}
+
+~~~~title=\char`\"{}Finish\char`\"{}>
+
+~~~~</resource>
+
+~~<resource~id=\char`\"{}6\char`\"{}
+
+~~~~src=\char`\"{}/res/msu/korte/tests/units.problem\char`\"{}
+
+~~~~type=\char`\"{}mandatory\char`\"{}
+
+~~~~title=\char`\"{}Physical~Units~Test\char`\"{}>
+
+~~~~</resource>
+
+~~<resource~id=\char`\"{}9\char`\"{}
+
+~~~~src=\char`\"{}/res/msu/korte/chapters/onedim.sequence\char`\"{}
+
+~~~~title=\char`\"{}Motion~in~One~Dimension\char`\"{}>
+
+~~~~</resource>
+
+~~<resource~id=\char`\"{}11\char`\"{}
+
+~~~~src=\char`\"{}/res/msu/bauer/bridges/units.sequence\char`\"{}
+
+~~~~title=\char`\"{}Physical~Units~Refresher\char`\"{}>
+
+~~~~</resource>
+
+~~<condition~id=\char`\"{}19\char`\"{}
+
+~~~~type=\char`\"{}stop\char`\"{}
+
+~~~~value=\char`\"{}user.assessments{[}this./res/msu/korte/tests/units.problem{]}.status=solved\char`\"{}>
+
+~~~~</condition>
+
+~~<link~from=\char`\"{}1\char`\"{}~to=\char`\"{}6\char`\"{}></link>
+
+~~<link~from=\char`\"{}6\char`\"{}~to=\char`\"{}9\char`\"{}~condition=\char`\"{}19\char`\"{}></link>
+
+~~<link~from=\char`\"{}6\char`\"{}~to=\char`\"{}11\char`\"{}></link>
+
+~~<link~from=\char`\"{}11\char`\"{}~to=\char`\"{}6\char`\"{}></link>
+
+~~</map>
+\end{lyxcode}
+
+\caption{\label{XML}XML for Map in Figure \ref{Map_In_Advanced_Editor}}
+\end{figure}
+
+=end latex
+
+Fig. "XML for Map in Figure" shows the XML representation of the
+resource map shown in Fig. "Example of a Map in the Advanced Editor",
+which is the format in which maps are stored. In the figure, however,
+additional graphical map layout information generated by the Advanced
+Resource Assembly Tool is not displayed. This graphical information is
+optional to re-generate the same graphical layout when the map is
+brought up again in the Resource Assembly Tool, and is not needed for
+any other system functionality.
+
+Maps can be generated by tools other than the Resource Assembly
+Tool. In particular, an author might have some other representation of
+a course sequence, which can be converted into a map using scripts. If
+this map then were to be brought up in the Resource Assembly Tool, the
+Tool would automatically generate a graphical layout for it. Each
+entry of the map (resources, conditions and links) is stored in a
+separate tag.
+
+Resources and conditionsX<conditions> have to have unique ID
+numbers. These numbers are automatically generated by the Resource
+Assembly Tool when the entry is first created, or added to the entries
+when a map generated outside the Resource Assembly Tool is first
+retrieved. They can also be assigned by custom scripts or added in by
+hand.
+
+In the XML example, entry 1 is the start resource of the map. When
+this map is accessed, the source (src) URL of this tag will be the
+first resource rendered. Entry 2 is the finish resource of this
+map. This resource will be the last resource in the sequence of
+resources. Entry 6 is a problem resource with the given URL and title,
+as well as the priority "mandatory". Entry 19 is a condition, which is
+used by the link between entries 6, the problem, and 9, a
+sequence. I<The final syntax for conditions has not yet been
+determined.>
+
+=cut
+
 use strict;
 use Apache::Constants qw(:common);
 use Apache::lonnet;
@@ -318,17 +453,38 @@ sub pastetarget {
 # modifies @resources
 
 sub startfinish {
+# Remove all start and finish
     foreach (@order) {
 	my ($name,$url,$ext)=split(/\:/,$resources[$_]);
         if ($url=~/http\&colon\:\/\//) { $ext='true'; }
         $resources[$_]=$name.':'.$url.':'.$ext.':normal:res';
     }
+# Garbage collection
+    my $stillchange=1;
+     while (($#order>1) && ($stillchange)) {
+       $stillchange=0;
+       for (my $i=0;$i<=$#order;$i++) {
+ 	  my ($name,$url,$ext)=split(/\:/,$resources[$order[$i]]);
+          unless ($url) {
+# Take out empty resource
+              for (my $j=$i+1;$j<=$#order;$j++) {
+                  $order[$j-1]=$order[$j];
+	      }
+              $#order--;
+	      $stillchange=1;
+              last;
+          }
+       }
+    }
+# Put in a start resource
    my ($name,$url,$ext)=split(/\:/,$resources[$order[0]]);
    $resources[$order[0]]=$name.':'.$url.':'.$ext.':start:res';
+# Make sure this has at least start and finish
    if ($#order==0) {
        $resources[$#resources+1]='::false';
        $order[1]=$#resources;
    }
+# Make the last one a finish resource
    ($name,$url,$ext)=split(/\:/,$resources[$order[$#order]]);
    $resources[$order[$#order]]=$name.':'.$url.':'.$ext.':finish:res';
 }
@@ -818,7 +974,7 @@ after selected
 <input type=text size=20 name=importmap>
 <input type=button 
 onClick="javascript:openbrowser('simpleedit','importmap','sequence,page','')"
-value="Browse"><input type=submit name=loadmap value="Load Map"><hr>
+value="Select Map"><input type=submit name=loadmap value="Load Map"><hr>
 <input type=submit name="discard" value="Discard Selected">
 <input type=submit name="clear" value="Clear All">
 <input type=button onClick="javascript:viewimport()" value="View">
@@ -892,6 +1048,9 @@ sub viewmap {
     }
     my $idx=0;
     $r->print('<h1>'.$url.'</h1>');
+    if ($adv) {
+	$r->print('<p><b><font color="red">Map contents are not shown in order.</font></b></p><br />');
+    }
     foreach (&attemptread(&Apache::lonnet::filelocation('',$url))) {
 	if (defined($_)) {
             $idx++;