--- loncom/interface/lonhtmlcommon.pm	2009/08/13 16:05:33	1.182.4.3
+++ loncom/interface/lonhtmlcommon.pm	2009/02/22 18:30:27	1.203
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common html routines
 #
-# $Id: lonhtmlcommon.pm,v 1.182.4.3 2009/08/13 16:05:33 raeburn Exp $
+# $Id: lonhtmlcommon.pm,v 1.203 2009/02/22 18:30:27 harmsja Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -62,31 +62,6 @@ use Apache::lonlocal;
 use Apache::lonnet;
 use LONCAPA;
 
-##############################################
-##############################################
-
-=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";
-   }
-}
 
 ##############################################
 ##############################################
@@ -130,13 +105,11 @@ sub dragmath_js {
     my ($popup) = @_;
     return <<ENDDRAGMATHJS;
                 <script type="text/javascript">
-                // <![CDATA[
                   function mathedit(textarea, doc) {
                      targetEntry = textarea;
                      targetDoc   = doc;
                      newwin  = window.open("/adm/dragmath/applet/$popup.html","","width=565,height=500,resizable");
                   }
-                // ]]>
                 </script>
 
 ENDDRAGMATHJS
@@ -312,7 +285,7 @@ sub checkbox {
         $Str .= 'value="'.$value.'"';
     } 
     if ($checked) {
-        $Str .= ' checked="checked"';
+        $Str .= ' checked="1"';
     }
     $Str .= ' />';
     return $Str;
@@ -334,7 +307,7 @@ sub radio {
         $Str .= 'value="'.$value.'"';
     } 
     if ($checked eq $value) {
-        $Str .= ' checked="checked"';
+        $Str .= ' checked="1"';
     }
     $Str .= ' />';
     return $Str;
@@ -432,7 +405,6 @@ sub date_setter {
     my $result = "\n<!-- $dname date setting form -->\n";
     $result .= <<ENDJS;
 <script type="text/javascript">
-// <![CDATA[
     function $dname\_checkday() {
         var day   = document.$formname.$dname\_day.value;
         var month = document.$formname.$dname\_month.value;
@@ -493,10 +465,9 @@ document.$formname.$dname\_year.value,
         }
 
     }
-// ]]>
 </script>
 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()" >};
     # Month
     my @Months = qw/January February  March     April   May      June 
@@ -979,7 +950,6 @@ 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['.
         "var popwin;
          function openpopwin () {
          popwin=open(\'\',\'popwin\',\'width=400,height=100\');".
@@ -990,9 +960,7 @@ sub Create_PrgWin {
 	      &mt('Starting').'" /><\\/form>'.$end_page.
               "\');".
         "popwin.document.close();}".
-        "\nwindow.setTimeout(openpopwin,0).
-        '// ]]>'.
-        '</script>");
+        "\nwindow.setTimeout(openpopwin,0)</script>");
 	$prog_state{'formname'}='popremain';
 	$prog_state{'inputname'}="remaining";
     } elsif ($type eq 'inline') {
@@ -1025,14 +993,10 @@ sub Create_PrgWin {
 # update progress
 sub Update_PrgWin {
     my ($r,$prog_state,$displayString)=@_;
-    &r_print($r,'<script type="text/javascript">'.
-             '// <![CDATA['.
-             $$prog_state{'window'}.'.document.'.
+    &r_print($r,'<script type="text/javascript">'.$$prog_state{'window'}.'.document.'.
 	     $$prog_state{'formname'}.'.'.
 	     $$prog_state{'inputname'}.'.value="'.
-	     $displayString.'";'.
-             '// ]]>'.
-             '</script>');
+	     $displayString.'";</script>');
     $$prog_state{'laststart'}=&Time::HiRes::time();
 }
 
@@ -1085,15 +1049,11 @@ sub Increment_PrgWin {
     if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
         $lasttime = '';
     }
-    &r_print($r,'<script>'.
-             '// <![CDATA['.
-             $$prog_state{'window'}.'.document.'.
+    &r_print($r,'<script>'.$$prog_state{'window'}.'.document.'.
 	     $$prog_state{'formname'}.'.'.
 	     $$prog_state{'inputname'}.'.value="'.
 	     $$prog_state{'done'}.'/'.$$prog_state{'max'}.
-	     ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'.
-             '// ]]>'.
-             '</script>');
+	     ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'.'</script>');
     $$prog_state{'laststart'}=&Time::HiRes::time();
 }
 
@@ -1101,11 +1061,7 @@ 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,'<script>popwin.close()</script>'."\n");
     } elsif ($$prog_state{'type'} eq 'inline') {
 	&Update_PrgWin($r,$prog_state,&mt('Done'));
     }
@@ -1186,8 +1142,7 @@ sub spellheader {
 
     my $nothing=&javascript_nothing();
     return (<<ENDCHECK);
-<script type="text/javascript">
-// <![CDATA[
+<script type="text/javascript"> 
 //<!-- BEGIN LON-CAPA Internal
 var checkwin;
 
@@ -1198,7 +1153,6 @@ function spellcheckerwindow(string) {
     checkwin.document.close();
 }
 // END LON-CAPA Internal -->
-// ]]>
 </script>
 ENDCHECK
 }
@@ -1272,8 +1226,7 @@ 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">';
     my $lang = &htmlarea_lang();
     foreach my $field (@fields) {
 	$output.="
@@ -1286,9 +1239,7 @@ sub htmlareaselectactive {
     oFCKeditor.Config['DefaultLanguage'] = '$lang';
 }";
     }
-    $output.="\nwindow.status='Activated Editfields';\n".
-             '// ]]>'.
-             '</script><br />'.
+    $output.="\nwindow.status='Activated Editfields';\n</script><br />".
 	&disablelink(@fields);
     return $output;
 }
@@ -1327,6 +1278,8 @@ Inputs: $component (the large text on th
         $menulink (boolean, controls whether to include a link to /adm/menu)
         $helplink (if 'nohelp' don't include the orange help link)
         $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
+           when including the text on the right.
 Returns a string containing breadcrumbs for the current page.
 
 =item clear_breadcrumbs
@@ -1355,14 +1308,15 @@ returns: nothing
         my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt) = @_;
         #
 	$css_class ||= 'LC_breadcrumbs';
-        my $Str = "\n".'<table class="'.$css_class.'"><tr><td>';
+        my $Str1 = '<ol id="LC_MenuBreadcrumbs">';
+        my $Str = '';
         #
         # Make the faq and bug data cascade
         my $faq = '';
         my $bug = '';
 	my $help='';
 	# Crumb Symbol
-	my $crumbsymbol = '&raquo;&nbsp;';
+	my $crumbsymbol = '&#x25b6; ';
         # The last breadcrumb does not have a link, so handle it separately.
         my $last = pop(@Crumbs);
         #
@@ -1385,8 +1339,8 @@ returns: nothing
                     no_mt  =>$no_mt_descr,
                 });
         }
-        my $links .= 
-            join($crumbsymbol,
+        my $links .= '<li>'.
+            join('</li><li>'.$crumbsymbol,
                  map {
                      $faq = $_->{'faq'} if (exists($_->{'faq'}));
                      $bug = $_->{'bug'} if (exists($_->{'bug'}));
@@ -1404,12 +1358,12 @@ returns: nothing
 		     }
                      $result;
                      } @Crumbs
-                 );
-        $links .= $crumbsymbol if ($links ne '');
+                 ).'</li>';
+        $links .= '<li>'.$crumbsymbol if ($links ne '');
 	if ($last->{'no_mt'}) {
-	    $links .= '<b>'.$last->{'text'}.'</b>';
+	    $links .= '<b>'.$last->{'text'}.'</b></li>';
 	} else {
-	    $links .= '<b>'.&mt($last->{'text'}).'</b>';
+	    $links .= '<b>'.&mt($last->{'text'}).'</b></li>';
 	}
         #
         my $icons = '';
@@ -1429,10 +1383,11 @@ returns: nothing
 							 $faq,$bug);
 	}
         #
-        $Str .= $links.'</td>';
+        $Str1 .= $links.'</ol>';
         #
         if (defined($component)) {
-            $Str .= '<td class="'.$css_class.'_component">';
+            $Str .= "\n".'<table class="'.$css_class.'">'
+                   .'<tr><td class="'.$css_class.'_component">';
             if ($no_mt) {
                 $Str .= $component;
             } else {
@@ -1441,15 +1396,14 @@ returns: nothing
 	    if ($icons ne '') {
 		$Str .= '&nbsp;'.$icons;
 	    }
-	    $Str .= '</td>';
+	    $Str .= '</td></tr></table>'."\n";
         }
-        $Str .= '</tr></table>'."\n";
         #
         # Return the @Crumbs stack to what we started with
         push(@Crumbs,$last);
         shift(@Crumbs);
         #
-        return $Str;
+        return "$Str\n$Str1";
     }
 
     sub clear_breadcrumbs {
@@ -1551,9 +1505,9 @@ END
 }
 
 sub row_title {
-    my ($title,$css_title_class,$css_value_class) = @_;
     $row_count[0]++;
     my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
+    my ($title,$css_title_class,$css_value_class) = @_;
     $css_title_class ||= 'LC_pick_box_title';
     $css_title_class = 'class="'.$css_title_class.'"';
 
@@ -1599,7 +1553,7 @@ sub role_select_row {
         $output = &row_title($title,$css_class);
     }
     $output .= qq|
-                                  <select name="roles" multiple="multiple" >\n|;
+                                  <select name="roles" multiple="multiple">\n|;
     foreach my $role (@$roles) {
         my $plrole;
         if ($role eq 'ow') {
@@ -1644,7 +1598,6 @@ sub course_selection {
     my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles) = @_;
     my $output = qq|
 <script type="text/javascript">
-// <![CDATA[
     function coursePick (formname) {
         for  (var i=0; i<formname.coursepick.length; i++) {
             if (formname.coursepick[i].value == 'category') {
@@ -1667,7 +1620,6 @@ sub course_selection {
             formname.courselist = '';
         }
     }
-// ]]>
 </script>
     |;
     my $courseform='<b>'.&Apache::loncommon::selectcourse_link
@@ -1772,6 +1724,7 @@ sub email_default_row {
 
 sub submit_row {
     my ($title,$cmd,$submit_text,$css_class) = @_;
+    $submit_text = &mt($submit_text);
     my $output = &row_title($title,$css_class,'LC_pick_box_submit');
     $output .= qq|
              <br />
@@ -1813,7 +1766,8 @@ sub topic_bar {
     return '
 <div class="LC_topic_bar">
     <img alt="'.&mt('Step [_1]',$imgnum).
-              '" src="/res/adm/pages/bl_step'.$imgnum.'.gif" />&nbsp;'.$title
+              '"src="/res/adm/pages/bl_step'.$imgnum.'.gif" />&nbsp;
+    <span>'.$title.'</span>
 </div>
 ';
 }
@@ -2067,7 +2021,108 @@ END
     return $scripttag;
 }
 
+##############################################
+##############################################
 
+# 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.
+
+# ---- Remove when done ----
+# This routine is part of the redesign of LON-CAPA and it's 
+# subject to change during this project.
+# Don't rely on its current functionality as it might be 
+# changed or removed.
+# --------------------------
+sub generate_menu {
+    my @menu = @_;
+
+    # usage: $wrap->(element, content, {attribute => value,...});
+    # output: content enclosed in html conform tags
+    my $wrap = sub {
+        return
+            qq|<$_[0]|
+          . join( '', map { qq| $_="${$_[2]}{$_}"| } keys %{ $_[2] } )
+          . ($_[1] ? qq|>$_[1]</$_[0]>| : qq|/>|). "\n";
+    };
+    
+    # subs for specific html elements
+    my $h3  = sub { return $wrap->( "h3",  @_ ) };
+    my $div = sub { return $wrap->( "div", @_ ) };
+    my $ul  = sub { return $wrap->( "ul",  @_ ) };
+    my $li  = sub { return $wrap->( "li",  @_ ) };
+    my $a   = sub { return $wrap->( "a",   @_ ) };
+    my $img = sub { return $wrap->( "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.
+            push @links, $li->(
+                        $a->(
+                            $img->("", {
+                                class => "LC_noBorder LC_middle",
+                                src   => "/res/adm/pages/$$link{icon}",
+                                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_ContentBoxSpecial LC_400Box"}) if scalar(@links);
+    }
+
+    # wrap the joined @categories in another <div> (column layout)
+    return $div->(join('', @categories), {class => "LC_columnSection"});
+}
 
 1;