Truong X. Nghiem

PubList - JabRef export to List of Publications

© 2010-2014 by Truong Nghiem.

Version: 2014-05-20.

Important: Since version 2011-02-11, the BibTeX field “filelinks” is renamed to “pllinks”. Please make change to your BibTeX files accordingly.

Download current version.

For a working example, see my research page.

About

PubList is a custom export for JabRef, which can be used to create HTML code for a list of publications (bibliography list). The generated HTML code does not contain a header nor a body. Its purpose is to be included in other HTML files or in text-to-html source files (e.g. Jemdoc).

Installation

Requirement: this software requires JabRef.

To install this export in JabRef, follow the steps below (you should also consult the help document of JabRef):

  • Extract and copy all files in the PubList distribution to a directory.

  • Open JabRef and select menu Options/Manage Custom Exports

  • In the opened dialog box, click “Add new” to create a new export. Enter “PubList” as the export name and “html” as the file extension. Click “Browse” and select file “publist.layout” in the PubList directory as the main layout file.

  • Click “OK” then “Close” to complete. When you select menu File/Export, PubList should be now in the list of available exports.

Usage

PubList exports a list of bibliography items from JabRef to raw HTML code. The generated HTML file cannot be dislayed directly but needs to be embedded in other HTML files. If your HTML files are generated by a text-to-html tool, such as Jemdoc or org-mode, you can include the HTML publication list file in your source file as raw HTML code. Currently, support for Jemdoc is included in the PubList distribution.

Export a publication list from JabRef

  • Open JabRef then select menu File/Export to export all items in your library. If you want to export selected items instead, highlight them in the main window and select menu File/Export selected entries.

  • In the export dialog, select “PubList” as the file format, specify a file name then click “Save.” A new file should be created containing the HTML code for the publication list.

Embed a PubList file in Jemdoc

All files necessary for embedding PubList files in Jemdoc are located in the sub-directory “Jemdoc” in the PubList distribution. First, copy bibtex.conf to somewhere jemdoc can find (it will be used as a configuration file for jemdoc). Then copy bibtex.css to the CSS folder of your output HTML files.

To produce the list in an HTML file named “bib.html” generated by PubList, create a new jemdoc document (or edit an existing one) and add the command:

 #includeraw{bib.html}

at the place where the list should appear. In the header of the jemdoc file, add the CSS file bibtex.css as following:

 # jemdoc: addcss{bibtex.css}

Jemdoc must be called with the configuration file bibtex.conf, as follows:

 jemdoc.py -c bibtex.conf -o <output folder> <jemdoc file>

Note that file bibtex.css must be in a directory where the output HTML file can find.

Custom CSS

The appearance of the publication list can be customized using the following CSS classes:

  • div.bibtex: the sliding box containing the BibTeX code.

  • biblist: the ordered list of publication items.

  • bibitem: the list item of one publication.

Refer to file bibtex.css for details.

Include links to files

In many cases, links to files need to be included after each publication, for example the PDF file of the paper, a ZIP file containing computer code, etc. These links can be created automatically using a custom field named “pllinks” in the BibTeX code of a publication. The format of this field is the same as that of the field “file” used by JabRef. Refer to JabRef's help document for more information.

Absolute URLs can also be included in this field. The full URLs must be used, for example http://www.google.com instead of just www.google.com. Other types of links, such as FTP or Email, can also be used in the same way.

NOTE: in older versions of PubList, the field “filelinks” was used instead of “pllinks”. It was renamed for consistency (prefix “pl” stands for PubList).

Custom style for a publication item

Each publication item is exported to an HTML list item (li tag). By default, a plain list item style is used (<li>…</li>). However, if a BibTeX item contains a field named “plstyle”, the content of this field will be appended to the “li” tag, allowing customizations by the user. For example, you can define a CSS class named “reditem” to set the font color to red:

  .biblist li.reditem {color:red;}

and include a field “plstyle” in a BibTeX item:

  plstyle = {class="reditem"}

then the exported HTML code of the item will be:

  <li class="reditem">...</li>

Licence

PubList is open-source software. You are free to use it however you like. You may redistribute it. You may modify it to suit your need.

If you redistribute PubList or derive your work from PubList, you are encouraged to give me credit (for example by including my name and a link to my website in your work or on your webpage). You are also encouraged to share any derivative work.

I would appreciate if you notify me of any bugs you might find or fix, of any suggestions you might have, and of any enhancement you might make.

Disclaimer: PUBLIST IS DISTRIBUTED WITHOUT ANY WARRANTY. THE AUTHOR MAKES NO EXPRESS OR IMPLIED WARRANTIES OR CONDITIONS INCLUDING, WITHOUT LIMITATION, THE WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE WITH RESPECT TO THE SOFTWARE. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES CAUSED BY USING THE SOFTWARE.