--- rat/lonratedt.pm 2003/04/07 20:47:06 1.44 +++ rat/lonratedt.pm 2004/11/17 20:14:23 1.63 @@ -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.63 2004/11/17 20:14:23 raeburn 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} + + +~~ + +~~~~ + +~~ + +~~~~ + +~~ + +~~~~ + +~~ + +~~~~ + +~~ + +~~~~ + +~~ + +~~~~ + +~~ + +~~ + +~~ + +~~ + +~~ +\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; -use vars qw(@order @resources); +use vars qw(@order @resources @resparms); # Mapread read maps into global arrays @links and @resources, determines status @@ -54,8 +187,10 @@ sub mapread { undef @links; undef @resources; undef @order; + undef @resparms; @resources=(''); @order=(); + @resparms=(); my ($outtext,$errtext)=&Apache::lonratsrv::loadmap($fn,''); if ($errtext) { return ($errtext,2); } @@ -70,7 +205,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 +223,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 +238,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); } } } @@ -254,6 +393,10 @@ sub attemptread { # --------------------------------------------------------- Build up RAT screen sub ratedt { my ($r,$url)=@_; + my $frameset = ''; + if ($ENV{'environment.remote'} eq 'off') { + $frameset = ''; + } $r->print(< @@ -262,9 +405,9 @@ sub ratedt { var flag=0; - +$frameset - + @@ -278,12 +421,15 @@ sub buttons { my $adv=shift; my $output='
'; if ($adv==1) { - $output.=''; + $output.=''. + &Apache::loncommon::help_open_topic('Sequence_Advanced_Editor_Creation');; } else { unless ($adv==2) { - $output.=''; + $output.=''. + &Apache::loncommon::help_open_topic('Sequence_Simple_Editor_Creation'); } - $output.=''; + $output.=''. + &Apache::loncommon::help_open_topic('Sequence_Advanced_Editor_Creation'); } return $output.'

'; } @@ -375,6 +521,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 +542,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(<
'; + } else { + $targetmsg=''.&mt('An error occured while saving.').'
'; + } } if ($ENV{'form.revert'}) { - $targetmsg='Reverting ...
'; + $targetmsg=''.&mt('Reverted.').'
'; unlink($tmpfn); my ($errtext,$fatal)= &mapread(&Apache::lonnet::filelocation('',$url),''); } if (-e $tmpfn) { $targetmsg= - 'You are working with an unsaved version of your map.
'; + ''.&mt('You are working with an unsaved version of your map.').'
'; my ($errtext,$fatal)=&mapread($tmpfn,''); } # ---------------------------------------------------------- Process form input @@ -742,7 +952,7 @@ sub smpedt { $importdetail='&'.$importdetail; $importdetail=~s/^\&+/\&/; my $importwindow= - ''. + ''. join("\n",map { $idx++; if ($_) { @@ -757,7 +967,7 @@ sub smpedt { $idx=0; $targetdetail=''; my $targetwindow= - ''. + ''. join("\n",map { my ($name,$url)=split(/\:/,$resources[$_]); unless ($name) { $name=(split(/\//,$url))[-1]; } @@ -771,7 +981,29 @@ 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, + ($ENV{'environment.remote'} ne 'off')). + &Apache::loncommon::help_open_menu('','Sequence_Simple_Editor_Creation','Sequence_Simple_Editor_Creation','',6,'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(< @@ -808,7 +1040,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 +1060,37 @@ $buttons - +
Temporary Assembly Workspace
$lt{'ta'}   File: $url
- - -after selected + + +$lt{'as'}

- - - +value="Select Map">
+ + +
  +"javascript:impfortarget.value=1;groupsearch()" value="$lt{'se'}"> -after selected +"javascript:impfortarget.value=1;groupimport();" value="$lt{'im'}"> +$lt{'as'}
- - - + + +
$targetmsg - - - + + +
-Cut selected
+$lt{'cs'}


-Copy selected
+$lt{'ps'}


-Paste after selected
+$lt{'pas'}