Diff for /loncom/interface/lonhelpmenu.pm between versions 1.3 and 1.18

version 1.3, 2004/07/03 19:33:30 version 1.18, 2004/12/20 21:11:41
Line 30  use strict; Line 30  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;
   
 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','color','function','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;
   
Line 47  sub handler { Line 48  sub handler {
     my $function = $ENV{'form.function'};      my $function = $ENV{'form.function'};
     my $component_help = $ENV{'form.component_help'};      my $component_help = $ENV{'form.component_help'};
     my $origurl = $ENV{'form.origurl'};      my $origurl = $ENV{'form.origurl'};
       my $stayOnPage = $ENV{'form.stayonpage'};
     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 59  sub handler { Line 61  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,$color,$function,$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,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail);
     }      }
Line 67  sub handler { Line 69  sub handler {
 }  }
   
 sub display_help_banner {  sub display_help_banner {
     my ($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail) = @_;      my ($r,$color,$function,$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 $bodytag = &Apache::loncommon::bodytag('',$function,'rightmargin="0" leftmargin="0" marginwidth="0" topmargin="1" marginheight="1"',1);
     $bodytag=~/[\n\r]/ /g;      $bodytag=~s/[\n\r]/ /g;
     my $fontcolor = &Apache::loncommon::designparm($function.'.font');      my $fontcolor = &Apache::loncommon::designparm($function.'.font');
     my $alinkcolor = &Apache::loncommon::designparm($function.'.alink');      my $alinkcolor = &Apache::loncommon::designparm($function.'.alink');
     my $vlinkcolor = &Apache::loncommon::designparm($function.'.vlink');      my $vlinkcolor = &Apache::loncommon::designparm($function.'.vlink');
     my $pagecolor = &Apache::loncommon::designparm($function.'.pgbg');      my $pagecolor = &Apache::loncommon::designparm($function.'.pgbg');
     my $tablecolor = &Apache::loncommon::designparm($function.'.tabbg');      my $tablecolor = &Apache::loncommon::designparm($function.'.tabbg');
       my $location=&Apache::loncommon::lonhttpdurl("/adm");
       if (($tablecolor eq '') || ($tablecolor eq '#FFFFFF')) {
           $tablecolor = '#EEEE99';
       }
       my $scripttag = '';
       if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
           my $displayurl = &Apache::lonnet::escape($origurl);
           $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&function=$function";
           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&function=$function";
           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
       {
   
           if(str.indexOf("@") >= 0) {
               return true;
           }
           return false;
       }
   }
   </script>
   SCRIPT_TWO
       }
     $r->print(<<END);      $r->print(<<END);
 <html>  <html>
 <head>  <head>
Line 88  sub display_help_banner { Line 149  sub display_help_banner {
  a:hover {text-decoration: underline; color: $vlinkcolor; }   a:hover {text-decoration: underline; color: $vlinkcolor; }
 -->  -->
 </style>  </style>
 <script type="text/javascript">  $scripttag
 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>  
 </head>  </head>
 $bodytag  $bodytag
  <table width="600" border="0" cellspacing="0" cellpadding="0" height="55">  END
       if ($stayOnPage) {
           $r->print('<table width="700" border="0" cellspacing="0" cellpadding="0" height="55">');
       } else {
           $r->print('<table width="600" border="0" cellspacing="0" cellpadding="0" height="55">');
       }
       $r->print(<<END);
   <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' />&nbsp;&nbsp;<b><font size="+1">LON-CAPA help/support</font></b></legend>
  <table width="100%" border="0" cellpadding="0" cellspacing="0" bgcolor="#000000">   <table width="100%" border="0" cellpadding="0" cellspacing="0" bgcolor="#000000">
   <tr>    <tr>
    <td>     <td>
Line 119  END Line 178  END
     if (($component_url) || ($ENV{'user.adv'})) {      if (($component_url) || ($ENV{'user.adv'})) {
         if ($component_url) {          if ($component_url) {
             $r->print("              $r->print("
             <td align=\"center\">&nbsp;<b><a href=\"$component_url\" target=\"bodyframe\">");              <td align=\"center\"><b><a href=\"$component_url\" target=\"bodyframe\">");
         } elsif ($ENV{'user.adv'}) {          } elsif ($ENV{'user.adv'}) {
             $r->print('<td align="center">&nbsp;<b><a href="javascript:noTopic()" target="bodyframe">');              $r->print('<td align="center">&nbsp;<b><a href="/adm/help/nohelptopic.html" target="bodyframe">');
         }          }
         $r->print('          $r->print('
    <image src="/adm/help/gif/smallHelp.gif" border="0" alt="(Topic help)" valign="middle" />&nbsp;Topic help</a></b>&nbsp;</td>');    <img src="'.$location.'/help/gif/smallHelp.gif" border="0" alt="(Topic help)" valign="middle" />&nbsp;Topic help</a></b>&nbsp;</td>');
     }      }
     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 align="center">&nbsp;<b><a href="javascript:gohelpdesk()"><img src="'.$location.'/lonIcons/helpdesk.gif" border="0" alt="(Ask helpdesk)" valign="middle" />&nbsp;Ask helpdesk</a></b>&nbsp;</td>');
     }      }
     if ($ENV{'user.adv'}) {      if ($faq && $ENV{'user.adv'}) {
         $r->print(<<END)          $r->print(<<END);
             <td align="center">              <td align="center">
              &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;               &nbsp;<b><a href="$faqbaseurl/fom/cache/$faq.html" target="bodyframe"><img src="$location/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>  END
       }
       if ($ENV{'user.adv'}) {
           $r->print(<<END);
               <td align="center">&nbsp;<b><a href="$bugurl" target="bodyframe"><img src="$location/lonMisc/smallBug.gif" border="0" alt="(Report a bug)" valign="middle" />&nbsp;Report a bug</a>&nbsp;</b></td>
   END
       }
       if ($stayOnPage) {
           $r->print(<<END);
               <td align="center">&nbsp;<b><a href="$origurl" target="_top"><img src="$location/lonIcons/move_up.gif" border="0" alt="(Return to last location)" valign="middle" />&nbsp;Return to last location</a></b>&nbsp;</td>
   END
       } else {
           $r->print(<<END);
               <td align="center">&nbsp;<b><a href="javascript:window.close()" target="_top"><img src="$location/lonIcons/closepage.gif" border="0" alt="(Close window)" valign="bottom" />&nbsp;Close</a></b>&nbsp;</td>
 END  END
     }      }
     $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>             </tr>
           </table>            </table>
          </td>           </td>
Line 167  END Line 238  END
 sub display_help_mainpage {  sub display_help_mainpage {
     my ($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail) = @_;      my ($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail) = @_;
     my $bodytag = &Apache::loncommon::bodytag('',$function,'topmargin="0" marginheight="0"',1);      my $bodytag = &Apache::loncommon::bodytag('',$function,'topmargin="0" marginheight="0"',1);
     $bodytag=~/[\n\r]/ /g;      $bodytag=~s/[\n\r]/ /g;
       my %lt =&Apache::lonlocal::texthash(
           'heco' => 'Help Content',
           'topp' => 'Topic Page',
           'chen' => 'Choose an entry below to go directly to a relevant help page',
           'orto' => 'or to submit a help request to the LON-CAPA support staff at your institution.',
           'vthp' => 'Visit the help page for ',
           'disp' => 'Display the page in the inline help system that covers this topic.',
           '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.',
           'inhs' => 'Inline help system for',
           'coth' => 'Consult the inline help system for this topic.',
           'cont' => 'Contact the LON-CAPA support team',
           'suhr' => 'Submit a help request to the team responsible for LON-CAPA support at this institution.',
           'stuq' => 'Questions about course content should not be directed to the support team, but instead should be sent to the course instructor',
           'faqo' => 'FAQ-O-Matic Help system',
           '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',
           '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.',
           'suim' => ' Suggested improvements may include additional functionality, improved usability, or changes to wording used in LON-CAPA pages, including the embedded help system.'
       );
   
     $r->print(<<END);      $r->print(<<END);
 <html>  <html>
  <head>   <head>
   <title>Help Content</title>    <title>$lt{'heco'}</title>
   <script type="text/javascript">  
 function noTopic() {  
     bodyframe.document.write("<html><head><title>Topic Page</title></head>$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>  
  </head>   </head>
 $bodytag  $bodytag
 Choose an entry below to go directly to a relevant help page  
 END  END
     if ($requestmail) {      $r->print($lt{'chen'});
         $r->print(", or to submit a help request to the LON-CAPA support staff at you institution.");      if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
           $r->print(', '.$lt{'orto'});
     } else {      } else {
         $r->print(".");          $r->print(".");
     }      }
Line 194  END Line 277  END
             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'}) {              } elsif ($ENV{'user.adv'}) {
                 $r->print("                  $r->print("
               <ul>                <ul>
                <li><td align=\"center\">&nbsp;<a href=\"javascript:noTopic()\">Inline help system for $topic</a></li></ul>                 <li><td align=\"center\">&nbsp;<a href=\"/adm/help/nohelptopic.html\">$lt{'inhs'} $topic</a></li></ul>
                <p>Consult the inline help system for this topic.</p>");                 <p>$lt{'coth'}</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=".&Apache::lonnet::escape($origurl)."&function=$function\">$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 /><b>'.&mt('Note').'</b>: '.$lt{'stuq'}.'. '.&mt('This can be done using the').' <a href="/adm/communicate" target="_top">'.&mt('COM').'</a> '.&mt('button, or the FDBK button when viewing a content page.'));
            }
            $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(<<END);

Removed from v.1.3  
changed lines
  Added in v.1.18


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
500 Internal Server Error

Internal Server Error

The server encountered an internal error or misconfiguration and was unable to complete your request.

Please contact the server administrator at root@localhost to inform them of the time this error occurred, and the actions you performed just before this error.

More information about this error may be available in the server error log.