--- loncom/interface/lonhtmlcommon.pm 2007/11/16 06:31:26 1.170 +++ loncom/interface/lonhtmlcommon.pm 2009/05/20 17:39:06 1.216 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # a pile of common html routines # -# $Id: lonhtmlcommon.pm,v 1.170 2007/11/16 06:31:26 albertel Exp $ +# $Id: lonhtmlcommon.pm,v 1.216 2009/05/20 17:39:06 bisitz Exp $ # # Copyright Michigan State University Board of Trustees # @@ -67,6 +67,85 @@ use LONCAPA; =pod +=item confirm_success + +Successful completion of an operation message + +=cut + +sub confirm_success { + my ($message,$failure)=@_; + if ($failure) { + return ''."\n" + .' '."\n" + .$message."\n" + .''."\n"; + } else { + return ''."\n" + .' '."\n" + .$message."\n" + .''."\n"; + } +} + +############################################## +############################################## + +=pod + +=item dragmath_button + +Creates a button that launches a dragmath popup-window, in which an +expression can be edited and pasted as LaTeX into a specified textarea. + + textarea - Name of the textarea to edit. + helpicon - If true, show a help icon to the right of the button. + +=cut + +sub dragmath_button { + my ($textarea,$helpicon) = @_; + my $help_text; + if ($helpicon) { + $help_text = &Apache::loncommon::help_open_topic('Authoring_Math_Editor'); + } + my $buttontext=&mt('Edit Math'); + return <$help_text +ENDDRAGMATH +} + +############################################## + +=pod + +=item dragmath_js + +Javascript used to open pop-up window containing dragmath applet which +can be used to paste LaTeX into a textarea. + +=cut + +sub dragmath_js { + my ($popup) = @_; + return < + function mathedit(textarea, doc) { + targetEntry = textarea; + targetDoc = doc; + newwin = window.open("/adm/dragmath/applet/$popup.html","","width=565,height=500,resizable"); + } + + +ENDDRAGMATHJS +} + + +############################################## +############################################## + +=pod + =item authorbombs =cut @@ -231,7 +310,7 @@ sub checkbox { $Str .= 'value="'.$value.'"'; } if ($checked) { - $Str .= ' checked="1"'; + $Str .= ' checked="checked"'; } $Str .= ' />'; return $Str; @@ -253,7 +332,7 @@ sub radio { $Str .= 'value="'.$value.'"'; } if ($checked eq $value) { - $Str .= ' checked="1"'; + $Str .= ' checked="checked"'; } $Str .= ' />'; return $Str; @@ -311,6 +390,7 @@ The method used to restrict user input w sub date_setter { my ($formname,$dname,$currentvalue,$special,$includeempty,$state, $no_hh_mm_ss,$defhour,$defmin,$defsec,$nolink) = @_; + my $now = time; my $wasdefined=1; if (! defined($state) || $state ne 'disabled') { $state = ''; @@ -319,28 +399,25 @@ sub date_setter { $no_hh_mm_ss = 0; } if ($currentvalue eq 'now') { - $currentvalue=time; + $currentvalue = $now; } if ((!defined($currentvalue)) || ($currentvalue eq '')) { $wasdefined=0; if ($includeempty) { $currentvalue = 0; } else { - $currentvalue = time; + $currentvalue = $now; } } # other potentially useful values: wkday,yrday,is_daylight_savings + my $tzname; my ($sec,$min,$hour,$mday,$month,$year)=('','',undef,'','',''); if ($currentvalue) { - ($sec,$min,$hour,$mday,$month,$year,undef,undef,undef) = - localtime($currentvalue); - $year += 1900; + ($tzname,$sec,$min,$hour,$mday,$month,$year) = &get_timedates($currentvalue); } unless ($wasdefined) { + ($tzname,$sec,$min,$hour,$mday,$month,$year) = &get_timedates($now); if (($defhour) || ($defmin) || ($defsec)) { - ($sec,$min,$hour,$mday,$month,$year,undef,undef,undef) = - localtime(time); - $year += 1900; $sec=($defsec?$defsec:0); $min=($defmin?$defmin:0); $hour=($defhour?$defhour:0); @@ -415,7 +492,7 @@ document.$formname.$dname\_year.value, } ENDJS - $result .= ' '; + $result .= ' '; my $monthselector = qq{<\\/form>'.$end_page. "\');". @@ -1192,6 +1303,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 @@ -1217,36 +1330,52 @@ returns: nothing my @Crumbs; sub breadcrumbs { - my ($component,$component_help,$menulink,$helplink,$css_class) = @_; + my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt, $CourseBreadcrumbs) = @_; # - $css_class ||= 'LC_breadcrumbs'; - my $Str = "\n".''; + + + if($CourseBreadcrumbs){ + $Str1 .= $links.''; + } else { + $Str1 .= $links.''; + } # if (defined($component)) { - $Str .= '
'; + $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 $help=''; + # Crumb Symbol + my $crumbsymbol = '» '; # 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; if (exists($env{'request.course.id'}) && $env{'request.course.id'} ne '') { $description = $env{'course.'.$env{'request.course.id'}.'.description'}; + $no_mt_descr = 1; + } + $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; } - unshift(@Crumbs,{ - href =>'/adm/menu', - title =>'Go to main menu', - target =>'_top', - text =>$description, - }); } - my $links .= - join('->', + my $links .= '
    • '. + join('
    • '.$crumbsymbol, map { $faq = $_->{'faq'} if (exists($_->{'faq'})); $bug = $_->{'bug'} if (exists($_->{'bug'})); @@ -1255,6 +1384,7 @@ returns: nothing if (defined($_->{'target'}) && $_->{'target'} ne '') { $result .= 'target="'.$_->{'target'}.'" '; } + # set the possible translation for title if ($_->{'no_mt'}) { $result .='title="'.$_->{'title'}.'">'. $_->{'text'}.''; @@ -1264,14 +1394,20 @@ returns: nothing } $result; } @Crumbs - ); - $links .= '->' if ($links ne ''); + ).'
    • '; +#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 $icons = ''; $faq = $last->{'faq'} if (exists($last->{'faq'})); $bug = $last->{'bug'} if (exists($last->{'bug'})); @@ -1289,23 +1425,33 @@ returns: nothing $faq,$bug); } # - $Str .= $links.'
'. - &mt($component); + $Str .= "\n".'' + .''; + $Str .= '
'; + if ($no_mt) { + $Str .= $component; + } else { + $Str .= &mt($component); + } if ($icons ne '') { $Str .= ' '.$icons; } - $Str .= '
'."\n"; } - $Str .= '
'."\n"; # # Return the @Crumbs stack to what we started with push(@Crumbs,$last); shift(@Crumbs); - # - return $Str; + # Return a table and after that the breadcrumb's line + return "$Str\n$Str1"; } sub clear_breadcrumbs { @@ -1332,7 +1478,7 @@ returns: nothing # row1 # row2 # row3 ... etc. -# &submit_row(0 +# &submit_row() # &end_pick_box() # # where row1, row 2 etc. are chosen from &role_select_row,&course_select_row, @@ -1374,6 +1520,9 @@ returns: nothing # routines, but can also be called directly to start and end rows which have # needs that are not accommodated by the *_select_row() routines. +{ # Start: row_count block for pick_box +my @row_count; + sub start_pick_box { my ($css_class) = @_; if (defined($css_class)) { @@ -1381,6 +1530,7 @@ sub start_pick_box { } else { $css_class= 'class="LC_pick_box"'; } + unshift(@row_count,0); my $output = <<"END"; END @@ -1388,26 +1538,38 @@ END } sub end_pick_box { + shift(@row_count); my $output = <<"END";
END return $output; } +sub row_headline { + my $output = <<"END"; + +END + return $output; +} + 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'; $css_title_class ||= 'LC_pick_box_title'; $css_title_class = 'class="'.$css_title_class.'"'; $css_value_class ||= 'LC_pick_box_value'; - $css_value_class = 'class="'.$css_value_class.'"'; + if ($title ne '') { + $title .= ':'; + } my $output = <<"ENDONE"; - $title: + $title - + ENDONE return $output; } @@ -1429,6 +1591,9 @@ ENDTWO return $output; } +} # End: row_count block for pick_box + + sub role_select_row { my ($roles,$title,$css_class,$show_separate_custom,$cdom,$cnum) = @_; my $output; @@ -1436,7 +1601,7 @@ sub role_select_row { $output = &row_title($title,$css_class); } $output .= qq| - \n|; foreach my $role (@$roles) { my $plrole; if ($role eq 'ow') { @@ -1563,7 +1728,7 @@ sub status_select_row { $output = &row_title($title,$css_class,'LC_pick_box_select'); } $output .= qq| - \n|; foreach my $status_type (sort(keys(%{$types}))) { $output .= ' '; } @@ -1607,6 +1772,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|
@@ -1637,6 +1803,25 @@ sub course_custom_roles { ############################################## ############################################## + +# topic_bar +# +# Generates a div containing a numbered (static image) followed by a title +# with a background color defined in the corresponding CSS: LC_topic_bar +# +sub topic_bar { + my ($imgnum,$title) = @_; + return ' +
+ '.&mt('Step [_1]',$imgnum).
+              '   + '.$title.' +
+'; +} + +############################################## +############################################## # echo_form_input # @@ -1884,6 +2069,109 @@ 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]| : 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

, concatenate with + # joined and in
    tags wrapped @links + # and wrap everything in an enclosing
    and push it into + # @categories + # such that each element looks like: + #

    title

    • ...
    • ...
    + # 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
    (column layout) + return $div->(join('', @categories), {class => "LC_columnSection"}); +} + 1; __END__