--- rat/lonratedt.pm 2003/04/07 20:47:06 1.44
+++ rat/lonratedt.pm 2007/01/16 21:10:55 1.87
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Edit Handler for RAT Maps
#
-# $Id: lonratedt.pm,v 1.44 2003/04/07 20:47:06 www Exp $
+# $Id: lonratedt.pm,v 1.87 2007/01/16 21:10:55 albertel Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -25,250 +25,184 @@
#
# http://www.lon-capa.org/
#
-# (TeX Content Handler
-#
-# 05/29/00,05/30 Gerd Kortemeyer)
-# 7/1,6/30 Gerd Kortemeyer
+
package Apache::lonratedt;
-use strict;
-use Apache::Constants qw(:common);
-use Apache::lonnet;
-use Apache::lonratsrv;
-use Apache::lonsequence;
-use Apache::loncommon;
-use File::Copy;
+=pod
-use vars qw(@order @resources);
+=head1 NAME
+Apache::lonratedt: simple resource assembly tool
-# Mapread read maps into global arrays @links and @resources, determines status
-# sets @order - pointer to resources in right order
-# sets @resources - array with the resources with correct idx
-#
-sub mapread {
- my $fn=shift;
+=head1 SYNOPSIS
- my @links;
- undef @links;
- undef @resources;
- undef @order;
- @resources=('');
- @order=();
-
- my ($outtext,$errtext)=&Apache::lonratsrv::loadmap($fn,'');
- if ($errtext) { return ($errtext,2); }
-
-# -------------------------------------------------------------------- Read map
- foreach (split(/\<\&\>/,$outtext)) {
- my ($command,$number,$content)=split(/\<\:\>/,$_);
- if ($command eq 'objcont') {
- $resources[$number]=$content;
- }
- 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=();
- my @endings=();
- undef @starters;
- undef @endings;
-
- foreach (@links) {
- if (defined($_)) {
- my ($start,$end,$cond)=split(/\:/,$_);
- if ((defined($starters[$start])) || (defined($endings[$end]))) {
- return
- ('Map has branchings. Use advanced editor.',1);
- }
- $starters[$start]=1;
- $endings[$end]=1;
- if ($cond) {
- return
- ('Map has conditions. Use advanced editor.',1);
- }
- }
+lonratedt provides the routines and the handler for the Advanced
+ Resource Assembly Tool (RAT), and ties the various pieces together
+ with Javascript.
- }
- for (my $i=1; $i<=$#resources; $i++) {
- if (defined($resources[$i])) {
- unless (($starters[$i]) || ($endings[$i])) {
- return
- ('Map has unconnected resources. Use advanced editor.',1);
- }
- }
- }
-# ---------------------------------------------- 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
+=head1 OVERVIEW
- my $startidx=0;
- my $endidx=0;
- for (my $i=0; $i<=$#resources; $i++) {
- if (defined($resources[$i])) {
- my ($title,$url,$ext,$type)=split(/\:/,$resources[$i]);
- if ($type eq 'start') { $startidx=$i; }
- if ($type eq 'finish') { $endidx=$i; }
- }
- }
- my $k=0;
- my $currentidx=$startidx;
- $order[$k]=$currentidx;
- for (my $i=0; $i<=$#resources; $i++) {
- foreach (@links) {
- my ($start,$end)=split(/\:/,$_);
- if ($start==$currentidx) {
- $currentidx=$end;
- $k++;
- $order[$k]=$currentidx;
- last;
- }
- }
- if ($currentidx==$endidx) { last; }
- }
- return $errtext;
-}
+=head2 Map Representation
-# ---------------------------------------------- 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;
+=begin latex
- my @links;
- undef @links;
- my @theseres;
- undef @theseres;
-
- my ($outtext,$errtext)=&Apache::lonratsrv::loadmap($fn,'');
- if ($errtext) { return @theseres }
-
-# -------------------------------------------------------------------- Read map
- foreach (split(/\<\&\>/,$outtext)) {
- my ($command,$number,$content)=split(/\<\:\>/,$_);
- if ($command eq 'objcont') {
- $theseres[$number]=$content;
- }
- if ($command eq 'objlinks') {
- $links[$number]=$content;
- }
- }
+%
+\begin{figure}
+\begin{center}\includegraphics[%
+ width=0.55\paperwidth,bb = 0 0 200 100, draft, type=eps]{Map_Example}\end{center}
-# --------------------------------------------------------------- Sort, sort of
- my @objsort=();
- undef @objsort;
+\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::lonsequence();
+use Apache::loncommon();
+use Apache::lonlocal;
+use LONCAPA::map();
+use File::Copy;
+use LONCAPA;
+use HTML::Entities();
# --------------------------------------------------------- Build up RAT screen
sub ratedt {
my ($r,$url)=@_;
- $r->print(<
-
-
-
-
-