README.rst 1.71 KB
Newer Older
1
=======================================
User expired's avatar
User expired committed
2
3
4
Command line tools for bibtex citations
=======================================

5
:Author: Bjoern Bastian <bjoern.bastian@uibk.ac.at>
6
:Date: 2019-11-26
7
8
9

This projects contains several shell scripts for the following tasks.

User expired's avatar
User expired committed
10
11
12
13
14
15
16
17
-   Generate file names and citation keys
-   Format bibtex files
-   Abbreviate journal names
-   Insert links to pdf files for JabRef
-   Manage multi record bibtex files
-   Extract single records
-   Output text citations for copy and paste

18
19
.. contents::

20
The html version of this file is created with ``python-docutils``::
User expired's avatar
User expired committed
21

22
    make README.html
User expired's avatar
User expired committed
23
24

Usage
25
=====
26
27
See online documentation in `bibtools.pdf`_ or build ``doc/bibtools.pdf``
yourself with ``make doc``.
User expired's avatar
User expired committed
28

29
30
Setup on Linux
==============
31
- GNU AWK is required.  For Ubuntu you may install the ``gawk`` package::
32
33

    sudo apt-get install gawk
User expired's avatar
User expired committed
34

35
- Install scripts to ``$HOME/bin``::
User expired's avatar
User expired committed
36
37
38

    make install

39
- Run all or selected tests::
40
41
42
43

    make test # all tests
    ./test/test_runner pattern...

44
  with one or more filter patterns containing the wildcard ``*``.  Otherwise,
45
  usual regular expressions are supported, for example ``testJournal[UD]*``.
46

47
- To uninstall, remove scripts from ``$HOME/bin``::
User expired's avatar
User expired committed
48
49

    make uninstall
50

51
52
53
54
55
56
57
58
59
Notes on the BibTeX format
==========================
- BibTeX entries are formatted in a unique way with sorted tags (field names)
  and contents enclosed in curly braces.
- Tags must start with a letter from the English alphabet and otherwise may
  only contain the additional characters ``-`` and ``_``.
- New BibTeX files may enclose contents in quotation marks, but string
  concatenation with ``#`` is not supported.

60
.. _bibtools.pdf: https://bbastian.pavo.uberspace.de/files/bibtools/bibtools.pdf