[BACK]Return to lonhelpmenu.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonhelpmenu.pm between versions 1.6 and 1.41

version 1.6, 2004/07/03 20:25:51 version 1.41, 2013/07/19 17:11:09
Line 1 Line 1
 # The LearningOnline Network with CAPA  # The LearningOnline Network with CAPA
 # generate frame-based help system  # generate frame-based help system
 #  #
   # $Id$
   #
 # Copyright Michigan State University Board of Trustees  # Copyright Michigan State University Board of Trustees
 #  #
 # This file is part of the LearningOnline Network with CAPA (LON-CAPA).  # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
Line 30  use strict; Line 32  use strict;
 use lib qw(/home/httpd/lib/perl);  use lib qw(/home/httpd/lib/perl);
 use Apache::Constants qw(:common);  use Apache::Constants qw(:common);
 use Apache::loncommon();  use Apache::loncommon();
   use Apache::lonlocal;
   use Apache::lonnet;
   use lib '/home/httpd/lib/perl/';
   use LONCAPA;
   
 sub handler {  sub handler {
     my ($r) = @_;      my ($r) = @_;
     &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['page','color','function','faq','bug','topic','component_help','origurl']);      &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['page','faq','bug','topic','component_help','origurl','stayonpage']);
     &Apache::loncommon::content_type($r,'text/html');      &Apache::loncommon::content_type($r,'text/html');
     $r->send_http_header;      $r->send_http_header;
   
     if ($r->header_only) {      if ($r->header_only) {
         return OK;          return OK;
     }      }
     my $color = $ENV{'form.color'};      my $faq = $env{'form.faq'};
     my $faq = $ENV{'form.faq'};      my $bug = $env{'form.bug'};
     my $bug = $ENV{'form.bug'};      my $topic = $env{'form.topic'};
     my $topic = $ENV{'form.topic'};      my $component_help = $env{'form.component_help'};
     my $function = $ENV{'form.function'};      my $origurl = $env{'form.origurl'};
     my $component_help = $ENV{'form.component_help'};      my $stayOnPage = $env{'form.stayonpage'};
     my $origurl = $ENV{'form.origurl'};  
     my $component_url = $component_help;      my $component_url = $component_help;
     if ($component_url) {      if ($component_url) {
         $component_url = '/adm/help/'.$component_url.'.hlp';          $component_url = '/adm/help/'.$component_url.'.hlp';
Line 58  sub handler { Line 63  sub handler {
     }      }
     my $faqbaseurl = $Apache::lonnet::perlvar{'FAQHost'};      my $faqbaseurl = $Apache::lonnet::perlvar{'FAQHost'};
     my $requestmail = $Apache::lonnet::perlvar{'lonSupportEMail'};      my $requestmail = $Apache::lonnet::perlvar{'lonSupportEMail'};
     if ($ENV{'form.page'} eq 'banner') {      if ($env{'form.page'} eq 'banner') {
         &display_help_banner($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail);          &display_help_banner($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage);
     } elsif ($ENV{'form.page'} eq 'body') {      } elsif ($env{'form.page'} eq 'body') {
         &display_help_mainpage($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail);          &display_help_mainpage($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail);
     }      }
     return OK;      return OK;
 }  }
   
 sub display_help_banner {  sub display_help_banner {
     my ($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail) = @_;      my ($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage) = @_;
     my $bodytag = &Apache::loncommon::bodytag('',$function,'rightmargin="0" leftmargin="0" marginwidth="0" topmargin="1" marginheight="1"',1);      my $location=&Apache::loncommon::lonhttpdurl("/adm");
     $bodytag=~s/[\n\r]/ /g;      my $dom = $env{'request.role.domain'};
     my $fontcolor = &Apache::loncommon::designparm($function.'.font');      my %helpconfig = &Apache::lonnet::get_dom('configuration',['helpsettings'],$dom);
     my $alinkcolor = &Apache::loncommon::designparm($function.'.alink');      my $scripttag = '';
     my $vlinkcolor = &Apache::loncommon::designparm($function.'.vlink');      if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
     my $pagecolor = &Apache::loncommon::designparm($function.'.pgbg');          my $displayurl = &escape($origurl);
     my $tablecolor = &Apache::loncommon::designparm($function.'.tabbg');          $scripttag = (<<"SCRIPT_ONE");
   <script>
   function gohelpdesk() {
       var actiontype = null;
       try {
           actiontype = parent.bodyframe.document.logproblem.action.value;
       }
       catch(error) {
           parent.bodyframe.location = "/adm/support?origurl=$displayurl";
           return;
       }
       if (actiontype) {
           var loc = parent.bodyframe.location.href;
           if (loc.indexOf("/adm/support") > -1) {
               if (parent.bodyframe.document.logproblem.action.value == "process") {
                   if (validmail(parent.bodyframe.document.logproblem.email) == false) {
                       alert("The e-mail address you entered: "+parent.bodyframe.document.logproblem.email.value+" is not a valid e-mail address.");
                       return;
                   }
                   parent.bodyframe.document.logproblem.submit();
                   return;
               }
           }
           parent.bodyframe.location = "/adm/support?origurl=$displayurl";
           return;
       }
   }
   SCRIPT_ONE
           $scripttag .= (<<'SCRIPT_TWO');
   function validmail(field) {
       var str = field.value;
       if (window.RegExp) {
           var reg1str = "(@.*@)|(\\.\\.)|(@\\.)|(\\.@)|(^\\.)";
           var reg2str = "^.+\\@(\\[?)[a-zA-Z0-9\\-\\.]+\\.([a-zA-Z]{2,3}|[0-9]{1,3})(\\]?)$"; //"
           var reg1 = new RegExp(reg1str);
           var reg2 = new RegExp(reg2str);
           if (!reg1.test(str) && reg2.test(str)) {
               return true;
           }
           return false;
       }
       else
       {
   
     $r->print(<<END);          if(str.indexOf("@") >= 0) {
 <html>              return true;
 <head>          }
 <title>Help Banner</title>          return false;
 <style type="text/css">      }
 <!--  
  a:link {text-decoration: none; color: $fontcolor; }  
  a:visited {text-decoration: none; color: $fontcolor; }  
  a:active {text-decoration: none; color: $fontcolor; }  
  a:hover {text-decoration: underline; color: $vlinkcolor; }  
 -->  
 </style>  
 <script type="text/javascript">  
 function noTopic () {   
     bodyframe.document.write("<html><head><title>Topic Page</title></head>")  
     bodyframe.document.write('$bodytag')  
     bodyframe.document.write("The LON-CAPA help system does not currently include a specific pop-up help item for this topic. You may wish to consult the LON-CAPA <a href='/adm/help/author.manual.pdf'>Authoring Manual</a> or the <a href='/adm/help/course.manual.pdf'>Course Coordinator Manual</a>.")  
     bodyframe.document.write("</body></html>")  
     body.document.close()  
 }  }
 </script>  </script>
 </head>  SCRIPT_TWO
 $bodytag      }
  <table width="600" border="0" cellspacing="0" cellpadding="0" height="55">  
       my %body_layout = 
    ('rightmargin'  => "0",
    'leftmargin'   => "0",
    'marginwidth'  => "0",
    'topmargin'    => "1",
    'marginheight' => "1");
       my $start_page = 
    &Apache::loncommon::start_page('',$scripttag,
          {'add_entries' => \%body_layout,
    'only_body'   => 1,});
       $r->print($start_page);
   
       my $width = ($stayOnPage) ? '95%' : '600';
       $r->print('<table id="LC_helpmenu" width="'.$width.'">');
   
       my $general_help = &Apache::loncommon::general_help();
       $r->print('
   <tr height="50">    <tr height="50">
    <td width='5'>&nbsp;</td>     <td width="5">&nbsp;</td>
    <td>     <td>
     <fieldset><legend><img src="/adm/lonIcons/minilogo.gif" height='20' width='29' valign='bottom' />&nbsp;&nbsp;<b><font size="+1">LON-CAPA help/support</font></b></legend>      <fieldset><legend><img src="'.$location.'/lonIcons/minilogo.gif" height="20" width="29" valign="bottom" alt="('.&mt('LON-CAPA help/support').')" />&nbsp;&nbsp;'.&mt('LON-CAPA help/support').'</legend>
  <table width="100%" border="0" cellpadding="0" cellspacing="0" bgcolor="#000000">   <table id="LC_helpmenu_links">
   <tr>     <tr>
    <td>   <td><span class="LC_nobreak"><a href="/adm/help/'.$general_help.'.hlp" target="bodyframe">
     <table width="100%" border="0" cellpadding="0" cellspacing="1" bgcolor="#000000">    <img src="'.$location.'/help/help.png" border="0" alt="('.&mt('General help').')" valign="middle" />&nbsp;'.&mt('General Help').'</a>&nbsp;</span></td>');
      <tr>      if ($component_url) {
       <td>   $r->print("<td><span class=\"LC_nobreak\"><a href=\"$component_url\" target=\"bodyframe\">".
        <table width="100%" border="0" cellpadding="0" cellspacing="0" bgcolor="#ffffff">    '<img src="'.$location.'/help/help.png" border="0" alt="('.&mt('Topic help').')" valign="middle" />&nbsp;'.$topic.'</a>&nbsp;</span></td>');
         <tr>  
          <td>  
   <table width="100%" border="0" cellpadding="0" cellspacing="1" bgcolor="#ffffff">  
            <tr bgcolor="$tablecolor">  
 END  
     if (($component_url) || ($ENV{'user.adv'})) {  
         if ($component_url) {  
             $r->print("  
             <td align=\"center\">&nbsp;<b><a href=\"$component_url\" target=\"bodyframe\">");  
     $r->print('  
    <image src="/adm/help/gif/smallHelp.gif" border="0" alt="(Topic help)" valign="middle" />&nbsp;Topic help</a></b>&nbsp;</td>');  
         } elsif (0 && $ENV{'user.adv'}) {  
     #FIXME doing this in JS is problematic since JS can't control frames that go to outside sites  
             $r->print('<td align="center">&nbsp;<b><a href="javascript:noTopic()" target="bodyframe">');  
         }  
     }      }
     if ($requestmail) {      if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
         $r->print('          $r->print('
             <td align="center">&nbsp;<b><a href="/adm/support?origurl='.$origurl.'&function='.$function.'" target="bodyframe"><image src="/adm/lonMisc/feedback.gif" border="0" alt="(Ask helpdesk)" valign="middle" />&nbsp;Ask helpdesk</a></b>&nbsp;</td>');              <td><span class="LC_nobreak">&nbsp;<a href="javascript:gohelpdesk()"><img src="'.$location.'/lonIcons/helpdesk.gif" border="0" alt="('.&mt('Ask helpdesk').')" valign="middle" />&nbsp;'.&mt('Ask helpdesk').'</a>&nbsp;</span></td>');
     }      }
     if ($ENV{'user.adv'}) {      if ($faq && $env{'user.adv'}) {
         $r->print(<<END)          $r->print('
             <td align="center">               <td><span class="LC_nobreak">&nbsp;<a href="'.$faqbaseurl.'/fom/cache/'.$faq.'.html" target="bodyframe"><img src="'.$location.'/lonMisc/smallFAQ.gif" border="0" alt="('.&mt('FAQ').')" valign="middle" />&nbsp;'.&mt('FAQ').'</a>&nbsp;</span>
              &nbsp;<b><a href="$faqbaseurl/fom/cache/$faq.html" target="bodyframe"><image src="/adm/lonMisc/smallFAQ.gif" border="0" alt="(FAQ)" valign="middle" />&nbsp;FAQ</a></b>&nbsp;              </td>');
             </td>      }
             <td align="center">&nbsp;<b><a href="$bugurl" target="bodyframe"><image src="/adm/lonMisc/smallBug.gif" border="0" alt="(Report a bug)" valign="middle" />&nbsp;Report a bug</a>&nbsp;</b></td>      if ($env{'user.adv'}) {
 END      if ($helpconfig{'helpsettings'}{'submitbugs'} eq '1' ||
       $helpconfig{'helpsettings'}{'submitbugs'} eq '' ) {
           $r->print('
               <td><span class="LC_nobreak"&nbsp;<b><a href="'.$bugurl.'" target="bodyframe"><img src="'.$location.'/lonMisc/smallBug.gif" border="0" alt="('.&mt('Report a bug').')" valign="middle" />&nbsp;'.&mt('Report a bug').'</a>&nbsp;</b></span></td>');
    }
       }
       if ($stayOnPage) {
           $r->print('
               <td><span class="LC_nobreak">&nbsp;<a href="'.$origurl.'" target="_top"><img src="'.$location.'/lonIcons/move_up.gif" border="0" alt="('.&mt('Return to last location').')" valign="middle" />&nbsp;'.&mt('Return to last location').'</a>&nbsp;</span></td>');
       } else {
           $r->print('
               <td><span class="LC_nobreak"&nbsp;<a href="javascript:window.close()" target="_top"><img src="$location/lonIcons/closepage.gif" border="0" alt="('.&mt('Close window').')" valign="bottom" />&nbsp;'.&mt('Close').'</a>&nbsp;</span></td>');
     }      }
     $r->print(<<END);      $r->print(<<END);
             <td align="center">&nbsp;<b><a href="javascript:window.close()" target="_top"><image src="/adm/lonIcons/move_up.gif" border="0" alt="(Close window)" valign="middle" />Close</a></b>&nbsp;</td>  
            </tr>  
           </table>  
          </td>  
         </tr>  
        </table>  
       </td>  
      </tr>  
     </table>  
    </td>  
   </tr>    </tr>
  </table>   </table>
 </fieldset>  </fieldset>
   </td>    </td>
   <td width='5'>&nbsp;</td>    <td width='100%'>&nbsp;</td>
  </tr>   </tr>
  <tr height='5'>   <tr height='5'>
   <td colspan='3' height='5'>&nbsp;</td>    <td colspan='3' height='5'>&nbsp;</td>
  </tr>   </tr>
 </table>  </table>
 </body>  
 </html>  
 END  END
       $r->print(&Apache::loncommon::end_page());
 }  }
   
 sub display_help_mainpage {  sub display_help_mainpage {
     my ($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail) = @_;      my ($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail) = @_;
     my $bodytag = &Apache::loncommon::bodytag('',$function,'topmargin="0" marginheight="0"',1);  
     $bodytag=~s/[\n\r]/ /g;      my %lt =&Apache::lonlocal::texthash(
     $r->print(<<END);          'topp' => 'Topic Page',
 <html>          'chen' => 'Choose an entry below to go directly to a relevant help page',
  <head>          'orto' => 'or to submit a help request to the LON-CAPA support staff at your institution.',
   <title>Help Content</title>          'vthp' => 'Visit the help page for ',
   <script type="text/javascript">          'disp' => 'Display the page in the inline help system that covers this topic.',
 function noTopic() {          'crac' => 'Create an account for yourself in the LON-CAPA Bugzilla tracking system, if you wish to report bugs you have encountered in the LON-CAPA software, or if you have suggestions for improvements in LON-CAPA.',
     bodyframe.document.write('<html><head><title>Topic Page</title></head>$bodytag')          'cont' => 'Contact the LON-CAPA support team',
     bodyframe.document.write("The LON-CAPA help system does not currently include a specific pop-up help item for this topic. You may wish to consult the LON-CAPA <a href='/adm/help/author.manual.pdf'>Authoring Manual</a> or the <a href='/adm/help/course.manual.pdf'>Course Coordinator Manual</a>.")          'suhr' => 'Submit a help request to the team responsible for LON-CAPA support at this institution.',
     bodyframe.document.write("</body></html>")          'faqo' => 'FAQ-O-Matic Help system',
     body.document.close()          'tfaq' => 'The FAQ-O-Matic is a compendium of answers provided to common questions asked by users of LON-CAPA over the past couple of years.',
 }          'lbug' => 'LON-CAPA Bugzilla bug/feature request tracking system',
   </script>          'crea' => 'Create an account for yourself in the LON-CAPA Bugzilla tracking system, if you wish to report bugs you have encountered in the LON-CAPA software,or if you have suggestions for improvements in LON-CAPA.',
  </head>          'suim' => ' Suggested improvements may include additional functionality, improved usability, or changes to wording used in LON-CAPA pages, including the embedded help system.'
 $bodytag      );
 Choose an entry below to go directly to a relevant help page  
 END      my %body_layout = 
     if ($requestmail) {   ('topmargin'    => "0",
         $r->print(", or to submit a help request to the LON-CAPA support staff at you institution.");   'marginheight' => "0");
       my $start_page =
    &Apache::loncommon::start_page('Help Content',undef,
          {'add_entries' => \%body_layout,
    'only_body'   => 1,});
       $r->print($start_page);
       $r->print('<b>'.$lt{'chen'});
       if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
           $r->print(', '.$lt{'orto'});
     } else {      } else {
         $r->print(".");          $r->print(".");
     }      }
       $r->print('</b>');
     if ($topic) {      if ($topic) {
         if ( ($component_url) || ($ENV{'user.adv'}) ) {          if ( ($component_url) || ($env{'user.adv'}) ) {
             if ($component_url) {              if ($component_url) {
                 $r->print("                  $r->print("
           <ul>            <ul>
            <li><a href=\"$component_url\">Visit the help page for $topic</a></li>             <li><a href=\"$component_url\">$lt{'vthp'} $topic</a></li>
           </ul>            </ul>
           <p>Display the page in the inline help system that covers this topic.</p>            <p>$lt{'disp'}</p>
                 ");                  ");
             } elsif ($ENV{'user.adv'}) {  
                 $r->print("  
               <ul>  
                <li><td align=\"center\">&nbsp;<a href=\"javascript:noTopic()\">Inline help system for $topic</a></li></ul>  
                <p>Consult the inline help system for this topic.</p>");  
             }              }
         }          }
     }      }
     if ($requestmail) {      if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
         $r->print("          $r->print("
           <ul>            <ul>
            <li><a href=\"/adm/support?origurl=$origurl&function=$function\" target=\"bodyframe\">Contact the LON-CAPA support team</a></li>             <li><a href=\"/adm/support?origurl=".&escape($origurl)."\">$lt{'cont'}</a></li>
           </ul>            </ul>
           <p>Submit a help request to the team responsible for LON-CAPA support at this institution.</p>            <p>$lt{'suhr'}");
           <ul>           unless ($env{'user.adv'}) {
         ");               $r->print('<br />'.
                          &mt('[_1]Note[_2]: questions about course content should not be directed to the support team, but instead should be sent to the course instructor.'). 
                          ' '.
                          &mt('This can be done by clicking the [_1]Communicate[_2] link or the "Send Feedback" link when viewing a content page.',
                             '<a href="/adm/communicate" target="_top">','</a>')); 
            }
            $r->print("</p>");
     }      }
     if ($faqbaseurl && $ENV{'user.adv'}) {      if ($faqbaseurl && $env{'user.adv'}) {
         if (!defined($faq) ||$faq eq '') {          if (!defined($faq) ||$faq eq '') {
             $faq = '1';              $faq = '1';
         }          }
         $r->print("          $r->print("
            <li><a href=\"$faqbaseurl/fom/cache/$faq.html\">FAQ-O-Matic Help system</a></li>            <ul>
              <li><a href=\"$faqbaseurl/fom/cache/$faq.html\">$lt{'faqo'}</a></li>
           </ul>            </ul>
           <p>The FAQ-O-Matic is a compendium of answers provided to common questions asked by users of LON-CAPA over the past couple of years.</p>            <p>$lt{'tfaq'}</p>
         ");          ");
     }      }
     if ($bugurl && $ENV{'user.adv'}) {      if ($bugurl && $env{'user.adv'}) {
         $bugurl .= '?'.$bug;          $bugurl .= '?'.$bug;
         $r->print("          $r->print("
           <ul>            <ul>
            <li><a href=\"$bugurl\">LON-CAPA Bugzilla bug/feature request tracking             <li><a href=\"$bugurl\">$lt{'lbug'}</a></li>
 system</a></li>  
           </ul>            </ul>
           <p>Create an account for yourself in the LON-CAPA Bugzilla tracking system, if you wish to report bugs you have encountered in the LON-CAPA software,            <p>$lt{'crea'} $lt{'suim'}</p>
 or if you have suggestions for improvements in LON-CAPA.  Suggested improvements may include additional functionality, improved usability, or changes to wording used in LON-CAPA pages, including the embedded help system.</p>  
         ");          ");
     }      }
     $r->print(<<END);      $r->print(&Apache::loncommon::end_page());
  </body>  
 </html>  
 END  
 }  }
   
 1;  1;
Removed from v.1.6  
changed lines
  Added in v.1.41

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>