BibHTML quick user guide
========================

BibHTML is a piece of PHP software to generate a list of
publications, ordered per year, from a BibTex file.

This list may be subdivided into categories (articles/books/conference
proceedings), see example.php / conf-bibHTML.inc.


Usage
-----

For a quick test, surf to example.php

To insert your own list, change conf-bibHTML.txt:
- change BIBLIOFILE to be the path to your bib-file
- choose whether to split each year into categories 
  (SPLITBYTYPE=TRUE) or not.

To change the looks:
- update bibHTML/css/bibHTML.css
  see "Tweaking the look" below for a short guideline.



Files
-----

Example/auxiliary files:
 - README		- this file.
 - example.bib		- example bib file
 - example.php		- example php file

Core files (located in the bibHTML subdir):
- biblink.php		 - outputs bibtex of one entry
- conf-bibHTML.php	 - configuration file
- inc-bibHTML.php	 - main bibHTML file
- inc-parseauthors.php	 - Bibliophile BibTex Parser's author parser
- inc-parsebib.php	 - Bibliophile BibTex Parser's BibTex parser
- mapping-tex-html.txt	 - file mapping latex code to HTML entities
- css/bibHTML.css	 - example style sheet for BibHTML
- templates/		 - directory with the per-entry-type templates
- templates/bibHTML.tmpl - core looks of bibHTML

The main bibHTML.tmpl template determines the core looks of bibHTML,
such as linking to CSS file, adding javascript for opening/closing
sections, setting how to the list is composed (in this distribution, as
<ul> or <ol> containing one <li> per item), etc.


Tweaking the look
-----------------
BibHTML generates an HTML structure with classes to facilitate style
management via CSS.
To change the looks of the generated HTML, simply change the style file
(and/or load your website's default style file first).

The classes introduced by bibHTML are outlined below. For each entry,
all the displayed fields (title, authors, year, etc.) are encapsulated
within "<span class=$field>...</span>".

<div bibHTML>

   <div bibyear>
     <h2>2013</h2>

     <h3 biblist-type></h3>		<!-- only if split by type -->
     <ol biblist-entries>
        <li bibentry></li>
     </ol>

     ... IF split by type THEN repeat type structure ...
   </div>

   ... repeat year structure ...

</div>
