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.

    1: # The LearningOnline Network with CAPA
    2: # displays the main menu
    3: #
    4: # $Id: lonmainmenu.pm,v 1.14 2025/03/25 01:02:59 raeburn Exp $
    5: #
    6: # Copyright Michigan State University Board of Trustees
    7: #
    8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
    9: #
   10: # LON-CAPA is free software; you can redistribute it and/or modify
   11: # it under the terms of the GNU General Public License as published by
   12: # the Free Software Foundation; either version 2 of the License, or
   13: # (at your option) any later version.
   14: #
   15: # LON-CAPA is distributed in the hope that it will be useful,
   16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
   17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   18: # GNU General Public License for more details.
   19: #
   20: # You should have received a copy of the GNU General Public License
   21: # along with LON-CAPA; if not, write to the Free Software
   22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   23: #
   24: # /home/httpd/html/adm/gpl.txt
   25: #
   26: # http://www.lon-capa.org/
   27: #
   28: #
   29: # There are two parameters controlling the action of this module:
   30: #
   31: # browser.interface - if this is 'textual', it overrides the second parameter
   32: # and goes to screen reader PDA mode
   33: #
   34: 
   35: package Apache::lonmainmenu;
   36: 
   37: use strict;
   38: use Apache::Constants qw(:common REDIRECT);
   39: use Apache::loncommon();
   40: use Apache::lonnet;
   41: use Apache::lonmenu();
   42: use Apache::lonlocal;
   43: 
   44: sub handler {
   45:     my $r = shift;
   46: 
   47:     # Check for critical messages and redirect if present.
   48:     my ($redirect,$url) = &Apache::loncommon::critical_redirect(300,'menu');
   49:     if ($redirect) {
   50:         &Apache::loncommon::content_type($r,'text/html');
   51:         $r->header_out(Location => $url);
   52:         return REDIRECT;
   53:     }
   54: 
   55:     &Apache::loncommon::no_cache($r);
   56:     &Apache::loncommon::content_type($r,'text/html');
   57:     $r->send_http_header;
   58:     return OK if $r->header_only;
   59: 
   60: # ---- Print the screen, pretend to be in text mode to generate text-based menu
   61: # temporarily set interface to "faketextual" and remote to "off", which renders
   62: # the main menu
   63:     $env{'browser.interface'}='faketextual';
   64: 
   65: #
   66: # If menu collection is in effect in course context, determine if Main Menu
   67: # will be shown.
   68: #
   69:     my $showmenu = 1;
   70:     my $deeplinkmenu;
   71:     if ($env{'request.course.id'}) {
   72:         (my $menucoll,$deeplinkmenu,my $menuref) =
   73:             &Apache::loncommon::menucoll_in_effect();
   74:         if (($menucoll) && (ref($menuref) eq 'HASH')) {
   75:             if ($menuref->{'main'} eq 'n') {
   76:                 $showmenu = 0;
   77:             }
   78:         }
   79:     }
   80:     my $js;
   81:     my $args = { 'bread_crumbs' => 1 };
   82:     if ($showmenu) {
   83:         $js = <<"END";
   84: <script type="text/javascript">
   85: // <![CDATA[
   86: function formatMenuText() {
   87:     var textArray = document.getElementsByClassName("LC_menu_text");
   88:     if (textArray.length > 0) {
   89:         var singleLineHeight = textArray[0].offsetHeight;
   90:         for (var i=1; i<textArray.length; i++) {
   91:             if (textArray[i].offsetHeight > singleLineHeight) {
   92:                 var el = textArray[i].previousElementSibling;
   93:                 el.style.cssFloat = "left";
   94:                 el.style.marginRight = "5px";
   95:             }
   96:         }
   97:     }
   98: }
   99: // ]]>
  100: </script>
  101: END
  102:         $args->{'add_entries'} = { 'onload' => 'javascript:formatMenuText();' };
  103:     }
  104: 
  105:     $r->print(&Apache::loncommon::start_page( 'Main Menu',$js,$args).
  106:               '<div class="LC_landmark" role="main">');
  107: #
  108: # If menu collection is in effect in course context, and Main Menu is 
  109: # not included, display message in place of usual menu items.
  110: #
  111:     unless ($showmenu) {
  112:         my $nomenumsg;
  113:         my $crstype = &Apache::loncommon::course_type();
  114:         if ($deeplinkmenu) {
  115:             $nomenumsg = &mt('Page unavailable');
  116:         } else {
  117:             $nomenumsg = &mt("Main Menu page is unavailable in this $crstype");
  118:         }
  119:         $r->print('<h1 class="LC_heading_3">'.$nomenumsg.'</h1>'.
  120:                   '</div>'.&Apache::loncommon::end_page());
  121:         return OK;
  122:     }
  123: #
  124: # A span with class of LC_menu_text needs to be first item with that class.
  125: # It will be used by formatMenuText() to determine the offsetHeight for a single line.
  126: #
  127:     $r->print('<span class="LC_menu_text">&nbsp;</span>'.
  128:               &Apache::lonmenu::inlinemenu().
  129:               '</div>'.&Apache::loncommon::end_page());
  130:     return OK;
  131: }
  132: 
  133: 
  134: 1;
  135: __END__
  136: 
  137: 
  138: 
  139: 
  140: 
  141: 
  142: