Skip to content

README.md

Latest commit

 

History

History
97 lines (62 loc) · 2.86 KB

README.md

File metadata and controls

97 lines (62 loc) · 2.86 KB
Raw

bibtex2html.py

bibtex2html.py converts a bibtex file into an html file or a group of html files. It considers additional fields (e.g., note, code, etc.) in bibtex. It also can show corresponding google scholar citations related with bibtex entries by parsing the google scholar profile. The group mode was inspired by bibtex2html by Dr. Gregoire Malandain.

Dependancies

Dependencies can be satisfied by running pip install -r requirements.txt

Install

  • Use pip:
sudo pip install bibtex2html.py
  • Or download latest codes from github
git clone https://github.com/JianCheng/bibtex2html.py
cd  bibtex2html.py
pip install -r requirements.txt

Examples

To generate an html file

  • Generate paper lists by type and by year using a configuration file. It requires access to google scholar.
cd examples
bibtex2html.py papers.bib papers.html -c papers.ini
  • Do not show paper citations if you cannot access google scholar. Override options in configuration file.
bibtex2html.py papers.bib papers.html -c papers.ini --nc

Or

bibtex2html.py papers.bib papers.html -c papers.ini -i "{'show_citation':'no', 'show_total_citation':False}"
  • Generate paper list by type with a selected first author and selected years.
bibtex2html.py papers.bib papers.html -c papers.ini -i "{'show_paper_style':'type', 'selection_and': {'author_first': ['Jian Cheng'], 'year':[2010,2013] }}"
  • Generate paper lists by venue using a configuration file. It requires access to google scholar.
bibtex2html.py papers.bib papers.html -c papers.ini -i "{'show_paper_style':'venue'}"

To generate a group of html files

  • Use author_group option to specify a group of people, then generate html files for the group.
cd examples
bibtex2html.py papers_group.bib papers -c papers_group.ini

It outputs files in the folder papers.

  • Do not show paper citations if you cannot access google scholar. Override options in configuration file.
bibtex2html.py papers_group.bib papers -c papers_group.ini --nc

Publication metadata

Each generated publication <li> has the publication-item class and machine-readable attributes for client-side grouping and filtering:

  • data-bib-id, data-entry-type, and data-publication-type
  • data-year, data-venue, and data-venue-short
  • data-selected-venue and data-selected-venue-order
  • data-selected-paper and data-selected-paper-order
  • data-highlighted-author-roles

Set selected_paper_ids in the configuration file to an ordered list of exact, case-sensitive BibTeX IDs. Generation fails when an ID is duplicated or is not part of the generated publication set.

These attributes are additive and do not change the existing publication text or links.