org-passwords.el: Fix `org-passwords-generate-password-with-symbols` to not insert...
[org-mode.git] / contrib / lisp / org-bibtex-extras.el
blob5f050397f85a145d17dd3ac56b72ce61a487b664
1 ;;; org-bibtex-extras --- extras for working with org-bibtex entries
3 ;; Copyright (C) 2008-2014 Free Software Foundation, Inc.
5 ;; Author: Eric Schulte <eric dot schulte at gmx dot com>
6 ;; Keywords: outlines, hypermedia, bibtex, d3
7 ;; Homepage: http://orgmode.org
8 ;; Version: 0.01
10 ;; This file is not yet part of GNU Emacs.
12 ;; This program 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, or (at your option)
15 ;; any later version.
17 ;; This program 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/>.
25 ;;; Commentary:
27 ;; Warning: This should certainly be considered EXPERIMENTAL and still
28 ;; in development, feedback is welcome, but don't expect it
29 ;; to work.
31 ;; This file add some extra functionality to your bibtex entries which
32 ;; are stored as Org-mode headlines using org-bibtex.el. Most
33 ;; features expect that you keep all of your reading notes in a single
34 ;; file, set the `obe-bibtex-file' variable to the path to this file.
36 ;; - d3 view :: d3 is a Javascript library which supports interactive
37 ;; display of graphs. To view your citations as a d3
38 ;; graph, execute the following which will create a .json
39 ;; export of your references file, then grab a copy of
40 ;; d3, edit examples/force/force.js to replace
42 ;; var source`"miserables.json";
44 ;; with
46 ;; var source`"your-references.json";
48 ;; then view examples/force/force.html in your browser.
50 ;; - HTML export :: Customize the `obe-html-link-base' variable so
51 ;; that it points to an html export of your
52 ;; references, then add the following to your html
53 ;; export hook, and citations will be resolved during
54 ;; html export.
56 ;; (add-hook 'org-export-first-hook
57 ;; (lambda ()
58 ;; (when (equal org-export-current-backend 'html)
59 ;; (obe-html-export-citations))))
61 ;;; Code:
62 (require 'org-bibtex)
64 (defcustom obe-bibtex-file nil "File holding bibtex entries.")
66 (defcustom obe-html-link-base nil
67 "Base of citation links.
68 For example, to point to your `obe-bibtex-file' use the following.
70 (setq obe-html-link-base (format \"file:%s\" obe-bibtex-file))
73 (defvar obe-citations nil)
74 (defun obe-citations ()
75 "Return all citations from `obe-bibtex-file'."
76 (or obe-citations
77 (save-window-excursion
78 (find-file (or obe-bibtex-file
79 (error "`obe-bibtex-file' has not been configured")))
80 (goto-char (point-min))
81 (while (re-search-forward " :CUSTOM_ID: \\(.+\\)$" nil t)
82 (push (org-no-properties (match-string 1))
83 obe-citations))
84 obe-citations)))
86 (defun obe-html-export-citations ()
87 "Convert all \\cite{...} citations in the current file into HTML links."
88 (save-excursion
89 (goto-char (point-min))
90 (while (re-search-forward "\\\\cite{\\([^\000}]+\\)}" nil t)
91 (replace-match
92 (save-match-data
93 (mapconcat (lambda (c) (format "[[%s#%s][%s]]" obe-html-link-base c c))
94 (mapcar #'org-babel-trim
95 (split-string (match-string 1) ",")) ", "))))))
97 (defun obe-meta-to-json (meta &optional fields)
98 "Turn a list of META data from citations into a string of json."
99 (let ((counter 1) nodes links)
100 (flet ((id (it) (position it nodes :test #'string= :key #'car))
101 (col (k) (mapcar (lambda (r) (cdr (assoc k r))) meta))
102 (add (lst)
103 (dolist (el lst) (push (cons el counter) nodes))
104 (incf counter)))
105 ;; build the nodes of the graph
106 (add (col :title))
107 (add (remove-if (lambda (author) (string-match "others" author))
108 (remove-duplicates (apply #'append (col :authors))
109 :test #'string=)))
110 (dolist (field fields)
111 (add (remove-duplicates (col field) :test #'string=)))
112 ;; build the links in the graph
113 (dolist (citation meta)
114 (let ((dest (id (cdr (assoc :title citation)))))
115 (dolist (author (mapcar #'id (cdr (assoc :authors citation))))
116 (when author (push (cons author dest) links)))
117 (let ((jid (id (cdr (assoc :journal citation)))))
118 (when jid (push (cons jid dest) links)))
119 (let ((cid (id (cdr (assoc :category citation)))))
120 (when cid (push (cons cid dest) links)))))
121 ;; build the json string
122 (format "{\"nodes\":[%s],\"links\":[%s]}"
123 (mapconcat
124 (lambda (pair)
125 (format "{\"name\":%S,\"group\":%d}"
126 (car pair) (cdr pair)))
127 nodes ",")
128 (mapconcat
129 (lambda (link)
130 (format "{\"source\":%d,\"target\":%d,\"value\":1}"
131 (car link) (cdr link)))
132 (meta-to-links meta nodes) ",")))))
134 (provide 'org-bibtex-extras)
135 ;;; org-bibtex-extras ends here