===================
    bibtex2html
===================

bibtex2html is a set of tools that transforms bibtex files
into XML files and then into HTML files.

Sara Sprenkle 2003.01.15


-----------------
BibteXML
-----------------

BibteXML is an XML representation of a bibtex file.

http://bibtexml.sourceforge.net/


-----------------
bibtex2xml
-----------------

bibtex2xml.py is a python script that takes a properly-formatted
bibtex file as input and outputs a bibteXML file.

bibtex2xml.py is based on a script from SourceForge's bibteXML.  
	http://bibtexml.sourceforge.net/
The script has been significantly modified and enhanced from the original.

bibtex2xml imposes some limitations on bibtex files.
There are latex or bibtex-specific semantics that the script cannot handle.

See bibtex2xml.py for specifics about the script's abilities and limitations.


-----------------
XSL files
-----------------

bibtexml2html.xsl is used to transform bibtexml files into an HTML page
that is a list of publications, sorted in alphabetical order by title.

bibtexml2html_year.xsl is the same as bibtexml2html.xsl but sorts publications by 
year and then by title.  (Note that it does not sort by month and year.)


-----------------
What you need
-----------------

1. A python interpreter in your path

2. xt --> a Java implementation of XSL
	Your CLASSPATH must be set correctly.
   I editted the xt script in the xt demo directory to set the CLASSPATH.
   As of 2003-01-15, the xt code is available from http://www.blnz.com/xt/index.html


---------------
To run
---------------

To transform a bibtex file into XML (bibtexml), use

% python bibtex2xml.py <orig.bib> > <output.xml>


To transform the bibtexml to HTML, using the xt transformer, run

% xt <input.xml> <input.xsl> <out.html>


To do the transformation from bibtex to HTML in one command,
using bibtexml2html.xsl, run

% bibtex2html <orig.bib> <output.xml> <output.html>


---------------
Notes
---------------

The bottleneck of the whole transformation process is transforming the
bibtex file into the XML file.  After the bibtex file is transformed into
XML, you should only do transformations from XML into HTML.

The bottleneck of transforming from bibtex to XML is searching for and
replacing abbreviations.
During testing, a file of nearly 500 entries of size about 160 K
with 50 abbreviations, takes about a minute to transform into XML.

As the bibtexml output file says, you may need to manually clean up some
parts of the file because the script does not handle everything that bibtex does.