--- loncom/interface/lonhtmlcommon.pm 2008/11/11 20:12:17 1.183
+++ loncom/interface/lonhtmlcommon.pm 2009/06/04 16:47:25 1.221
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# a pile of common html routines
#
-# $Id: lonhtmlcommon.pm,v 1.183 2008/11/11 20:12:17 droeschl Exp $
+# $Id: lonhtmlcommon.pm,v 1.221 2009/06/04 16:47:25 bisitz Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -62,6 +62,31 @@ 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";
+ }
+}
##############################################
##############################################
@@ -105,11 +130,13 @@ 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
@@ -136,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');
}
}
@@ -285,7 +312,7 @@ sub checkbox {
$Str .= 'value="'.$value.'"';
}
if ($checked) {
- $Str .= ' checked="1"';
+ $Str .= ' checked="checked"';
}
$Str .= ' />';
return $Str;
@@ -307,7 +334,7 @@ sub radio {
$Str .= 'value="'.$value.'"';
}
if ($checked eq $value) {
- $Str .= ' checked="1"';
+ $Str .= ' checked="checked"';
}
$Str .= ' />';
return $Str;
@@ -405,6 +432,7 @@ 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;
@@ -465,9 +493,10 @@ 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
@@ -950,17 +979,20 @@ 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\');".
"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)</script>");
+ "\nwindow.setTimeout(openpopwin,0)".
+ '// ]]>'.
+ '</script>');
$prog_state{'formname'}='popremain';
$prog_state{'inputname'}="remaining";
} elsif ($type eq 'inline') {
@@ -993,10 +1025,14 @@ sub Create_PrgWin {
# update progress
sub Update_PrgWin {
my ($r,$prog_state,$displayString)=@_;
- &r_print($r,'<script type="text/javascript">'.$$prog_state{'window'}.'.document.'.
+ &r_print($r,'<script type="text/javascript">'.
+ '// <![CDATA['.
+ $$prog_state{'window'}.'.document.'.
$$prog_state{'formname'}.'.'.
$$prog_state{'inputname'}.'.value="'.
- $displayString.'";</script>');
+ $displayString.'";'.
+ '// ]]>'.
+ '</script>');
$$prog_state{'laststart'}=&Time::HiRes::time();
}
@@ -1049,11 +1085,15 @@ sub Increment_PrgWin {
if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
$lasttime = '';
}
- &r_print($r,'<script>'.$$prog_state{'window'}.'.document.'.
+ &r_print($r,'<script>'.
+ '// <![CDATA['.
+ $$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();
}
@@ -1061,7 +1101,11 @@ sub Increment_PrgWin {
sub Close_PrgWin {
my ($r,$prog_state)=@_;
if ($$prog_state{'type'} eq 'popup') {
- &r_print($r,'<script>popwin.close()</script>'."\n");
+ &r_print($r,'<script>'.
+ '// <![CDATA['.
+ 'popwin.close()'.
+ '// ]]>'.
+ '</script>'."\n");
} elsif ($$prog_state{'type'} eq 'inline') {
&Update_PrgWin($r,$prog_state,&mt('Done'));
}
@@ -1143,6 +1187,7 @@ sub spellheader {
my $nothing=&javascript_nothing();
return (<<ENDCHECK);
<script type="text/javascript">
+// <![CDATA[
//<!-- BEGIN LON-CAPA Internal
var checkwin;
@@ -1153,6 +1198,7 @@ function spellcheckerwindow(string) {
checkwin.document.close();
}
// END LON-CAPA Internal -->
+// ]]>
</script>
ENDCHECK
}
@@ -1226,7 +1272,8 @@ sub htmlareaselectactive {
my @fields=@_;
unless (&htmlareabrowser()) { return ''; }
if (&htmlareablocked()) { return '<br />'.&enablelink(@fields); }
- my $output='<script type="text/javascript" defer="1">';
+ my $output='<script type="text/javascript" defer="1">'
+ .'// <![CDATA[';
my $lang = &htmlarea_lang();
foreach my $field (@fields) {
$output.="
@@ -1239,7 +1286,9 @@ 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;
}
@@ -1278,6 +1327,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
@@ -1303,22 +1354,28 @@ 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".'<table class="'.$css_class.'"><tr><td>';
+ $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='';
- # Crumb Symbol
- my $crumbsymbol = ' ▶ ';
+ 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;
@@ -1328,41 +1385,47 @@ 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 '');
+
+ my $result = htmltag( 'a',
+ $_->{no_mt} ? $_->{text} : mt($_->{text}),
+ {
+ href => $_->{href},
+ title => $_->{no_mt} ? $_->{title} : mt($_->{title}),
+ target => $_->{target},
+ });
+ $result = htmltag( 'li', $crumbsymbol.$result);
+ } @Crumbs;
+#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 $icons = '';
$faq = $last->{'faq'} if (exists($last->{'faq'}));
$bug = $last->{'bug'} if (exists($last->{'bug'}));
@@ -1380,23 +1443,33 @@ returns: nothing
$faq,$bug);
}
#
- $Str .= $links.'</td>';
+
+
+ if($CourseBreadcrumbs){
+ $Str1 .= $links.'</ul>';
+ } else {
+ $Str1 .= $links.'</ol></div>';
+ }
#
if (defined($component)) {
- $Str .= '<td class="'.$css_class.'_component">'.
- &mt($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 .= ' '.$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 a table and after that the breadcrumb's line
+ return "$Str\n$Str1";
}
sub clear_breadcrumbs {
@@ -1465,6 +1538,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)) {
@@ -1472,6 +1548,7 @@ sub start_pick_box {
} else {
$css_class= 'class="LC_pick_box"';
}
+ unshift(@row_count,0);
my $output = <<"END";
<table $css_class>
END
@@ -1479,6 +1556,7 @@ END
}
sub end_pick_box {
+ shift(@row_count);
my $output = <<"END";
</table>
END
@@ -1494,11 +1572,12 @@ 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';
$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 .= ':';
@@ -1508,7 +1587,7 @@ sub row_title {
<td $css_title_class>
$title
</td>
- <td $css_value_class>
+ <td class="$css_value_class $css_class">
ENDONE
return $output;
}
@@ -1530,6 +1609,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;
@@ -1537,7 +1619,7 @@ sub role_select_row {
$output = &row_title($title,$css_class);
}
$output .= qq|
- <select name="roles" multiple >\n|;
+ <select name="roles" multiple="multiple">\n|;
foreach my $role (@$roles) {
my $plrole;
if ($role eq 'ow') {
@@ -1582,6 +1664,7 @@ 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') {
@@ -1604,6 +1687,7 @@ sub course_selection {
formname.courselist = '';
}
}
+// ]]>
</script>
|;
my $courseform='<b>'.&Apache::loncommon::selectcourse_link
@@ -1664,7 +1748,7 @@ sub status_select_row {
$output = &row_title($title,$css_class,'LC_pick_box_select');
}
$output .= qq|
- <select name="types" multiple>\n|;
+ <select name="types" multiple="multiple">\n|;
foreach my $status_type (sort(keys(%{$types}))) {
$output .= ' <option value="'.$status_type.'">'.$$types{$status_type}.'</option>';
}
@@ -1746,13 +1830,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" />
- <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>';
}
##############################################
@@ -2004,6 +2086,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 <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;
+}
+
+
##############################################
##############################################
@@ -2015,10 +2144,13 @@ END
# 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',
+# {
+# 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',
+# 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)'
# },
@@ -2036,28 +2168,58 @@ END
# Don't rely on its current functionality as it might be
# changed or removed.
# --------------------------
-
sub generate_menu {
my @menu = @_;
- my $menu_html = '';
-
- foreach my $category (@menu) { #FIXME: insert appropriate classnames for styles when they're finished.
- $menu_html .='<div class=""><h3 class="">'.$category->{'categorytitle'}.'</h3><ul class="">';
- foreach my $item (@{ $category->{items} }) {
- next if (! $item->{'permission'});
- $menu_html .= '<li class="">'.
- qq{<a href="$item->{'url'}" title="$item->{'linktitle'}">}.
- &mt($item->{'linktext'}).'</a>';
- if (exists($item->{'help'})) {
- $menu_html .= &Apache::loncommon::help_open_topic($item->{'help'});
- }
- $menu_html .= '</li>';
- }
- $menu_html .= '</div>';
+ # 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_ContentBoxSpecial LC_400Box"}) if scalar(@links);
}
- return $menu_html;
-}
+ # wrap the joined @categories in another <div> (column layout)
+ return $div->(join('', @categories), {class => "LC_columnSection"});
+}
1;