--- loncom/interface/lonhtmlcommon.pm 2009/04/07 15:40:38 1.207
+++ loncom/interface/lonhtmlcommon.pm 2009/06/04 16:33:08 1.220
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# a pile of common html routines
#
-# $Id: lonhtmlcommon.pm,v 1.207 2009/04/07 15:40:38 amueller Exp $
+# $Id: lonhtmlcommon.pm,v 1.220 2009/06/04 16:33:08 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');
}
}
@@ -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,6 +493,7 @@ document.$formname.$dname\_year.value,
}
}
+// ]]>
</script>
ENDJS
$result .= ' <span class="LC_nobreak">';
@@ -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;
}
@@ -1305,13 +1354,13 @@ returns: nothing
my @Crumbs;
sub breadcrumbs {
- my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt, $no_realBreadcrumb) = @_;
+ my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt, $CourseBreadcrumbs) = @_;
#
- $css_class ||= 'LC_breadcrumbs';
- my $Str1 = '<ol id="LC_MenuBreadcrumbs">';
+ $css_class ||= 'LC_breadcrumbs';
+ my $Str1 = '<div id="LC_head_subbox"><ol id="LC_MenuBreadcrumbs">';
- if($no_realBreadcrumb){
- $Str1 = '<ul class="LC_CourseBreadcrumbs">';
+ if($CourseBreadcrumbs){
+ $Str1 = '<ul id="LC_CourseBreadcrumbs">';
}
my $Str = '';
@@ -1319,14 +1368,14 @@ returns: nothing
# 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;
@@ -1336,35 +1385,34 @@ 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 .= '<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>';
+
+ 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 '');
@@ -1397,10 +1445,10 @@ returns: nothing
#
- if($no_realBreadcrumb){
+ if($CourseBreadcrumbs){
$Str1 .= $links.'</ul>';
} else {
- $Str1 .= $links.'</ol>';
+ $Str1 .= $links.'</ol></div>';
}
#
if (defined($component)) {
@@ -1523,9 +1571,9 @@ 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';
- my ($title,$css_title_class,$css_value_class) = @_;
$css_title_class ||= 'LC_pick_box_title';
$css_title_class = 'class="'.$css_title_class.'"';
@@ -1616,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') {
@@ -1638,6 +1687,7 @@ sub course_selection {
formname.courselist = '';
}
}
+// ]]>
</script>
|;
my $courseform='<b>'.&Apache::loncommon::selectcourse_link
@@ -1742,7 +1792,6 @@ 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|
<br />
@@ -1781,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>';
}
##############################################
@@ -2039,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;
+}
+
+
##############################################
##############################################
@@ -2076,23 +2170,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