Return to lonmainmenu.pm CVS log

Up to [LON-CAPA] / loncom / interface

- WCAG 2 compliance.
  Replace layout table with divs. Eliminate duplicate links for icon and
  text for each menu link. Customize  &generate_menu() already used for
  "Sub Menu" pages to also create "Main Menu" page.

# The LearningOnline Network with CAPA
# displays the main menu
#
# $Id: lonmainmenu.pm,v 1.14 2025/03/25 01:02:59 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#
#
# There are two parameters controlling the action of this module:
#
# browser.interface - if this is 'textual', it overrides the second parameter
# and goes to screen reader PDA mode
#

package Apache::lonmainmenu;

use strict;
use Apache::Constants qw(:common REDIRECT);
use Apache::loncommon();
use Apache::lonnet;
use Apache::lonmenu();
use Apache::lonlocal;

sub handler {
    my $r = shift;

    # Check for critical messages and redirect if present.
    my ($redirect,$url) = &Apache::loncommon::critical_redirect(300,'menu');
    if ($redirect) {
        &Apache::loncommon::content_type($r,'text/html');
        $r->header_out(Location => $url);
        return REDIRECT;
    }

    &Apache::loncommon::no_cache($r);
    &Apache::loncommon::content_type($r,'text/html');
    $r->send_http_header;
    return OK if $r->header_only;

# ---- Print the screen, pretend to be in text mode to generate text-based menu
# temporarily set interface to "faketextual" and remote to "off", which renders
# the main menu
    $env{'browser.interface'}='faketextual';

#
# If menu collection is in effect in course context, determine if Main Menu
# will be shown.
#
    my $showmenu = 1;
    my $deeplinkmenu;
    if ($env{'request.course.id'}) {
        (my $menucoll,$deeplinkmenu,my $menuref) =
            &Apache::loncommon::menucoll_in_effect();
        if (($menucoll) && (ref($menuref) eq 'HASH')) {
            if ($menuref->{'main'} eq 'n') {
                $showmenu = 0;
            }
        }
    }
    my $js;
    my $args = { 'bread_crumbs' => 1 };
    if ($showmenu) {
        $js = <<"END";
<script type="text/javascript">
// <![CDATA[
function formatMenuText() {
    var textArray = document.getElementsByClassName("LC_menu_text");
    if (textArray.length > 0) {
        var singleLineHeight = textArray[0].offsetHeight;
        for (var i=1; i<textArray.length; i++) {
            if (textArray[i].offsetHeight > singleLineHeight) {
                var el = textArray[i].previousElementSibling;
                el.style.cssFloat = "left";
                el.style.marginRight = "5px";
            }
        }
    }
}
// ]]>
</script>
END
        $args->{'add_entries'} = { 'onload' => 'javascript:formatMenuText();' };
    }

    $r->print(&Apache::loncommon::start_page( 'Main Menu',$js,$args).
              '<div class="LC_landmark" role="main">');
#
# If menu collection is in effect in course context, and Main Menu is 
# not included, display message in place of usual menu items.
#
    unless ($showmenu) {
        my $nomenumsg;
        my $crstype = &Apache::loncommon::course_type();
        if ($deeplinkmenu) {
            $nomenumsg = &mt('Page unavailable');
        } else {
            $nomenumsg = &mt("Main Menu page is unavailable in this $crstype");
        }
        $r->print('<h1 class="LC_heading_3">'.$nomenumsg.'</h1>'.
                  '</div>'.&Apache::loncommon::end_page());
        return OK;
    }
#
# A span with class of LC_menu_text needs to be first item with that class.
# It will be used by formatMenuText() to determine the offsetHeight for a single line.
#
    $r->print('<span class="LC_menu_text">&nbsp;</span>'.
              &Apache::lonmenu::inlinemenu().
              '</div>'.&Apache::loncommon::end_page());
    return OK;
}


1;
__END__