--- loncom/interface/lonhtmlcommon.pm	2009/05/22 17:57:19	1.218
+++ loncom/interface/lonhtmlcommon.pm	2009/08/10 12:32:34	1.229
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # a pile of common html routines
 #
-# $Id: lonhtmlcommon.pm,v 1.218 2009/05/22 17:57:19 bisitz Exp $
+# $Id: lonhtmlcommon.pm,v 1.229 2009/08/10 12:32:34 droeschl Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -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
 
@@ -1314,15 +1314,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 +1355,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);
         #
@@ -1398,43 +1389,33 @@ returns: nothing
                 $last = $menulink;
             }
         }
-        my $links .= '<li>'. 
-            join('</li><li>'.$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'}.'" ';
-                     }
-			# set the possible translation for title 
-		     if ($_->{'no_mt'}) {
-			 $result .='title="'.$_->{'title'}.'">'.
-			     $_->{'text'}.'</a>';
-		     } else {
-			 $result .='title="'.&mt($_->{'title'}).'">'.
-			     &mt($_->{'text'}).'</a>';
-		     }
-                     $result;
-                     } @Crumbs
-                 ).'</li>';
-#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>';
+
+                     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 '') {
@@ -1443,39 +1424,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 {
@@ -1836,13 +1814,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;
-    <span>'.$title.'</span>
-</div>
-';
+    return '<div class="LC_topic_bar">'
+          .'<img src="/res/adm/pages/bl_step'.$imgnum.'.gif"'
+          .' alt="'.&mt('Step [_1]',$imgnum).'" />'
+          .' '.$title
+          .'</div>';
 }
 
 ##############################################
@@ -2094,6 +2070,72 @@ END
     return $scripttag;
 }
 
+
+# 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"});
+};
+
+
 ##############################################
 ##############################################
 
@@ -2131,23 +2173,8 @@ END
 # --------------------------
 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 ($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
    
@@ -2190,13 +2217,112 @@ sub generate_menu {
         push @categories, 
             $div->($h3->(mt($$category{categorytitle}), {class=>"LC_hcell"}).
             $ul->(join('' ,@links),  {class =>"LC_ListStyleNormal" }),
-            {class=>"LC_ContentBoxSpecial 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__