# The LearningOnline Network with CAPA # generate frame-based help system # # Copyright Michigan State University Board of Trustees # # This file is part of the LearningOnline Network with CAPA (LON-CAPA). # # LON-CAPA is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # # LON-CAPA is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with LON-CAPA; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # # /home/httpd/html/adm/gpl.txt # # http://www.lon-capa.org/ # package Apache::lonhelpmenu; use strict; use lib qw(/home/httpd/lib/perl); use Apache::Constants qw(:common); use Apache::loncommon(); sub handler { my ($r) = @_; &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; 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 $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; if ($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,$stayOnPage); } elsif ($ENV{'form.page'} eq 'body') { &display_help_mainpage($r,$color,$function,$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,$stayOnPage) = @_; 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'); if (($tablecolor eq '') || ($tablecolor eq '#FFFFFF')) { $tablecolor = '#CCCCFF'; } $r->print(< Help Banner $bodytag END if ($stayOnPage) { $r->print(''); } else { $r->print('
'); } $r->print(<
 
  LON-CAPA help/support
END if (($component_url) || ($ENV{'user.adv'})) { if ($component_url) { $r->print(" '); } if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { $r->print(' '); } if ($faq && $ENV{'user.adv'}) { $r->print(<   FAQ  END } if ($ENV{'user.adv'}) { $r->print(<  Report a bug  END } if ($stayOnPage) { $r->print(<  Return to last location  END } else { $r->print(<  Close  END } $r->print(<
 "); } elsif ($ENV{'user.adv'}) { $r->print(' '); } $r->print(' (Topic help) Topic help  (Ask helpdesk) Ask helpdesk 
 
 
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=~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.', '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(< $lt{'heco'} $bodytag END $r->print($lt{'chen'}); if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) { $r->print(', '.$lt{'orto'}); } else { $r->print("."); } if ($topic) { if ( ($component_url) || ($ENV{'user.adv'}) ) { if ($component_url) { $r->print("

$lt{'disp'}

"); } elsif ($ENV{'user.adv'}) { $r->print("

$lt{'coth'}

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

$lt{'suhr'}

"); } if ($faqbaseurl && $ENV{'user.adv'}) { if (!defined($faq) ||$faq eq '') { $faq = '1'; } $r->print("

$lt{'tfaq'}

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

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

"); } $r->print(< END } 1;