--- rat/lonratedt.pm 2002/05/22 20:39:59 1.27
+++ rat/lonratedt.pm 2003/10/21 20:40:10 1.48
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Edit Handler for RAT Maps
#
-# $Id: lonratedt.pm,v 1.27 2002/05/22 20:39:59 www Exp $
+# $Id: lonratedt.pm,v 1.48 2003/10/21 20:40:10 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -32,13 +32,151 @@
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}
+
+\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 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
+
+=cut
+
use strict;
use Apache::Constants qw(:common);
use Apache::lonnet;
use Apache::lonratsrv;
+use Apache::lonsequence;
+use Apache::loncommon;
+use Apache::lonlocal;
+use File::Copy;
-my @order;
-my @resources;
+use vars qw(@order @resources);
# Mapread read maps into global arrays @links and @resources, determines status
@@ -67,6 +205,9 @@ sub mapread {
if ($command eq 'objlinks') {
$links[$number]=$content;
}
+ if ($command eq 'objparms') {
+ return('Map has resource parameters. Use advanced editor.',1);
+ }
}
# ------------------------------------------------------- Is this a linear map?
my @starters=();
@@ -98,7 +239,12 @@ sub mapread {
}
}
}
-
+# ---------------------------------------------- Did we just read an empty map?
+ if ($#resources<1) {
+ undef $resources[0];
+ $resources[1]=':::start';
+ $resources[2]=':::finish';
+ }
# -------------------------------------------------- This is a linear map, sort
my $startidx=0;
@@ -129,7 +275,9 @@ sub mapread {
}
# ---------------------------------------------- Read a map as well as possible
-
+# Also used by the sequence handler
+# Call lonsequence::attemptread to read from resource space
+#
sub attemptread {
my $fn=shift;
@@ -263,7 +411,6 @@ ENDDOCUMENT
# ---------------------------------------------------------------- Make buttons
sub buttons {
- if ($ENV{'form.forceselect'}) { return ''; }
my $adv=shift;
my $output='