--- loncom/interface/lonhelpmenu.pm 2004/07/03 20:45:23 1.7 +++ loncom/interface/lonhelpmenu.pm 2013/08/08 14:31:54 1.42 @@ -1,6 +1,8 @@ # The LearningOnline Network with CAPA # generate frame-based help system # +# $Id: lonhelpmenu.pm,v 1.42 2013/08/08 14:31:54 raeburn Exp $ +# # Copyright Michigan State University Board of Trustees # # This file is part of the LearningOnline Network with CAPA (LON-CAPA). @@ -30,221 +32,257 @@ use strict; use lib qw(/home/httpd/lib/perl); use Apache::Constants qw(:common); use Apache::loncommon(); +use Apache::lonlocal; +use Apache::lonnet; +use lib '/home/httpd/lib/perl/'; +use LONCAPA; 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','faq','bug','topic','component_help','origurl','stayonpage']); &Apache::loncommon::content_type($r,'text/html'); $r->send_http_header; if ($r->header_only) { return OK; } - my $color = $ENV{'form.color'}; - my $faq = $ENV{'form.faq'}; - my $bug = $ENV{'form.bug'}; - my $topic = $ENV{'form.topic'}; - my $function = $ENV{'form.function'}; - my $component_help = $ENV{'form.component_help'}; - my $origurl = $ENV{'form.origurl'}; + my $faq = $env{'form.faq'}; + my $bug = $env{'form.bug'}; + my $topic = $env{'form.topic'}; + 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'; } my $bugurl = $Apache::lonnet::perlvar{'BugzillaHost'}; - $bugurl .= 'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.$origurl; + $bugurl .= 'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.$origurl; if ($bug) { - $bugurl .= '&component='.$bug; + $bugurl .= '&component='.$bug; } 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); - } elsif ($ENV{'form.page'} eq 'body') { - &display_help_mainpage($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail); + if ($env{'form.page'} eq 'banner') { + &display_help_banner($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage); + } elsif ($env{'form.page'} eq 'body') { + &display_help_mainpage($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail); } return OK; } sub display_help_banner { - my ($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail) = @_; - my $bodytag = &Apache::loncommon::bodytag('',$function,'rightmargin="0" leftmargin="0" marginwidth="0" topmargin="1" marginheight="1"',1); - $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 ($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage) = @_; + my $location=&Apache::loncommon::lonhttpdurl("/adm"); + my $dom = $env{'request.role.domain'}; + my %helpconfig = &Apache::lonnet::get_dom('configuration',['helpsettings'],$dom); + my $scripttag = ''; + if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { + my $displayurl = &escape($origurl); + $scripttag = (<<"SCRIPT_ONE"); + - -$bodytag - - - -
  -
  LON-CAPA help/support - +SCRIPT_TWO + } + + my %body_layout = + ('rightmargin' => "0", + 'leftmargin' => "0", + 'marginwidth' => "0", + 'topmargin' => "1", + 'marginheight' => "1"); + my $start_page = + &Apache::loncommon::start_page('Help',$scripttag, + {'only_body' => 1,}); + $r->print($start_page); + + my $width = ($stayOnPage) ? '95%' : '600'; + $r->print('
'); + + my $general_help = &Apache::loncommon::general_help(); + $r->print(' + - + - +
  - - -
- - - - -
- - -END - if (($component_url) || ($ENV{'user.adv'})) { - if ($component_url) { - $r->print(" - '); - } 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(' - -
 "); - $r->print(' - (Topic help) Topic help  '); - } +
('.&mt('LON-CAPA help/support').')  '.&mt('LON-CAPA help/support').' + + + '); + if ($component_url) { + $r->print("'); } - if ($requestmail) { + if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { $r->print(' - '); + '); } - if ($faq && $ENV{'user.adv'}) { - $r->print(< -   FAQ  - -END + if ($faq && $env{'user.adv'}) { + $r->print(' + '); } - if ($ENV{'user.adv'}) { - $r->print(<  Report a bug  -END + if ($env{'user.adv'}) { + if ($helpconfig{'helpsettings'}{'submitbugs'} eq '1' || + $helpconfig{'helpsettings'}{'submitbugs'} eq '' ) { + $r->print(' + '); + } + } + if ($stayOnPage) { + $r->print(' + '); + } else { + $r->print(' + '); } $r->print(< Close  - - -
-
-
  
 
- - END + $r->print(&Apache::loncommon::end_page()); } 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=~s/[\n\r]/ /g; - $r->print(< - - Help Content - - -$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."); + my ($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail) = @_; + + my %lt =&Apache::lonlocal::texthash( + '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.', + 'cont' => 'Contact the LON-CAPA support team', + 'suhr' => 'Submit a help request to the team responsible for LON-CAPA support at this institution.', + '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 %body_layout = + ('topmargin' => "0", + '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(''.$lt{'chen'}); + if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { + $r->print(', '.$lt{'orto'}); } else { $r->print("."); } + $r->print(''); if ($topic) { - if ( ($component_url) || ($ENV{'user.adv'}) ) { + if ( ($component_url) || ($env{'user.adv'}) ) { 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(" -
    -
 Inline help system for $topic -

Consult the inline help system for this topic.

"); } } } - 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('[_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.', + '','')); + } + $r->print("

    "); } - if ($faqbaseurl && $ENV{'user.adv'}) { + 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'}) { + 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(< - -END + $r->print(&Apache::loncommon::end_page()); } 1;