--- loncom/interface/lonhtmlcommon.pm 2008/11/11 20:12:17 1.183
+++ loncom/interface/lonhtmlcommon.pm 2010/05/30 18:30:52 1.273
@@ -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.273 2010/05/30 18:30:52 droeschl Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -63,6 +63,45 @@ use Apache::lonnet;
use LONCAPA;
+sub coursepreflink {
+ my ($text,$category)=@_;
+ if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
+ return '<a href="'.&HTML::Entities::encode("/adm/courseprefs?phase=display&actions=$category",'<>&"').'">'.$text.'</a>';
+ } else {
+ return '';
+ }
+}
+
+sub raw_href_to_link {
+ my ($message)=@_;
+ $message=~s/(https?\:\/\/[^\s\'\"\<]+)([\s\<]|$)/<a href="$1"><tt>$1<\/tt><\/a>$2/gi;
+ return $message;
+}
+
+##############################################
+##############################################
+
+=item confirm_success
+
+Successful completion of an operation message
+
+=cut
+
+sub confirm_success {
+ my ($message,$failure)=@_;
+ if ($failure) {
+ return '<span class="LC_error" style="font-size: inherit;">'."\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";
+ }
+}
+
##############################################
##############################################
@@ -86,7 +125,7 @@ sub dragmath_button {
}
my $buttontext=&mt('Edit Math');
return <<ENDDRAGMATH;
- <input type="button" value="$buttontext", onclick="javascript:mathedit('$textarea',document)" />$help_text
+ <input type="button" value="$buttontext" onclick="javascript:mathedit('$textarea',document)" />$help_text
ENDDRAGMATH
}
@@ -98,18 +137,19 @@ ENDDRAGMATH
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 <<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
@@ -133,10 +173,10 @@ sub authorbombs {
$url=&Apache::lonnet::declutter($url);
my ($udom,$uname)=($url=~m{^($LONCAPA::domain_re)/($LONCAPA::username_re)/});
my %bombs=&Apache::lonmsg::all_url_author_res_msg($uname,$udom);
- foreach (keys %bombs) {
- if ($_=~/^$udom\/$uname\//) {
+ foreach my $bomb (keys(%bombs)) {
+ if ($bomb =~ /^$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');
}
}
@@ -195,6 +235,9 @@ sub select_recent {
unless ($value =~/^error\:/) {
my $escaped = &Apache::loncommon::escape_url($value);
&Apache::loncommon::inhibit_menu_check(\$escaped);
+ if ($area eq 'residx') {
+ next if ((!&Apache::lonnet::allowed('bre',$value)) && (!&Apache::lonnet::allowed('bro',$value)));
+ }
$return.="\n<option value='$escaped'>".
&unescape((split(/\&/,$recent{$value}))[1]).
'</option>';
@@ -212,7 +255,7 @@ sub get_recent {
# Begin filling return_hash with any 'always_include' option
my %time_hash = ();
my %return_hash = ();
- foreach my $item (keys %recent) {
+ foreach my $item (keys(%recent)) {
my ($thistime,$thisvalue)=(split(/\&/,$recent{$item}));
if ($thistime eq 'always_include') {
$return_hash{$item} = &unescape($thisvalue);
@@ -285,7 +328,7 @@ sub checkbox {
$Str .= 'value="'.$value.'"';
}
if ($checked) {
- $Str .= ' checked="1"';
+ $Str .= ' checked="checked"';
}
$Str .= ' />';
return $Str;
@@ -307,7 +350,7 @@ sub radio {
$Str .= 'value="'.$value.'"';
}
if ($checked eq $value) {
- $Str .= ' checked="1"';
+ $Str .= ' checked="checked"';
}
$Str .= ' />';
return $Str;
@@ -337,7 +380,8 @@ dname_hour, dname_min, and dname_sec.
The current setting for this time parameter. A unix format time
(time in seconds since the beginning of Jan 1st, 1970, GMT.
-An undefined value is taken to indicate the value is the current time.
+An undefined value is taken to indicate the value is the current time
+unless it is requested to leave it empty. See $includeempty.
Also, to be explicit, a value of 'now' also indicates the current time.
=item $special
@@ -347,6 +391,9 @@ the date_setter. See lonparmset for exa
=item $includeempty
+If it is set (true) and no date/time value is provided,
+the date/time fields are left empty.
+
=item $state
Specifies the initial state of the form elements. Either 'disabled' or empty.
@@ -366,7 +413,11 @@ sub date_setter {
my ($formname,$dname,$currentvalue,$special,$includeempty,$state,
$no_hh_mm_ss,$defhour,$defmin,$defsec,$nolink) = @_;
my $now = time;
- my $wasdefined=1;
+
+ my $tzname;
+ my ($sec,$min,$hour,$mday,$month,$year) = ('', '', undef,''.''.'');
+ #other potentially useful values: wkday,yrday,is_daylight_savings
+
if (! defined($state) || $state ne 'disabled') {
$state = '';
}
@@ -374,37 +425,29 @@ sub date_setter {
$no_hh_mm_ss = 0;
}
if ($currentvalue eq 'now') {
- $currentvalue = $now;
+ $currentvalue = $now;
}
- if ((!defined($currentvalue)) || ($currentvalue eq '')) {
- $wasdefined=0;
- if ($includeempty) {
- $currentvalue = 0;
- } else {
- $currentvalue = $now;
- }
+
+ # Default value: Set empty date field to current time
+ # unless empty inclusion is requested
+ if ((!$includeempty) && (!$currentvalue)) {
+ $currentvalue = $now;
}
- # other potentially useful values: wkday,yrday,is_daylight_savings
- my $tzname;
- my ($sec,$min,$hour,$mday,$month,$year)=('','',undef,'','','');
+ # Do we have a date? Split it!
if ($currentvalue) {
- ($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=($defsec?$defsec:0);
- $min=($defmin?$defmin:0);
- $hour=($defhour?$defhour:0);
- } elsif (!$includeempty) {
- $sec=0;
- $min=0;
- $hour=0;
- }
+ ($tzname,$sec,$min,$hour,$mday,$month,$year) = &get_timedates($currentvalue);
+
+ #No values provided for hour, min, sec? Use default 0
+ if (($defhour) || ($defmin) || ($defsec)) {
+ $sec = ($defsec ? $defsec : 0);
+ $min = ($defmin ? $defmin : 0);
+ $hour = ($defhour ? $defhour : 0);
+ }
}
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 +508,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
@@ -476,23 +520,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) {
@@ -580,7 +624,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
@@ -949,18 +993,19 @@ 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">'.
+ &r_print($r,&Apache::lonhtmlcommon::scripttag(
"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)"
+ ));
$prog_state{'formname'}='popremain';
$prog_state{'inputname'}="remaining";
} elsif ($type eq 'inline') {
@@ -993,10 +1038,12 @@ sub Create_PrgWin {
# update progress
sub Update_PrgWin {
my ($r,$prog_state,$displayString)=@_;
- &r_print($r,'<script type="text/javascript">'.$$prog_state{'window'}.'.document.'.
- $$prog_state{'formname'}.'.'.
- $$prog_state{'inputname'}.'.value="'.
- $displayString.'";</script>');
+ &r_print($r,&Apache::lonhtmlcommon::scripttag(
+ $$prog_state{'window'}.'.document.'.
+ $$prog_state{'formname'}.'.'.
+ $$prog_state{'inputname'}.'.value="'.
+ $displayString.'";'
+ ));
$$prog_state{'laststart'}=&Time::HiRes::time();
}
@@ -1014,7 +1061,7 @@ sub Increment_PrgWin {
#
my $str;
if ($min == 0 && $sec > 1) {
- $str = '[_2] seconds';
+ $str = '[_1] seconds';
} elsif ($min == 1 && $sec > 1) {
$str = '1 minute [_2] seconds';
} elsif ($min == 1 && $sec < 2) {
@@ -1049,11 +1096,13 @@ sub Increment_PrgWin {
if ($user_browser eq 'explorer' && $user_os =~ 'mac') {
$lasttime = '';
}
- &r_print($r,'<script>'.$$prog_state{'window'}.'.document.'.
- $$prog_state{'formname'}.'.'.
- $$prog_state{'inputname'}.'.value="'.
- $$prog_state{'done'}.'/'.$$prog_state{'max'}.
- ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'.'</script>');
+ &r_print($r,&Apache::lonhtmlcommon::scripttag(
+ $$prog_state{'window'}.'.document.'.
+ $$prog_state{'formname'}.'.'.
+ $$prog_state{'inputname'}.'.value="'.
+ $$prog_state{'done'}.'/'.$$prog_state{'max'}.
+ ': '.$time_est.' '.&mt('remaining').' '.$lasttime.'";'
+ ));
$$prog_state{'laststart'}=&Time::HiRes::time();
}
@@ -1061,7 +1110,9 @@ 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,&Apache::lonhtmlcommon::scripttag(
+ 'popwin.close()'
+ ));
} elsif ($$prog_state{'type'} eq 'inline') {
&Update_PrgWin($r,$prog_state,&mt('Done'));
}
@@ -1081,47 +1132,45 @@ sub r_print {
# ------------------------------------------------------- Puts directory header
sub crumbs {
- my ($uri,$target,$prefix,$form,$size,$noformat,$skiplast)=@_;
- if (! defined($size)) {
- $size = '+2';
- }
+ my ($uri,$target,$prefix,$form,$skiplast)=@_;
if ($target) {
$target = ' target="'.
&Apache::loncommon::escape_single($target).'"';
}
- my $output='';
- unless ($noformat) { $output.='<br /><tt><b>'; }
- $output.='<font size="'.$size.'">'.$prefix.'/';
- if ($env{'user.adv'}) {
- my $path=$prefix.'/';
- foreach my $dir (split('/',$uri)) {
+ my $output='<span class="LC_filename">';
+ $output.=$prefix.'/';
+ if (($env{'user.adv'}) || ($env{'user.author'})) {
+ my $path=$prefix.'/';
+ foreach my $dir (split('/',$uri)) {
if (! $dir) { next; }
$path .= $dir;
- if ($path eq $uri) {
- if ($skiplast) {
- $output.=$dir;
+ if ($path eq $uri) {
+ if ($skiplast) {
+ $output.=$dir;
last;
- }
- } else {
- $path.='/';
- }
+ }
+ } else {
+ $path.='/';
+ }
my $href_path = &HTML::Entities::encode($path,'<>&"');
- &Apache::loncommon::inhibit_menu_check(\$href_path);
- if ($form) {
- my $href = 'javascript:'.$form.".action='".$href_path."';".$form.'.submit();';
- $output.=qq{<a href="$href" $target>$dir</a>/};
- } else {
- $output.=qq{<a href="$href_path" $target>$dir</a>/};
- }
- }
+ &Apache::loncommon::inhibit_menu_check(\$href_path);
+ if ($form) {
+ my $href = 'javascript:'.$form.".action='".$href_path."';".$form.'.submit();';
+ $output.=qq{<a href="$href"$target>$dir</a>/};
+ } else {
+ $output.=qq{<a href="$href_path"$target>$dir</a>/};
+ }
+ }
} else {
- foreach my $dir (split('/',$uri)) {
+ foreach my $dir (split('/',$uri)) {
if (! $dir) { next; }
- $output.=$dir.'/';
- }
+ $output.=$dir.'/';
+ }
}
if ($uri !~ m|/$|) { $output=~s|/$||; }
- return $output.'</font>'.($noformat?'':'</b></tt><br />');
+ $output.='</span>';
+
+ return $output;
}
# --------------------- A function that generates a window for the spellchecker
@@ -1143,6 +1192,7 @@ sub spellheader {
my $nothing=&javascript_nothing();
return (<<ENDCHECK);
<script type="text/javascript">
+// <![CDATA[
//<!-- BEGIN LON-CAPA Internal
var checkwin;
@@ -1153,6 +1203,7 @@ function spellcheckerwindow(string) {
checkwin.document.close();
}
// END LON-CAPA Internal -->
+// ]]>
</script>
ENDCHECK
}
@@ -1186,11 +1237,18 @@ ENDLINK
}
sub htmlareaheaders {
- return if (&htmlareablocked());
- return if (!&htmlareabrowser());
- return (<<ENDHEADERS);
-<script type="text/javascript" src="/fckeditor/fckeditor.js"></script>
-ENDHEADERS
+ my $s="";
+ if (&htmlareabrowser()) {
+ $s.=(<<ENDEDITOR);
+<script type="text/javascript" src="/ckeditor/ckeditor.js"></script>
+ENDEDITOR
+ }
+ $s.=(<<ENDJQUERY);
+<script type="text/javascript" src="/adm/jQuery/js/jquery-1.3.2.min.js"></script>
+<script type="text/javascript" src="/adm/jQuery/js/jquery-ui-1.7.2.custom.min.js"></script>
+<link rel="stylesheet" type="text/css" href="/adm/jQuery/css/smoothness/jquery-ui-1.7.2.custom.css" />
+ENDJQUERY
+ return $s;
}
# ----------------------------------------------------------------- Preferences
@@ -1225,22 +1283,80 @@ sub htmlarea_lang {
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="defer">'."\n"
+ .'// <![CDATA['."\n";
my $lang = &htmlarea_lang();
- foreach my $field (@fields) {
- $output.="
-{
- var oFCKeditor = new FCKeditor('$field');
- oFCKeditor.Config['CustomConfigurationsPath'] =
- '/fckeditor/loncapaconfig.js';
- oFCKeditor.ReplaceTextarea();
- oFCKeditor.Config['AutoDetectLanguage'] = false;
- oFCKeditor.Config['DefaultLanguage'] = '$lang';
-}";
+ $output.='
+
+ function containsBlockHtml(id) {
+ var re = $("#"+id).html().search(/(?:\<\;|\<)(br|h1|h2|h3|h4|h5|h6|p|ol|ul|table|pre|address|blockquote|center|div)[\s]*((?:\/[\s]*(?:\>\;|\>)|(?:\>\;|\>)[\s\S]*(?:\<\;|\<)\/[\s]*\1[\s]*\(?:\>\;|\>))/im);
+ return (re >= 0);
+ }
+
+ function startRichEditor(id) {
+ CKEDITOR.replace(id,
+ {
+ customConfig: "/ckeditor/loncapaconfig.js"
+ }
+ );
+ }
+
+ function destroyRichEditor(id) {
+ CKEDITOR.instances[id].destroy();
}
- $output.="\nwindow.status='Activated Editfields';\n</script><br />".
- &disablelink(@fields);
+
+ function editorHandler(event) {
+ var rawid = $(this).attr("id");
+ var id = new RegExp("LC_rt_(.*)").exec(rawid)[1]
+ event.preventDefault();
+ if ($(this).hasClass("LC_enable_rt")) {
+ startRichEditor(id);
+ $("#LC_rt_"+id).html("<b>« Plain text</b>");
+ $("#LC_rt_"+id).attr("title", "Disable rich text formatting and edit in plain text");
+ $("#LC_rt_"+id).addClass("LC_disable_rt");
+ $("#LC_rt_"+id).removeClass("LC_enable_rt");
+ } else {
+ destroyRichEditor(id);
+ $("#LC_rt_"+id).html("<b>Rich formatting »</b>");
+ $("#LC_rt_"+id).attr("title", "Enable rich text formatting (bold, italic, etc.)");
+ $("#LC_rt_"+id).addClass("LC_enable_rt");
+ $("#LC_rt_"+id).removeClass("LC_disable_rt");
+ }
+ }
+
+ $(document).ready(function(){
+ $(".LC_richAlwaysOn").each(function() {
+ startRichEditor($(this).attr("id"));
+ });
+ $(".LC_richDetectHtml").each(function() {
+ var id = $(this).attr("id");
+ if(containsBlockHtml(id)) {
+ $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Disable rich text formatting and edit in plain text\" class=\"LC_disable_rt\"><b>« Plain text</b></a></div>");
+ startRichEditor(id);
+ $("#LC_rt_"+id).click(editorHandler);
+ }
+ else {
+ $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Enable rich text formatting (bold, italic, etc.)\" class=\"LC_enable_rt\"><b>Rich formatting »</b></a></div>");
+ $("#LC_rt_"+id).click(editorHandler);
+ }
+ });
+ $(".LC_richDefaultOn").each(function() {
+ var id = $(this).attr("id");
+ $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Disable rich text formatting and edit in plain text\" class=\"LC_disable_rt\"><b>« Plain text</b></a></div>");
+ startRichEditor(id);
+ $("#LC_rt_"+id).click(editorHandler);
+ });
+ $(".LC_richDefaultOff").each(function() {
+ var id = $(this).attr("id");
+ $(this).before("<div><a href=\"#\" id=\"LC_rt_"+id+"\" title=\"Enable rich text formatting (bold, italic, etc.)\" class=\"LC_enable_rt\"><b>Rich formatting »</b></a></div>");
+ $("#LC_rt_"+id).click(editorHandler);
+ });
+
+ });
+';
+ $output.="\nwindow.status='Activated Editfields';\n"
+ .'// ]]>'."\n"
+ .'</script><br />';
return $output;
}
@@ -1265,19 +1381,19 @@ 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)
$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
@@ -1301,71 +1417,75 @@ returns: nothing
############################################################
{
my @Crumbs;
+ my %tools = ();
sub breadcrumbs {
- my ($component,$component_help,$menulink,$helplink,$css_class) = @_;
- #
- $css_class ||= 'LC_breadcrumbs';
- my $Str = "\n".'<table class="'.$css_class.'"><tr><td>';
+ my ($component,$component_help,$menulink,$helplink,$css_class,$no_mt, $CourseBreadcrumbs) = @_;
#
+ $css_class ||= 'LC_breadcrumbs';
+
# Make the faq and bug data cascade
- my $faq = '';
- my $bug = '';
- my $help='';
- # Crumb Symbol
- my $crumbsymbol = ' ▶ ';
+ my $faq = '';
+ my $bug = '';
+ 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 '') {
+ if ((exists($env{'request.course.id'})) &&
+ ($env{'request.course.id'} ne '') &&
+ ($env{'course.'.$env{'request.course.id'}.'.description'} ne '')) {
$description =
$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,
- });
- }
- my $links .=
- join($crumbsymbol,
- map {
- $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 '');
- if ($last->{'no_mt'}) {
- $links .= '<b>'.$last->{'text'}.'</b>';
- } else {
- $links .= '<b>'.&mt($last->{'text'}).'</b>';
- }
- #
+ $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 "",
+ map {
+ $faq = $_->{'faq'} if (exists($_->{'faq'}));
+ $bug = $_->{'bug'} if (exists($_->{'bug'}));
+ $help = $_->{'help'} if (exists($_->{'help'}));
+
+ my $result = $_->{no_mt} ? $_->{text} : mt($_->{text});
+
+ if ($_->{href}){
+ $result = htmltag( 'a', $result,
+ { href => $_->{href},
+ title => $_->{no_mt} ? $_->{title} : mt($_->{title}),
+ target => $_->{target}, });
+ }
+
+ $result = htmltag( 'li', "$result $crumbsymbol");
+ } @Crumbs;
+
+ #should the last Element be translated?
+
+ my $lasttext = $last->{'no_mt'} ? $last->{'text'}
+ : mt( $last->{'text'} );
+
+ $links .= htmltag( 'li', htmltag('h1', $lasttext), {title => $lasttext});
+
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 '') {
@@ -1374,37 +1494,146 @@ 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);
- }
- #
- $Str .= $links.'</td>';
- #
- if (defined($component)) {
- $Str .= '<td class="'.$css_class.'_component">'.
- &mt($component);
- if ($icons ne '') {
- $Str .= ' '.$icons;
- }
- $Str .= '</td>';
+ if ($faq ne '' || $component_help ne '' || $bug ne '') {
+ $icons .= &Apache::loncommon::help_open_menu($component,
+ $component_help,
+ $faq,$bug);
}
- $Str .= '</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;
+ }
+
+ render_tools(\$links);
+ $links = htmltag('div', $links,
+ { id => "LC_breadcrumbs" }) unless ($CourseBreadcrumbs) ;
+ render_advtools(\$links);
+
# Return the @Crumbs stack to what we started with
push(@Crumbs,$last);
shift(@Crumbs);
- #
- return $Str;
+ # Return the breadcrumb's line
+ return "$links";
}
sub clear_breadcrumbs {
undef(@Crumbs);
+ undef(%tools);
}
sub add_breadcrumb {
- push (@Crumbs,@_);
+ push(@Crumbs,@_);
+ }
+
+=item add_breadcrumb_tool($category, $html)
+
+Adds $html to $category of the breadcrumb toolbar container.
+
+$html is usually a link to a page that invokes a function on the currently
+displayed data (e.g. print when viewing a problem)
+
+Currently there are 3 possible values for $category:
+
+=over
+
+=item navigation
+left of breadcrumbs line
+
+=item tools
+right of breadcrumbs line
+
+=item advtools
+advanced tools shown in a separate box below breadcrumbs line
+
+=back
+
+returns: nothing
+
+=cut
+
+ sub add_breadcrumb_tool {
+ my ($category, @html) = @_;
+ return unless @html;
+ if (!defined(%tools)) {
+ %tools = ( navigation => [], tools => [], advtools => []);
+ }
+
+ #this cleans data received from lonmenu::innerregister
+ @html = grep {defined $_ && $_ ne ''} @html;
+ for (@html) {
+ s/align="(right|left)"//;
+ s/<span.*?\/span>// if $category ne 'advtools';
+ }
+
+ push @{$tools{$category}}, @html;
+ }
+
+=item clear_breadcrumb_tools()
+
+Clears the breadcrumb toolbar container.
+
+returns: nothing
+
+=cut
+
+ sub clear_breadcrumb_tools {
+ undef(%tools);
+ }
+
+=item render_tools(\$breadcrumbs)
+
+Creates html for breadcrumb tools (categories navigation and tools) and inserts
+\$breadcrumbs at the correct position.
+
+input: \$breadcrumbs - a reference to the string containing prepared
+breadcrumbs.
+
+returns: nothing
+=cut
+
+#TODO might split this in separate functions for each category
+ sub render_tools {
+ my ($breadcrumbs) = @_;
+ return unless defined %tools;
+
+ my $navigation = list_from_array($tools{navigation},
+ { listattr => { class=>"LC_breadcrumb_tools_navigation" } });
+ my $tools = list_from_array($tools{tools},
+ { listattr => { class=>"LC_breadcrumb_tools_tools" } });
+ $$breadcrumbs = list_from_array([$navigation, $tools, $$breadcrumbs],
+ { listattr => { class=>'LC_breadcrumb_tools_outerlist' } });
+ }
+
+=item render_advtools(\$breadcrumbs)
+
+Creates html for advanced tools (category advtools) and inserts \$breadcrumbs
+at the correct position.
+
+input: \$breadcrumbs - a reference to the string containing prepared
+breadcrumbs (after render_tools call).
+
+returns: nothing
+=cut
+
+ sub render_advtools {
+ my ($breadcrumbs) = @_;
+ return unless (defined $tools{'advtools'})
+ and (scalar(@{$tools{'advtools'}}) > 0);
+
+ $$breadcrumbs .= Apache::loncommon::head_subbox(
+ funclist_from_array($tools{'advtools'}) );
}
} # End of scope for @Crumbs
@@ -1465,6 +1694,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 +1704,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 +1712,7 @@ END
}
sub end_pick_box {
+ shift(@row_count);
my $output = <<"END";
</table>
END
@@ -1493,22 +1727,23 @@ END
}
sub row_title {
- my ($title,$css_title_class,$css_value_class) = @_;
+ my ($title,$css_title_class,$css_value_class, $css_value_furtherAttributes) = @_;
+ $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";
- <tr class="LC_pick_box_row">
+ <tr class="LC_pick_box_row" $css_value_furtherAttributes>
<td $css_title_class>
$title
</td>
- <td $css_value_class>
+ <td class="$css_value_class $css_class">
ENDONE
return $output;
}
@@ -1530,14 +1765,20 @@ 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 $crstype = 'Course';
+ if ($cdom ne '' && $cnum ne '') {
+ $crstype = &Apache::loncommon::course_type($cdom.'_'.$cnum);
+ }
my $output;
if (defined($title)) {
$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') {
@@ -1556,7 +1797,7 @@ sub role_select_row {
$plrole = &mt('Custom Role');
}
} else {
- $plrole=&Apache::lonnet::plaintext($role);
+ $plrole=&Apache::lonnet::plaintext($role,$crstype);
}
if (($role ne 'cr') || (!$show_separate_custom)) {
$output .= ' <option value="'.$role.'">'.$plrole.'</option>';
@@ -1571,17 +1812,18 @@ sub role_select_row {
sub course_select_row {
my ($title,$formname,$totcodes,$codetitles,$idlist,$idlist_titles,
- $css_class) = @_;
+ $css_class,$crstype) = @_;
my $output = &row_title($title,$css_class);
- $output .= &course_selection($formname,$totcodes,$codetitles,$idlist,$idlist_titles);
+ $output .= &course_selection($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype);
$output .= &row_closure();
return $output;
}
sub course_selection {
- my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles) = @_;
+ my ($formname,$totcodes,$codetitles,$idlist,$idlist_titles,$crstype) = @_;
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,11 +1846,22 @@ sub course_selection {
formname.courselist = '';
}
}
+// ]]>
</script>
|;
+
+ my ($allcrs,$pickspec);
+ if ($crstype eq 'Community') {
+ $allcrs = &mt('All communities');
+ $pickspec = &mt('Pick specific communities:');
+ } else {
+ $allcrs = &mt('All courses');
+ $pickspec = &mt('Pick specific course(s):');
+ }
+
my $courseform='<b>'.&Apache::loncommon::selectcourse_link
- ($formname,'pickcourse','pickdomain','coursedesc','',1).'</b>';
- $output .= '<input type="radio" name="coursepick" value="all" onclick="coursePick(this.form)" />'.&mt('All courses').'<br />';
+ ($formname,'pickcourse','pickdomain','coursedesc','',1,$crstype).'</b>';
+ $output .= '<input type="radio" name="coursepick" value="all" onclick="coursePick(this.form)" />'.$allcrs.'<br />';
if ($totcodes > 0) {
my $numtitles = @$codetitles;
if ($numtitles > 0) {
@@ -1653,7 +1906,7 @@ sub course_selection {
$output .= '</tr></table><br />';
}
}
- $output .= '<input type="radio" name="coursepick" value="specific" onclick="coursePick(this.form);opencrsbrowser('."'".$formname."','dccourse','dcdomain','coursedesc','','1'".')" />'.&mt('Pick specific course(s):').' '.$courseform.' <input type="text" value="0" size="4" name="coursetotal" /><input type="hidden" name="courselist" value="" />selected.<br />'."\n";
+ $output .= '<input type="radio" name="coursepick" value="specific" onclick="coursePick(this.form);opencrsbrowser('."'".$formname."','dccourse','dcdomain','coursedesc','','1','$crstype'".')" />'.$pickspec.' '.$courseform.' <input type="text" value="0" size="4" name="coursetotal" /><input type="hidden" name="courselist" value="" />selected.<br />'."\n";
return $output;
}
@@ -1664,7 +1917,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>';
}
@@ -1736,28 +1989,53 @@ sub course_custom_roles {
}
+sub resource_info_box {
+ my ($symb,$onlyfolderflag)=@_;
+ my $return='';
+ if ($symb) {
+ $return=&Apache::loncommon::start_data_table();
+ my ($map,$id,$resource)=&Apache::lonnet::decode_symb($symb);
+ my $folder=&Apache::lonnet::gettitle($map);
+ $return.=&Apache::loncommon::start_data_table_row().
+ '<th>'.&mt('Folder:').'</th><td>'.$folder.'</td>'.
+ &Apache::loncommon::end_data_table_row();
+ unless ($onlyfolderflag) {
+ $return.=&Apache::loncommon::start_data_table_row().
+ '<th>'.&mt('Resource:').'</th><td>'.&Apache::lonnet::gettitle($symb).'</td>'.
+ &Apache::loncommon::end_data_table_row();
+ }
+ $return.=&Apache::loncommon::end_data_table();
+ } else {
+ $return='<p><span class="LC_error">'.&mt('No context provided.').'</span></p>';
+ }
+ return $return;
+
+}
+
##############################################
##############################################
# 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
-#
+# Generates a div containing an (optional) number with a white background followed by a
+# title with a background color defined in the corresponding CSS: LC_topic_bar
+# Inputs:
+# 1. number to display.
+# If input for number is empty only the title will be displayed.
+# 2. title text to display.
+# Outputs - a scalar containing html mark-up for the div.
+
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>
-';
+ my ($num,$title) = @_;
+ my $number = '';
+ if ($num ne '') {
+ $number = '<span>'.$num.'</span>';
+ }
+ return '<div class="LC_topic_bar">'.$number.$title.'</div>';
}
##############################################
##############################################
-
# echo_form_input
#
# Generates html markup to add form elements from the referrer page
@@ -1822,7 +2100,6 @@ sub echo_form_input {
##############################################
##############################################
-
# set_form_elements
#
# Generates javascript to set form elements to values based on
@@ -1887,7 +2164,7 @@ sub set_form_elements {
$values{$name}[$i] =~ s/([\r\n\f]+)/\\n/g;
$values{$name}[$i] =~ s/"/\\"/g;
}
- if ($$elements{$name} eq 'text') {
+ if (($$elements{$name} eq 'text') || ($$elements{$name} eq 'hidden')) {
my $numvalues = @{$values{$name}};
if ($numvalues > 1) {
my $valuestring = join('","',@{$values{$name}});
@@ -1922,6 +2199,8 @@ sub set_form_elements {
$output .= qq|
if (courseForm.elements['$name'].value == "$value") {
courseForm.elements['$name'].checked = true;
+ } else {
+ courseForm.elements['$name'].checked = false;
}|;
}
}
@@ -1963,6 +2242,7 @@ sub set_form_elements {
}
}
$output .= "
+ return;
}\n";
return $output;
}
@@ -2004,6 +2284,121 @@ 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, [start|end|both]);
+#
+# EXAMPLES:
+# - scripttag("alert('Hello World!')", 'both')
+# returns:
+# <script type="text/javascript">
+# // BEGIN LON-CAPA Internal
+# alert(Hello World!')
+# // END LON-CAPA Internal
+# </script>
+#
+# NOTES:
+# - works currently only for javascripts
+#
+# OUTPUT:
+# Scriptcode properly enclosed in <script> and CDATA tags (and LC
+# Internal markers if 2nd argument is given)
+sub scripttag {
+ my ( $content, $marker ) = @_;
+ return unless defined $content;
+
+ my $begin = "\n// BEGIN LON-CAPA Internal\n";
+ my $end = "\n// END LON-CAPA Internal\n";
+
+ if ($marker) {
+ $content = $begin . $content if $marker eq 'start' or $marker eq 'both';
+ $content .= $end if $marker eq 'end' or $marker eq 'both';
+ }
+
+ $content = "\n// <![CDATA[\n$content\n// ]]>\n";
+
+ return htmltag('script', $content, {type => 'text/javascript'});
+};
+
+
+=item list_from_array( \@array, { listattr =>{}, itemattr =>{} } )
+
+Constructs a XHTML list from \@array.
+
+input:
+
+=over
+
+=item \@array
+
+A reference to the array containing text that will be wrapped in <li></li> tags.
+
+=item { listattr => {}, itemattr =>{} }
+
+Attributes for <ul> and <li> passed in as hash references.
+See htmltag() for more details.
+
+=back
+
+returns: XHTML list as String.
+
+=cut
+
+# \@items, {listattr => { class => 'abc', id => 'xyx' }, itemattr => {class => 'abc', id => 'xyx'}}
+sub list_from_array {
+ my ($items, $args) = @_;
+ return unless scalar @$items;
+ my ($ul, $li) = inittags( qw(ul li) );
+ my $listitems = join '', map { $li->($_, $args->{itemattr}) } @$items;
+ return $ul->( $listitems, $args->{listattr} );
+}
+
+
##############################################
##############################################
@@ -2015,10 +2410,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)'
# },
@@ -2030,34 +2428,182 @@ END
#
# 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 = @_;
- 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_Box LC_400Box"})) if scalar(@links);
}
- return $menu_html;
+
+ # 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 '<ul class="LC_funclist"><li style="font-weight:bold; margin-left:0.8em;">'.$legendtext.'</li>'."\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 {
+ return "</ul>\n";
}
+=pod
+
+=item funclist_from_array( \@array, {legend => 'text for legend'} )
+
+Constructs a XHTML list from \@array with the first item being visually
+highlighted and set to the value of legend or 'Functions' if legend is
+empty.
+
+=over
+
+=item \@array
+
+A reference to the array containing text that will be wrapped in <li></li> tags.
+
+=item { legend => 'text' }
+
+A string that's used as visually highlighted first item. 'Functions' is used if
+it's value evaluates to false.
+
+=back
+
+returns: XHTML list as string.
+
+=back
+
+=cut
+
+sub funclist_from_array {
+ my ($items, $args) = @_;
+ $args->{legend} ||= mt('Functions');
+ return list_from_array( [$args->{legend}, @$items],
+ { listattr => {class => 'LC_funclist'} });
+}
1;