--- loncom/interface/lonhtmlcommon.pm	2009/06/08 18:04:45	1.222
+++ loncom/interface/lonhtmlcommon.pm	2009/08/13 14:54:52	1.233
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common html routines
 #
-# $Id: lonhtmlcommon.pm,v 1.222 2009/06/08 18:04:45 bisitz Exp $
+# $Id: lonhtmlcommon.pm,v 1.233 2009/08/13 14:54:52 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -82,7 +82,7 @@ sub confirm_success {
             .'</span>'."\n";
    } else {
       return '<span class="LC_success">'."\n"
-            .'<img src="/adm/lonIcons/navmap.correct.gif" alt="'.&mt('Ok').'" /> '."\n"
+            .'<img src="/adm/lonIcons/navmap.correct.gif" alt="'.&mt('OK').'" /> '."\n"
             .$message."\n"
             .'</span>'."\n";
    }
@@ -160,8 +160,8 @@ sub authorbombs {
     $url=&Apache::lonnet::declutter($url);
     my ($udom,$uname)=($url=~m{^($LONCAPA::domain_re)/($LONCAPA::username_re)/});
     my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);
-    foreach (keys %bombs) {
-	if ($_=~/^$udom\/$uname\//) {
+    foreach my $bomb (keys(%bombs)) {
+	if ($bomb =~ /^$udom\/$uname\//) {
 	    return '<a href="/adm/bombs/'.$url.
 		'"><img src="'.&Apache::loncommon::lonhttpdurl('/adm/lonMisc/bomb.gif').'" alt="'.&mt('Bomb').'" border="0" /></a>'.
 		&Apache::loncommon::help_open_topic('About_Bombs');
@@ -239,7 +239,7 @@ sub get_recent {
 # Begin filling return_hash with any 'always_include' option
     my %time_hash = ();
     my %return_hash = ();
-    foreach my $item (keys %recent) {
+    foreach my $item (keys(%recent)) {
         my ($thistime,$thisvalue)=(split(/\&/,$recent{$item}));
         if ($thistime eq 'always_include') {
             $return_hash{$item} = &unescape($thisvalue);
@@ -505,23 +505,23 @@ ENDJS
     unshift(@Months,'If you can read this an error occurred');
     if ($includeempty) { $monthselector.="<option value=''></option>"; }
     for(my $m = 1;$m <=$#Months;$m++) {
-        $monthselector .= qq{      <option value="$m" };
-        $monthselector .= "selected " if ($m-1 eq $month);
-        $monthselector .= '> '.&mt($Months[$m]).' </option>';
+        $monthselector .= qq{      <option value="$m"};
+        $monthselector .= ' selected="selected"' if ($m-1 eq $month);
+        $monthselector .= '> '.&mt($Months[$m]).' </option>'."\n";
     }
     $monthselector.= '  </select>';
     # Day
     my $dayselector = qq{<input type="text" name="$dname\_day" $state value="$mday" size="3" $special onchange="javascript:$dname\_checkday()" />};
     # 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 >};
     if ($includeempty) { 
         $hourselector.=qq{<option value=''></option>};
     }
     for (my $h = 0;$h<24;$h++) {
-        $hourselector .= qq{<option value="$h" };
-        $hourselector .= "selected " if (defined($hour) && $hour == $h);
+        $hourselector .= qq{<option value="$h"};
+        $hourselector .= ' selected="selected"' if (defined($hour) && $hour == $h);
         $hourselector .= ">";
         my $timest='';
         if ($h == 0) {
@@ -609,7 +609,7 @@ Inputs:
 
 =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
 
@@ -978,8 +978,7 @@ sub Create_PrgWin {
 
 	#the whole function called through timeout is due to issues
 	#in mozilla Read BUG #2665 if you want to know the whole story
-	&r_print($r,'<script type="text/javascript">'.
-        '// <![CDATA['.
+	&r_print($r,&Apache::lonhtmlcommon::scripttag(
         "var popwin;
          function openpopwin () {
          popwin=open(\'\',\'popwin\',\'width=400,height=100\');".
@@ -990,9 +989,8 @@ sub Create_PrgWin {
 	      &mt('Starting').'" /><\\/form>'.$end_page.
               "\');".
         "popwin.document.close();}".
-        "\nwindow.setTimeout(openpopwin,0)".
-        '// ]]>'.
-        '</script>');
+        "\nwindow.setTimeout(openpopwin,0)"
+    ));
 	$prog_state{'formname'}='popremain';
 	$prog_state{'inputname'}="remaining";
     } elsif ($type eq 'inline') {
@@ -1025,14 +1023,12 @@ sub Create_PrgWin {
 # update progress
 sub Update_PrgWin {
     my ($r,$prog_state,$displayString)=@_;
-    &r_print($r,'<script type="text/javascript">'.
-        '// <![CDATA['.
+    &r_print($r,&Apache::lonhtmlcommon::scripttag(
         $$prog_state{'window'}.'.document.'.
-	     $$prog_state{'formname'}.'.'.
-	     $$prog_state{'inputname'}.'.value="'.
-	     $displayString.'";'.
-        '// ]]>'.
-        '</script>');
+        $$prog_state{'formname'}.'.'.
+        $$prog_state{'inputname'}.'.value="'.
+        $displayString.'";'
+    ));
     $$prog_state{'laststart'}=&Time::HiRes::time();
 }
 
@@ -1085,15 +1081,13 @@ sub Increment_PrgWin {
     if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
         $lasttime = '';
     }
-    &r_print($r,'<script>'.
-        '// <![CDATA['.
+    &r_print($r,&Apache::lonhtmlcommon::scripttag(
         $$prog_state{'window'}.'.document.'.
-	     $$prog_state{'formname'}.'.'.
-	     $$prog_state{'inputname'}.'.value="'.
-	     $$prog_state{'done'}.'/'.$$prog_state{'max'}.
-	     ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'.
-        '// ]]>'.
-        '</script>');
+        $$prog_state{'formname'}.'.'.
+        $$prog_state{'inputname'}.'.value="'.
+        $$prog_state{'done'}.'/'.$$prog_state{'max'}.
+        ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'
+    ));
     $$prog_state{'laststart'}=&Time::HiRes::time();
 }
 
@@ -1101,11 +1095,9 @@ sub Increment_PrgWin {
 sub Close_PrgWin {
     my ($r,$prog_state)=@_;
     if ($$prog_state{'type'} eq 'popup') {
-        &r_print($r,'<script>'.
-            '// <![CDATA['.
-            'popwin.close()'.
-            '// ]]>'.
-            '</script>'."\n");
+        &r_print($r,&Apache::lonhtmlcommon::scripttag(
+            'popwin.close()'
+        ));
     } elsif ($$prog_state{'type'} eq 'inline') {
 	&Update_PrgWin($r,$prog_state,&mt('Done'));
     }
@@ -1272,8 +1264,8 @@ sub htmlareaselectactive {
     my @fields=@_;
     unless (&htmlareabrowser()) { return ''; }
     if (&htmlareablocked()) { return '<br />'.&enablelink(@fields); }
-    my $output='<script type="text/javascript" defer="1">'
-              .'// <![CDATA[';
+    my $output='<script type="text/javascript" defer="1">'."\n"
+              .'// <![CDATA['."\n";
     my $lang = &htmlarea_lang();
     foreach my $field (@fields) {
 	$output.="
@@ -1287,7 +1279,7 @@ sub htmlareaselectactive {
 }";
     }
     $output.="\nwindow.status='Activated Editfields';\n"
-            .'// ]]>'
+            .'// ]]>'."\n"
             .'</script><br />'.
 	&disablelink(@fields);
     return $output;
@@ -1314,15 +1306,13 @@ sub htmlareabrowser {
 =item breadcrumbs
 
 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
-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.
 
 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
         $menulink (boolean, controls whether to include a link to /adm/menu)
         $helplink (if 'nohelp' don't include the orange help link)
@@ -1357,20 +1347,13 @@ returns: nothing
         my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt, $CourseBreadcrumbs) = @_;
         #
         $css_class ||= 'LC_breadcrumbs';
-        my $Str1 = '<div id="LC_head_subbox"><ol id="LC_MenuBreadcrumbs">';
-	
-		if($CourseBreadcrumbs){
-			$Str1 = '<ul id="LC_CourseBreadcrumbs">';
-		}
 
-        my $Str = '';
-        #
         # Make the faq and bug data cascade
-        my $faq = '';
-        my $bug = '';
-        my $help='';
+        my $faq  = '';
+        my $bug  = '';
+        my $help = '';
         # Crumb Symbol
-        my $crumbsymbol = '&raquo;&nbsp;';
+        my $crumbsymbol = '&raquo;';
         # The last breadcrumb does not have a link, so handle it separately.
         my $last = pop(@Crumbs);
         #
@@ -1405,30 +1388,26 @@ returns: nothing
                      $help = $_->{'help'} if (exists($_->{'help'}));
 
                      my $result = htmltag( 'a', 
-                                           $_->{no_mt} ? $_->{text} : mt($_->{text}), 
+                                           $_->{no_mt} ? 
+                                            $_->{text} : mt($_->{text}), 
                                            { 
                                                href   => $_->{href},
-                                               title  => $_->{no_mt} ? $_->{title} : mt($_->{title}),
+                                               title  => $_->{no_mt} ? 
+                                                $_->{title} : mt($_->{title}),
                                                target => $_->{target},
                                            });
-                     $result = htmltag( 'li', $crumbsymbol.$result);
+                     $result = htmltag( 'li', "$result $crumbsymbol");
                      } @Crumbs;
-#Workaround for edit course. 
-	if(@Crumbs == 0 ){
-		$links .= '<li>' if ($links ne '');
-	} else {
-		$links .= '<li>'.$crumbsymbol if ($links ne '');
-	}
-#should the last Element be translated?
-	if ($last->{'no_mt'}) {
-	    $links .= '<b>'.$last->{'text'}.'</b>';
-	} else {
-	    $links .= '<b>'.&mt($last->{'text'}).'</b>';
-	}
-	$links .= '</li>';
+
+        #should the last Element be translated?
+        $links  .= htmltag( 'li', 
+                        htmltag( 'b', 
+                                 $last->{'no_mt'} ? 
+                                 $last->{'text'} : mt($last->{'text'}) ));
+
         my $icons = '';
-        $faq = $last->{'faq'} if (exists($last->{'faq'}));
-        $bug = $last->{'bug'} if (exists($last->{'bug'}));
+        $faq  = $last->{'faq'}  if (exists($last->{'faq'}));
+        $bug  = $last->{'bug'}  if (exists($last->{'bug'}));
         $help = $last->{'help'} if (exists($last->{'help'}));
         $component_help=($component_help?$component_help:$help);
 #        if ($faq ne '') {
@@ -1437,39 +1416,36 @@ returns: nothing
 #        if ($bug ne '') {
 #            $icons .= &Apache::loncommon::help_open_bug($bug);
 #        }
-	if ($faq ne '' || $component_help ne '' || $bug ne '') {
-	    $icons .= &Apache::loncommon::help_open_menu($component,
-							 $component_help,
-							 $faq,$bug);
-	}
+        if ($faq ne '' || $component_help ne '' || $bug ne '') {
+            $icons .= &Apache::loncommon::help_open_menu($component,
+                                                         $component_help,
+                                                         $faq,$bug);
+        }
         #
 		
 
-		if($CourseBreadcrumbs){
-        	$Str1 .= $links.'</ul>';
-		} else {
-        	$Str1 .= $links.'</ol></div>';		
-		}
-        #
-        if (defined($component)) {
-            $Str .= "\n".'<table class="'.$css_class.'">'
-                   .'<tr><td class="'.$css_class.'_component">';
-            if ($no_mt) {
-                $Str .= $component;
-            } else {
-                $Str .= &mt($component);
-            }
-	    if ($icons ne '') {
-		$Str .= '&nbsp;'.$icons;
-	    }
-	    $Str .= '</td></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;
+        }
+        
+        $links = htmltag('div', $links, 
+                        { id => "LC_breadcrumbs" }) unless ($CourseBreadcrumbs) ;
+
         # Return the @Crumbs stack to what we started with
         push(@Crumbs,$last);
         shift(@Crumbs);
-        # Return a table and after that the breadcrumb's line
-        return "$Str\n$Str1";
+        # Return the breadcrumb's line
+        return "$links";
     }
 
     sub clear_breadcrumbs {
@@ -1477,7 +1453,7 @@ returns: nothing
     }
 
     sub add_breadcrumb {
-        push (@Crumbs,@_);
+        push(@Crumbs,@_);
     }
 
 } # End of scope for @Crumbs
@@ -2133,6 +2109,41 @@ sub inittags {
 }
 
 
+# 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'});
+};
+
+
 ##############################################
 ##############################################
 
@@ -2183,7 +2194,7 @@ sub generate_menu {
             # 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.
-            push @links, $li->(
+            push(@links,$li->(
                         $a->(
                             $img->("", {
                                 class => "LC_noBorder LC_middle",
@@ -2201,7 +2212,7 @@ sub generate_menu {
                             }).
                          (defined($$link{help}) ? 
                          Apache::loncommon::help_open_topic($$link{help}) : ''),
-                         {class => "LC_menubuttons_inline_text"});
+                         {class => "LC_menubuttons_inline_text"}));
         }
 
         # wrap categorytitle in <h3>, concatenate with 
@@ -2211,16 +2222,115 @@ sub generate_menu {
         # 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, 
+        push(@categories, 
             $div->($h3->(mt($$category{categorytitle}), {class=>"LC_hcell"}).
             $ul->(join('' ,@links),  {class =>"LC_ListStyleNormal" }),
-            {class=>"LC_Box LC_400Box"}) if scalar(@links);
+            {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 "<fieldset>\n<legend>$legendtext</legend>\n"
+          .'<ul class="LC_funclist">'."\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 {
+    my($r)=@_;
+    return "</ul>\n</fieldset>\n";
+}
+
 1;
 
 __END__