[BACK]Return to lonhtmlcommon.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonhtmlcommon.pm between versions 1.182.2.1 and 1.253.2.7

version 1.182.2.1, 2009/01/12 01:53:38 version 1.253.2.7, 2010/12/02 13:47:17
Line 63  use Apache::lonnet; Line 63  use Apache::lonnet;
 use LONCAPA;  use LONCAPA;
   
   
   sub coursepreflink {
      my ($text,$category)=@_;
      if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
         return '<a href="/adm/courseprefs?phase=display&actions='.$category.'">'.$text.'</a>';
      } else {
         return '';
      }
   }
   
   sub raw_href_to_link {
      my ($message)=@_;
      $message=~s/(https?\:\/\/[^\s\'\"]+)(\s|$)/<a href="$1"><tt>$1<\/tt><\/a>$2/gi;
      return $message;
   }
   
   ##############################################
   ##############################################
   
   =pod
   
   =item confirm_success
   
   Successful completion of an operation message
   
   =cut
   
   sub confirm_success {
      my ($message,$failure)=@_;
      if ($failure) {
         return '<span class="LC_error">'."\n"
               .'<img src="/adm/lonIcons/navmap.wrong.gif" alt="'.&mt('Error').'" /> '."\n"
               .$message."\n"
               .'</span>'."\n";
      } else {
         return '<span class="LC_success">'."\n"
               .'<img src="/adm/lonIcons/navmap.correct.gif" alt="'.&mt('OK').'" /> '."\n"
               .$message."\n"
               .'</span>'."\n";
      }
   }
   
 ##############################################  ##############################################
 ##############################################  ##############################################
   
Line 86  sub dragmath_button { Line 127  sub dragmath_button {
     }      }
     my $buttontext=&mt('Edit Math');      my $buttontext=&mt('Edit Math');
     return <<ENDDRAGMATH;      return <<ENDDRAGMATH;
                 <input type="button" value="$buttontext", onclick="javascript:mathedit('$textarea',document)" />$help_text                  <input type="button" value="$buttontext" onclick="javascript:mathedit('$textarea',document)" />$help_text
 ENDDRAGMATH  ENDDRAGMATH
 }  }
   
Line 105  sub dragmath_js { Line 146  sub dragmath_js {
     my ($popup) = @_;      my ($popup) = @_;
     return <<ENDDRAGMATHJS;      return <<ENDDRAGMATHJS;
                 <script type="text/javascript">                  <script type="text/javascript">
                   // <![CDATA[
                   function mathedit(textarea, doc) {                    function mathedit(textarea, doc) {
                      targetEntry = textarea;                       targetEntry = textarea;
                      targetDoc   = doc;                       targetDoc   = doc;
                      newwin  = window.open("/adm/dragmath/applet/$popup.html","","width=565,height=500,resizable");                       newwin  = window.open("/adm/dragmath/applet/$popup.html","","width=565,height=500,resizable");
                   }                    }
                   // ]]>
                 </script>                  </script>
   
 ENDDRAGMATHJS  ENDDRAGMATHJS
Line 133  sub authorbombs { Line 176  sub authorbombs {
     $url=&Apache::lonnet::declutter($url);      $url=&Apache::lonnet::declutter($url);
     my ($udom,$uname)=($url=~m{^($LONCAPA::domain_re)/($LONCAPA::username_re)/});      my ($udom,$uname)=($url=~m{^($LONCAPA::domain_re)/($LONCAPA::username_re)/});
     my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);      my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);
     foreach (keys %bombs) {      foreach my $bomb (keys(%bombs)) {
  if ($_=~/^$udom\/$uname\//) {   if ($bomb =~ /^$udom\/$uname\//) {
     return '<a href="/adm/bombs/'.$url.      return '<a href="/adm/bombs/'.$url.
  '"><img src="'.&Apache::loncommon::lonhttpdurl('/adm/lonMisc/bomb.gif').'" border="0" /></a>'.   '"><img src="'.&Apache::loncommon::lonhttpdurl('/adm/lonMisc/bomb.gif').'" alt="'.&mt('Bomb').'" border="0" /></a>'.
  &Apache::loncommon::help_open_topic('About_Bombs');   &Apache::loncommon::help_open_topic('About_Bombs');
  }   }
     }      }
Line 195  sub select_recent { Line 238  sub select_recent {
  unless ($value =~/^error\:/) {   unless ($value =~/^error\:/) {
     my $escaped = &Apache::loncommon::escape_url($value);      my $escaped = &Apache::loncommon::escape_url($value);
     &Apache::loncommon::inhibit_menu_check(\$escaped);      &Apache::loncommon::inhibit_menu_check(\$escaped);
               if ($area eq 'residx') {
                   next if ((!&Apache::lonnet::allowed('bre',$value)) && (!&Apache::lonnet::allowed('bro',$value)));
               }
     $return.="\n<option value='$escaped'>".      $return.="\n<option value='$escaped'>".
  &unescape((split(/\&/,$recent{$value}))[1]).   &unescape((split(/\&/,$recent{$value}))[1]).
  '</option>';   '</option>';
Line 212  sub get_recent { Line 258  sub get_recent {
 # Begin filling return_hash with any 'always_include' option  # Begin filling return_hash with any 'always_include' option
     my %time_hash = ();      my %time_hash = ();
     my %return_hash = ();      my %return_hash = ();
     foreach my $item (keys %recent) {      foreach my $item (keys(%recent)) {
         my ($thistime,$thisvalue)=(split(/\&/,$recent{$item}));          my ($thistime,$thisvalue)=(split(/\&/,$recent{$item}));
         if ($thistime eq 'always_include') {          if ($thistime eq 'always_include') {
             $return_hash{$item} = &unescape($thisvalue);              $return_hash{$item} = &unescape($thisvalue);
Line 285  sub checkbox { Line 331  sub checkbox {
         $Str .= 'value="'.$value.'"';          $Str .= 'value="'.$value.'"';
     }       } 
     if ($checked) {      if ($checked) {
         $Str .= ' checked="1"';          $Str .= ' checked="checked"';
     }      }
     $Str .= ' />';      $Str .= ' />';
     return $Str;      return $Str;
Line 307  sub radio { Line 353  sub radio {
         $Str .= 'value="'.$value.'"';          $Str .= 'value="'.$value.'"';
     }       } 
     if ($checked eq $value) {      if ($checked eq $value) {
         $Str .= ' checked="1"';          $Str .= ' checked="checked"';
     }      }
     $Str .= ' />';      $Str .= ' />';
     return $Str;      return $Str;
Line 364  The method used to restrict user input w Line 410  The method used to restrict user input w
 ##############################################  ##############################################
 sub date_setter {  sub date_setter {
     my ($formname,$dname,$currentvalue,$special,$includeempty,$state,      my ($formname,$dname,$currentvalue,$special,$includeempty,$state,
         $no_hh_mm_ss,$defhour,$defmin,$defsec,$nolink) = @_;          $no_hh_mm_ss,$defhour,$defmin,$defsec,$nolink,$hide_timezone) = @_;
     my $now = time;      my $now = time;
     my $wasdefined=1;      my $wasdefined=1;
     if (! defined($state) || $state ne 'disabled') {      if (! defined($state) || $state ne 'disabled') {
Line 405  sub date_setter { Line 451  sub date_setter {
     my $result = "\n<!-- $dname date setting form -->\n";      my $result = "\n<!-- $dname date setting form -->\n";
     $result .= <<ENDJS;      $result .= <<ENDJS;
 <script type="text/javascript">  <script type="text/javascript">
   // <![CDATA[
     function $dname\_checkday() {      function $dname\_checkday() {
         var day   = document.$formname.$dname\_day.value;          var day   = document.$formname.$dname\_day.value;
         var month = document.$formname.$dname\_month.value;          var month = document.$formname.$dname\_month.value;
Line 465  document.$formname.$dname\_year.value, Line 512  document.$formname.$dname\_year.value,
         }          }
   
     }      }
   // ]]>
 </script>  </script>
 ENDJS  ENDJS
     $result .= '  <span style="white-space: nowrap;">';      $result .= '  <span class="LC_nobreak">';
     my $monthselector = qq{<select name="$dname\_month" $special $state onchange="javascript:$dname\_checkday()" >};      my $monthselector = qq{<select name="$dname\_month" $special $state onchange="javascript:$dname\_checkday()" >};
     # Month      # Month
     my @Months = qw/January February  March     April   May      June       my @Months = qw/January February  March     April   May      June 
Line 476  ENDJS Line 524  ENDJS
     unshift(@Months,'If you can read this an error occurred');      unshift(@Months,'If you can read this an error occurred');
     if ($includeempty) { $monthselector.="<option value=''></option>"; }      if ($includeempty) { $monthselector.="<option value=''></option>"; }
     for(my $m = 1;$m <=$#Months;$m++) {      for(my $m = 1;$m <=$#Months;$m++) {
         $monthselector .= qq{      <option value="$m" };          $monthselector .= qq{      <option value="$m"};
         $monthselector .= "selected " if ($m-1 eq $month);          $monthselector .= ' selected="selected"' if ($m-1 eq $month);
         $monthselector .= '> '.&mt($Months[$m]).' </option>';          $monthselector .= '> '.&mt($Months[$m]).' </option>'."\n";
     }      }
     $monthselector.= '  </select>';      $monthselector.= '  </select>';
     # Day      # Day
     my $dayselector = qq{<input type="text" name="$dname\_day" $state value="$mday" size="3" $special onchange="javascript:$dname\_checkday()" />};      my $dayselector = qq{<input type="text" name="$dname\_day" $state value="$mday" size="3" $special onchange="javascript:$dname\_checkday()" />};
     # Year      # Year
     my $yearselector = qq{<input type="year" name="$dname\_year" $state value="$year" size="5" $special onchange="javascript:$dname\_checkday()" />};      my $yearselector = qq{<input type="text" name="$dname\_year" $state value="$year" size="5" $special onchange="javascript:$dname\_checkday()" />};
     #      #
     my $hourselector = qq{<select name="$dname\_hour" $special $state >};      my $hourselector = qq{<select name="$dname\_hour" $special $state >};
     if ($includeempty) {       if ($includeempty) { 
         $hourselector.=qq{<option value=''></option>};          $hourselector.=qq{<option value=''></option>};
     }      }
     for (my $h = 0;$h<24;$h++) {      for (my $h = 0;$h<24;$h++) {
         $hourselector .= qq{<option value="$h" };          $hourselector .= qq{<option value="$h"};
         $hourselector .= "selected " if (defined($hour) && $hour == $h);          $hourselector .= ' selected="selected"' if (defined($hour) && $hour == $h);
         $hourselector .= ">";          $hourselector .= ">";
         my $timest='';          my $timest='';
         if ($h == 0) {          if ($h == 0) {
Line 515  ENDJS Line 563  ENDJS
         $cal_link = qq{<a href="javascript:$dname\_opencalendar()">};          $cal_link = qq{<a href="javascript:$dname\_opencalendar()">};
     }      }
     #      #
     my $tzone = ' '.$tzname.' ';      my $tzone;
       unless ($hide_timezone) {
           $tzone = ' '.$tzname.' ';
       }
     if ($no_hh_mm_ss) {      if ($no_hh_mm_ss) {
         $result .= &mt('[_1] [_2] [_3] ',          $result .= &mt('[_1] [_2] [_3] ',
                        $monthselector,$dayselector,$yearselector).                         $monthselector,$dayselector,$yearselector).
Line 580  Inputs: Line 631  Inputs:
   
 =item $dname  =item $dname
   
 The name passed to &datesetter, which prefixes the form elements.  The name passed to &date_setter, which prefixes the form elements.
   
 =item $defaulttime  =item $defaulttime
   
Line 595  Returns: Unix time represented in the fo Line 646  Returns: Unix time represented in the fo
 ##############################################  ##############################################
 ##############################################  ##############################################
 sub get_date_from_form {  sub get_date_from_form {
     my ($dname) = @_;      my ($dname,$timezone) = @_;
     my ($sec,$min,$hour,$day,$month,$year);      my ($sec,$min,$hour,$day,$month,$year);
     #      #
     if (defined($env{'form.'.$dname.'_second'})) {      if (defined($env{'form.'.$dname.'_second'})) {
Line 645  sub get_date_from_form { Line 696  sub get_date_from_form {
     if (($year<1970) || ($year>2037)) { return undef; }      if (($year<1970) || ($year>2037)) { return undef; }
     if (defined($sec) && defined($min)   && defined($hour) &&      if (defined($sec) && defined($min)   && defined($hour) &&
         defined($day) && defined($month) && defined($year)) {          defined($day) && defined($month) && defined($year)) {
         my $timezone = &Apache::lonlocal::gettimezone();          if (defined($timezone)) {
               if (&Apache::lonlocal::gettimezone($timezone) eq 'local') {
                   $timezone = &Apache::lonlocal::gettimezone();
               }
           } else {
               $timezone = &Apache::lonlocal::gettimezone();
           }
         my $dt = DateTime->new( year   => $year,          my $dt = DateTime->new( year   => $year,
                                 month  => $month,                                  month  => $month,
                                 day    => $day,                                  day    => $day,
Line 949  sub Create_PrgWin { Line 1006  sub Create_PrgWin {
   
  #the whole function called through timeout is due to issues   #the whole function called through timeout is due to issues
  #in mozilla Read BUG #2665 if you want to know the whole story   #in mozilla Read BUG #2665 if you want to know the whole story
  &r_print($r,'<script type="text/javascript">'.   &r_print($r,&Apache::lonhtmlcommon::scripttag(
         "var popwin;          "var popwin;
          function openpopwin () {           function openpopwin () {
          popwin=open(\'\',\'popwin\',\'width=400,height=100\');".           popwin=open(\'\',\'popwin\',\'width=400,height=100\');".
         "popwin.document.writeln(\'".$start_page.          "popwin.document.writeln(\'".$start_page.
               "<h4>".&mt("$heading")."<\/h4>".                "<h4>".&mt("$heading")."<\/h4>".
               "<form action= \"\" name=\"popremain\" method=\"post\">".                "<form action=\"\" name=\"popremain\" method=\"post\">".
               '<input type="text" size="'.$width.'" name="remaining" value="'.                '<input type="text" size="'.$width.'" name="remaining" value="'.
       &mt('Starting').'" /><\\/form>'.$end_page.        &mt('Starting').'" /><\\/form>'.$end_page.
               "\');".                "\');".
         "popwin.document.close();}".          "popwin.document.close();}".
         "\nwindow.setTimeout(openpopwin,0)</script>");          "\nwindow.setTimeout(openpopwin,0)"
       ));
  $prog_state{'formname'}='popremain';   $prog_state{'formname'}='popremain';
  $prog_state{'inputname'}="remaining";   $prog_state{'inputname'}="remaining";
     } elsif ($type eq 'inline') {      } elsif ($type eq 'inline') {
Line 993  sub Create_PrgWin { Line 1051  sub Create_PrgWin {
 # update progress  # update progress
 sub Update_PrgWin {  sub Update_PrgWin {
     my ($r,$prog_state,$displayString)=@_;      my ($r,$prog_state,$displayString)=@_;
     &r_print($r,'<script type="text/javascript">'.$$prog_state{'window'}.'.document.'.      &r_print($r,&Apache::lonhtmlcommon::scripttag(
      $$prog_state{'formname'}.'.'.          $$prog_state{'window'}.'.document.'.
      $$prog_state{'inputname'}.'.value="'.          $$prog_state{'formname'}.'.'.
      $displayString.'";</script>');          $$prog_state{'inputname'}.'.value="'.
           $displayString.'";'
       ));
     $$prog_state{'laststart'}=&Time::HiRes::time();      $$prog_state{'laststart'}=&Time::HiRes::time();
 }  }
   
Line 1049  sub Increment_PrgWin { Line 1109  sub Increment_PrgWin {
     if ($user_browser eq 'explorer' && $user_os =~ 'mac') {      if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
         $lasttime = '';          $lasttime = '';
     }      }
     &r_print($r,'<script>'.$$prog_state{'window'}.'.document.'.      &r_print($r,&Apache::lonhtmlcommon::scripttag(
      $$prog_state{'formname'}.'.'.          $$prog_state{'window'}.'.document.'.
      $$prog_state{'inputname'}.'.value="'.          $$prog_state{'formname'}.'.'.
      $$prog_state{'done'}.'/'.$$prog_state{'max'}.          $$prog_state{'inputname'}.'.value="'.
      ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'.'</script>');          $$prog_state{'done'}.'/'.$$prog_state{'max'}.
           ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'
       ));
     $$prog_state{'laststart'}=&Time::HiRes::time();      $$prog_state{'laststart'}=&Time::HiRes::time();
 }  }
   
Line 1061  sub Increment_PrgWin { Line 1123  sub Increment_PrgWin {
 sub Close_PrgWin {  sub Close_PrgWin {
     my ($r,$prog_state)=@_;      my ($r,$prog_state)=@_;
     if ($$prog_state{'type'} eq 'popup') {      if ($$prog_state{'type'} eq 'popup') {
  &r_print($r,'<script>popwin.close()</script>'."\n");          &r_print($r,&Apache::lonhtmlcommon::scripttag(
               'popwin.close()'
           ));
     } elsif ($$prog_state{'type'} eq 'inline') {      } elsif ($$prog_state{'type'} eq 'inline') {
  &Update_PrgWin($r,$prog_state,&mt('Done'));   &Update_PrgWin($r,$prog_state,&mt('Done'));
     }      }
Line 1081  sub r_print { Line 1145  sub r_print {
 # ------------------------------------------------------- Puts directory header  # ------------------------------------------------------- Puts directory header
   
 sub crumbs {  sub crumbs {
     my ($uri,$target,$prefix,$form,$size,$noformat,$skiplast)=@_;      my ($uri,$target,$prefix,$form,$skiplast)=@_;
     if (! defined($size)) {  
         $size = '+2';  
     }  
     if ($target) {      if ($target) {
         $target = ' target="'.          $target = ' target="'.
                   &Apache::loncommon::escape_single($target).'"';                    &Apache::loncommon::escape_single($target).'"';
     }      }
     my $output='';      my $output='<span class="LC_filename">';
     unless ($noformat) { $output.='<br /><tt><b>'; }      $output.=$prefix.'/';
     $output.='<font size="'.$size.'">'.$prefix.'/';      if (($env{'user.adv'}) || ($env{'user.author'})) {
     if ($env{'user.adv'}) {          my $path=$prefix.'/';
  my $path=$prefix.'/';          foreach my $dir (split('/',$uri)) {
  foreach my $dir (split('/',$uri)) {  
             if (! $dir) { next; }              if (! $dir) { next; }
             $path .= $dir;              $path .= $dir;
     if ($path eq $uri) {              if ($path eq $uri) {
  if ($skiplast) {                  if ($skiplast) {
     $output.=$dir;                      $output.=$dir;
                     last;                      last;
  }                   } 
     } else {              } else {
  $path.='/';                   $path.='/'; 
     }                  }
             my $href_path = &HTML::Entities::encode($path,'<>&"');              my $href_path = &HTML::Entities::encode($path,'<>&"');
     &Apache::loncommon::inhibit_menu_check(\$href_path);              &Apache::loncommon::inhibit_menu_check(\$href_path);
     if ($form) {              if ($form) {
         my $href = 'javascript:'.$form.".action='".$href_path."';".$form.'.submit();';                  my $href = 'javascript:'.$form.".action='".$href_path."';".$form.'.submit();';
         $output.=qq{<a href="$href" $target>$dir</a>/};                  $output.=qq{<a href="$href"$target>$dir</a>/};
     } else {              } else {
         $output.=qq{<a href="$href_path" $target>$dir</a>/};                  $output.=qq{<a href="$href_path"$target>$dir</a>/};
     }              }
  }          }
     } else {      } else {
  foreach my $dir (split('/',$uri)) {          foreach my $dir (split('/',$uri)) {
             if (! $dir) { next; }              if (! $dir) { next; }
     $output.=$dir.'/';              $output.=$dir.'/';
  }          }
     }      }
     if ($uri !~ m|/$|) { $output=~s|/$||; }      if ($uri !~ m|/$|) { $output=~s|/$||; }
     return $output.'</font>'.($noformat?'':'</b></tt><br />');      $output.='</span>';
   
       return $output;
 }  }
   
 # --------------------- A function that generates a window for the spellchecker  # --------------------- A function that generates a window for the spellchecker
Line 1143  sub spellheader { Line 1205  sub spellheader {
     my $nothing=&javascript_nothing();      my $nothing=&javascript_nothing();
     return (<<ENDCHECK);      return (<<ENDCHECK);
 <script type="text/javascript">   <script type="text/javascript"> 
   // <![CDATA[
 //<!-- BEGIN LON-CAPA Internal  //<!-- BEGIN LON-CAPA Internal
 var checkwin;  var checkwin;
   
Line 1153  function spellcheckerwindow(string) { Line 1216  function spellcheckerwindow(string) {
     checkwin.document.close();      checkwin.document.close();
 }  }
 // END LON-CAPA Internal -->  // END LON-CAPA Internal -->
   // ]]>
 </script>  </script>
 ENDCHECK  ENDCHECK
 }  }
Line 1226  sub htmlareaselectactive { Line 1290  sub htmlareaselectactive {
     my @fields=@_;      my @fields=@_;
     unless (&htmlareabrowser()) { return ''; }      unless (&htmlareabrowser()) { return ''; }
     if (&htmlareablocked()) { return '<br />'.&enablelink(@fields); }      if (&htmlareablocked()) { return '<br />'.&enablelink(@fields); }
     my $output='<script type="text/javascript" defer="1">';      my $output='<script type="text/javascript" defer="1">'."\n"
                 .'// <![CDATA['."\n";
     my $lang = &htmlarea_lang();      my $lang = &htmlarea_lang();
     foreach my $field (@fields) {      foreach my $field (@fields) {
  $output.="   $output.="
Line 1239  sub htmlareaselectactive { Line 1304  sub htmlareaselectactive {
     oFCKeditor.Config['DefaultLanguage'] = '$lang';      oFCKeditor.Config['DefaultLanguage'] = '$lang';
 }";  }";
     }      }
     $output.="\nwindow.status='Activated Editfields';\n</script><br />".      $output.="\nwindow.status='Activated Editfields';\n"
               .'// ]]>'."\n"
               .'</script><br />'.
  &disablelink(@fields);   &disablelink(@fields);
     return $output;      return $output;
 }  }
Line 1265  sub htmlareabrowser { Line 1332  sub htmlareabrowser {
 =item breadcrumbs  =item breadcrumbs
   
 Compiles the previously registered breadcrumbs into an series of links.  Compiles the previously registered breadcrumbs into an series of links.
 FAQ and BUG links will be placed on the left side of the table if they  
 are defined for the last registered breadcrumb.    
 Additionally supports a 'component', which will be displayed on the  Additionally supports a 'component', which will be displayed on the
 right side of the table (without a link).  right side of the breadcrumbs enclosing div (without a link).
 A link to help for the component will be included if one is specified.  A link to help for the component will be included if one is specified.
   
 All inputs can be undef without problems.  All inputs can be undef without problems.
   
 Inputs: $component (the large text on the right side of the table),  Inputs: $component (the text on the right side of the breadcrumbs trail),
         $component_help          $component_help
         $menulink (boolean, controls whether to include a link to /adm/menu)          $menulink (boolean, controls whether to include a link to /adm/menu)
         $helplink (if 'nohelp' don't include the orange help link)          $helplink (if 'nohelp' don't include the orange help link)
         $css_class (optional name for the class to apply to the table for CSS)          $css_class (optional name for the class to apply to the table for CSS)
         $no_mt (optional flag, 1 if &mt() is _not_ to be applied to $component          $no_mt (optional flag, 1 if &mt() is _not_ to be applied to $component
            when including the text on the right.             when including the text on the right.
   
 Returns a string containing breadcrumbs for the current page.  Returns a string containing breadcrumbs for the current page.
   
 =item clear_breadcrumbs  =item clear_breadcrumbs
Line 1304  returns: nothing Line 1368  returns: nothing
 ############################################################  ############################################################
 {  {
     my @Crumbs;      my @Crumbs;
       my %tools = ();
           
     sub breadcrumbs {      sub breadcrumbs {
         my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt) = @_;          my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt, $CourseBreadcrumbs) = @_;
         #  
  $css_class ||= 'LC_breadcrumbs';  
         my $Str = "\n".'<table class="'.$css_class.'"><tr><td>';  
         #          #
           $css_class ||= 'LC_breadcrumbs';
   
         # Make the faq and bug data cascade          # Make the faq and bug data cascade
         my $faq = '';          my $faq  = '';
         my $bug = '';          my $bug  = '';
  my $help='';          my $help = '';
  # Crumb Symbol          # Crumb Symbol
  my $crumbsymbol = ' &#x25b6; ';          my $crumbsymbol = '&raquo;';
         # The last breadcrumb does not have a link, so handle it separately.          # The last breadcrumb does not have a link, so handle it separately.
         my $last = pop(@Crumbs);          my $last = pop(@Crumbs);
         #          #
         # The first one should be the course or a menu link          # The first one should be the course or a menu link
  if (!defined($menulink)) { $menulink=1; }          if (!defined($menulink)) { $menulink=1; }
         if ($menulink) {          if ($menulink) {
             my $description = 'Menu';              if ($menulink eq '_nomenu') {
             my $no_mt_descr = 0;                  return unless($last);
             if (exists($env{'request.course.id'}) &&               } else {
                 $env{'request.course.id'} ne '') {                  my $description = 'Menu';
                 $description =                   my $href = '/adm/menu';
                     $env{'course.'.$env{'request.course.id'}.'.description'};                  my $tooltip = 'Go to main menu';
                 $no_mt_descr = 1;                  my $no_mt_descr = 0;
             }                  if ((exists($env{'request.course.id'})) &&
             unshift(@Crumbs,{                      ($env{'request.course.id'} ne '') && 
                     href   =>'/adm/menu',                      !($env{'form.context'} eq 'requestcrs')) {
                     title  =>'Go to main menu',                      if ((&Apache::loncommon::needs_gci_custom()) || ($env{'user.domain'} eq 'gcitest')) {
                     target =>'_top',                          if ($env{'environment.remotenavmap'} eq 'on') {
                     text   =>$description,                              # open link using javascript when remote navmap is activated
                     no_mt  =>$no_mt_descr,                              $href = "javascript:gonav('/adm/navmaps');";
                 });                          } else {
                               $href = '/adm/navmaps';
                           }
                           $tooltip = 'Contents';
                       }
                       if ($env{'course.'.$env{'request.course.id'}.'.description'} ne '') {
                           $description =
                               $env{'course.'.$env{'request.course.id'}.'.description'};
                           $no_mt_descr = 1;
                       }
                   }
                   $menulink =  {  href   => $href,
                                   title  => $tooltip,
                                   target => '_top',
                                   text   => $description,
                                   no_mt  => $no_mt_descr, };
                   if ($last) {
                       #$last set, so we have some crumbs
                       unshift(@Crumbs,$menulink);
                   } else {
                       #only menulink crumb present
                       $last = $menulink;
                   }
               }
         }          }
         my $links .=           my $links = join "", 
             join($crumbsymbol,  
                  map {                   map {
                      $faq = $_->{'faq'} if (exists($_->{'faq'}));                       $faq  = $_->{'faq'}  if (exists($_->{'faq'}));
                      $bug = $_->{'bug'} if (exists($_->{'bug'}));                       $bug  = $_->{'bug'}  if (exists($_->{'bug'}));
                      $help = $_->{'help'} if (exists($_->{'help'}));                       $help = $_->{'help'} if (exists($_->{'help'}));
                      my $result = '<a href="'.$_->{'href'}.'" ';  
                      if (defined($_->{'target'}) && $_->{'target'} ne '') {                       my $result = $_->{no_mt} ? $_->{text} : mt($_->{text});
                          $result .= 'target="'.$_->{'target'}.'" ';  
                        if ($_->{href}){
                            $result = htmltag( 'a', $result, 
                                              { 
                                                  href   => $_->{href},
                                                  title  => $_->{no_mt} ? 
                                                   $_->{title} : mt($_->{title}),
                                                  target => $_->{target},
                                              });
                      }                       }
      if ($_->{'no_mt'}) {  
  $result .='title="'.$_->{'title'}.'">'.                       $result = htmltag( 'li', "$result $crumbsymbol");
      $_->{'text'}.'</a>';                   } @Crumbs;
      } else {  
  $result .='title="'.&mt($_->{'title'}).'">'.          #should the last Element be translated?
      &mt($_->{'text'}).'</a>';  
      }          my $lasttext = $last->{'no_mt'} ? $last->{'text'}
                      $result;                       : mt( $last->{'text'} );
                      } @Crumbs  
                  );          # last breadcrumb is the first order heading of a page
         $links .= $crumbsymbol if ($links ne '');          # for course breadcrumbs it's just bold
  if ($last->{'no_mt'}) {          $links .= htmltag( 'li', htmltag($CourseBreadcrumbs ? 'b' : 'h1',
     $links .= '<b>'.$last->{'text'}.'</b>';                             $lasttext), {title => $lasttext});
  } else {  
     $links .= '<b>'.&mt($last->{'text'}).'</b>';  
  }  
         #  
         my $icons = '';          my $icons = '';
         $faq = $last->{'faq'} if (exists($last->{'faq'}));          $faq  = $last->{'faq'}  if (exists($last->{'faq'}));
         $bug = $last->{'bug'} if (exists($last->{'bug'}));          $bug  = $last->{'bug'}  if (exists($last->{'bug'}));
         $help = $last->{'help'} if (exists($last->{'help'}));          $help = $last->{'help'} if (exists($last->{'help'}));
         $component_help=($component_help?$component_help:$help);          $component_help=($component_help?$component_help:$help);
 #        if ($faq ne '') {  #        if ($faq ne '') {
Line 1377  returns: nothing Line 1468  returns: nothing
 #        if ($bug ne '') {  #        if ($bug ne '') {
 #            $icons .= &Apache::loncommon::help_open_bug($bug);  #            $icons .= &Apache::loncommon::help_open_bug($bug);
 #        }  #        }
  if ($faq ne '' || $component_help ne '' || $bug ne '') {          if ($faq ne '' || $component_help ne '' || $bug ne '') {
     $icons .= &Apache::loncommon::help_open_menu($component,              $icons .= &Apache::loncommon::help_open_menu($component,
  $component_help,                                                           $component_help,
  $faq,$bug);                                                           $faq,$bug);
  }  
         #  
         $Str .= $links.'</td>';  
         #  
         if (defined($component)) {  
             $Str .= '<td class="'.$css_class.'_component">';  
             if ($no_mt) {  
                 $Str .= $component;  
             } else {  
                 $Str .= &mt($component);  
             }  
     if ($icons ne '') {  
  $Str .= '&nbsp;'.$icons;  
     }  
     $Str .= '</td>';  
         }          }
         $Str .= '</tr></table>'."\n";  
         #          #
   
   
           unless ($CourseBreadcrumbs) {
               $links = htmltag('ol',  $links, { id => "LC_MenuBreadcrumbs"   });
           } else {
               $links = htmltag('ul',  $links, { class => "LC_CourseBreadcrumbs" });
           }
   
           if ($component) {
               $links = htmltag('span', 
                                ( $no_mt ? $component : mt($component) ).
                                ( $icons ? $icons : '' ),
                                { class => 'LC_breadcrumbs_component' } )
                                .$links;
           }
           
           render_tools(\$links);
           $links = htmltag('div', $links, 
                           { id => "LC_breadcrumbs" }) unless ($CourseBreadcrumbs) ;
           render_advtools(\$links);
   
         # Return the @Crumbs stack to what we started with          # Return the @Crumbs stack to what we started with
         push(@Crumbs,$last);          push(@Crumbs,$last);
         shift(@Crumbs);          shift(@Crumbs);
         #          # Return the breadcrumb's line
         return $Str;          return "$links";
     }      }
   
     sub clear_breadcrumbs {      sub clear_breadcrumbs {
         undef(@Crumbs);          undef(@Crumbs);
           undef(%tools);
     }      }
   
     sub add_breadcrumb {      sub add_breadcrumb {
         push (@Crumbs,@_);          push(@Crumbs,@_);
       }
       
   =item add_breadcrumb_tool($category, $html)
   
   Adds $html to $category of the breadcrumb toolbar container.
   
   $html is usually a link to a page that invokes a function on the currently
   displayed data (e.g. print when viewing a problem)
   
   Currently there are 3 possible values for $category:
   
   =over
   
   =item navigation
   left of breadcrumbs line
   
   =item tools
   right of breadcrumbs line
   
   =item advtools
   advanced tools shown in a separate box below breadcrumbs line
   
   =back
   
   returns: nothing
   
   =cut
   
       sub add_breadcrumb_tool {
           my ($category, @html) = @_;
           return unless @html;
           if (!defined(%tools)) {
               %tools = ( navigation => [], tools => [], advtools => []);
           }
   
           #this cleans data received from lonmenu::innerregister
           @html = grep {defined $_ && $_ ne ''} @html;
           for (@html) {
               s/align="(right|left)"//;
               s/<span.*?\/span>// if $category ne 'advtools';
           }
   
           push @{$tools{$category}}, @html;
       }
   
   =item clear_breadcrumb_tools()
   
   Clears the breadcrumb toolbar container.
   
   returns: nothing
   
   =cut
   
       sub clear_breadcrumb_tools {
           undef(%tools);
       }
   
   =item render_tools(\$breadcrumbs)
   
   Creates html for breadcrumb tools (categories navigation and tools) and inserts
   \$breadcrumbs at the correct position.
   
   input: \$breadcrumbs - a reference to the string containing prepared
   breadcrumbs.
   
   returns: nothing
   =cut
   
   #TODO might split this in separate functions for each category
       sub render_tools {
           my ($breadcrumbs) = @_;
           return unless defined %tools;
   
           my $navigation = list_from_array($tools{navigation},
                      { listattr => { class=>"LC_breadcrumb_tools_navigation" } });
           my $tools = list_from_array($tools{tools},
                      { listattr => { class=>"LC_breadcrumb_tools_tools" } });
           $$breadcrumbs = list_from_array([$navigation, $tools, $$breadcrumbs],
                      { listattr => { class=>'LC_breadcrumb_tools_outerlist' } });
       }
   
   =item render_advtools(\$breadcrumbs,$legend)
   
   Creates html for advanced tools (category advtools) and inserts \$breadcrumbs
   at the correct position.
   
   input: \$breadcrumbs - a reference to the string containing prepared
   breadcrumbs (after render_tools call).
   
   returns: nothing
   =cut
   
       sub render_advtools {
           my ($breadcrumbs,$legend) = @_;
           return unless     (defined $tools{'advtools'})
                         and (scalar(@{$tools{'advtools'}}) > 0);
           my $args;
           if ($legend) {
               $args = {legend => $legend};
           }
           $$breadcrumbs .= Apache::loncommon::head_subbox(
                               funclist_from_array($tools{'advtools'},$args));
     }      }
   
 } # End of scope for @Crumbs  } # End of scope for @Crumbs
Line 1472  returns: nothing Line 1671  returns: nothing
 # routines, but can also be called directly to start and end rows which have   # routines, but can also be called directly to start and end rows which have 
 # needs that are not accommodated by the *_select_row() routines.      # needs that are not accommodated by the *_select_row() routines.    
   
   { # Start: row_count block for pick_box
   my @row_count;
   
 sub start_pick_box {  sub start_pick_box {
     my ($css_class) = @_;      my ($css_class) = @_;
     if (defined($css_class)) {      if (defined($css_class)) {
Line 1479  sub start_pick_box { Line 1681  sub start_pick_box {
     } else {      } else {
  $css_class= 'class="LC_pick_box"';   $css_class= 'class="LC_pick_box"';
     }      }
       unshift(@row_count,0);
     my $output = <<"END";      my $output = <<"END";
  <table $css_class>   <table $css_class>
 END  END
Line 1486  END Line 1689  END
 }  }
   
 sub end_pick_box {  sub end_pick_box {
       shift(@row_count);
     my $output = <<"END";      my $output = <<"END";
        </table>         </table>
 END  END
Line 1500  END Line 1704  END
 }  }
   
 sub row_title {  sub row_title {
     my ($title,$css_title_class,$css_value_class) = @_;      my ($title,$css_title_class,$css_value_class, $css_value_furtherAttributes) = @_;
       $row_count[0]++;
       my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
     $css_title_class ||= 'LC_pick_box_title';      $css_title_class ||= 'LC_pick_box_title';
     $css_title_class = 'class="'.$css_title_class.'"';      $css_title_class = 'class="'.$css_title_class.'"';
   
     $css_value_class ||= 'LC_pick_box_value';      $css_value_class ||= 'LC_pick_box_value';
     $css_value_class = 'class="'.$css_value_class.'"';  
   
     if ($title ne '') {      if ($title ne '') {
         $title .= ':';          $title .= ':';
     }      }
     my $output = <<"ENDONE";      my $output = <<"ENDONE";
            <tr class="LC_pick_box_row">             <tr class="LC_pick_box_row" $css_value_furtherAttributes> 
             <td $css_title_class>              <td $css_title_class>
        $title         $title
             </td>              </td>
             <td $css_value_class>              <td class="$css_value_class $css_class">
 ENDONE  ENDONE
     return $output;      return $output;
 }  }
Line 1537  ENDTWO Line 1742  ENDTWO
     return $output;      return $output;
 }  }
   
   } # End: row_count block for pick_box
   
 sub role_select_row {  sub role_select_row {
     my ($roles,$title,$css_class,$show_separate_custom,$cdom,$cnum) = @_;      my ($roles,$title,$css_class,$show_separate_custom,$cdom,$cnum) = @_;
       my $crstype = 'Course';
       if ($cdom ne '' && $cnum ne '') {
           $crstype = &Apache::loncommon::course_type($cdom.'_'.$cnum);
       }
     my $output;      my $output;
     if (defined($title)) {      if (defined($title)) {
         $output = &row_title($title,$css_class);          $output = &row_title($title,$css_class);
     }      }
     $output .= qq|      $output .= qq|
                                   <select name="roles" multiple >\n|;                                    <select name="roles" multiple="multiple">\n|;
     foreach my $role (@$roles) {      foreach my $role (@$roles) {
         my $plrole;          my $plrole;
         if ($role eq 'ow') {          if ($role eq 'ow') {
Line 1563  sub role_select_row { Line 1774  sub role_select_row {
                 $plrole = &mt('Custom Role');                  $plrole = &mt('Custom Role');
             }              }
         } else {          } else {
             $plrole=&Apache::lonnet::plaintext($role);              $plrole=&Apache::lonnet::plaintext($role,$crstype);
         }          }
         if (($role ne 'cr') || (!$show_separate_custom)) {          if (($role ne 'cr') || (!$show_separate_custom)) {
             $output .= '  <option value="'.$role.'">'.$plrole.'</option>';              $output .= '  <option value="'.$role.'">'.$plrole.'</option>';
Line 1578  sub role_select_row { Line 1789  sub role_select_row {
   
 sub course_select_row {  sub course_select_row {
     my ($title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles,      my ($title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles,
  $css_class) = @_;   $css_class,$crstype) = @_;
     my $output = &row_title($title,$css_class);      my $output = &row_title($title,$css_class);
     $output .= &course_selection($formname,$totcodes,$codetitles,$idlist,$idlist_titles);      $output .= &course_selection($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype);
     $output .= &row_closure();      $output .= &row_closure();
     return $output;      return $output;
 }  }
   
 sub course_selection {  sub course_selection {
     my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles) = @_;      my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype) = @_;
     my $output = qq|      my $output = qq|
 <script type="text/javascript">  <script type="text/javascript">
   // <![CDATA[
     function coursePick (formname) {      function coursePick (formname) {
         for  (var i=0; i<formname.coursepick.length; i++) {          for  (var i=0; i<formname.coursepick.length; i++) {
             if (formname.coursepick[i].value == 'category') {              if (formname.coursepick[i].value == 'category') {
Line 1611  sub course_selection { Line 1823  sub course_selection {
             formname.courselist = '';              formname.courselist = '';
         }          }
     }      }
   // ]]>
 </script>  </script>
     |;      |;
   
       my ($allcrs,$pickspec);
       if ($crstype eq 'Community') {
           $allcrs = &mt('All communities');
           $pickspec = &mt('Pick specific communities:');
       } else {
           $allcrs = &mt('All courses');
           $pickspec = &mt('Pick specific course(s):');
       }
   
     my $courseform='<b>'.&Apache::loncommon::selectcourse_link      my $courseform='<b>'.&Apache::loncommon::selectcourse_link
                      ($formname,'pickcourse','pickdomain','coursedesc','',1).'</b>';                       ($formname,'pickcourse','pickdomain','coursedesc','',1,$crstype).'</b>';
         $output .= '<input type="radio" name="coursepick" value="all" onclick="coursePick(this.form)" />'.&mt('All courses').'<br />';          $output .= '<input type="radio" name="coursepick" value="all" onclick="coursePick(this.form)" />'.$allcrs.'<br />';
     if ($totcodes > 0) {      if ($totcodes > 0) {
         my $numtitles = @$codetitles;          my $numtitles = @$codetitles;
         if ($numtitles > 0) {          if ($numtitles > 0) {
Line 1660  sub course_selection { Line 1883  sub course_selection {
             $output .= '</tr></table><br />';              $output .= '</tr></table><br />';
         }          }
     }      }
     $output .= '<input type="radio" name="coursepick" value="specific" onclick="coursePick(this.form);opencrsbrowser('."'".$formname."','dccourse','dcdomain','coursedesc','','1'".')" />'.&mt('Pick specific course(s):').' '.$courseform.'&nbsp;&nbsp;<input type="text" value="0" size="4" name="coursetotal" /><input type="hidden" name="courselist" value="" />selected.<br />'."\n";      $output .= '<input type="radio" name="coursepick" value="specific" onclick="coursePick(this.form);opencrsbrowser('."'".$formname."','dccourse','dcdomain','coursedesc','','1','$crstype'".')" />'.$pickspec.' '.$courseform.'&nbsp;&nbsp;<input type="text" value="0" size="4" name="coursetotal" /><input type="hidden" name="courselist" value="" />selected.<br />'."\n";
     return $output;      return $output;
 }  }
   
Line 1671  sub status_select_row { Line 1894  sub status_select_row {
         $output = &row_title($title,$css_class,'LC_pick_box_select');          $output = &row_title($title,$css_class,'LC_pick_box_select');
     }      }
     $output .= qq|      $output .= qq|
                                     <select name="types" multiple>\n|;                                      <select name="types" multiple="multiple">\n|;
     foreach my $status_type (sort(keys(%{$types}))) {      foreach my $status_type (sort(keys(%{$types}))) {
         $output .= '  <option value="'.$status_type.'">'.$$types{$status_type}.'</option>';          $output .= '  <option value="'.$status_type.'">'.$$types{$status_type}.'</option>';
     }      }
Line 1748  sub course_custom_roles { Line 1971  sub course_custom_roles {
   
 # topic_bar  # topic_bar
 #  #
 # Generates a div containing a numbered (static image) followed by a title  # Generates a div containing an (optional) number with a white background followed by a 
 # with a background color defined in the corresponding CSS: LC_topic_bar  # title with a background color defined in the corresponding CSS: LC_topic_bar
 #  # Inputs:
   # 1. number to display.
   #    If input for number is empty only the title will be displayed. 
   # 2. title text to display.
   # Outputs - a scalar containing html mark-up for the div.
   
 sub topic_bar {  sub topic_bar {
     my ($imgnum,$title) = @_;      my ($num,$title) = @_;
     return '      my $number = '';
 <div class="LC_topic_bar">      if ($num ne '') {
     <img alt="'.&mt('Step [_1]',$imgnum).          $number = '<span>'.$num.'</span>';
               '"src="/res/adm/pages/bl_step'.$imgnum.'.gif" />&nbsp;      }
     <span>'.$title.'</span>      return '<div class="LC_topic_bar">'.$number.$title.'</div>';
 </div>  
 ';  
 }  }
   
 ##############################################  ##############################################
 ##############################################  ##############################################
                                                                                
 # echo_form_input  # echo_form_input
 #  #
 # Generates html markup to add form elements from the referrer page  # Generates html markup to add form elements from the referrer page
Line 1829  sub echo_form_input { Line 2054  sub echo_form_input {
   
 ##############################################  ##############################################
 ##############################################  ##############################################
                                                                                
 # set_form_elements  # set_form_elements
 #  #
 # Generates javascript to set form elements to values based on  # Generates javascript to set form elements to values based on
Line 1894  sub set_form_elements { Line 2118  sub set_form_elements {
             $values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g;              $values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g;
             $values{$name}[$i] =~ s/"/\\"/g;              $values{$name}[$i] =~ s/"/\\"/g;
         }          }
         if ($$elements{$name} eq 'text') {          if (($$elements{$name} eq 'text') || ($$elements{$name} eq 'hidden')) {
             my $numvalues = @{$values{$name}};              my $numvalues = @{$values{$name}};
             if ($numvalues > 1) {              if ($numvalues > 1) {
                 my $valuestring = join('","',@{$values{$name}});                  my $valuestring = join('","',@{$values{$name}});
Line 1929  sub set_form_elements { Line 2153  sub set_form_elements {
                     $output .= qq|                      $output .= qq|
       if (courseForm.elements['$name'].value == "$value") {        if (courseForm.elements['$name'].value == "$value") {
           courseForm.elements['$name'].checked = true;            courseForm.elements['$name'].checked = true;
         } else {
             courseForm.elements['$name'].checked = false;
       }|;        }|;
                 }                  }
             }              }
Line 1970  sub set_form_elements { Line 2196  sub set_form_elements {
         }          }
     }      }
     $output .= "      $output .= "
       return;
 }\n";  }\n";
     return $output;      return $output;
 }  }
Line 2012  END Line 2239  END
 }  }
   
   
   # USAGE: htmltag(element, content, {attribute => value,...});
   #
   # EXAMPLES: 
   #  - htmltag('a', 'this is an anchor', {href  => 'www.example.com', 
   #                                       title => 'this is a title'})
   #
   #  - You might want to set up needed tags like: 
   #
   #     my $h3  = sub { return htmltag( "h3",  @_ ) };
   #
   #    ... and use them: $h3->("This is a headline")
   #
   #  - To set up a couple of tags, see sub inittags
   #
   # NOTES:
   # - Empty elements, such as <br/> are correctly terminated, 
   #   i.e. htmltag('br') returns <br/> 
   # - Empty attributes (title="") are filtered out.
   # - The function will not check for deprecated attributes.
   #
   # OUTPUT: content enclosed in xhtml conform tags
   sub htmltag{
       return
           qq|<$_[0]|
           . join( '', map { qq| $_="${$_[2]}{$_}"| if ${$_[2]}{$_} } keys %{ $_[2] } )
           . ($_[1] ? qq|>$_[1]</$_[0]>| : qq|/>|). "\n";
   };
   
   
   # USAGE: inittags(@tags);
   #
   # EXAMPLES:
   #  - my ($h1, $h2, $h3) = inittags( qw( h1 h2 h3 ) )
   #    $h1->("This is a headline") #Returns: <h1>This is a headline</h1>
   #
   # NOTES: See sub htmltag for further information.
   #
   # OUTPUT: List of subroutines. 
   sub inittags {
       my @tags = @_;
       return map { my $tag = $_;
                    sub { return htmltag( $tag, @_ ) }
                  } @tags;
   }
   
   
   # USAGE: scripttag(scriptcode, [start|end|both]);
   #
   # EXAMPLES: 
   #  - scripttag("alert('Hello World!')", 'both') 
   #    returns:
   #    <script type="text/javascript">
   #    // BEGIN LON-CAPA Internal
   #    alert(Hello World!')
   #    // END LON-CAPA Internal
   #    </script>
   #
   # NOTES:
   # - works currently only for javascripts
   #
   # OUTPUT: 
   # Scriptcode properly enclosed in <script> and CDATA tags (and LC
   # Internal markers if 2nd argument is given)
   sub scripttag {
       my ( $content, $marker ) = @_;
       return unless defined $content;
   
       my $begin = "\n// BEGIN LON-CAPA Internal\n";
       my $end   = "\n// END LON-CAPA Internal\n";
   
       if ($marker) {
           $content  = $begin . $content if $marker eq 'start' or $marker eq 'both';
           $content .= $end              if $marker eq 'end'   or $marker eq 'both';
       }
   
       $content = "\n// <![CDATA[\n$content\n// ]]>\n";
   
       return htmltag('script', $content, {type => 'text/javascript'});
   };
   
   
   =item list_from_array( \@array, { listattr =>{}, itemattr =>{} } )
   
   Constructs a XHTML list from \@array.
   
   input:
   
   =over
   
   =item \@array
   
   A reference to the array containing text that will be wrapped in <li></li> tags.
   
   =item { listattr => {}, itemattr =>{} }
   
   Attributes for <ul> and <li> passed in as hash references.
   See htmltag() for more details.
   
   =back
   
   returns: XHTML list as String.
   
   =cut
   
   # \@items, {listattr => { class => 'abc', id => 'xyx' }, itemattr => {class => 'abc', id => 'xyx'}}
   sub list_from_array {
       my ($items, $args) = @_;
       return unless scalar @$items;
       my ($ul, $li) = inittags( qw(ul li) );
       my $listitems = join '', map { $li->($_, $args->{itemattr}) } @$items;
       return $ul->( $listitems, $args->{listattr} );
   }
   
   
   ##############################################
   ##############################################
   
   # generate_menu
   #
   # Generates html markup for a menu. 
   #
   # Inputs:
   # An array of following structure:
   #   ({ categorytitle => 'Categorytitle',
   # items => [
   #    {
   #           linktext    => 'Text to be displayed',
   # url        => 'URL the link is pointing to, i.e. /adm/site?action=dosomething',
   # permission  => 'Contains permissions as returned from lonnet::allowed(),
   #         must evaluate to true in order to activate the link',
   # icon        =>  'icon filename',
   # alttext    => 'alt text for the icon',
   # help    => 'Name of the corresponding helpfile',
   # linktitle   => 'Description of the link (used for title tag)'
   #    },
   #    ...
   # ]
   #   }, 
   #   ...
   #   )
   #
   # Outputs: A scalar containing the html markup for the menu.
   
   sub generate_menu {
       my @menu = @_;
       # subs for specific html elements
       my ($h3, $div, $ul, $li, $a, $img) = inittags( qw(h3 div ul li a img) ); 
       
       my @categories; # each element represents the entire markup for a category
      
       foreach my $category (@menu) {
           my @links;  # contains the links for the current $category
           foreach my $link (@{$$category{items}}) {
               next unless $$link{permission};
               
               # create the markup for the current $link and push it into @links.
               # each entry consists of an image and a text optionally followed 
               # by a help link.
               my $src;
               if ($$link{icon} ne '') {
                   $src = '/res/adm/pages/'.$$link{icon};
               }
               push(@links,$li->(
                           $a->(
                               $img->("", {
                                   class => "LC_noBorder LC_middle",
                                   src   => $src,
                                   alt   => mt(defined($$link{alttext}) ?
                                   $$link{alttext} : $$link{linktext})
                               }), {
                               href  => $$link{url},
                               title => mt($$link{linktitle})
                               }).
                           $a->(mt($$link{linktext}), {
                               href  => $$link{url},
                               title => mt($$link{linktitle}),
                               class => "LC_menubuttons_link"
                               }).
                            (defined($$link{help}) ? 
                            Apache::loncommon::help_open_topic($$link{help}) : ''),
                            {class => "LC_menubuttons_inline_text"}));
           }
   
           # wrap categorytitle in <h3>, concatenate with 
           # joined and in <ul> tags wrapped @links
           # and wrap everything in an enclosing <div> and push it into
           # @categories
           # such that each element looks like:
           # <div><h3>title</h3><ul><li>...</li>...</ul></div>
           # the category won't be added if there aren't any links
           push(@categories, 
               $div->($h3->(mt($$category{categorytitle}), {class=>"LC_hcell"}).
               $ul->(join('' ,@links),  {class =>"LC_ListStyleNormal" }),
               {class=>"LC_Box LC_400Box"})) if scalar(@links);
       }
   
       # wrap the joined @categories in another <div> (column layout)
       return $div->(join('', @categories), {class => "LC_columnSection"});
   }
   
   ##############################################
   ##############################################
   
   =pod
   
   =item &start_funclist
   
   Start list of available functions
   
   Typically used to offer a simple list of available functions
   at top or bottom of page.
   All available functions/actions for the current page
   should be included in this list.
   
   If the optional headline text is not provided, a default text will be used.
   
   
   Related routines:
   =over 4
   add_item_funclist
   end_funclist
   =back
   
   
   Inputs: (optional) headline text
   
   Returns: HTML code with function list start
   
   =cut
   
   ##############################################
   ##############################################
   
   sub start_funclist {
       my($legendtext)=@_;
       $legendtext=&mt('Functions') if !$legendtext;
       return '<ul class="LC_funclist"><li style="font-weight:bold; margin-left:0.8em;">'.$legendtext.'</li>'."\n";
   }
   
   
   ##############################################
   ##############################################
   
   =pod
   
   =item &add_item_funclist
   
   Adds an item to the list of available functions
   
   Related routines:
   =over 4
   start_funclist
   end_funclist
   =back
   
   Inputs: content item with text and link to function
   
   Returns: HTML code with list item for funclist
   
   =cut
   
   ##############################################
   ##############################################
   
   sub add_item_funclist {
       my($content) = @_;
       return '<li>'.$content.'</li>'."\n";
   }
   
   =pod
   
   =item &end_funclist
   
   End list of available functions
   
   Related routines:
   =over 4
   start_funclist
   add_item_funclist
   =back
   
   Inputs: ./.
   
   Returns: HTML code with function list end
   =cut
   
   sub end_funclist {
       return "</ul>\n";
   }
   
   =pod
   
   =item funclist_from_array( \@array, {legend => 'text for legend'} )
   
   Constructs a XHTML list from \@array with the first item being visually
   highlighted and set to the value of legend or 'Functions' if legend is
   empty.
   
   =over
   
   =item \@array
   
   A reference to the array containing text that will be wrapped in <li></li> tags.
   
   =item { legend => 'text' }
   
   A string that's used as visually highlighted first item. 'Functions' is used if
   it's value evaluates to false.
   
   =back
   
   returns: XHTML list as string.
   
   =back
   
   =cut
   
   sub funclist_from_array {
       my ($items, $args) = @_;
       $args->{legend} ||= mt('Functions');
       return list_from_array( [$args->{legend}, @$items],
                  { listattr => {class => 'LC_funclist'} });
   }
   
 1;  1;
   
Removed from v.1.182.2.1  
changed lines
  Added in v.1.253.2.7

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>