--- loncom/interface/lonhtmlcommon.pm 2009/05/20 20:27:37 1.217 +++ loncom/interface/lonhtmlcommon.pm 2009/06/11 16:48:33 1.224 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # a pile of common html routines # -# $Id: lonhtmlcommon.pm,v 1.217 2009/05/20 20:27:37 raeburn Exp $ +# $Id: lonhtmlcommon.pm,v 1.224 2009/06/11 16:48:33 bisitz Exp $ # # Copyright Michigan State University Board of Trustees # @@ -77,12 +77,12 @@ sub confirm_success { my ($message,$failure)=@_; if ($failure) { return ''."\n" - .' '."\n" + .''.&mt('Error').' '."\n" .$message."\n" .''."\n"; } else { return ''."\n" - .' '."\n" + .''.&mt('Ok').' '."\n" .$message."\n" .''."\n"; } @@ -130,11 +130,13 @@ sub dragmath_js { my ($popup) = @_; return < + // ENDDRAGMATHJS @@ -161,7 +163,7 @@ sub authorbombs { foreach (keys %bombs) { if ($_=~/^$udom\/$uname\//) { return ''. + '">'.&mt('Bomb').''. &Apache::loncommon::help_open_topic('About_Bombs'); } } @@ -430,6 +432,7 @@ sub date_setter { my $result = "\n\n"; $result .= < +// ENDJS $result .= ' '; @@ -975,6 +979,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,'"); + "\nwindow.setTimeout(openpopwin,0)". + '// ]]>'. + ''); $prog_state{'formname'}='popremain'; $prog_state{'inputname'}="remaining"; } elsif ($type eq 'inline') { @@ -1018,10 +1025,14 @@ sub Create_PrgWin { # update progress sub Update_PrgWin { my ($r,$prog_state,$displayString)=@_; - &r_print($r,''); + $displayString.'";'. + '// ]]>'. + ''); $$prog_state{'laststart'}=&Time::HiRes::time(); } @@ -1074,11 +1085,15 @@ sub Increment_PrgWin { if ($user_browser eq 'explorer' && $user_os =~ 'mac') { $lasttime = ''; } - &r_print($r,''); + ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'. + '// ]]>'. + ''); $$prog_state{'laststart'}=&Time::HiRes::time(); } @@ -1086,7 +1101,11 @@ sub Increment_PrgWin { sub Close_PrgWin { my ($r,$prog_state)=@_; if ($$prog_state{'type'} eq 'popup') { - &r_print($r,''."\n"); + &r_print($r,''."\n"); } elsif ($$prog_state{'type'} eq 'inline') { &Update_PrgWin($r,$prog_state,&mt('Done')); } @@ -1168,6 +1187,7 @@ sub spellheader { my $nothing=&javascript_nothing(); return (< +// +// ]]> ENDCHECK } @@ -1251,7 +1272,8 @@ sub htmlareaselectactive { my @fields=@_; unless (&htmlareabrowser()) { return ''; } if (&htmlareablocked()) { return '
'.&enablelink(@fields); } - my $output='
". + $output.="\nwindow.status='Activated Editfields';\n" + .'// ]]>' + .'
'. &disablelink(@fields); return $output; } @@ -1290,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) @@ -1333,20 +1355,13 @@ returns: nothing my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt, $CourseBreadcrumbs) = @_; # $css_class ||= 'LC_breadcrumbs'; - my $Str1 = '
    '; - - if($CourseBreadcrumbs){ - $Str1 = '
      '; - } - 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 = '» '; + my $crumbsymbol = '»'; # The last breadcrumb does not have a link, so handle it separately. my $last = pop(@Crumbs); # @@ -1374,43 +1389,33 @@ returns: nothing $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 = '{'target'}) && $_->{'target'} ne '') { - $result .= 'target="'.$_->{'target'}.'" '; - } - # set the possible translation for title - if ($_->{'no_mt'}) { - $result .='title="'.$_->{'title'}.'">'. - $_->{'text'}.''; - } else { - $result .='title="'.&mt($_->{'title'}).'">'. - &mt($_->{'text'}).''; - } - $result; - } @Crumbs - ).'
      • '; -#Workaround for edit course. - if(@Crumbs == 0 ){ - $links .= '
    • ' if ($links ne ''); - } else { - $links .= '
    • '.$crumbsymbol if ($links ne ''); - } -#should the last Element be translated? - if ($last->{'no_mt'}) { - $links .= ''.$last->{'text'}.''; - } else { - $links .= ''.&mt($last->{'text'}).''; - } - $links .= '
      • '; + + 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 '') { @@ -1419,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.'
    '; - } else { - $Str1 .= $links.'
'; - } - # - if (defined($component)) { - $Str .= "\n".'' - .'
'; - if ($no_mt) { - $Str .= $component; - } else { - $Str .= &mt($component); - } - if ($icons ne '') { - $Str .= ' '.$icons; - } - $Str .= '
'."\n"; + unless ($CourseBreadcrumbs) { + $links = htmltag('ol', $links, { id => "LC_MenuBreadcrumbs" }); + } else { + $links = htmltag('ul', $links, { id => "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_head_subbox" }) 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 { @@ -1646,6 +1648,7 @@ sub course_selection { my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles) = @_; my $output = qq| |; my $courseform=''.&Apache::loncommon::selectcourse_link @@ -1810,13 +1814,11 @@ sub course_custom_roles { # sub topic_bar { my ($imgnum,$title) = @_; - return ' -
- '.&mt('Step [_1]',$imgnum). - '   - '.$title.' -
-'; + return '
' + .''.&mt('Step [_1]',$imgnum).'' + .' '.$title + .'
'; } ############################################## @@ -2068,6 +2070,53 @@ 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
are correctly terminated, +# i.e. htmltag('br') returns
+# - 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]| : qq|/>|). "\n"; +}; + + +# USAGE: inittags(@tags); +# +# EXAMPLES: +# - my ($h1, $h2, $h3) = initTags( qw( h1 h2 h3 ) ) +# $h1->("This is a headline") #Returns:

This is a headline

+# +# NOTES: See sub htmltag for further information. +# +# OUTPUT: List of subroutines. +sub inittags { + my @tags = @_; + return map { my $tag = $_; + sub { return htmltag( $tag, @_ ) } + } @tags; +} + + ############################################## ############################################## @@ -2105,23 +2154,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]| : 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 @@ -2164,13 +2198,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
(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 "
\n$legendtext\n" + .'
    '."\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 '
  • '.$content.'
    • '."\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 "
\n
\n"; +} + 1; __END__