Bibolamazi’s configuration section

If you open the Bibolamazi application and open your bibolamazi file (or create a new one), you’ll immediately be prompted to edit its configuration section.


The configuration section should contain instructions of the form:

keyword: <instruction>

The possible keywords are src:, package:, and filter:, and they should appear in this order in the bibolamazifile (sources must precede package imports which must precede filter instructions).

You may also include comments in the configuration section. Any line starting with two percent signs %% will be ignored by bibolamazi:

%% This line is a comment and will be ignored by bibolamazi.

Comments must be on a line of their own.

Specifying sources

Sources are where your original bibtex entries are stored, i.e., the bibtex entries you would like to process. This can be, for instance, a bibtex file which a reference manager such as Mendeley keeps in sync.

Sources are specified with the src: keyword. As an example:

src: mysource.bib

You should specify one or more files from which entries should be read. If more than one file is given for the same src: instruction, only the FIRST file that exists is read. This is useful for example if you often work from two different computers, on which your bibtex source is in different places:

src: /home/philippe/bibtexfiles/mylibrary.bib /Users/philippe/bibtexfiles/mylibrary.bib

You may use separate src: instructions to merge entries from several files:

src: mysource1.bib
src: anothersource.bib

You can also specify alternate locations for each source file:

%% merge entries from source1.bib and src2.bib which reside either in %% /home/philippe or /Users/philippe src: /home/philippe/bibtexfiles/source1.bib /Users/philippe/bibtexfiles/source1.bib src: /home/philippe/bibtexfiles/src2.bib /Users/philippe/bibtexfiles/src2.bib

Instead of a file name, you may also specify a HTTP or FTP URL. If your filename or URL contains spaces, enclose the name in double quotes: "My Bibtex Library.bib". You can also specify a path like ~/bibtexfiles/mylibrary.bib which is interpreted relative to your HOME directory.

Specifying filters

Once all the entries are collected from the various sources, you may now apply filters to them.

A filter is applied using the filter: command:

filter: filtername [options and arguments]

Filters usually accept options and arguments in a shell-like fashion, but this may vary in principle from filter to filter. For example, one may use the arxiv filter to strip away all arXiv preprint information from all published entries, and normalize unpublished entries to refer to the arxiv in a uniform fashion:

filter: arxiv -sMode=strip -sUnpublishedMode=eprint

In the Bibolamazi application, when editing filter options you can click on the “? info” button to get information about that filter.

If you are using the command-line bibolamazi program, a full list of options can be obtained with:

> bibolamazi --help <filtername>

and a list of available filters can be obtained by running:

> bibolamazi --list-filters

Note: Filters are organized into filter packages (see below). A filter is searched in each filter package until a match is found. To force the lookup of a filter in a specific package, you may prefix the package name to the filter, e.g.:

filter: myfilterpackage:myfiltername -sOption1=val1  ...

Example/Template Configuration Section

%% BIBOLAMAZI configuration section.
%% Additional two leading percent signs indicate comments in the configuration.

%% **** SOURCES ****

%% The _first_ accessible file in _each_ source list will be read and filtered.

src:   "<source file 1>" "<alternate source file 1>"
src:   "<source file 2>"

%% Add additional sources here. Alternative files are useful, e.g., if the same
%% file must be accessed with different paths on different machines.

%% **** FILTERS ****

%% Specify filters here. Specify as many filters as you want, each with a `filter:'
%% directive. See also `bibolamazi --list-filters' and `bibolamazi --help <filter>'.

filter: filter_name  <filter options>

%% Example:
filter: arxiv -sMode=strip -sUnpublishedMode=eprint

%% Finally, if your file is in a VCS, sort all entries by citation key so that you don't
%% get huge file differences for each commit each time bibolamazi is run:
filter: orderentries

Available Filters

You can get a full list of available filters if you open the bibolamazi help & reference browser window (from the main application startup window). You can click on the various filters displayed to view their documentation on how to use them.

Filter Packages

Filters are organized into filter packages. All built-in filters are in the package named bibolamazi.filters. If you want to write your own filters, or use someone else’s own filters, then you can install further filter packages.

A filter package is a regular Python package whose modules can be run as filters. These are documented at greater length in the Section Filter Packages. If you develop your own filters, it is recommended to group them in your own filter package (please do not fiddle with the built-in filter package unless you plan to submit your changes to improve bibolamazi).

You can include filter packages from within a bibolamazi file by using the syntax:

package: path/to/filter/pkgname

The path should point to a directory which is a valid python package, i.e., which contains the file. More generally, you can use the syntax:

package: <filter-package-specification>

Where <filter-package-specification> is any valid specification of a filter package as documented in Importing a filter package. For instance, since Bibolamazi 4.2, you may also specify a github repository directly:

package: github:phfaist/mybibolamazifilters

When such a directive is encountered, the package is automatically downloaded in a cached directory, and the filters it contains can directly be used in the bibolamazi file. To specify a specific branch or commit ID, you may use the syntax:

package: github:phfaist/mybibolamazifilters/mybranch

See Filter Packages for further documentation on filter packages, how to import them, how to create your own, etc. There, you’ll also see how it is possible to register filter packages at specific locations in a way which applies to all bibolamazi files, without having to include package: directives (but then it might be harder to share your bibolamazi file with others).