From SemanticLab

Contents 1 Introduction 2 bibSearch 2.1 Usage 2.1.1 Configuration File 2.1.2 Examples 3 bibPublish 3.1 Configuration File 3.2 Templates 4 Documentation 5 Sources

Introduction

The BibTexSuite provides tools for efficient handling of BibTeX files. Currently the suite only comprises the bibSearch.py and bibPublish.py tool.

bibSearch

bibSearch.py search BibTeX files for keywords and displays matching results.

Usage

bibSearch.py searches all BibTeX files in the given path for entries containing the given keywords and returns them in one of the following output formats:

• citation
• bibTeX entry
• wikipedia citation

bibSearch.py [-c] [-w] [-b] [-p path] {search terms}

Configuration File

The program saves its configuration under ~/.bibTexSuite/searchconfig.py (if no configuration file is present a skeleton version with default values will be created).

The configuration file contains the following directives:

 DEFAULT_BIB_SEARCH_PATH ... A list of paths to search for bibtex files
 DEFAULT_OUTPUT_FORMAT   ... the default output format (citation|bibtex|wikipedia)

Examples

• Search for all entries containing the terms weichselbraun and ontology and output the results in the default output format.

 bibSearch.py weichselbraun ontology 

• Search for all entries containing the term wohlgenannt in the default path and the paths /media/cdrom and /media/usbstick and output them as bibTeX entries.

 bibSearch.py -b -p /media/cdrom -p /media/usbstick wohlgenannt

• Example configuration file:

 # bibSearch example config file
 #
 # default output format (citation, bibtex, wikipedia)
 DEFAULT_OUTPUT_FORMAT = 'citation'
 #
 # default path to search for *.bib files
 DEFAULT_BIB_SEARCH_PATH = ['/home/albert/data/common/literature', '/home/share']

bibPublish

bibPublish publishes your BibTeX files. (Warning: this tool is still under heavy development)

Features:

• support for custom templates
• adds a downloadable BibTeX file to each entry
• adds an own file with the abstract (if specified)
• attaches the publication (as .pdf) to the entry (if specified)

Configuration File

The program saves its configuration under ~/.bibTexSuite/publishconfig.py (if no configuration file is present a skeleton version with default values will be created).

The configuration file contains the following directives:

DEFAULT_TEMPLATE       ... the default template to use
DEFAULT_TYPE_ORDER     ... the order in which publication types get published
BIB_PUBLISH_FILES      ... a list of BibTeX files to be published
PDF_SEARCH_PATH        ... path to search for pdf's.
BIB_PUBLISH_OUTPUT_DIR ... directory for publishing the Web page containing the bibliography

Templates

bibPublish stores its templates under ~/.bibTexSuite/templates. Each template contains it's own directory (e.g. ~/.bibTexSuite/templates/fides for the default FIDES-style).

The template contains the following files:

 head.html             ... the head of the bibliography Web site
 foot.html             ... the site's foot.
 {bibtype}-head.html   ... the head of the {bibtype} section (e.g. article-head.html)
 {bibtype}-entry.html  ... all entries of that {bibtype}
 {bibtype}-foot.html   ... the foot of the type.

In addition translation files control how BibTeX data is converted:

 str.csv    ... translation tables for single strings (e.g. "--" -> "-")
 attr.csv   ... translation table for attributes (e.g. "editor" -> ", Ed. %s")
 files.csv  ... specifies the design of pdf/abstract/bibtex links

Documentation

• API Documentation

Sources

Checkout bibTexSuite from the subversion repository:

 git clone git://git.semanticlab.net/oss/bibTexSuite

Dependencies

• python2.5 or higher
• python-bibtex