--- loncom/interface/lonhtmlcommon.pm	2009/08/14 12:18:46	1.182.4.7
+++ loncom/interface/lonhtmlcommon.pm	2009/08/10 16:27:39	1.230
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common html routines
 #
-# $Id: lonhtmlcommon.pm,v 1.182.4.7 2009/08/14 12:18:46 raeburn Exp $
+# $Id: lonhtmlcommon.pm,v 1.230 2009/08/10 16:27:39 bisitz 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";
    }
@@ -163,7 +163,7 @@ sub authorbombs {
     foreach (keys %bombs) {
 	if ($_=~/^$udom\/$uname\//) {
 	    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');
 	}
     }
@@ -496,7 +496,7 @@ 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 
@@ -978,21 +978,19 @@ 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">'."\n".
-        '// <![CDATA['."\n".
+	&r_print($r,&Apache::lonhtmlcommon::scripttag(
         "var popwin;
          function openpopwin () {
          popwin=open(\'\',\'popwin\',\'width=400,height=100\');".
         "popwin.document.writeln(\'".$start_page.
               "<h4>".&mt("$heading")."<\/h4>".
-              "<form action= \"\" name=\"popremain\" method=\"post\">".
+              "<form action=\"\" name=\"popremain\" method=\"post\">".
               '<input type="text" size="'.$width.'" name="remaining" value="'.
 	      &mt('Starting').'" /><\\/form>'.$end_page.
               "\');".
         "popwin.document.close();}".
-        "\nwindow.setTimeout(openpopwin,0)\n".
-        '// ]]>'."\n".
-        '</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">'."\n".
-             '// <![CDATA['."\n".
-             $$prog_state{'window'}.'.document.'.
-	     $$prog_state{'formname'}.'.'.
-	     $$prog_state{'inputname'}.'.value="'.
-	     $displayString.'";'."\n".
-             '// ]]>'."\n".
-             '</script>');
+    &r_print($r,&Apache::lonhtmlcommon::scripttag(
+        $$prog_state{'window'}.'.document.'.
+        $$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>'."\n".
-             '// <![CDATA['."\n".
-             $$prog_state{'window'}.'.document.'.
-	     $$prog_state{'formname'}.'.'.
-	     $$prog_state{'inputname'}.'.value="'.
-	     $$prog_state{'done'}.'/'.$$prog_state{'max'}.
-	     ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'."\n".
-             '// ]]>'."\n".
-             '</script>');
+    &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.'";'
+    ));
     $$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>'."\n".
-                 '// <![CDATA['."\n".
-                 'popwin.close()'."n".
-                 '// ]]>'."\n".
-                 '</script>'."\n");
+        &r_print($r,&Apache::lonhtmlcommon::scripttag(
+            'popwin.close()'
+        ));
     } elsif ($$prog_state{'type'} eq 'inline') {
 	&Update_PrgWin($r,$prog_state,&mt('Done'));
     }
@@ -1186,7 +1178,7 @@ sub spellheader {
 
     my $nothing=&javascript_nothing();
     return (<<ENDCHECK);
-<script type="text/javascript">
+<script type="text/javascript"> 
 // <![CDATA[
 //<!-- BEGIN LON-CAPA Internal
 var checkwin;
@@ -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.="
@@ -1286,9 +1278,9 @@ sub htmlareaselectactive {
     oFCKeditor.Config['DefaultLanguage'] = '$lang';
 }";
     }
-    $output.="\nwindow.status='Activated Editfields';\n".
-             '// ]]>'."\n".
-             '</script><br />'.
+    $output.="\nwindow.status='Activated Editfields';\n"
+            .'// ]]>'."\n"
+            .'</script><br />'.
 	&disablelink(@fields);
     return $output;
 }
@@ -1314,19 +1306,19 @@ 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)
         $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
@@ -1352,22 +1344,21 @@ returns: nothing
     my @Crumbs;
     
     sub breadcrumbs {
-        my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt) = @_;
-        #
-	$css_class ||= 'LC_breadcrumbs';
-        my $Str = "\n".'<table class="'.$css_class.'"><tr><td>';
+        my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt, $CourseBreadcrumbs) = @_;
         #
+        $css_class ||= 'LC_breadcrumbs';
+
         # Make the faq and bug data cascade
-        my $faq = '';
-        my $bug = '';
-	my $help='';
-	# Crumb Symbol
-	my $crumbsymbol = '&raquo;&nbsp;';
+        my $faq  = '';
+        my $bug  = '';
+        my $help = '';
+        # Crumb Symbol
+        my $crumbsymbol = '&raquo;';
         # The last breadcrumb does not have a link, so handle it separately.
         my $last = pop(@Crumbs);
         #
         # The first one should be the course or a menu link
-	if (!defined($menulink)) { $menulink=1; }
+        if (!defined($menulink)) { $menulink=1; }
         if ($menulink) {
             my $description = 'Menu';
             my $no_mt_descr = 0;
@@ -1377,44 +1368,46 @@ returns: nothing
                     $env{'course.'.$env{'request.course.id'}.'.description'};
                 $no_mt_descr = 1;
             }
-            unshift(@Crumbs,{
-                    href   =>'/adm/menu',
-                    title  =>'Go to main menu',
-                    target =>'_top',
-                    text   =>$description,
-                    no_mt  =>$no_mt_descr,
-                });
+            $menulink =  {  href   =>'/adm/menu',
+                            title  =>'Go to main menu',
+                            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 .= 
-            join($crumbsymbol,
+        my $links = join "", 
                  map {
-                     $faq = $_->{'faq'} if (exists($_->{'faq'}));
-                     $bug = $_->{'bug'} if (exists($_->{'bug'}));
+                     $faq  = $_->{'faq'}  if (exists($_->{'faq'}));
+                     $bug  = $_->{'bug'}  if (exists($_->{'bug'}));
                      $help = $_->{'help'} if (exists($_->{'help'}));
-                     my $result = '<a href="'.$_->{'href'}.'" ';
-                     if (defined($_->{'target'}) && $_->{'target'} ne '') {
-                         $result .= 'target="'.$_->{'target'}.'" ';
-                     }
-		     if ($_->{'no_mt'}) {
-			 $result .='title="'.$_->{'title'}.'">'.
-			     $_->{'text'}.'</a>';
-		     } else {
-			 $result .='title="'.&mt($_->{'title'}).'">'.
-			     &mt($_->{'text'}).'</a>';
-		     }
-                     $result;
-                     } @Crumbs
-                 );
-        $links .= $crumbsymbol if ($links ne '');
-	if ($last->{'no_mt'}) {
-	    $links .= '<b>'.$last->{'text'}.'</b>';
-	} else {
-	    $links .= '<b>'.&mt($last->{'text'}).'</b>';
-	}
-        #
+
+                     my $result = htmltag( 'a', 
+                                           $_->{no_mt} ? 
+                                            $_->{text} : mt($_->{text}), 
+                                           { 
+                                               href   => $_->{href},
+                                               title  => $_->{no_mt} ? 
+                                                $_->{title} : mt($_->{title}),
+                                               target => $_->{target},
+                                           });
+                     $result = htmltag( 'li', "$result $crumbsymbol");
+                     } @Crumbs;
+
+        #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 '') {
@@ -1423,33 +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);
-	}
-        #
-        $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>';
+        if ($faq ne '' || $component_help ne '' || $bug ne '') {
+            $icons .= &Apache::loncommon::help_open_menu($component,
+                                                         $component_help,
+                                                         $faq,$bug);
         }
-        $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;
+        }
+        
+        $links = htmltag('div', $links, 
+                        { id => "LC_breadcrumbs" }) unless ($CourseBreadcrumbs) ;
+
         # Return the @Crumbs stack to what we started with
         push(@Crumbs,$last);
         shift(@Crumbs);
-        #
-        return $Str;
+        # Return the breadcrumb's line
+        return "$links";
     }
 
     sub clear_breadcrumbs {
@@ -1599,7 +1595,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') {
@@ -1810,12 +1806,11 @@ sub course_custom_roles {
 #
 sub topic_bar {
     my ($imgnum,$title) = @_;
-    return '
-<div class="LC_topic_bar">
-    <img alt="'.&mt('Step [_1]',$imgnum).
-              '" src="/res/adm/pages/bl_step'.$imgnum.'.gif" />&nbsp;'.$title.'
-</div>
-';
+    return '<div class="LC_topic_bar">'
+          .'<img src="/res/adm/pages/bl_step'.$imgnum.'.gif"'
+          .' alt="'.&mt('Step [_1]',$imgnum).'" />'
+          .' '.$title
+          .'</div>';
 }
 
 ##############################################
@@ -2068,6 +2063,257 @@ 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, true/false);
+#
+# EXAMPLES: 
+#  - scripttag("alert('Hello World!')") 
+#
+# NOTES:
+# - works currently only for javascripts
+#
+# OUTPUT: Scriptcode properly enclosed in <script> and CDATA tags (and LC
+# Internal markers if 2nd argument evaluates to true)
+sub scripttag {
+    my ($content, $internal) = @_;
+    $content = "// BEGIN LON-CAPA Internal\n$content\n// END LON-CAPA Internal" if $internal;
+    $content = "\n// <![CDATA[\n$content\n// ]]>\n";
+    htmltag("script", $content, {type => "text/javascript"});
+    return htmltag("script", $content, {type => "text/javascript"});
+};
+
+
+##############################################
+##############################################
+
+# 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 = @_;
+    # 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.
+            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_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;