1 ;;; org-bibtex.el --- Org links to BibTeX entries
3 ;; Copyright (C) 2007-2015 Free Software Foundation, Inc.
5 ;; Authors: Bastien Guerry <bzg@gnu.org>
6 ;; Carsten Dominik <carsten dot dominik at gmail dot com>
7 ;; Eric Schulte <schulte dot eric at gmail dot com>
8 ;; Keywords: org, wp, capture
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; This file implements links to database entries in BibTeX files.
28 ;; Instead of defining a special link prefix, it uses the normal file
29 ;; links combined with a custom search mechanism to find entries
30 ;; by reference key. And it constructs a nice description tag for
31 ;; the link that contains the author name, the year and a short title.
33 ;; It also stores detailed information about the entry so that
34 ;; capture templates can access and enter this information easily.
36 ;; The available properties for each entry are listed here:
38 ;; :author :publisher :volume :pages
39 ;; :editor :url :number :journal
40 ;; :title :year :series :address
41 ;; :booktitle :month :annote :abstract
44 ;; Here is an example of a capture template that use some of this
45 ;; information (:author :year :title :journal :pages):
47 ;; (setq org-capture-templates
48 ;; '((?b "* READ %?\n\n%a\n\n%:author (%:year): %:title\n \
49 ;; In %:journal, %:pages.")))
51 ;; Let's say you want to capture this BibTeX entry:
54 ;; author = {Danny Dolev and Andrew C. Yao},
55 ;; title = {On the security of public-key protocols},
56 ;; journal = {IEEE Transaction on Information Theory},
60 ;; pages = {198--208},
64 ;; M-x `org-capture' on this entry will produce this buffer:
66 ;; =====================================================================
67 ;; * READ <== [point here]
69 ;; [[file:file.bib::dolev83][Dolev & Yao 1983: security of public key protocols]]
71 ;; Danny Dolev and Andrew C. Yao (1983): On the security of public-key protocols
72 ;; In IEEE Transaction on Information Theory, 198--208.
73 ;; =====================================================================
75 ;; Additionally, the following functions are now available for storing
76 ;; bibtex entries within Org-mode documents.
78 ;; - Run `org-bibtex' to export the current file to a .bib.
80 ;; - Run `org-bibtex-check' or `org-bibtex-check-all' to check and
81 ;; fill in missing field of either the current, or all headlines
83 ;; - Run `org-bibtex-create' to add a bibtex entry
85 ;; - Use `org-bibtex-read' to read a bibtex entry after `point' or in
86 ;; the active region, then call `org-bibtex-write' in a .org file to
87 ;; insert a heading for the read bibtex entry
89 ;; - All Bibtex information is taken from the document compiled by
90 ;; Andrew Roberts from the Bibtex manual, available at
91 ;; http://www.andy-roberts.net/res/writing/latex/bibentries.pdf
95 ;; The link creation part has been part of Org-mode for a long time.
97 ;; Creating better capture template information was inspired by a request
98 ;; of Austin Frank: http://article.gmane.org/gmane.emacs.orgmode/4112
99 ;; and then implemented by Bastien Guerry.
101 ;; Eric Schulte eventually added the functions for translating between
102 ;; Org-mode headlines and Bibtex entries, and for fleshing out the Bibtex
103 ;; fields of existing Org-mode headlines.
105 ;; Org-mode loads this module by default - if this is not what you want,
106 ;; configure the variable `org-modules'.
114 (require 'org-compat
)
116 (defvar org-bibtex-description nil
) ; dynamically scoped from org.el
117 (defvar org-id-locations
)
119 (declare-function bibtex-beginning-of-entry
"bibtex" ())
120 (declare-function bibtex-generate-autokey
"bibtex" ())
121 (declare-function bibtex-parse-entry
"bibtex" (&optional content
))
122 (declare-function bibtex-url
"bibtex" (&optional pos no-browse
))
123 (declare-function org-babel-trim
"ob" (string &optional regexp
))
127 (defvar org-bibtex-types
129 (:description .
"An article from a journal or magazine")
130 (:required
:author
:title
:journal
:year
)
131 (:optional
:volume
:number
:pages
:month
:note
))
133 (:description .
"A book with an explicit publisher")
134 (:required
(:editor
:author
) :title
:publisher
:year
)
135 (:optional
(:volume
:number
) :series
:address
:edition
:month
:note
))
137 (:description .
"A work that is printed and bound, but without a named publisher or sponsoring institution.")
139 (:optional
:author
:howpublished
:address
:month
:year
:note
))
142 (:required
:author
:title
:booktitle
:year
)
143 (:optional
:editor
:pages
:organization
:publisher
:address
:month
:note
))
145 (:description .
"A part of a book, which may be a chapter (or section or whatever) and/or a range of pages.")
146 (:required
(:author
:editor
) :title
(:chapter
:pages
) :publisher
:year
)
147 (:optional
:crossref
(:volume
:number
) :series
:type
:address
:edition
:month
:note
))
149 (:description .
"A part of a book having its own title.")
150 (:required
:author
:title
:booktitle
:publisher
:year
)
151 (:optional
:crossref
:editor
(:volume
:number
) :series
:type
:chapter
:pages
:address
:edition
:month
:note
))
153 (:description .
"An article in a conference proceedings")
154 (:required
:author
:title
:booktitle
:year
)
155 (:optional
:crossref
:editor
(:volume
:number
) :series
:pages
:address
:month
:organization
:publisher
:note
))
157 (:description .
"Technical documentation.")
159 (:optional
:author
:organization
:address
:edition
:month
:year
:note
))
161 (:description .
"A Master’s thesis.")
162 (:required
:author
:title
:school
:year
)
163 (:optional
:type
:address
:month
:note
))
165 (:description .
"Use this type when nothing else fits.")
167 (:optional
:author
:title
:howpublished
:month
:year
:note
))
169 (:description .
"A PhD thesis.")
170 (:required
:author
:title
:school
:year
)
171 (:optional
:type
:address
:month
:note
))
173 (:description .
"The proceedings of a conference.")
174 (:required
:title
:year
)
175 (:optional
:editor
(:volume
:number
) :series
:address
:month
:organization
:publisher
:note
))
177 (:description .
"A report published by a school or other institution.")
178 (:required
:author
:title
:institution
:year
)
179 (:optional
:type
:address
:month
:note
))
181 (:description .
"A document having an author and title, but not formally published.")
182 (:required
:author
:title
:note
)
183 (:optional
:month
:year
)))
184 "Bibtex entry types with required and optional parameters.")
186 (defvar org-bibtex-fields
187 '((:address .
"Usually the address of the publisher or other type of institution. For major publishing houses, van Leunen recommends omitting the information entirely. For small publishers, on the other hand, you can help the reader by giving the complete address.")
188 (:annote .
"An annotation. It is not used by the standard bibliography styles, but may be used by others that produce an annotated bibliography.")
189 (:author .
"The name(s) of the author(s), in the format described in the LaTeX book. Remember, all names are separated with the and keyword, and not commas.")
190 (:booktitle .
"Title of a book, part of which is being cited. See the LaTeX book for how to type titles. For book entries, use the title field instead.")
191 (:chapter .
"A chapter (or section or whatever) number.")
192 (:crossref .
"The database key of the entry being cross referenced.")
193 (:edition .
"The edition of a book for example, 'Second'. This should be an ordinal, and should have the first letter capitalized, as shown here; the standard styles convert to lower case when necessary.")
194 (:editor .
"Name(s) of editor(s), typed as indicated in the LaTeX book. If there is also an author field, then the editor field gives the editor of the book or collection in which the reference appears.")
195 (:howpublished .
"How something strange has been published. The first word should be capitalized.")
196 (:institution .
"The sponsoring institution of a technical report.")
197 (:journal .
"A journal name.")
198 (:key .
"Used for alphabetizing, cross-referencing, and creating a label when the author information is missing. This field should not be confused with the key that appears in the \\cite command and at the beginning of the database entry.")
199 (:month .
"The month in which the work was published or, for an unpublished work, in which it was written. You should use the standard three-letter abbreviation,")
200 (:note .
"Any additional information that can help the reader. The first word should be capitalized.")
201 (:number .
"Any additional information that can help the reader. The first word should be capitalized.")
202 (:organization .
"The organization that sponsors a conference or that publishes a manual.")
203 (:pages .
"One or more page numbers or range of numbers, such as 42-111 or 7,41,73-97 or 43+ (the ‘+’ in this last example indicates pages following that don’t form simple range). BibTEX requires double dashes for page ranges (--).")
204 (:publisher .
"The publisher’s name.")
205 (:school .
"The name of the school where a thesis was written.")
206 (:series .
"The name of a series or set of books. When citing an entire book, the title field gives its title and an optional series field gives the name of a series or multi-volume set in which the book is published.")
207 (:title .
"The work’s title, typed as explained in the LaTeX book.")
208 (:type .
"The type of a technical report for example, 'Research Note'.")
209 (:volume .
"The volume of a journal or multi-volume book.")
210 (:year .
"The year of publication or, for an unpublished work, the year it was written. Generally it should consist of four numerals, such as 1984, although the standard styles can handle any year whose last four nonpunctuation characters are numerals, such as '(about 1984)'"))
211 "Bibtex fields with descriptions.")
213 (defvar org-bibtex-entries nil
214 "List to hold parsed bibtex entries.")
216 (defcustom org-bibtex-autogen-keys nil
217 "Set to a truth value to use `bibtex-generate-autokey' to generate keys."
222 (defcustom org-bibtex-prefix nil
223 "Optional prefix for all bibtex property names.
224 For example setting to `BIB_' would allow interoperability with fireforg."
231 (defcustom org-bibtex-treat-headline-as-title t
232 "Treat headline text as title if title property is absent.
233 If an entry is missing a title property, use the headline text as
234 the property. If this value is t, `org-bibtex-check' will ignore
235 a missing title field."
240 (defcustom org-bibtex-export-arbitrary-fields nil
241 "When converting to bibtex allow fields not defined in `org-bibtex-fields'.
242 This only has effect if `org-bibtex-prefix' is defined, so as to
243 ensure that other org-properties, such as CATEGORY or LOGGING are
244 not placed in the exported bibtex entry."
249 (defcustom org-bibtex-key-property
"CUSTOM_ID"
250 "Property that holds the bibtex key.
251 By default, this is CUSTOM_ID, which enables easy linking to
252 bibtex headlines from within an org file. This can be set to ID
253 to enable global links, but only with great caution, as global
259 (defcustom org-bibtex-tags nil
260 "List of tag(s) that should be added to new bib entries."
263 :type
'(repeat :tag
"Tag" (string)))
265 (defcustom org-bibtex-tags-are-keywords nil
266 "Convert the value of the keywords field to tags and vice versa.
267 If set to t, comma-separated entries in a bibtex entry's keywords
268 field will be converted to org tags. Note: spaces will be escaped
269 with underscores, and characters that are not permitted in org
270 tags will be removed.
272 If t, local tags in an org entry will be exported as a
273 comma-separated string of keywords when exported to bibtex. Tags
274 defined in `org-bibtex-tags' or `org-bibtex-no-export-tags' will
280 (defcustom org-bibtex-no-export-tags nil
281 "List of tag(s) that should not be converted to keywords.
282 This variable is relevant only if `org-bibtex-tags-are-keywords' is t."
285 :type
'(repeat :tag
"Tag" (string)))
287 (defcustom org-bibtex-type-property-name
"btype"
288 "Property in which to store bibtex entry type (e.g., article)."
294 ;;; Utility functions
295 (defun org-bibtex-get (property)
296 (let ((it (let ((org-special-properties
297 (delete "FILE" (copy-sequence org-special-properties
))))
299 (org-entry-get (point) (upcase property
))
300 (org-entry-get (point) (concat org-bibtex-prefix
301 (upcase property
)))))))
302 (when it
(org-babel-trim it
))))
304 (defun org-bibtex-put (property value
)
305 (let ((prop (upcase (if (keywordp property
)
306 (substring (symbol-name property
) 1)
309 (concat (unless (string= org-bibtex-key-property prop
) org-bibtex-prefix
)
313 (defun org-bibtex-headline ()
314 "Return a bibtex entry of the given headline as a string."
315 (let* ((val (lambda (key lst
) (cdr (assoc key lst
))))
316 (to (lambda (string) (intern (concat ":" string
))))
317 (from (lambda (key) (substring (symbol-name key
) 1)))
318 flatten
; silent compiler warning
319 (flatten (lambda (&rest lsts
)
320 (apply #'append
(mapcar
322 (if (listp e
) (apply flatten e
) (list e
)))
324 (notes (buffer-string))
325 (id (org-bibtex-get org-bibtex-key-property
))
326 (type (org-bibtex-get org-bibtex-type-property-name
))
327 (tags (when org-bibtex-tags-are-keywords
332 (append org-bibtex-tags
333 org-bibtex-no-export-tags
))
335 (org-get-local-tags-at))))))
338 "@%s{%s,\n%s\n}\n" type id
341 (format " %s={%s}" (car pair
) (cdr pair
)))
343 (if (and org-bibtex-export-arbitrary-fields
347 (let ((key (car kv
)) (val0 (cdr kv
)))
349 (string-match org-bibtex-prefix key
)
351 (downcase (concat org-bibtex-prefix
352 org-bibtex-type-property-name
))
354 (cons (downcase (replace-regexp-in-string
355 org-bibtex-prefix
"" key
))
357 (org-entry-properties nil
'standard
))
360 (let ((value (or (org-bibtex-get (funcall from field
))
361 (and (equal :title field
)
362 (nth 4 (org-heading-components))))))
363 (when value
(cons (funcall from field
) value
))))
365 (funcall val
:required
(funcall val
(funcall to type
) org-bibtex-types
))
366 (funcall val
:optional
(funcall val
(funcall to type
) org-bibtex-types
))))))
371 (bibtex-beginning-of-entry)
372 (if (re-search-forward "keywords.*=.*{\\(.*\\)}" nil t
)
373 (progn (goto-char (match-end 1)) (insert ", "))
374 (search-forward ",\n" nil t
)
375 (insert " keywords={},\n")
376 (search-backward "}," nil t
))
377 (insert (mapconcat #'identity tags
", ")))
380 (defun org-bibtex-ask (field)
381 (unless (assoc field org-bibtex-fields
)
382 (error "Field:%s is not known" field
))
383 (save-window-excursion
384 (let* ((name (substring (symbol-name field
) 1))
385 (buf-name (format "*Bibtex Help %s*" name
)))
386 (with-output-to-temp-buffer buf-name
387 (princ (cdr (assoc field org-bibtex-fields
))))
388 (with-current-buffer buf-name
(visual-line-mode 1))
389 (org-fit-window-to-buffer (get-buffer-window buf-name
))
390 (let ((result (read-from-minibuffer (format "%s: " name
))))
391 (when (> (length result
) 0) result
)))))
393 (defun org-bibtex-autokey ()
394 "Generate an autokey for the current headline."
395 (org-bibtex-put org-bibtex-key-property
396 (if org-bibtex-autogen-keys
397 (let* ((entry (org-bibtex-headline))
401 (bibtex-generate-autokey))))
402 ;; test for duplicate IDs if using global ID
404 (equal org-bibtex-key-property
"ID")
406 (hash-table-p org-id-locations
)
407 (gethash key org-id-locations
))
408 (warn "Another entry has the same ID"))
410 (read-from-minibuffer "id: "))))
412 (defun org-bibtex-fleshout (type &optional optional
)
413 "Fleshout current heading, ensuring all required fields are present.
414 With optional argument OPTIONAL, also prompt for optional fields."
415 (let ((val (lambda (key lst
) (cdr (assoc key lst
))))
416 (keyword (lambda (name) (intern (concat ":" (downcase name
)))))
417 (name (lambda (keyword) (substring (symbol-name keyword
) 1))))
418 (dolist (field (append
419 (if org-bibtex-treat-headline-as-title
420 (remove :title
(funcall val
:required
(funcall val type org-bibtex-types
)))
421 (funcall val
:required
(funcall val type org-bibtex-types
)))
422 (when optional
(funcall val
:optional
(funcall val type org-bibtex-types
)))))
423 (when (consp field
) ; or'd pair of fields e.g., (:editor :author)
424 (let ((present (first (remove
427 (lambda (f) (when (org-bibtex-get (funcall name f
)) f
))
429 (setf field
(or present
(funcall keyword
430 (org-icompleting-read
431 "Field: " (mapcar name field
)))))))
432 (let ((name (funcall name field
)))
433 (unless (org-bibtex-get name
)
434 (let ((prop (org-bibtex-ask field
)))
435 (when prop
(org-bibtex-put name prop
)))))))
436 (when (and type
(assoc type org-bibtex-types
)
437 (not (org-bibtex-get org-bibtex-key-property
)))
438 (org-bibtex-autokey)))
441 ;;; Bibtex link functions
442 (org-add-link-type "bibtex" 'org-bibtex-open
)
443 (add-hook 'org-store-link-functions
'org-bibtex-store-link
)
445 (defun org-bibtex-open (path)
446 "Visit the bibliography entry on PATH."
447 (let* ((search (when (string-match "::\\(.+\\)\\'" path
)
448 (match-string 1 path
)))
449 (path (substring path
0 (match-beginning 0))))
450 (org-open-file path t nil search
)))
452 (defun org-bibtex-store-link ()
453 "Store a link to a BibTeX entry."
454 (when (eq major-mode
'bibtex-mode
)
455 (let* ((search (org-create-file-search-in-bibtex))
456 (link (concat "file:" (abbreviate-file-name buffer-file-name
)
458 (entry (mapcar ; repair strings enclosed in "..." or {...}
461 "^\\(?:{\\|\"\\)\\(.*\\)\\(?:}\\|\"\\)$" (cdr c
))
462 (cons (car c
) (match-string 1 (cdr c
))) c
))
464 (bibtex-beginning-of-entry)
465 (bibtex-parse-entry)))))
466 (org-store-link-props
467 :key
(cdr (assoc "=key=" entry
))
468 :author
(or (cdr (assoc "author" entry
)) "[no author]")
469 :editor
(or (cdr (assoc "editor" entry
)) "[no editor]")
470 :title
(or (cdr (assoc "title" entry
)) "[no title]")
471 :booktitle
(or (cdr (assoc "booktitle" entry
)) "[no booktitle]")
472 :journal
(or (cdr (assoc "journal" entry
)) "[no journal]")
473 :publisher
(or (cdr (assoc "publisher" entry
)) "[no publisher]")
474 :pages
(or (cdr (assoc "pages" entry
)) "[no pages]")
475 :url
(or (cdr (assoc "url" entry
)) "[no url]")
476 :year
(or (cdr (assoc "year" entry
)) "[no year]")
477 :month
(or (cdr (assoc "month" entry
)) "[no month]")
478 :address
(or (cdr (assoc "address" entry
)) "[no address]")
479 :volume
(or (cdr (assoc "volume" entry
)) "[no volume]")
480 :number
(or (cdr (assoc "number" entry
)) "[no number]")
481 :annote
(or (cdr (assoc "annote" entry
)) "[no annotation]")
482 :series
(or (cdr (assoc "series" entry
)) "[no series]")
483 :abstract
(or (cdr (assoc "abstract" entry
)) "[no abstract]")
484 :btype
(or (cdr (assoc "=type=" entry
)) "[no type]")
487 :description org-bibtex-description
))))
489 (defun org-create-file-search-in-bibtex ()
490 "Create the search string and description for a BibTeX database entry."
491 ;; Make a good description for this entry, using names, year and the title
492 ;; Put it into the `description' variable which is dynamically scoped.
493 (let ((bibtex-autokey-names 1)
494 (bibtex-autokey-names-stretch 1)
495 (bibtex-autokey-name-case-convert-function 'identity
)
496 (bibtex-autokey-name-separator " & ")
497 (bibtex-autokey-additional-names " et al.")
498 (bibtex-autokey-year-length 4)
499 (bibtex-autokey-name-year-separator " ")
500 (bibtex-autokey-titlewords 3)
501 (bibtex-autokey-titleword-separator " ")
502 (bibtex-autokey-titleword-case-convert-function 'identity
)
503 (bibtex-autokey-titleword-length 'infty
)
504 (bibtex-autokey-year-title-separator ": "))
505 (setq org-bibtex-description
(bibtex-generate-autokey)))
506 ;; Now parse the entry, get the key and return it.
508 (bibtex-beginning-of-entry)
509 (cdr (assoc "=key=" (bibtex-parse-entry)))))
511 (defun org-execute-file-search-in-bibtex (s)
512 "Find the link search string S as a key for a database entry."
513 (when (eq major-mode
'bibtex-mode
)
514 ;; Yes, we want to do the search in this file.
515 ;; We construct a regexp that searches for "@entrytype{" followed by the key
516 (goto-char (point-min))
517 (and (re-search-forward (concat "@[a-zA-Z]+[ \t\n]*{[ \t\n]*"
518 (regexp-quote s
) "[ \t\n]*,") nil t
)
519 (goto-char (match-beginning 0)))
520 (if (and (match-beginning 0) (equal current-prefix-arg
'(16)))
521 ;; Use double prefix to indicate that any web link should be browsed
522 (let ((b (current-buffer)) (p (point)))
523 ;; Restore the window configuration because we just use the web link
524 (set-window-configuration org-window-config-before-follow-link
)
525 (with-current-buffer b
528 (recenter 0)) ; Move entry start to beginning of window
529 ;; return t to indicate that the search is done.
532 ;; Finally add the link search function to the right hook.
533 (add-hook 'org-execute-file-search-functions
'org-execute-file-search-in-bibtex
)
536 ;;; Bibtex <-> Org-mode headline translation functions
537 (defun org-bibtex (&optional filename
)
538 "Export each headline in the current file to a bibtex entry.
539 Headlines are exported using `org-bibtex-headline'."
541 (list (read-file-name
542 "Bibtex file: " nil nil nil
543 (file-name-nondirectory
544 (concat (file-name-sans-extension (buffer-file-name)) ".bib")))))
547 (let ((bibtex-entries
548 (remove nil
(org-map-entries
551 (org-bibtex-headline)
552 (error (throw 'bib
(point)))))))))
553 (with-temp-file filename
554 (insert (mapconcat #'identity bibtex-entries
"\n")))
555 (message "Successfully exported %d BibTeX entries to %s"
556 (length bibtex-entries
) filename
) nil
))))
558 (goto-char error-point
)
559 (message "Bibtex error at %S" (nth 4 (org-heading-components))))))
561 (defun org-bibtex-check (&optional optional
)
562 "Check the current headline for required fields.
563 With prefix argument OPTIONAL also prompt for optional fields."
566 (org-narrow-to-subtree)
567 (let ((type (let ((name (org-bibtex-get org-bibtex-type-property-name
)))
568 (when name
(intern (concat ":" name
))))))
569 (when type
(org-bibtex-fleshout type optional
)))))
571 (defun org-bibtex-check-all (&optional optional
)
572 "Check all headlines in the current file.
573 With prefix argument OPTIONAL also prompt for optional fields."
574 (interactive) (org-map-entries (lambda () (org-bibtex-check optional
))))
576 (defun org-bibtex-create (&optional arg nonew
)
577 "Create a new entry at the given level.
578 With a prefix arg, query for optional fields as well.
579 If nonew is t, add data to the headline of the entry at point."
581 (let* ((type (org-icompleting-read
582 "Type: " (mapcar (lambda (type)
583 (substring (symbol-name (car type
)) 1))
586 (org-bibtex-get org-bibtex-type-property-name
))))
587 (type (if (keywordp type
) type
(intern (concat ":" type
))))
588 (org-bibtex-treat-headline-as-title (if nonew nil t
)))
589 (unless (assoc type org-bibtex-types
)
590 (error "Type:%s is not known" type
))
592 (org-back-to-heading)
594 (let ((title (org-bibtex-ask :title
)))
596 (org-bibtex-put "TITLE" title
)))
597 (org-bibtex-put org-bibtex-type-property-name
598 (substring (symbol-name type
) 1))
599 (org-bibtex-fleshout type arg
)
600 (mapc (lambda (tag) (org-toggle-tag tag
'on
)) org-bibtex-tags
)))
602 (defun org-bibtex-create-in-current-entry (&optional arg
)
603 "Add bibliographical data to the current entry.
604 With a prefix arg, query for optional fields."
606 (org-bibtex-create arg t
))
608 (defun org-bibtex-read ()
609 "Read a bibtex entry and save to `org-bibtex-entries'.
610 This uses `bibtex-parse-entry'."
612 (let ((keyword (lambda (str) (intern (concat ":" (downcase str
)))))
613 (clean-space (lambda (str) (replace-regexp-in-string
614 "[[:space:]\n\r]+" " " str
)))
616 (lambda (str) ; strip enclosing "..." and {...}
617 (dolist (pair '((34 .
34) (123 .
125) (123 .
125)))
618 (when (and (> (length str
) 1)
619 (= (aref str
0) (car pair
))
620 (= (aref str
(1- (length str
))) (cdr pair
)))
621 (setf str
(substring str
1 (1- (length str
)))))) str
)))
624 (cons (let ((field (funcall keyword
(car pair
))))
629 (funcall clean-space
(funcall strip-delim
(cdr pair
)))))
630 (save-excursion (bibtex-beginning-of-entry) (bibtex-parse-entry)))
631 org-bibtex-entries
)))
633 (defun org-bibtex-read-buffer (buffer)
634 "Read all bibtex entries in BUFFER and save to `org-bibtex-entries'.
635 Return the number of saved entries."
636 (interactive "bbuffer: ")
637 (let ((start-length (length org-bibtex-entries
)))
638 (with-current-buffer buffer
640 (goto-char (point-max))
641 (while (not (= (point) (point-min)))
644 (bibtex-beginning-of-entry))))
645 (let ((added (- (length org-bibtex-entries
) start-length
)))
646 (message "parsed %d entries" added
)
649 (defun org-bibtex-read-file (file)
650 "Read FILE with `org-bibtex-read-buffer'."
651 (interactive "ffile: ")
652 (org-bibtex-read-buffer (find-file-noselect file
'nowarn
'rawfile
)))
654 (defun org-bibtex-write ()
655 "Insert a heading built from the first element of `org-bibtex-entries'."
657 (when (= (length org-bibtex-entries
) 0)
658 (error "No entries in `org-bibtex-entries'"))
659 (let* ((entry (pop org-bibtex-entries
))
660 (org-special-properties nil
) ; avoids errors with `org-entry-put'
661 (val (lambda (field) (cdr (assoc field entry
))))
662 (togtag (lambda (tag) (org-toggle-tag tag
'on
))))
664 (insert (funcall val
:title
))
665 (org-bibtex-put "TITLE" (funcall val
:title
))
666 (org-bibtex-put org-bibtex-type-property-name
667 (downcase (funcall val
:type
)))
672 (:key
(org-bibtex-put org-bibtex-key-property
(cdr pair
)))
673 (:keywords
(if org-bibtex-tags-are-keywords
678 (replace-regexp-in-string
679 "[^[:alnum:]_@#%]" ""
680 (replace-regexp-in-string "[ \t]+" "_" kw
))))
681 (split-string (cdr pair
) ", *"))
682 (org-bibtex-put (car pair
) (cdr pair
))))
683 (otherwise (org-bibtex-put (car pair
) (cdr pair
)))))
684 (mapc togtag org-bibtex-tags
)))
686 (defun org-bibtex-yank ()
687 "If kill ring holds a bibtex entry yank it as an Org-mode headline."
690 (with-temp-buffer (yank 1) (setf entry
(org-bibtex-read)))
693 (error "Yanked text does not appear to contain a BibTeX entry"))))
695 (defun org-bibtex-import-from-file (file)
696 "Read bibtex entries from FILE and insert as Org-mode headlines after point."
697 (interactive "ffile: ")
698 (dotimes (_ (org-bibtex-read-file file
))
699 (save-excursion (org-bibtex-write))
700 (re-search-forward org-property-end-re
)
701 (open-line 1) (forward-char 1)))
703 (defun org-bibtex-export-to-kill-ring ()
704 "Export current headline to kill ring as bibtex entry."
706 (let ((result (org-bibtex-headline)))
707 (kill-new result
) result
))
709 (defun org-bibtex-search (string)
710 "Search for bibliographical entries in agenda files.
711 This function relies `org-search-view' to locate results."
712 (interactive "sSearch string: ")
713 (let ((org-agenda-overriding-header "Bib search results:")
714 (org-agenda-search-view-always-boolean t
))
716 (format "%s +{:%s%s:}"
717 string
(or org-bibtex-prefix
"")
718 org-bibtex-type-property-name
))))
720 (provide 'org-bibtex
)
722 ;;; org-bibtex.el ends here