--- rat/lonratedt.pm 2003/06/16 13:51:46 1.45
+++ rat/lonratedt.pm 2004/04/26 16:56:26 1.57
@@ -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.57 2004/04/26 16:56:26 www Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -25,22 +25,155 @@
#
# http://www.lon-capa.org/
#
-# (TeX Content Handler
-#
-# 05/29/00,05/30 Gerd Kortemeyer)
-# 7/1,6/30 Gerd Kortemeyer
+
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;
use Apache::lonratsrv;
use Apache::lonsequence;
use Apache::loncommon;
+use Apache::lonlocal;
use File::Copy;
-use vars qw(@order @resources);
+use vars qw(@order @resources @resparms);
# Mapread read maps into global arrays @links and @resources, determines status
@@ -70,7 +203,11 @@ sub mapread {
$links[$number]=$content;
}
if ($command eq 'objparms') {
- return('Map has resource parameters. Use advanced editor.',1);
+ if ($resparms[$number]) {
+ $resparms[$number].='&&&'.$content;
+ } else {
+ $resparms[$number]=$content;
+ }
}
}
# ------------------------------------------------------- Is this a linear map?
@@ -84,13 +221,13 @@ sub mapread {
my ($start,$end,$cond)=split(/\:/,$_);
if ((defined($starters[$start])) || (defined($endings[$end]))) {
return
- ('Map has branchings. Use advanced editor.',1);
+ (&mt('Map has branchings. Use advanced editor.'),1);
}
$starters[$start]=1;
$endings[$end]=1;
if ($cond) {
return
- ('Map has conditions. Use advanced editor.',1);
+ (&mt('Map has conditions. Use advanced editor.'),1);
}
}
@@ -99,7 +236,7 @@ sub mapread {
if (defined($resources[$i])) {
unless (($starters[$i]) || ($endings[$i])) {
return
- ('Map has unconnected resources. Use advanced editor.',1);
+ (&mt('Map has unconnected resources. Use advanced editor.'),1);
}
}
}
@@ -278,12 +415,15 @@ sub buttons {
my $adv=shift;
my $output='<form method=post>';
if ($adv==1) {
- $output.='<input type=submit name=forceadv value="Edit">';
+ $output.='<input type=submit name=forceadv value="'.&mt('Edit').'">'.
+ &Apache::loncommon::help_open_topic('Sequence_Advanced_Editor_Creation');;
} else {
unless ($adv==2) {
- $output.='<input type=submit name=forcesmp value="Simple Edit">';
+ $output.='<input type=submit name=forcesmp value="'.&mt('Simple Edit').'">'.
+ &Apache::loncommon::help_open_topic('Sequence_Simple_Editor_Creation');
}
- $output.='<input type=submit name=forceadv value="Advanced Edit">';
+ $output.='<input type=submit name=forceadv value="'.&mt('Advanced Edit').'">'.
+ &Apache::loncommon::help_open_topic('Sequence_Advanced_Editor_Creation');
}
return $output.'</form><hr>';
}
@@ -375,6 +515,13 @@ sub storemap {
if (defined($resources[$order[$i]])) {
$output.='<&>objcont<:>'.$order[$i].'<:>'.$resources[$order[$i]];
}
+ if (defined($resparms[$order[$i]])) {
+ foreach (split('&&&',$resparms[$order[$i]])) {
+ if ($_) {
+ $output.='<&>objparms<:>'.$order[$i].'<:>'.$_;
+ }
+ }
+ }
if (defined($order[$i+1])) {
if (defined($resources[$order[$i+1]])) {
$output.='<&>objlinks<:>'.$k.'<:>'.
@@ -389,8 +536,61 @@ sub storemap {
&Apache::lonratsrv::loadmap($fn,&Apache::lonratsrv::savemap($fn,''));
}
+# ------------------------------------------ Store and get parameters in global
+
+sub storeparameter {
+ my ($to,$name,$value,$ptype)=@_;
+ my $newentry='';
+ my $nametype='';
+ foreach (split('&&&',$resparms[$to])) {
+ my ($thistype,$thisname,$thisvalue)=split('___',$_);
+ if ($thisname) {
+ unless ($thisname eq $name) {
+ $newentry.=$_.'&&&';
+ } else {
+ $nametype=$thistype;
+ }
+ }
+ }
+ unless ($ptype) { $ptype=$nametype; }
+ unless ($ptype) { $ptype='string'; }
+ $newentry.=$ptype.'___'.$name.'___'.$value;
+ $resparms[$to]=$newentry;
+}
+
+sub delparameter {
+ my ($to,$name)=@_;
+ my $newentry='';
+ my $nametype='';
+ foreach (split('&&&',$resparms[$to])) {
+ my ($thistype,$thisname,$thisvalue)=split('___',$_);
+ if ($thisname) {
+ unless ($thisname eq $name) {
+ $newentry.=$_.'&&&';
+ }
+ }
+ }
+ $resparms[$to]=$newentry;
+}
+
+sub getparameter {
+ my ($to,$name);
+ my $value=undef;
+ my $ptype=undef;
+ foreach (split('&&&',$resparms[$to])) {
+ my ($thistype,$thisname,$thisvalue)=split('___',$_);
+ if ($thisname eq $name) {
+ $value=$thisvalue;
+ $ptype=$thistype;
+ }
+ }
+ return ($value,$ptype);
+}
+
+# ----------------------------------------------------------------- Edit script
sub editscript {
my $mode=shift;
+ my $resurl=&Apache::loncommon::lastresurl();
return(<<ENDSCRIPT);
var srch;
var srchflag=-1; // 1 means currently open
@@ -435,7 +635,7 @@ function idxopen(mode) {
var options="scrollbars=1,resizable=1,menubar=0";
idxmode=mode;
idxflag=1;
- idx=open("/res/?launch=1&mode=$mode&catalogmode="+mode,"idxout",options);
+ idx=open("$resurl/?launch=1&mode=$mode&catalogmode="+mode,"idxout",options);
idx.focus();
}
@@ -474,7 +674,7 @@ function idxcheck(mode) {
var editbrowser;
function openbrowser(formname,elementname,only,omit) {
- var url = '/res/?';
+ var url = '$resurl/?';
if (editbrowser == null) {
url += 'launch=1&';
}
@@ -518,7 +718,7 @@ sub smpedt {
}
if (-e $tmpfn) {
$targetmsg=
- '<b><font color="red">You are working with an unsaved version of your map.</font></b><br>';
+ '<b><font color="red">'.&mt('You are working with an unsaved version of your map.').'</font></b><br>';
my ($errtext,$fatal)=&mapread($tmpfn,'');
}
# ---------------------------------------------------------- Process form input
@@ -742,7 +942,7 @@ sub smpedt {
$importdetail='&'.$importdetail;
$importdetail=~s/^\&+/\&/;
my $importwindow=
- '<option value="-1"> ---- Import and Paste Area ---- </option>'.
+ '<option value="-1"> ---- '.&mt('Import and Paste Area').' ---- </option>'.
join("\n",map {
$idx++;
if ($_) {
@@ -757,7 +957,7 @@ sub smpedt {
$idx=0;
$targetdetail='';
my $targetwindow=
- '<option value="0"> ------- Target Edit Map ------- </option>'.
+ '<option value="0"> ------- '.&mt('Target Edit Map').' ------- </option>'.
join("\n",map {
my ($name,$url)=split(/\:/,$resources[$_]);
unless ($name) { $name=(split(/\//,$url))[-1]; }
@@ -771,7 +971,30 @@ sub smpedt {
# ----------------------------------------------------- Start simple RAT screen
my $editscript=&editscript('simple');
- my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1);
+ my $bodytag=&Apache::loncommon::bodytag(undef,undef,undef,1).
+ &Apache::loncommon::help_open_topic('Sequence_Simple_Editor_Creation').
+ &Apache::loncommon::help_open_faq(6).
+ &Apache::loncommon::help_open_bug('RAT');
+ my %lt=&Apache::lonlocal::texthash(
+ 'sa' => 'Save',
+ 'nt' => 'New Title',
+ 'se' => 'Search',
+ 'im' => 'Import',
+ 'vi' => 'View',
+ 'lm' => 'Load Map',
+ 'ds' => 'Discard Selected',
+ 'ca' => 'Clear All',
+ 'ta' => 'Temporary Assembly Workspace',
+ 'rv' => 'Revert to Last Saved',
+ 'sa' => 'Save',
+ 'mu' => 'Move Up',
+ 'md' => 'Move Down',
+ 're' => 'Rename',
+ 'as' => 'after selected',
+ 'cs' => 'Cut selected',
+ 'ps' => 'Copy selected',
+ 'pas' => 'Paste after selected',
+ );
$r->print(<<ENDSMPHEAD);
<html>
<head>
@@ -808,7 +1031,7 @@ sub smpedt {
oldname=unescape(nameparts.join('"'));
nameparts=oldname.split(''');
oldname=unescape(nameparts.join("'"));
- newtitle=prompt('New Title',oldname);
+ newtitle=prompt('$lt{'nt'}',oldname);
if (newtitle) {
document.forms.simpleedit.renameres.value=1;
document.forms.simpleedit.renameidx.value=selidx;
@@ -828,37 +1051,37 @@ $buttons
<input type=hidden name=renametitle value=''>
<input type=hidden name=renameidx value=0>
<table>
- <tr><th width="40%">Temporary Assembly Workspace</th>
+ <tr><th width="40%">$lt{'ta'}</th>
<th> </th>
<th width="40%">File: $url</th></tr>
<tr><td bgcolor="#FFFFCC">
-<input type=button onClick="javascript:groupsearch()" value="Search">
-<input type=button onClick="javascript:groupimport();" value="Import">
-after selected
+<input type=button onClick="javascript:groupsearch()" value="$lt{'se'}">
+<input type=button onClick="javascript:groupimport();" value="$lt{'im'}">
+$lt{'as'}
<hr>
<input type=text size=20 name=importmap>
<input type=button
onClick="javascript:openbrowser('simpleedit','importmap','sequence,page','')"
-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">
+value="Select Map"><input type=submit name=loadmap value="$lt{'lm'}"><hr>
+<input type=submit name="discard" value="$lt{'ds'}">
+<input type=submit name="clear" value="$lt{'ca'}">
+<input type=button onClick="javascript:viewimport()" value="$lt{'vi'}">
</td><td> </td><td bgcolor="#FFFFCC">
<input type=button onClick=
-"javascript:impfortarget.value=1;groupsearch()" value="Search">
+"javascript:impfortarget.value=1;groupsearch()" value="$lt{'se'}">
<input type=button onClick=
-"javascript:impfortarget.value=1;groupimport();" value="Import">
-after selected
+"javascript:impfortarget.value=1;groupimport();" value="$lt{'im'}">
+$lt{'as'}
<hr>
-<input type=submit name="moveup" value="Move Up">
-<input type=submit name="movedown" value="Move Down">
-<input type=button onClick="javascript:renametarget()" value="Rename">
+<input type=submit name="moveup" value="$lt{'mu'}">
+<input type=submit name="movedown" value="$lt{'md'}">
+<input type=button onClick="javascript:renametarget()" value="$lt{'re'}">
<hr>$targetmsg
-<input type=submit name="revert" value="Revert to Last Saved">
-<input type=submit name="save" value="Save">
-<input type=button onClick="javascript:viewtarget()" value="View">
+<input type=submit name="revert" value="$lt{'rv'}">
+<input type=submit name="save" value="$lt{'sa'}">
+<input type=button onClick="javascript:viewtarget()" value="$lt{'vi'}">
</td></tr>
<tr><td bgcolor="#FFFFCC"><select name="importsel" size=10 multiple>
@@ -866,13 +1089,13 @@ $importwindow
</select>
</td>
<td bgcolor="#FFFFAA" align="center">
-Cut selected<br>
+$lt{'cs'}<br>
<input type=submit name=cut value='<<<'><p>
<hr>
-Copy selected<br>
+$lt{'ps'}<br>
<input type=submit name=copy value='<--'><p>
<hr>
-Paste after selected<br>
+$lt{'pas'}<br>
<input type=submit name=paste value='-->'>
</td>
<td bgcolor="#FFFFCC"><select name="target" size=10 multiple>
@@ -907,14 +1130,16 @@ sub viewmap {
my ($r,$url,$adv,$errtext)=@_;
$r->print('<html>'.
&Apache::loncommon::bodytag('Edit Content of a Map').
- &buttons($adv));
+ &Apache::loncommon::help_open_faq(6).
+ &Apache::loncommon::help_open_bug('RAT').
+ &buttons($adv));
if ($errtext) {
- $r->print($errtext.'<hr>');
+ $r->print($errtext.'<hr />');
}
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 />');
+ $r->print('<p><b><font color="red">'.&mt('Map contents are not shown in order.').'</font></b></p><br />');
}
foreach (&attemptread(&Apache::lonnet::filelocation('',$url))) {
if (defined($_)) {
@@ -939,11 +1164,17 @@ sub viewmap {
sub handler {
my $r=shift;
- $r->content_type('text/html');
+ &Apache::loncommon::content_type($r,'text/html');
$r->send_http_header;
return OK if $r->header_only;
-
+ my $target = $ENV{'form.grade_target'};
+ if ($target eq 'meta') {
+ &Apache::loncommon::content_type($r,'text/html');
+ $r->send_http_header;
+ return OK;
+ }
+
my $url=$r->uri;
my $fn=&Apache::lonnet::filelocation('',$url);