Skip to main content

A package to convert between a latex bib file and a tex file containing glossaries entries

Project description

bib2glossary

Build Status

This package is intended to allow for the storage and management of latex glossary terms in standard reference management packages (such as Zotero), by converting between .bib files and .tex files containing \newglossaryentry or \newacronym definitions.

To date the only other way to achieve this is via bib2gls. However, it implementation is somewhat complex, and the item types it uses are not supported by Zotero.

In bib2glossary, the user may override the default relationships between reference item fields and glossary term parameters, by supplying a JSON file, e.g.:

{
    "abbreviation": "abbrevfield"
}

The defaults are taken from the Dictionary Entry type in Zotero.

For \newacronym:

Parameter Field
misc @type
longname journal*
abbreviation shorttitle
description abstract
plural series
longplural isbn
firstplural address**

For \newglossaryentry:

Parameter Field
misc @type
name journal*
description abstract
plural series
symbol volume
text edition
sort publisher

* This shows as 'Dictionary Title' in Zotero

** This shows as 'Place' in Zotero

[Note: The title field is not used, since it is usely used to generate the key.]

Installation

>> pip install bib2glossary

Usage

Conversion of \newacronym:

>> bib2acronym --help
>> bib2acronym path/to/file.bib --entry-type misc --param2field path/to/file.json

or

>> acronym2bib --help
>> acronym2bib path/to/file.tex --entry-type misc --param2field path/to/file.json

Conversion of \newglossaryentry:

>> bib2glossary --help
>> bib2glossary path/to/file.bib --entry-type misc --param2field path/to/file.json

or

>> glossary2bib --help
>> glossary2bib path/to/file.tex --entry-type misc --param2field path/to/file.json

Implementation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
bib2glossary-0.1.2-py2.py3-none-any.whl (16.2 kB) Copy SHA256 hash SHA256 Wheel py2.py3

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page