[BACK]Return to lonhelp.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface
File:  [LON-CAPA] / loncom / interface / lonhelp.pm
Revision 1.1: download - view: text, annotated - select for diffs
Fri Jul 5 16:12:31 2002 UTC (22 years, 10 months ago) by bowersj2
Branches: MAIN
CVS tags: HEAD
This commit implements the .tex-based online help system in LON-CAPA. It
may be necessary to manually run loncom/build/help_graphics_converter.pl
and doc/help/rebuildLabelHash.pl after a cvs update, and
loncapa_apache.conf may need to be manually copied to /etc. (The
loncapafiles.lpml has been updated.)

After merging this, the URL http://[loncapahost]/adm/help/Foils.hlp
should display a help file.

Also, some *very* out-of-date files have been removed from the /doc
directory.

# The LearningOnline Network with CAPA
# .tex help system web server handler
#
# 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/
#
# .tex file help handler
# YEAR=2002
# 7/4 Jeremy Bowers

package Apache::lonhelp;

use strict;
use Apache::Constants qw(:common :http);
use Apache::File;
use Apache::loncommon;
use tth;
use GDBM_File;

# This sub takes the name of a label in, and converts it to something
# that is a valid anchor name.
sub processLabelName 
{
    my ($name) = @_;
    $name =~ tr/a-zA-Z0-9/_/cs;
    return $name;
}

# Serve out the Tex
sub serveTex
{
    my ($tex, $r) = @_;

$r->print(<<HEADER);
<html>
    <head>
        <title>LON-CAPA Help</title>
    </head>
    <body bgcolor="#FFFFFF">
HEADER

    $r->print($tex);

$r->print(<<FOOTER);
    </body>
</html>
FOOTER
}

# Render takes a tex fragment, transforms it for TtH, and returns the
# HTML equivalent
sub render 
{
    my ($tex) = @_;
    tie (my %fragmentLabels, 'GDBM_File', '/home/httpd/html/adm/help/fragmentLabels.gdbm', 0, 0);

    # This tells TtH what to do with captions, labels, and other
    # things
    $tex = "\\documentclass{article}\n" . $tex;

    # We process these ourselves because TtH can't handle then without
    # LaTeX .aux files
    $tex =~ s|  \\ref\{([^}]*)\}
             |'\\href{' . 
              substr($fragmentLabels{$1}, 0, -4) .
              '#' . processLabelName($1) . 
             '}{graphic}'
             |gxe;

    # Figures leftover without captions
    $tex =~ s|  \\includegraphics(\[[^]]*\])*\{([^}]*)\}
             |  '\\begin{html}<img src="gif/' . $2 . '.gif" border="2"'.
                ' bordercolor="#000000"/>\\end{html}'
             |gxe;

    $tex = tth::tth($tex);

    # For some reason all captions come out as "Figure 0:", so
    # just duck the issue...

    $tex =~ s/Figure 0://g;

    untie %fragmentLabels;

    return $tex;
}

# UNCOMMENT FOR HANDLER ONLY
sub handler
{
     my $r = shift;

     my $filename = substr ($ENV{'REQUEST_URI'} , 
			    rindex($ENV{'REQUEST_URI'}, '/') + 1, -4);
     
     # Security check on the file; the whole filename must consist
     # of nothing but alphanums, ' ,, or ., or the file
     # will be "not found", no matter what.
     
     return 404 if ($filename !~ /\A[-0-9a-zA-z_'',.]+\Z/);

     (my $file = Apache::File->new("/home/httpd/html/adm/help/tex/".$filename.'.tex'))
	 or return 404;
     my $tex = join('', <$file>);
     $tex = render($tex);
     $r->content_type("text/html");
     serveTex($tex, $r);

     return OK;
}

1;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>