% $Id: README.txt,v 1.3 2006/05/22 22:30:07 cheon Exp $

Copyright (C) 2006 The University of Texas at El Paso

BibPHP 0.68

This distribution contains a set of PHP scripts that allow one to
browse and search BibTeX (.bib) files. The scripts were written by
Joel Garcia, Leonardo Ruiz, and Yoonsik Cheon.

CONTENTS

README.txt:	this file
bibtex.php:	main script
bibparser.php:	library classes including several bibtex parsers
bibidx.php:	command-line script to generate optional index files
                (.bib-idx) to improve the performance of bibtex.php,
		especially handling huge bibtex files.

INSTALLATION
  
(1) Publishing BibTex files 
    Upload a bibtex file, say mybib.bib, with scripts bibtex.php 
    and bibparser.php to your web directory, and point your browser
    to bibtex.php as follows.

    <URL_TO_YOUR_WEB_DIR>bibtex.php?file=mybib.bib

    E.g.,
    http://www.cs.utep.edu/~cheon/research/bib/bibtex.php?file=cheon.bib

    If the query string (i.e., ?file=) is missing, the default file
    specified in the script will be browsed; refer to bibtex.php. 

(2) Optional feature: Improving performance
    If your bib file contains more than 1000 citations, we recommend
    you to use optional index files. An index file consists of CSV lines
    that contain summary information of bib citations. If an index file
    exists, the bibtex.php script uses it automatically and parses the 
    original bibtex file incrementally on the per-citation basis only 
    if absolutely necessary.

    To generate an index file, use the included command-line script
    bibidx.php as follows. (This script assumes that you have a CGI
    version of PHP interpreter installed on your system.)

    bibidx.php mybib.bib

    Now, publish the generated index file, mybib.bib-idx, with the
    bibtex file (mybib.bib) to your web directory.

KNOWN PROBLEMS

(1) The @string definition is ignored.
(2) Most of embedded LaTeX commands are not translated.

Please any other problems or errors to us at cheon@cs.utep.edu.

COPYRIGHT NOTICE
 
This program 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.
 
This program 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.