Diff for /loncom/interface/lonhtmlcommon.pm between versions 1.298 and 1.310

version 1.298, 2012/01/02 05:07:06 version 1.310, 2012/04/18 14:13:29
Line 103  sub direct_parm_link { Line 103  sub direct_parm_link {
 ##############################################  ##############################################
 ##############################################  ##############################################
   
 =item confirm_success  =item &confirm_success()
   
 Successful completion of an operation message  Successful completion of an operation message
   
Line 129  sub confirm_success { Line 129  sub confirm_success {
   
 =pod  =pod
   
 =item dragmath_button  =item &dragmath_button()
   
 Creates a button that launches a dragmath popup-window, in which an   Creates a button that launches a dragmath popup-window, in which an 
 expression can be edited and pasted as LaTeX into a specified textarea.   expression can be edited and pasted as LaTeX into a specified textarea. 
Line 155  ENDDRAGMATH Line 155  ENDDRAGMATH
   
 =pod  =pod
   
 =item dragmath_js  =item &dragmath_js()
   
 Javascript used to open pop-up window containing dragmath applet which   Javascript used to open pop-up window containing dragmath applet which 
 can be used to paste LaTeX into a textarea.  can be used to paste LaTeX into a textarea.
   
 =cut  =cut
   
 sub dragmath_js {  sub dragmath_js {
Line 177  sub dragmath_js { Line 178  sub dragmath_js {
 ENDDRAGMATHJS  ENDDRAGMATHJS
 }  }
   
   ##############################################
   ##############################################
   
   =pod
   
   =item &dependencies_button()
   
   Creates a button that launches a popup-window, in which dependencies  
   for the web page in the main window can be added to, replaced or deleted.  
   
   =cut
   
   sub dependencies_button {
       my $buttontext=&mt('Manage Dependencies');
       return <<"END";
                   <input type="button" value="$buttontext" onclick="javascript:dependencycheck();" />
   END
   }
   
   ##############################################
   
   =pod
   
   =item &dependencycheck_js()
   
   Javascript used to open pop-up window containing interface to manage 
   dependencies for a web page uploaded diretcly to a course.
   
   =cut
   
   sub dependencycheck_js {
       my ($symb,$title) = @_;
       my $link = '/adm/dependencies?symb='.&HTML::Entities::encode($symb,'<>&"').
                  '&title='.&HTML::Entities::encode($title,'<>&"');
       return <<ENDJS;
                   <script type="text/javascript">
                   // <![CDATA[
                     function dependencycheck() {
                        depwin  = window.open("$link","","width=750,height=500,resizable,scrollbars=yes");
                     }
                   // ]]>
                   </script>
   ENDJS
   }
   
 ##############################################  ##############################################
 ##############################################  ##############################################
   
 =pod  =pod
   
 =item authorbombs  =item &authorbombs()
   
 =cut  =cut
   
Line 317  sub get_recent_frozen { Line 362  sub get_recent_frozen {
   
 =pod  =pod
   
 =item textbox  =item &textbox()
   
 =cut  =cut
   
Line 337  sub textbox { Line 382  sub textbox {
   
 =pod  =pod
   
 =item checkbox  =item &checkbox()
   
 =cut  =cut
   
Line 359  sub checkbox { Line 404  sub checkbox {
   
 =pod  =pod
   
 =item radiobutton  =item &radiobutton()
   
 =cut  =cut
   
Line 383  sub radio { Line 428  sub radio {
   
 =pod  =pod
   
 =item &date_setter  =item &date_setter()
   
 &date_setter returns html and javascript for a compact date-setting form.  &date_setter returns html and javascript for a compact date-setting form.
 To retrieve values from it, use &get_date_from_form().  To retrieve values from it, use &get_date_from_form.
   
 Inputs  Inputs
   
Line 636  sub build_url { Line 681  sub build_url {
   
 =pod  =pod
   
 =item &get_date_from_form  =item &get_date_from_form()
   
 get_date_from_form retrieves the date specified in an &date_setter form.  get_date_from_form retrieves the date specified in an &date_setter form.
   
Line 895  of items completed and an estimate of th Line 940  of items completed and an estimate of th
 =over 4  =over 4
   
   
 =item &Create_PrgWin  =item &Create_PrgWin()
   
 Writes javascript to the client to open a progress window and returns a  Writes javascript to the client to open a progress window and returns a
 data structure used for bookkeeping.  data structure used for bookkeeping.
Line 926  Inputs Line 971  Inputs
 Returns a hash containing the progress state data structure.  Returns a hash containing the progress state data structure.
   
   
 =item &Update_PrgWin  =item &Update_PrgWin()
   
 Updates the text in the progress indicator.  Does not increment the count.  Updates the text in the progress indicator.  Does not increment the count.
 See &Increment_PrgWin.  See &Increment_PrgWin.
Line 946  Inputs: Line 991  Inputs:
 Returns: none  Returns: none
   
   
 =item Increment_PrgWin  =item Increment_PrgWin()
   
 Increment the count of items completed for the progress window by $step or 1 if no step is provided.  Increment the count of items completed for the progress window by $step or 1 if no step is provided.
   
Line 968  Inputs: Line 1013  Inputs:
 Returns: none  Returns: none
   
   
 =item Close_PrgWin  =item &Close_PrgWin()
   
 Closes the progress window.  Closes the progress window.
   
Line 1072  sub Close_PrgWin { Line 1117  sub Close_PrgWin {
   
 sub crumbs {  sub crumbs {
     my ($uri,$target,$prefix,$form,$skiplast)=@_;      my ($uri,$target,$prefix,$form,$skiplast)=@_;
   # You cannot crumbnify uploaded or adm resources
       if ($uri=~/^\/*(uploaded|adm)\//) { return &mt('(Internal Course/Group Content)'); }
     if ($target) {      if ($target) {
         $target = ' target="'.          $target = ' target="'.
                   &Apache::loncommon::escape_single($target).'"';                    &Apache::loncommon::escape_single($target).'"';
Line 1109  sub crumbs { Line 1156  sub crumbs {
     if ($uri !~ m|/$|) { $output=~s|/$||; }      if ($uri !~ m|/$|) { $output=~s|/$||; }
     $output.='</span>';      $output.='</span>';
   
   
     return $output;      return $output;
 }  }
   
Line 1170  ENDEDITOR Line 1218  ENDEDITOR
 <script type="text/javascript" src="/adm/jQuery/js/jquery-1.6.2.min.js"></script>  <script type="text/javascript" src="/adm/jQuery/js/jquery-1.6.2.min.js"></script>
 <script type="text/javascript" src="/adm/jQuery/js/jquery-ui-1.8.16.custom.min.js"></script>  <script type="text/javascript" src="/adm/jQuery/js/jquery-ui-1.8.16.custom.min.js"></script>
 <link rel="stylesheet" type="text/css" href="/adm/jQuery/css/smoothness/jquery-ui-1.8.16.custom.css" />  <link rel="stylesheet" type="text/css" href="/adm/jQuery/css/smoothness/jquery-ui-1.8.16.custom.css" />
   <script type="text/javascript" src="/adm/jpicker/js/jpicker-1.1.6.min.js" >
   </script>
   <link rel="stylesheet" type="text/css" href="/adm/jpicker/css/jPicker-1.1.6.min.css" />
   <script type="text/javascript" src="/adm/countdown/js/jquery.countdown.js"></script>
   <link rel="stylesheet" type="text/css" href="/adm/countdown/css/jquery.countdown.css" />
 ENDJQUERY  ENDJQUERY
  return $s;   return $s;
 }  }
Line 1298  sub htmlareaselectactive { Line 1351  sub htmlareaselectactive {
  $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Enable rich text formatting (bold, italic, etc.)\" class=\"LC_enable_rt\"><b>Rich formatting &raquo;</b></a></div>");   $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Enable rich text formatting (bold, italic, etc.)\" class=\"LC_enable_rt\"><b>Rich formatting &raquo;</b></a></div>");
  $("#LC_rt_"+id).click(editorHandler);   $("#LC_rt_"+id).click(editorHandler);
  });   });
                   $.fn.jPicker.defaults.images.clientPath="/adm/jpicker/images/";
                   $(".colorchooser").jPicker();
   
   
  });   });
 ';  ';
       # Code to put a due date countdown in 'duedatecountdown' span.
       # This is currently located in the breadcrumb headers.
       # note that the dueDateLayout is internatinoalized below.
       # Here document is used to support the substitution into the javascript below.
       # ..which unforunately necessitates escaping the $'s in the javascript.
       # There are several times of importance
       #
       # serverDueDate -  The absolute time at which the problem expires.
       # serverTime    -  The server's time when the problem finished computing.
       # clientTime    -  The client's time...as close to serverTime as possible.
       #                  The clientTime will be slightly later due to
       #                  1. The latency between problem computation and 
       #                     the first network action.
       #                  2. The time required between the page load-start and the actual
       #                     initial javascript execution that got clientTime.
       # These are used as follows:
       #   The difference between clientTime and serverTime are used to 
       #   correct for differences in clock settings between the browser's system and the
       #   server's.
       #
       #   The difference between clientTime and the time at which the ready() method
       #   starts executing is used to estimate latencies for page load and submission.
       #   Since this is an estimate, it is doubled.  The latency estimate + one minute
       #   is used to determine when the countdown timer turns red to warn the user
       #   to think about submitting.
   
       my $dueDateLayout = '<b>' .  &mt('Due in: {dn} {dl} {hnn}{sep}{mnn}{sep}{snn} - Submit early!') . '</b>';
       $output .= <<JAVASCRIPT;
   
       var documentReadyTime;
   
   \$(document).ready(function() {
      if (typeof(dueDate) != "undefined") {
          documentReadyTime = (new Date()).getTime();
         \$("#duedatecountdown").countdown({until: dueDate, compact: true, 
            layout: "$dueDateLayout",
            onTick: function (periods) {
       var latencyEstimate = (documentReadyTime - clientTime) * 2;
               if(\$.countdown.periodsToSeconds(periods) < (60 + latencyEstimate)) {
                  \$(this).css("color", "red");   //Highlight last minute.
               }
            }
         });
      }
   });
   JAVASCRIPT
     if ($dragmath_prefix ne '') {      if ($dragmath_prefix ne '') {
         $output .= '          $output .= '
   
Line 1375  sub show_return_link { Line 1478  sub show_return_link {
 }  }
   
   
   ##
   #   Set the dueDate variable...note this is done in the timezone
   #   of the browser.
   #
   # @param epoch relative time at which the problem is due.
   #
   # @return the javascript fragment to set the date:
   #
   sub set_due_date {
       my $dueStamp = shift;
       my $duems    = $dueStamp * 1000; # Javascript Date object needs ms not seconds.
   
       my $now = time()*1000;
   
       # This slightly obscure bit of javascript sets the dueDate variable
       # to the time in the browser at which the problem was due.  
       # The code should correct for gross differences between the server
       # and client's time setting
   
       my $js = "
   <script type='text/javascript'>
     //<![CDATA[
   var serverDueDate = $duems;
   var serverTime    = $now;
   var clientTime    = (new Date()).getTime();
   var dueDate       = new Date(serverDueDate + (clientTime - serverTime));
   
     //]]>
   </script>
   ";
   
       return $js;
   }
   ##
   # Sets the time at which the problem finished computing.
   # This just updates the serverTime and clientTime variables above.
   # Calling this in e.g. end_problem provides a better estimate of the
   # difference beetween the server and client time setting as 
   # the difference contains less of the latency/problem compute time.
   #
   sub set_compute_end_time {
   
       my $now = time()*1000; # Javascript times are in ms.
       my $js = "
   <script type='text/javascript'>
   //<![CDATA[
   serverTime = $now;
   clientTime = (new Date()).getTime();
   //]]>
   </script>
   
   ";
       return $js;
       
   }
   
 ############################################################  ############################################################
 ############################################################  ############################################################
   
 =pod  =pod
   
 =item breadcrumbs  =item &breadcrumbs()
   
 Compiles the previously registered breadcrumbs into an series of links.  Compiles the previously registered breadcrumbs into an series of links.
 Additionally supports a 'component', which will be displayed on the  Additionally supports a 'component', which will be displayed on the
Line 1398  Inputs: $component (the text on the righ Line 1557  Inputs: $component (the text on the righ
            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()
   
 Clears the previously stored breadcrumbs.  Clears the previously stored breadcrumbs.
   
 =item add_breadcrumb  =item &add_breadcrumb()
   
 Pushes a breadcrumb on the stack of crumbs.  Pushes a breadcrumb on the stack of crumbs.
   
Line 1462  returns: nothing Line 1621  returns: nothing
         }          }
         my $links;          my $links;
         if ((&show_return_link) && (!$CourseBreadcrumbs)) {          if ((&show_return_link) && (!$CourseBreadcrumbs)) {
             my $alttext = 'Go Back';               my $alttext = &mt('Go Back');
             $links=&htmltag( 'a',"<img src='/res/adm/pages/reload.png' border='0' style='vertical-align:middle;' alt='$alttext' />",              $links=&htmltag( 'a',"<img src='/res/adm/pages/reload.png' border='0' style='vertical-align:middle;' alt='$alttext' />",
                             { href => '/adm/flip?postdata=return:',                              { href => '/adm/flip?postdata=return:',
                               title => &mt("Back to most recent content resource") });                                title => &mt("Back to most recent content resource") });
             $links=&htmltag('li',$links);               $links=&htmltag('li',$links);
         }          }
         $links.= join "",           $links.= join "", 
              map {               map {
Line 1493  returns: nothing Line 1652  returns: nothing
   
         # last breadcrumb is the first order heading of a page          # last breadcrumb is the first order heading of a page
         # for course breadcrumbs it's just bold          # for course breadcrumbs it's just bold
   
         $links .= &htmltag( 'li', htmltag($CourseBreadcrumbs ? 'b' : 'h1',          $links .= &htmltag( 'li', htmltag($CourseBreadcrumbs ? 'b' : 'h1',
                 $lasttext), {title => $lasttext});                  $lasttext), {title => $lasttext});
   
    $links .=   '<li> <span id="duedatecountdown"></span></li>'; 
   
         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'}));
Line 1513  returns: nothing Line 1675  returns: nothing
                                                          $faq,$bug);                                                           $faq,$bug);
         }          }
         #          #
   
   
   
         unless ($CourseBreadcrumbs) {          unless ($CourseBreadcrumbs) {
Line 1521  returns: nothing Line 1684  returns: nothing
             $links = &htmltag('ul',  $links, { class => "LC_CourseBreadcrumbs" });              $links = &htmltag('ul',  $links, { class => "LC_CourseBreadcrumbs" });
         }          }
   
   
         if ($component) {          if ($component) {
             $links = &htmltag('span',               $links = &htmltag('span', 
                              ( $no_mt ? $component : mt($component) ).                               ( $no_mt ? $component : mt($component) ).
                              ( $icons ? $icons : '' ),                               ( $icons ? $icons : '' ),
                              { class => 'LC_breadcrumbs_component' } )                               { class => 'LC_breadcrumbs_component' } )
                              .$links;                               .$links 
   ;
         }          }
                   
         &render_tools(\$links);          &render_tools(\$links);
Line 1537  returns: nothing Line 1702  returns: nothing
         # 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 the breadcrumb's line
   
       
   
         return "$links";          return "$links";
     }      }
   
Line 1550  returns: nothing Line 1720  returns: nothing
         push(@Crumbs,@_);          push(@Crumbs,@_);
     }      }
           
 =item add_breadcrumb_tool($category, $html)  =item &add_breadcrumb_tool($category, $html)
   
 Adds $html to $category of the breadcrumb toolbar container.  Adds $html to $category of the breadcrumb toolbar container.
   
Line 1593  returns: nothing Line 1763  returns: nothing
         push @{$tools{$category}}, @html;          push @{$tools{$category}}, @html;
     }      }
   
 =item clear_breadcrumb_tools()  =item &clear_breadcrumb_tools()
   
 Clears the breadcrumb toolbar container.  Clears the breadcrumb toolbar container.
   
Line 1605  returns: nothing Line 1775  returns: nothing
         undef(%tools);          undef(%tools);
     }      }
   
 =item render_tools(\$breadcrumbs)  =item &render_tools(\$breadcrumbs)
   
 Creates html for breadcrumb tools (categories navigation and tools) and inserts   Creates html for breadcrumb tools (categories navigation and tools) and inserts 
 \$breadcrumbs at the correct position.  \$breadcrumbs at the correct position.
Line 1614  input: \$breadcrumbs - a reference to th Line 1784  input: \$breadcrumbs - a reference to th
 breadcrumbs.  breadcrumbs.
   
 returns: nothing  returns: nothing
   
 =cut  =cut
   
 #TODO might split this in separate functions for each category  #TODO might split this in separate functions for each category
Line 1629  returns: nothing Line 1800  returns: nothing
                    { listattr => { class=>'LC_breadcrumb_tools_outerlist' } });                     { listattr => { class=>'LC_breadcrumb_tools_outerlist' } });
     }      }
   
 =item render_advtools(\$breadcrumbs)  =pod
   
   =item &render_advtools(\$breadcrumbs)
   
 Creates html for advanced tools (category advtools) and inserts \$breadcrumbs   Creates html for advanced tools (category advtools) and inserts \$breadcrumbs 
 at the correct position.  at the correct position.
Line 1638  input: \$breadcrumbs - a reference to th Line 1811  input: \$breadcrumbs - a reference to th
 breadcrumbs (after render_tools call).  breadcrumbs (after render_tools call).
   
 returns: nothing  returns: nothing
   
 =cut  =cut
   
     sub render_advtools {      sub render_advtools {
Line 2003  sub course_custom_roles { Line 2177  sub course_custom_roles {
   
   
 sub resource_info_box {  sub resource_info_box {
    my ($symb,$onlyfolderflag)=@_;     my ($symb,$onlyfolderflag,$stuvcurrent,$stuvdisp)=@_;
    my $return='';     my $return='';
      if ($stuvcurrent ne '') {
          $return = '<div class="LC_left_float">';
      }
    if ($symb) {     if ($symb) {
        $return=&Apache::loncommon::start_data_table();         $return.=&Apache::loncommon::start_data_table();
        my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb);         my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb);
        my $folder=&Apache::lonnet::gettitle($map);         my $folder=&Apache::lonnet::gettitle($map);
        $return.=&Apache::loncommon::start_data_table_row().         $return.=&Apache::loncommon::start_data_table_row().
                     '<th>'.&mt('Folder:').'</th><td>'.$folder.'</td>'.                      '<th align="left">'.&mt('Folder:').'</th><td>'.$folder.'</td>'.
                     &Apache::loncommon::end_data_table_row();                      &Apache::loncommon::end_data_table_row();
        unless ($onlyfolderflag) {         unless ($onlyfolderflag) {
           $return.=&Apache::loncommon::start_data_table_row().            $return.=&Apache::loncommon::start_data_table_row().
                     '<th>'.&mt('Resource:').'</th><td>'.&Apache::lonnet::gettitle($symb).'</td>'.                      '<th align="left">'.&mt('Resource:').'</th><td>'.&Apache::lonnet::gettitle($symb).'</td>'.
                       &Apache::loncommon::end_data_table_row();
          }
          if ($stuvcurrent ne '') {
              $return .= &Apache::loncommon::start_data_table_row().
                       '<th align="left">'.&mt("Student's current version:").'</th><td>'.$stuvcurrent.'</td>'.
                       &Apache::loncommon::end_data_table_row();
          }
          if ($stuvdisp ne '') {
              $return .= &Apache::loncommon::start_data_table_row().
                       '<th align="left">'.&mt("Student's version displayed:").'</th><td>'.$stuvdisp.'</td>'.
                     &Apache::loncommon::end_data_table_row();                      &Apache::loncommon::end_data_table_row();
        }         }
        $return.=&Apache::loncommon::end_data_table();         $return.=&Apache::loncommon::end_data_table();
     } else {      } else {
        $return='<p><span class="LC_error">'.&mt('No context provided.').'</span></p>';         $return='<p><span class="LC_error">'.&mt('No context provided.').'</span></p>';
     }      }
       if ($stuvcurrent ne '') {
           $return .= '</div>';
       }
     return $return;      return $return;
   
 }  }
   
 ##############################################  ##############################################
Line 2623  sub scripttag { Line 2812  sub scripttag {
     return htmltag('script', $content, {type => 'text/javascript'});      return htmltag('script', $content, {type => 'text/javascript'});
 };  };
   
   =pod
   
 =item list_from_array( \@array, { listattr =>{}, itemattr =>{} } )  =item &list_from_array( \@array, { listattr =>{}, itemattr =>{} } )
   
 Constructs a XHTML list from \@array.  Constructs a XHTML list from \@array.
   
Line 2715  sub generate_menu { Line 2905  sub generate_menu {
                                 $$link{alttext} : $$link{linktext})                                  $$link{alttext} : $$link{linktext})
                             }), {                              }), {
                             href  => $$link{url},                              href  => $$link{url},
                             title => mt($$link{linktitle})                              title => mt($$link{linktitle}),
                               class => 'LC_menubuttons_link'
                             }).                              }).
                         $a->(mt($$link{linktext}), {                          $a->(mt($$link{linktext}), {
                             href  => $$link{url},                              href  => $$link{url},
Line 2749  sub generate_menu { Line 2940  sub generate_menu {
   
 =pod  =pod
   
 =item &start_funclist  =item &start_funclist()
   
 Start list of available functions  Start list of available functions
   
Line 2789  sub start_funclist { Line 2980  sub start_funclist {
   
 =pod  =pod
   
 =item &add_item_funclist  =item &add_item_funclist()
   
 Adds an item to the list of available functions  Adds an item to the list of available functions
   
Line 2815  sub add_item_funclist { Line 3006  sub add_item_funclist {
   
 =pod  =pod
   
 =item &end_funclist  =item &end_funclist()
   
 End list of available functions  End list of available functions
   
Line 2836  sub end_funclist { Line 3027  sub end_funclist {
   
 =pod  =pod
   
 =item funclist_from_array( \@array, {legend => 'text for legend'} )  =item &funclist_from_array( \@array, {legend => 'text for legend'} )
   
 Constructs a XHTML list from \@array with the first item being visually  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  highlighted and set to the value of legend or 'Functions' if legend is

Removed from v.1.298  
changed lines
  Added in v.1.310


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