--- loncom/interface/lonhelpmenu.pm 2004/07/03 19:33:30 1.3 +++ loncom/interface/lonhelpmenu.pm 2005/02/17 08:29:42 1.19 @@ -30,10 +30,11 @@ use strict; use lib qw(/home/httpd/lib/perl); use Apache::Constants qw(:common); use Apache::loncommon(); +use Apache::lonlocal; sub handler { 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'); $r->send_http_header; @@ -47,6 +48,7 @@ sub handler { my $function = $ENV{'form.function'}; my $component_help = $ENV{'form.component_help'}; my $origurl = $ENV{'form.origurl'}; + my $stayOnPage = $ENV{'form.stayonpage'}; my $component_url = $component_help; if ($component_url) { $component_url = '/adm/help/'.$component_url.'.hlp'; @@ -59,7 +61,7 @@ sub handler { my $faqbaseurl = $Apache::lonnet::perlvar{'FAQHost'}; my $requestmail = $Apache::lonnet::perlvar{'lonSupportEMail'}; 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') { &display_help_mainpage($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail); } @@ -67,17 +69,77 @@ sub handler { } 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); - $bodytag=~/[\n\r]/ /g; + $bodytag=~s/[\n\r]/ /g; my $fontcolor = &Apache::loncommon::designparm($function.'.font'); my $alinkcolor = &Apache::loncommon::designparm($function.'.alink'); my $vlinkcolor = &Apache::loncommon::designparm($function.'.vlink'); my $pagecolor = &Apache::loncommon::designparm($function.'.pgbg'); 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_TWO + } + my $html=&Apache::lonxml::xmlbegin(); $r->print(< +$html Help Banner - +$scripttag $bodytag - +END + if ($stayOnPage) { + $r->print('
'); + } else { + $r->print('
'); + } + $r->print(< @@ -167,25 +239,37 @@ END sub display_help_mainpage { my ($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail) = @_; 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.' + ); + my $html=&Apache::lonxml::xmlbegin(); $r->print(< +$html - Help Content - + $lt{'heco'} $bodytag -Choose an entry below to go directly to a relevant help page END - if ($requestmail) { - $r->print(", or to submit a help request to the LON-CAPA support staff at you institution."); + $r->print($lt{'chen'}); + if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { + $r->print(', '.$lt{'orto'}); } else { $r->print("."); } @@ -194,46 +278,47 @@ END if ($component_url) { $r->print(" -

Display the page in the inline help system that covers this topic.

+

$lt{'disp'}

"); } elsif ($ENV{'user.adv'}) { $r->print("
  -
  LON-CAPA help/support +
  LON-CAPA help/support '); + (Topic help) Topic help '); } - if ($requestmail) { + if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { $r->print(' - '); + '); } - if ($ENV{'user.adv'}) { - $r->print(<print(< -   FAQ  +  (FAQ) FAQ  - +END + } + if ($ENV{'user.adv'}) { + $r->print(< (Report a bug) Report a bug  +END + } + if ($stayOnPage) { + $r->print(< (Return to last location) Return to last location  +END + } else { + $r->print(< (Close window) Close  END } $r->print(< Close 
@@ -119,27 +179,39 @@ END if (($component_url) || ($ENV{'user.adv'})) { if ($component_url) { $r->print(" -  "); + "); } elsif ($ENV{'user.adv'}) { - $r->print(' '); + $r->print(' '); } $r->print(' - (Topic help) Topic help  (Ask helpdesk) Ask helpdesk  (Ask helpdesk) Ask helpdesk  (Report a bug) Report a bug 
 Inline help system for $topic -

Consult the inline help system for this topic.

"); +
  •  $lt{'inhs'} $topic +

    $lt{'coth'}

    "); } } } - if ($requestmail) { + if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { $r->print(" -

    Submit a help request to the team responsible for LON-CAPA support at this institution.

    -
      - "); +

      $lt{'suhr'}"); + unless ($ENV{'user.adv'}) { + $r->print('
      '.&mt('Note').': '.$lt{'stuq'}.'. '.&mt('This can be done using the').' '.&mt('COM').' '.&mt('button, or the FDBK button when viewing a content page.')); + } + $r->print("

      "); } if ($faqbaseurl && $ENV{'user.adv'}) { if (!defined($faq) ||$faq eq '') { $faq = '1'; } $r->print(" -
    • FAQ-O-Matic Help system
    • + -

      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.

      +

      $lt{'tfaq'}

      "); } if ($bugurl && $ENV{'user.adv'}) { $bugurl .= '?'.$bug; $r->print(" -

      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. Suggested improvements may include additional functionality, improved usability, or changes to wording used in LON-CAPA pages, including the embedded help system.

      +

      $lt{'crea'} $lt{'suim'}

      "); } $r->print(<