--- rat/lonratedt.pm 2002/05/16 21:10:05 1.20 +++ rat/lonratedt.pm 2009/08/14 02:16:31 1.94.2.1 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Edit Handler for RAT Maps # -# $Id: lonratedt.pm,v 1.20 2002/05/16 21:10:05 www Exp $ +# $Id: lonratedt.pm,v 1.94.2.1 2009/08/14 02:16:31 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -25,316 +25,234 @@ # # 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; - -my @order=(); -my @resources=(); +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)=@_; + my %layout = ('border' => "0"); + if ($env{'environment.remote'} eq 'off') { + $layout{'rows'} = "1,250,*"; + } else { + $layout{'rows'} = "1,70,*"; + } + my $js =' +'; -# 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; + my $start_page = + &Apache::loncommon::start_page('Edit Sequence',$js, + {'frameset' => 1, + 'add_entries' => \%layout}); + my $end_page = + &Apache::loncommon::end_page({'frameset' => 1}); - my @links; - undef @links; - undef @resources; - undef @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; - } - } -# ------------------------------------------------------- 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); - } - } - - } - for (my $i=0; $i<=$#resources; $i++) { - if (defined($resources[$i])) { - unless (($starters[$i]) || ($endings[$i])) { - return - ('Map has unconnected resources. Use advanced editor.',1); - } - } - } + $r->print(< + + +$end_page +ENDDOCUMENT +} -# -------------------------------------------------- This is a linear map, sort +# ---------------------------------------------------------------- Make buttons - 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; - } +sub buttons { + my $adv=shift; + my $output='
'; + if ($adv==1) { + $output.=''. + &Apache::loncommon::help_open_topic('Sequence_Advanced_Editor_Creation'); + } else { + unless ($adv==2) { + $output.=''. + &Apache::loncommon::help_open_topic('Sequence_Simple_Editor_Creation'); } - if ($currentidx==$endidx) { last; } + $output.=''. + &Apache::loncommon::help_open_topic('Sequence_Advanced_Editor_Creation'); } - return $errtext; + return $output.'

'; } -# ---------------------------------------------- Read a map as well as possible - -sub attemptread { - my $fn=shift; - - 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; - } - } +# ----------------------------------------------------------------- Edit script +sub editscript { + my $mode=shift; + my $resurl= + &Apache::loncommon::escape_single(&Apache::loncommon::lastresurl()); + return(<print(< - - - - - - - - - +// --------------------------------------------------------- Open search window +function srchopen(mode) { + var options="scrollbars=1,resizable=1,menubar=0"; + srchmode=mode; + srchflag=1; + srch=open("/adm/searchcat?inhibitmenu=yes&launch=1&mode=$mode&catalogmode="+mode,"srchout",options); + srch.focus(); +} +// ----------------------------------------------------- launch indexer browser +function groupsearch() { + srchcheck('import'); +} -ENDDOCUMENT +function groupimport() { + idxcheck('import'); } -# ---------------------------------------------------------------- Make buttons +// ------------------------------------------------------- Do srch status check +function srchcheck(mode) { + if (!srch || srch.closed || srchmode!=mode) { + srchopen(mode); + } + srch.focus(); +} -sub buttons { - my $adv=shift; - my $output='
'; - if ($adv==1) { - $output.=''; - } else { - unless ($adv==2) { - $output.=''; - } - $output.=''; - } - return $output.'

'; +// -------------------------------------------------------- Do idx status check +function idxcheck(mode) { + if (!idx || idx.closed || idxmode!=mode) { + idxopen(mode); + } + idx.focus(); } -# ----------------------------------------------------------- Paste into target -# modifies @order, @resources -sub pastetarget { - my ($after,@which)=@_; - my @insertorder=(); - foreach (@which) { - if (defined($_)) { - my ($name,$url)=split(/\=/,$_); - my $idx=$#resources+1; - $insertorder[$#insertorder+1]=$idx; - my $ext='false'; - if ($url=~/^http\:\/\//) { $ext='true'; } - $resources[$idx]=$name.':'.$url.':normal:'.$ext.':res'; + var editbrowser; + function openbrowser(formname,elementname,only,omit) { + var url = '$resurl/?'; + if (editbrowser == null) { + url += 'launch=1&'; } + url += 'inhibitmenu=yes&'; + url += 'catalogmode=interactive&'; + url += 'mode=edit&'; + url += 'form=' + formname + '&'; + if (only != null) { + url += 'only=' + only + '&'; + } + if (omit != null) { + url += 'omit=' + omit + '&'; + } + url += 'element=' + elementname + ''; + var title = 'Browser'; + var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1'; + options += ',width=700,height=600'; + editbrowser = open(url,title,options,'1'); + editbrowser.focus(); } - print "insertorder:".join(',',@insertorder).'
'; - print "order:".join(',',@order).'
'; - my @oldorder=splice(@order,$after,$#insertorder+1,@insertorder); - print "oldorder:".join(',',@oldorder).'
'; - print "order:".join(',',@order).'
'; - @order=push(@order,@oldorder); - print "order:".join(',',@order).'
'; +ENDSCRIPT } - # ------------------------------------------------------- Simple edit processor sub smpedt { - my ($r,$errtext)=@_; + my ($r,$url,$errtext)=@_; my $buttons=&buttons(2); - -# ---------------------------------------------------------- Process form input - - my @importselect=(); - my @targetselect=(); - undef @importselect; - undef @targetselect; - if (defined($ENV{'form.import'})) { - if (ref($ENV{'form.import'})) { - @importselect=sort($ENV->{'form.import'}); + my $tmpfn=&Apache::lonnet::filelocation('',$url).'.tmp'; + my $targetmsg=''; + if ($env{'form.save'}) { + copy($tmpfn,&Apache::lonnet::filelocation('',$url)); + unlink($tmpfn); + my ($errtext,$fatal)= + &LONCAPA::map::mapread(&Apache::lonnet::filelocation('',$url),''); + unless ($fatal) { + $targetmsg=''.&mt('Saved.').'
'; } else { - @importselect=($ENV{'form.import'}); + $targetmsg=''.&mt('An error occurred while saving.').'
'; } } - if (defined($ENV{'form.target'})) { - if (ref($ENV{'form.target'})) { - @targetselect=sort($ENV->{'form.target'}); - } else { - @targetselect=($ENV{'form.target'}); - } + if ($env{'form.revert'}) { + $targetmsg=''.&mt('Reverted.').'
'; + unlink($tmpfn); + my ($errtext,$fatal)= + &LONCAPA::map::mapread(&Apache::lonnet::filelocation('',$url),''); } + if (-e $tmpfn) { + $targetmsg= + ''.&mt('You are working with an unsaved version of your map.').'
'; + my ($errtext,$fatal)=&LONCAPA::map::mapread($tmpfn,''); + } +# ---------------------------------------------------------- Process form input + + my @importselect=&Apache::loncommon::get_env_multiple('form.importsel'); + my @targetselect=&Apache::loncommon::get_env_multiple('form.target'); # ============================================================ Process commands - my $targetdetail=$ENV{'form.targetdetail'}; - my $importdetail=$ENV{'form.curimpdetail'}; + my $targetdetail=$env{'form.targetdetail'}; + my $importdetail=$env{'form.curimpdetail'}; # ---------------------------------------------------- Importing from groupsort - if (($ENV{'form.importdetail'}) && (!$ENV{'form.impfortarget'})) { + if (($env{'form.importdetail'}) && (!$env{'form.impfortarget'})) { $importdetail=''; - my @curimport=split(/\&/,$ENV{'form.curimpdetail'}); + my @curimport=split(/\&/,$env{'form.curimpdetail'}); my $lastsel; @@ -351,7 +269,7 @@ sub smpedt { } } - $importdetail.='&'.$ENV{'form.importdetail'}; + $importdetail.='&'.$env{'form.importdetail'}; for (my $i=$lastsel+1;$i<=$#curimport;$i++) { my ($name,$url)=split(/\=/,$curimport[$i]); @@ -363,12 +281,12 @@ sub smpedt { $importdetail=~s/^\&//; # ------------------------------------------------------------------- Clear all - } elsif ($ENV{'form.clear'}) { + } elsif ($env{'form.clear'}) { $importdetail=''; # ------------------------------------------------------------ Discard selected - } elsif ($ENV{'form.discard'}) { + } elsif ($env{'form.discard'}) { $importdetail=''; - my @curimport=split(/\&/,$ENV{'form.curimpdetail'}); + my @curimport=split(/\&/,$env{'form.curimpdetail'}); foreach (@importselect) { $curimport[$_]=''; } @@ -379,9 +297,9 @@ sub smpedt { } } # --------------------------------------------------------- Loading another map - } elsif ($ENV{'form.loadmap'}) { + } elsif ($env{'form.loadmap'}) { $importdetail=''; - my @curimport=split(/\&/,$ENV{'form.curimpdetail'}); + my @curimport=split(/\&/,$env{'form.curimpdetail'}); my $lastsel; @@ -399,11 +317,11 @@ sub smpedt { } foreach ( - &attemptread(&Apache::lonnet::filelocation('',$ENV{'form.importmap'}))) { + &Apache::lonsequence::attemptread(&Apache::lonnet::filelocation('',$env{'form.importmap'}))) { my ($name,$url)=split(/\:/,$_); if ($url) { - $importdetail.='&'.&Apache::lonnet::escape($name).'='. - &Apache::lonnet::escape($url); + $importdetail.='&'.&escape($name).'='. + &escape($url); } } @@ -417,278 +335,399 @@ sub smpedt { $importdetail=~s/^\&//; # ------------------------------------------------ Groupimport/search to target - } elsif ($ENV{'form.importdetail'}) { + } elsif ($env{'form.importdetail'}) { my $lastsel; - if (defined($targetselect[-1])) { $lastsel=$targetselect[-1]; } else { - $lastsel=$#order; + $lastsel=$#LONCAPA::map::order+1; } - &pastetarget($lastsel,split(/\&/,$ENV{'form.importdata'})); + &LONCAPA::map::pastetarget($lastsel,split(/\&/,$env{'form.importdetail'})); + &LONCAPA::map::storemap(&Apache::lonnet::filelocation('',$url)); # ------------------------------------------------------------------------- Cut - } elsif ($ENV{'form.cut'}) { + } elsif (($env{'form.cut'}) || ($env{'form.copy'})) { + $importdetail=''; + my @curimport=split(/\&/,$env{'form.curimpdetail'}); + + my $lastsel; + + if (defined($importselect[-1])) { + $lastsel=$importselect[-1]; + } else { + $lastsel=$#curimport; + } + + for (my $i=0;$i<=$lastsel;$i++) { + my ($name,$url)=split(/\=/,$curimport[$i]); + if ($url) { + $importdetail.='&'.$name.'='.$url; + } + } + + foreach (@targetselect) { + my ($name,$url)=split(/\:/,$LONCAPA::map::resources[$LONCAPA::map::order[$_-1]]); + if ($url) { + $importdetail.='&'.&escape($name).'='. + &escape($url); + } + } + + for (my $i=$lastsel+1;$i<=$#curimport;$i++) { + my ($name,$url)=split(/\=/,$curimport[$i]); + if ($url) { + $importdetail.='&'.$name.'='.$url; + } + } + $importdetail=~s/\&+/\&/g; + $importdetail=~s/^\&//; + + if ($env{'form.cut'}) { + my @neworder=(); + for (my $i=0;$i<=$#LONCAPA::map::order;$i++) { + my $include=1; + foreach (@targetselect) { + if ($_-1==$i) { $include=0; } + } + if ($include) { + $neworder[$#neworder+1]=$LONCAPA::map::order[$i]; + } else { + &LONCAPA::map::makezombie($LONCAPA::map::order[$i]); + } + } + @LONCAPA::map::order=@neworder; + &LONCAPA::map::storemap(&Apache::lonnet::filelocation('',$url)); + } + # ----------------------------------------------------------------------- Paste - } elsif ($ENV{'form.paste'}) { -# ------------------------------------------------ + } elsif ($env{'form.paste'}) { + my $lastsel; + if (defined($targetselect[-1])) { + $lastsel=$targetselect[-1]; + } else { + $lastsel=$#LONCAPA::map::order+1; + } + my @newsequence; + my @curimport=split(/\&/,$env{'form.curimpdetail'}); + foreach (@importselect) { + $newsequence[$#newsequence+1]=$curimport[$_]; + } + &LONCAPA::map::pastetarget($lastsel,@newsequence); + &LONCAPA::map::storemap(&Apache::lonnet::filelocation('',$url)); +# -------------------------------------------------------------------- Move up + } elsif ($env{'form.moveup'}) { + foreach (sort @targetselect) { + if ($_-1>0) { + my $movethis=$LONCAPA::map::order[$_-1]; + $LONCAPA::map::order[$_-1]=$LONCAPA::map::order[$_-2]; + $LONCAPA::map::order[$_-2]=$movethis; + } + } + &LONCAPA::map::storemap(&Apache::lonnet::filelocation('',$url)); +# ------------------------------------------------------------------ Move down + } elsif ($env{'form.movedown'}) { + foreach (reverse sort @targetselect) { + if ($_-1<$#LONCAPA::map::order) { + my $movethis=$LONCAPA::map::order[$_-1]; + $LONCAPA::map::order[$_-1]=$LONCAPA::map::order[$_]; + $LONCAPA::map::order[$_]=$movethis; + } + } + &LONCAPA::map::storemap(&Apache::lonnet::filelocation('',$url)); +# --------------------------------------------------------------------- Rename + } elsif ($env{'form.renameres'}) { + my $residx=$LONCAPA::map::order[$env{'form.renameidx'}-1]; + my ($name,@resrest)=split(/\:/,$LONCAPA::map::resources[$residx]); + $name=$env{'form.renametitle'}; + $name=~s/\:/\&colon\;/g; + $LONCAPA::map::resources[$residx]=$name.':'.join(':',@resrest); + &LONCAPA::map::storemap(&Apache::lonnet::filelocation('',$url)); } # ------------------------------------------------------------ Assemble windows my $idx=-1; - my $importwindow=join("\n",map { + $importdetail='&'.$importdetail; + $importdetail=~s/^\&+/\&/; + my $importwindow= + ''. + join("\n",map { $idx++; if ($_) { my ($name,$url)=split(/\=/,$_); unless ($name) { $name=(split(/\//,$url))[-1]; } unless ($name) { $name='EMPTY'; } - ''; } } split(/\&/,$importdetail)); $idx=0; - my $targetwindow=join("\n",map { - my ($name,$url)=split(/\:/,$resources[$_]); + $targetdetail=''; + my $targetwindow= + ''. + join("\n",map { + my ($name,$url)=split(/\:/,$LONCAPA::map::resources[$_]); unless ($name) { $name=(split(/\//,$url))[-1]; } unless ($name) { $name='EMPTY'; } - $targetdetail.='&'.&Apache::lonnet::escape($name).'='. - &Apache::lonnet::escape($url); + $name = &LONCAPA::map::qtescape($name); + $url = &LONCAPA::map::qtescape($url); + $targetdetail.='&'.&escape($name).'='. + &escape($url); $idx++; + $name = &HTML::Entities::encode($name,'\'"<>&'); ''; - } @order); + } @LONCAPA::map::order); # ----------------------------------------------------- Start simple RAT screen - $r->print(< - - - - +ENDJS + + my $start_page = &Apache::loncommon::start_page(undef,$js). + &Apache::loncommon::help_open_menu('Sequence_Simple_Editor_Creation', + 'Sequence_Simple_Editor_Creation', + 6,'RAT'); + my $end_page = &Apache::loncommon::end_page(); + + $r->print(<$errtext -
- +$errtext + + + + + - + - + - -
Import
$lt{'ta'}  Target
File: $url
- - -after selected -
- - + +$lt{'as'} +
+ +
- - - +value="Select Map" />
+ + +
  - - -after selected -
+ + + + +$lt{'as'} +
+ + + +
$targetmsg + + +
-Cut selected
-

-


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

+


+$lt{'ps'}
+

+ +$lt{'pas'}
+

- - - - + + + +
- +$end_page ENDSMPHEAD } # ----------------------------------------------------------------- No such dir sub nodir { my ($r,$dir)=@_; - $dir=~s/^\/home\/\w+\/public\_html//; - $r->print(< - -

No such directory: $dir

- - -ENDNODIR + $dir=~s{^/home/$LONCAPA::username_re/public_html}{}; + $r->print(&Apache::loncommon::start_page(undef,undef, + {'only_body' => 1, + 'bgcolor' => '#FFFFFF',}). + '

'. + &mt('No such directory: [_1]',''.$dir.''). + '

'. + &Apache::loncommon::end_page()); } # ---------------------------------------------------------------- View Handler sub viewmap { my ($r,$url,$adv,$errtext)=@_; - $r->print(''.&buttons($adv)); + $r->print( + &Apache::loncommon::start_page('Edit Content of a Map'). + &Apache::loncommon::help_open_menu('','',6,'RAT'). + &buttons($adv)); if ($errtext) { - $r->print($errtext.'
'); - } - foreach (&attemptread(&Apache::lonnet::filelocation('',$url))) { + $r->print('
' + .$errtext + .'
' + .'
' + ); + } + my $idx=0; + $r->print('

'.$url.'

'); + if ($adv) { + $r->print('

' + .&mt('Map contents are not shown in order.') + .'


' + ); + } + $r->print(&Apache::loncommon::start_data_table() + .&Apache::loncommon::start_data_table_header_row() + .''.&mt('Type').'' + .''.&mt('Title in map').'' + .''.&mt('Filename of resource').'' + .''.&mt('Link to published resource').'' + .''.&mt('Link to resource in Construction Space').'' + .&Apache::loncommon::end_data_table_header_row() + ); + foreach (&LONCAPA::map::attemptread(&Apache::lonnet::filelocation('',$url))) { if (defined($_)) { - my ($title,$url)=split(/\:/,$_); - $title=~s/\&colon\;/\:/g; - $url=~s/\&colon\;/\:/g; + $idx++; + my ($title,$url,$cond)=split(/\:/,$_); + if ($cond eq 'cond') { next; } + $title= &LONCAPA::map::qtescape($title); + $url = &LONCAPA::map::qtescape($url); unless ($title) { $title=(split(/\//,$url))[-1] }; - unless ($title) { $title='Empty'; } + unless ($title) { $title=''.&mt('Empty').''; } + my $resurl = $url; + my $resfilepath = $Apache::lonnet::perlvar{'lonDocRoot'}.$resurl; + my $filename; + if ($resurl =~ m#/([^/]+)$#) { + $filename = $1; + } + my $cstrurl = $resurl; + $cstrurl =~ s#^/res/[^/]+/([^/]+)/#/priv/$1/#; + $r->print(&Apache::loncommon::start_data_table_row() + .'' + .'' + .'' + .'' + .&HTML::Entities::encode(&LONCAPA::map::qtescape($title)) + .'' + .''.$filename.'' + .'' + ); if ($url) { - $r->print(''); + $r->print(''.&mt('Resource space').''); + } else { + $r->print(' '); } - $r->print(&Apache::lonratsrv::qtescape($title)); - if ($url) { $r->print(''); } - $r->print('
'); + $r->print(''); + if ($url) { + $r->print(''. + &mt('Construction space').''); + } else { + $r->print(' '); + } + $r->print('' + .&Apache::loncommon::end_data_table_row() + ); } } - $r->print(''); + $r->print(&Apache::loncommon::end_data_table()); + $r->print(&Apache::loncommon::end_page()); } # ================================================================ Main Handler 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); @@ -701,8 +740,8 @@ sub handler { # ------------------------------------------- Determine which tools can be used my $adv=0; - unless ($ENV{'form.forcesmp'}) { - if ($ENV{'form.forceadv'}) { + unless ($env{'form.forcesmp'}) { + if ($env{'form.forceadv'}) { $adv=1; } elsif (my $fh=Apache::File->new($fn)) { my $allmap=join('',<$fh>); @@ -714,16 +753,16 @@ sub handler { my $fatal=0; # -------------------------------------------------------------------- Load map - ($errtext,$fatal)=&mapread($fn,$errtext); + ($errtext,$fatal)=&LONCAPA::map::mapread($fn,$errtext); if ($fatal==1) { $adv=1; } # ----------------------------------- adv==1 now means "graphical MUST be used" - if ($ENV{'form.forceadv'}) { + if ($env{'form.forceadv'}) { &ratedt($r,$url); - } elsif ($ENV{'form.forcesmp'}) { - &smpedt($r,$errtext); + } elsif ($env{'form.forcesmp'}) { + &smpedt($r,$url,$errtext); } else { &viewmap($r,$url,$adv,$errtext); } @@ -735,7 +774,140 @@ __END__ +=pod + +=head1 NAME + +Apache::lonratedt: simple 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