--- rat/lonratedt.pm	2003/06/16 13:51:46	1.45
+++ 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.45 2003/06/16 13:51:46 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;