A set of scripts that use Bib2Bib and Bib2HTML to produce neatly formatted HTML reference lists that are organized based on metadata.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
textManipulationScripts
LICENSE
README.md
cleanup.sed
delete.sed
icon.png
macros.tex
mainPubsGen.sh
subPubsGen.sh

README.md

PubListConverter

A set of scripts that use Bib2Bib and Bibtex2HTML to produce neatly formatted HTML reference lists that are organized based on metadata. This project was created largely to simplify creating academic websites with links to full texts (especially via the ACM Author-Izer), hopefully you will find it helpful too. Examples of the resulting output can be found at my PIxL Lab Publications Page, as well as this sample:

Zachary O. Toups, Nicole K. Crenshaw, Rina R. Wehbe, Gustavo F. Tondello, and Lennart E. Nacke. 2016. “The Collecting Itself Feels Good”: Towards Collection Interfaces for Digital Game Objects. In Proceedings of the 2016 Annual Symposium on Computer-Human Interaction in Play (CHI PLAY ’16). 276–290. [ bib | doi | full text via authorizer ]

Capabilities:

Starting with a BibTeX file of publications, the user can create a bibliography HTML page with links to:

  1. DOI
  2. ACM Digital Library Authorizer link
  3. local full text
  4. local poster file
  5. raw BibTeX

The scripts can produce a list of references, according to a format you specify. Each reference ends with a set of access links, e.g.:

[ bib | doi | full text via authorizer ]

Publications can also be categorized, facilitating, for example, having a single page (which is necessary for ACM Author-Izer) that includes a full publication list, then linkable sub lists based on project or topic.

Requirements:

These bash scripts are intended to be run at the Unix command line. The following need to be installed:

  1. bib2bib
  2. bibtex2html

Using the Scripts

Necessary Environment

There are a few prerequisites to make use of the scripts.

  1. The setup assumes you will have one or more bibliography web pages and that these can link to a single, separate page that will serve to provide raw BibTeX data. The BibTeX data page contents will be generated automatically, but the URL where they will reside is needed in advance to set up the links correctly.
  2. You will need a .BST file to drive the creation of the references page. Most academic fields already have one that is in wide use (I use the ACM SIGCHI .BST file, available from the SIGCHI Conference Publications Format page).

Optional Modifications to Source BibTeX

By default, the scripts can generate references with links to a separate BibTeX page (described above). In addition, you can provide access links and projects (or categories).

Access Links

The scripts recognize and automatically include several types of access links. These will appear after each reference in square brackets, separated by pipes. You could modify the scripts to change this behavior, if desired. The [ bib ] link will appear automatically, linking to the appropriate location in the separate BibTeX page. In addition, if provided as BibTeX fields, the following will automatically be generated as links:

  1. Doi will produce a link that says [ doi ] and should include the document's object identifier; a link via doi.org will be generated.
  2. Local-Full-Text will produce a link that says [ full text ] and should be a complete URL pointing to where the full text of the paper is located.
  3. Local-Poster will produce a link that says [ poster ] and should be a complete URL pointing to where the appropriate poster is located.
  4. Authorizer will produce a link that says [ full text via authorizer ] and should be the ACM-provided Authorizer link for the paper. Note that the page that contains the link must have been configured via the ACM Author-Izer Service in advance, or the link will break.

Automatic Sub Project Sections

The scripts can also produce separate lists of sub projects, based on the contents of the BibTeX file. By default, these are appended to the main output HTML file after the complete list (facilitating having a single page that links to the ACM Author-Izer, but that has project-specific sections). In addition, sub project HTML files are produced (which I only use as an intermediate step, but the scripts do not delete them, in case someone else finds them useful).

To make use of this functionality, you need to provide a space-separated list of project identifiers in each entry of your BibTeX file with the field Projects. Each paper may belong to multiple projects. The project identifiers are used to set anchors in the HTML to the appropriate section and name the sub project files. They need not be human readable (and cannot contain spaces), human-readable names come later (see below).

Running the Converter Scripts

In addition to all of the above, you can filter the BibTeX file using bib2bib's condition filter functionality. The filter should be included in quotes as one of the command line options (empty quotes are necessary to use the whole file, unfiltered). See the bib2bib documentation (sections 3.1 and 3.2) for details: (https://www.lri.fr/~filliatr/bibtex2html/doc/manual.html).

To run the scripts, after making the modifications above, simply (ha ha) run:

./mainPubsGen.sh <source BibTeX file> <BST file> <URL that will hold the BibTeX page, in quotes, _with all forward slashes escaped_> <a bib2bib condition filter in quotes (empty quotes to use the whole file)> (0 or more pairs of project identifiers and human-readable project identifiers in quotes)

If everything works correctly, you should get the following files:

  1. mainPubs.html - the main publications list with all publications and then sub lists of all sub projects (with headers that include anchors). Normally, the contents of this file can be copied and pasted into a website (note that this file only contains the HTML contents, no <head> or <body> tags, which makes it suitable for dropping into WordPress or similar sites).
  2. mainPubs_bib.html - a page that contains the BibTeX for each entry on the page above, with headers that include anchors based on cite key. This page should be copied to the URL specified as the separate BibTeX data page.
  3. A series of sub-project HTML pages, each named <project identifier>SubPubs.html. These are contatenated at the end of mainPubs.html, but could be used on their own. Note that Author-Izer links will only work if the page was previously authorized!

For example, the following run produces the page at https://pixl.nmsu.edu/publications and https://pixl.nmsu.edu/pixl-pubs-bibtex.

./mainPubsGen.sh ../web/pixlPubs-raw.bib ../web/SIGCHI-Reference-Format.bst "https:\/\/pixl.nmsu.edu\/pixl-pubs-bibtex\/" "" TeC "Team Coordination Game" photoNav "PhotoNav" DGO "Digital Game Objects" gameCoord "Coordination in Games"

The following produces the publications by me (author Toups):

./mainPubsGen.sh ../web/pixlPubs-raw.bib ../web/SIGCHI-Reference-Format.bst "https:\/\/pixl.nmsu.edu\/pixl-pubs-bibtex\/" "'Author : \"Toups\"'"