--- loncom/interface/lonhelp.pm 2006/03/16 17:18:34 1.22 +++ loncom/interface/lonhelp.pm 2013/12/18 01:23:21 1.42 @@ -1,4 +1,7 @@ # The LearningOnline Network with CAPA +# +# $Id: lonhelp.pm,v 1.42 2013/12/18 01:23:21 raeburn Exp $ +# # .tex help system web server handler # # Copyright Michigan State University Board of Trustees @@ -24,8 +27,7 @@ # http://www.lon-capa.org/ # # .tex file help handler -# YEAR=2002 -# 7/4 Jeremy Bowers + package Apache::lonhelp; @@ -40,6 +42,9 @@ use Apache::lonlocal; use Apache::lonnet; use tth(); use GDBM_File(); +use lib '/home/httpd/lib/perl/'; +use LONCAPA; + # This sub takes the name of a label in, and converts it to something # that is a valid anchor name. @@ -52,48 +57,68 @@ sub processLabelName { # Serve out the text sub servetext { - my ($r,$text) = @_; - my $html=&Apache::lonxml::xmlbegin(); - my $htmlend=&Apache::lonxml::xmlend(); - my $bugs=&Apache::loncommon::help_open_bug('Documentation'); - my $header=&mt('LON-CAPA Help'); + my ($r,$uri,$text,$is_mobile,$firstfile) = @_; + my $bugs; + my %helpconfig = &Apache::lonnet::get_dom('configuration',['helpsettings'], + $env{'request.role.domain'}); + if (ref($helpconfig{'helpsettings'}) eq 'HASH') { + if ($helpconfig{'helpsettings'}{'submitbugs'} eq '1') { + $bugs = &Apache::loncommon::help_open_bug('Documentation',&mt('Report a documentation bug')); + } + } + my %lt = &Apache::lonlocal::texthash( + header => 'LON-CAPA Help', + search => 'Search LON-CAPA help', + query => 'Search', + ); $r->print(< - LON-CAPA Help - - -

$header
$bugs

+

help logo$lt{'header'}

HEADER - - $r->print($text); + if ($is_mobile) { + my $width = 500; + my $height = 400; + my $machine = &Apache::lonnet::absolute_url(); + $r->print(&Apache::loncommon::nicescroll_javascript('helpwrapper', + {cursorcolor => '#00F', + railalign => 'right', + railoffset => '{top:5,left:40}'}, + undef,1,$machine.$firstfile)); + $r->print('
'. + $text. + '
'); + } else { + $r->print($text); + } if (&Apache::lonnavmaps::advancedUser()) { - my $search=&mt('Search LON-CAPA help'); - my $about=&mt('About LON-CAPA help and More Help'); - $r->print(< -
-$search:
-$about - -$htmlend + $r->print(<
+ +
$lt{'search'} + + +
+ +
+
+
+
+$bugs FOOTER - } else { - $r->print(<print(< - -$htmlend ENDBODY - } + } # Render takes a tex fragment, transforms it for TtH, and returns the # HTML equivalent sub render { - my ($tex, $docroot, $serverroot) = @_; + my ($tex, $docroot) = @_; tie (my %fragmentLabels, 'GDBM_File', $docroot . '/adm/help/fragmentLabels.gdbm', 0, 0); # This tells TtH what to do with captions, labels, and other @@ -105,13 +130,27 @@ sub render { # absolute paths for use with help.loncapa.org $tex =~ s| \\ref\{([^}]*)\} | - if (not(exists($fragmentLabels{$1}))) { - &Apache::lonnet::logthis("ERROR: $1 not a valid help label"); - }; - '\\begin{html}' . + my $label=$1; + my $icon='/adm/help/help.png'; + my $ext; + if ($1!~/\.hlp$/) { + if (($1 =~ /^\w+\.manual\.pdf$/) && (-e $docroot.'/adm/help/'.$1)) { + $icon = '/adm/lonIcons/pdf.gif'; + } elsif ((!exists($fragmentLabels{$1})) && ($1!~/\.hlp$/)) { + &Apache::lonnet::logthis("ERROR: $1 not a valid help label"); + $label='Error'; + } else { + $label=substr($fragmentLabels{$1}, 0, -4); + $ext = '.hlp#' . &processLabelName($1); + } + } else { + $label=~s/\.hlp$//; + $ext = '.hlp#' . &processLabelName($1); + } + '\\begin{html}' . '\\end{html}' |gxe; @@ -120,7 +159,7 @@ sub render { # Figures leftover without captions $tex =~ s| \\includegraphics(\[[^]]*\])*\{([^}]*)\} - | '\\begin{html}\\end{html}' |gxe; @@ -137,19 +176,20 @@ sub render { # just duck the issue... $tex =~ s/Figure 0://g; - $tex.=$Apache::lontexconvert::errorstring; + $tex.=$Apache::lontexconvert::errorstring; untie %fragmentLabels; return $tex; } sub listmatches { - my ($docroot,$term) =@_; + my ($docroot,$term,$subdir) =@_; + unless ($subdir) { $subdir=''; } my $output=''; - opendir(DIR,$docroot.'/adm/help/tex/'); + opendir(DIR,$docroot.'/adm/help/tex/'.$subdir); foreach my $filename (sort readdir(DIR)) { if ($filename=~/\.tex$/) { - open(FH,$docroot.'/adm/help/tex/'.$filename); + open(FH,$docroot.'/adm/help/tex/'.$subdir.$filename); my $quote=''; while (my $line=) { if ($line=~/\Q$term\E/i) { @@ -157,7 +197,9 @@ sub listmatches { $line=~s/\{//gs; $line=~s/\}//gs; $line=~s/\\/ /gs; - $line=~s/\Q$term\E/\$term\<\/b\>/gsi; + $line=~s/\/\>\;/gs; + $line=~s/(\Q$term\E)/\$1\<\/b\>/gsi; $quote.='
...'.$line.'...'; } } @@ -167,28 +209,49 @@ sub listmatches { $title=~s/\_/ /gs; $title=~s/\.tex$//; $filename=~s/\.tex$/\.hlp/; - $output.='
  • '.$title.''.$quote.'
    • '; + $output.='
  • '.$title.''.$quote.'
    • '; } } } closedir(DIR); - return ($output?'
      '.$output.'
    ':&mt('"[_1]" not found',$term)); + return (($output?'
      '.$output.'
    ':&mt('"[_1]" not found',$term)),$output); } sub handler { my $r = shift; my $docroot = $r->dir_config('lonDocRoot'); - my $serverroot = $ENV{'HTTP_HOST'}; &Apache::lonlocal::get_language_handle($r); + &Apache::loncommon::content_type($r,"text/html"); + my $caller; + if ($env{'form.searchterm'}=~/\w/) { + $caller = 'search'; + } + my $starthash = { + only_body => 1, + add_entries => { + 'onload' => "javascript:expand_div('$caller');", + }, + }; + + my $firstfile; + my $start_page= + &Apache::loncommon::start_page('LON-CAPA Help',undef,$starthash); my $text=''; + my $uri = $r->uri; if ($env{'form.searchterm'}=~/\w/) { - &Apache::loncommon::content_type($r,"text/html"); - $text=&listmatches($docroot,$env{'form.searchterm'}); + ($text,my $matches)=&listmatches($docroot,$env{'form.searchterm'},&Apache::lonlocal::current_language().'/'); + if ($matches) { + my ($englishresult,$englishmatches)=&listmatches($docroot,$env{'form.searchterm'}); + if ($englishmatches) { + $text.='
    '.$englishresult; + } + } else { + $text=&listmatches($docroot,$env{'form.searchterm'}); + } } else { - my $filenames = &Apache::lonnet::unescape(substr ($ENV{'REQUEST_URI'} , - rindex($ENV{'REQUEST_URI'}, '/') + 1, -4)); + my $filenames = &unescape(substr($uri,rindex($uri,'/')+1,-4)); # Security check on the file; the whole filename must consist # of nothing but alphanums, ' ,, or ., or the file @@ -204,7 +267,8 @@ sub handler { # so replace : with , $filenames =~ s/:/,/g; my @files = split(/,/, $filenames); - + $firstfile = '/adm/help/'.$files[0].'.hlp'; + for my $filename (@files) { if (-e $docroot.'/adm/help/tex/'. &Apache::lonlocal::current_language().'/'. @@ -216,29 +280,15 @@ sub handler { or return HTTP_NOT_FOUND; $tex .= join('', <$file>); } - - if ($env{'browser.mathml'}) { - &Apache::loncommon::content_type($r,'text/xml'); - &tth::ttminit(); - if ($env{'browser.unicode'}) { - &tth::ttmoptions('-L -u1'); - } else { - &tth::ttmoptions('-L -u0'); - } - } else { - &Apache::loncommon::content_type($r,"text/html"); - &tth::tthinit(); - if ($env{'browser.unicode'}) { - &tth::tthoptions('-L -u1'); - } else { - &tth::tthoptions('-L -u0'); - } - } - $text = &render($tex, $docroot, $serverroot); + + $text = &render($tex, $docroot); } $r->send_http_header; - &servetext($r,$text); + $r->print($start_page); + &servetext($r,$uri,$text,$env{'browser.mobile'},$firstfile); + $r->print(&Apache::loncommon::end_page()); + return OK; }