publication_list

Easily manage publication list.

To install, run nikola plugin -i publication_list

Publication List

A Nikola plugin to easily manage publication list.

This plugin provides a directive publication_list, which reads a BibTeX file and display the references in them on the web page.

The publications are displayed in the following way. All publications are sorted by year in reverse order, i.e., recent publication first. Publications in the same year are grouped together with a year subtitle. Within the same year, publications are sorted by order they appear in the BibTeX file. Finally, each publication is formatted with the designated style.

Options

The publication-list directive accepts multiple options.

  • :bibtex_dir: indicates the directory where the bibtex file of each publication is generated. If empty, no bibtex file will be created for each publication. The default is bibtex.

  • :detail_page_dir: indicates the directory where the details pages of the publications are stored. If empty, no details page will be created. The default is papers.

  • :highlight_author: indicates the author to highlight. Usually this is the owner of the website. This can be a list of names separated by “;” if there are several optional names.

  • :style: indicates the style of the bibliography. All available styles are provided by Pybtex. You can see the list of styles in the Pybtex repository. The default style is unsrt.

Besides the options available above, if a publication entry has specified a "pdf" field with a URL to a pdf file, a "pdf" link will be shown below the publication.

If you need math support, please add the following to your EXTRA_HEAD_DATA option in your conf.py file, then every math equation surrounded by \( and \), e.g., the ones in the abstracts and titles, will be rendered properly.

r'<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"> </script>'

Example

A simple example:

Publications
------------

.. publication_list:: my-publications.bib
   :style: unsrt
   :highlight_author: Nikola Tesla

where my-publications.bib contains:

@article{a2015,
    title = {One Article in 2015},
    author = {Nikola Tesla},
    year = 2015,
    journal = {Great Journal},
    volume = 1,
    pages = {1--10},
    fulltext = {/pdf/a2015.pdf}
}

@book{b2010,
    title = {One Book in 2010},
    author = {Isaac Newton and Nikola Tesla},
    year = 2010,
    isbn = {000-0000000000},
    publisher = {Nikola Tesla Publishing Group},
    fulltext = {http://example.org/b2010.pdf}
}

@inproceedings{p2015,
    title = {One Conference in 2015},
    booktitle = {Nikola Tesla Conference},
    author = {Nikola Tesla},
    year = 2015
}

A live example is available here.

Screenshot

publication-list screenshot

Requirements:

  • pybtex>=0.20 (Python package)

Issues? Questions?

You can report issues with this plugin and request help via GitHub Issues.