bibretrieve.el

;;; bibretrieve.el --- Retrieve BibTeX entries from the internet

;; Copyright (C)
;; 2012, 2015 Antonio Sartori
;; 2012, 2013, 2017 Pavel Zorin-Kranich
;; Author: Antonio Sartori
;; Maintainer: Pavel Zorin-Kranich <pzorin@uni-bonn.de>
;; Homepage: https://github.com/pzorin/bibretrieve
;; Keywords: bibtex, bibliography, mathscinet, arxiv, zbmath
;; Package-Requires: ((auctex "11.87") (emacs "24.3"))

;; This file is part of BibRetrieve.

;; BibRetrieve is free software: you can redistribute it and/or
;; modify it under the terms of the GNU General Public License as
;; published by the Free Software Foundation, either version 3 of the
;; License, or (at your option) any later version.

;; BibRetrieve is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
;; General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with BibRetrieve.  If not, see
;; <http://www.gnu.org/licenses/>.

;;; Commentary:
;;
;; Usage: call
;;   M-x bibretrieve
;; Enter (part of) the author's name and/or title.
;; Matching BibTeX entries are fetched using the configured backends
;; and displayed in a selection buffer.
;; The entries can then be appended to the bibliography file
;; or inserted into the current buffer.
;;
;; Configuration:
;; To select which backends to use customize the variable "bibretrieve-backends".
;; To select a backend for a single invocation call the function with
;;   C-u M-x bibretrieve
;;
;; Extension:
;; To create a new backend define a new function
;; "bibretrieve-backend-NAME" that takes as input author and title
;; and returns a buffer that contains bibtex entries.
;; The function should be defined in "bibretrieve-base.el".
;; It is then necessary to advise bibretrieve of the new backend,
;; adding NAME to the list "bibretrieve-installed-backends".
;;
;; The url is retrieved via mm-url.  You may want to customize the
;; variable mm-url-use-external and mm-url-program.
;;
;; Acknowledgments: This program has been inspired by bibsnarf.  The
;; functions that create the urls for most backends are taken from
;; there.  This program uses the library mm-url.  This programs also uses
;; lot of function of RefTeX.  The selection process is entirely based on
;; reftex-sel.  Many functions have also been adapted from there.

;;; Code:

(eval-when-compile (require 'cl))

(eval-and-compile
(defgroup bibretrieve nil
  "BibRetrieve: Retrieve BibTeX entries from the internet."
  :group 'tools)

(defvar bibretrieve-installed-backends '("msn" "mrl" "arxiv" "citebase" "inspire" "zbm" )
  "List of installed backends for BibRetrieve.")

(defcustom bibretrieve-backends '(("mrl" . 10) ("zbm" . 5))
  "Backends customization variable for BibRetrieve.

Backends to use for the search, together with a timeout
for the research on every backend.
Timeout should be an integer number of seconds."
  :type '(alist :key-type string :value-type integer)
  :options bibretrieve-installed-backends
  :group 'bibretrieve)

(define-key-after
  (lookup-key (current-global-map) [menu-bar tools])
  [sep] '(menu-item "--"))
(define-key-after
  (lookup-key (current-global-map) [menu-bar tools])
  [bibretrieve] '("BibRetrieve" . bibretrieve))
)

(autoload 'bibretrieve "bibretrieve-base"
    " Search the web for bibliography entries.  After prompting for
 author and title, searches on the web, using the backends specified by
 the customization variable `bibretrieve-backends'. A selection process
 (using RefTeX Selection) allows to select entries to add to the
 current buffer or to a bibliography file.

 When called with a `C-u' prefix, permits to select the backend and the
 timeout for the search."
 t nil)

(provide 'bibretrieve)

;;; bibretrieve.el ends here