summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Lundin <mdl@imapmail.org>2011-05-01 17:01:59 -0400
committerEric Schulte <schulte.eric@gmail.com>2011-05-02 11:23:11 -0600
commit1918731fdf22dadaa8c8f6ebeb74c66f0e4690cb (patch)
tree9994c5b455a3ba2d8feb94fd7d36fd032553e3bb
parent3c148beeb7e2ab4031a5bd6d9515df0200dfb7bb (diff)
downloadorg-mode-1918731fdf22dadaa8c8f6ebeb74c66f0e4690cb.tar.gz
Add helper functions to org-bibtex
* lisp/org-bibtex.el: (org-bibtex-search): New function. (org-bibtex-export-to-kill-ring): New function. Export to kill ring. (org-bibtex-create-in-current-entry): New function (org-bibtex-create): Make it easier to add bib fields to an existing headline (org-bibtex-export-arbitrary-fields) (org-bibtex-treat-headline-as-title): Fix typos (org-bibtex-fleshout): Don't upcase optional field; remove ":" from type completion This patch implements several helper functions: exporting to kill ring, searching only for entries with bib fields, and creating bib fields in an existing headline. It makes the UI of org-bibtex-fleshout more consistent.
-rw-r--r--lisp/org-bibtex.el65
1 files changed, 47 insertions, 18 deletions
diff --git a/lisp/org-bibtex.el b/lisp/org-bibtex.el
index ba243fe..3df1f29 100644
--- a/lisp/org-bibtex.el
+++ b/lisp/org-bibtex.el
@@ -226,14 +226,14 @@ For example setting to 'BIB_' would allow interoperability with fireforg."
(defcustom org-bibtex-treat-headline-as-title t
"Treat headline text as title if title property is absent.
If an entry is missing a title property, use the headline text as
-the property. If this value is t, `org-bibtex-check` will ignore
+the property. If this value is t, `org-bibtex-check' will ignore
a missing title field."
:group 'org-bibtex
:type 'boolean)
(defcustom org-bibtex-export-arbitrary-fields nil
"When converting to bibtex allow fields not defined in `org-bibtex-fields'.
-This only has effect if org-bibtex-prefix is defined, so as to
+This only has effect if `org-bibtex-prefix' is defined, so as to
ensure that other org-properties, such as CATEGORY or LOGGING are
not placed in the exported bibtex entry."
:group 'org-bibtex
@@ -303,7 +303,7 @@ This variable is relevant only if `org-bibtex-export-tags-as-keywords` is t."
(type (org-bibtex-get "type"))
(tags (when org-bibtex-tags-are-keywords
(delq nil
- (mapcar
+ (mapcar
(lambda (tag)
(unless (member tag
(append org-bibtex-tags
@@ -318,13 +318,13 @@ This variable is relevant only if `org-bibtex-export-tags-as-keywords` is t."
(remove nil
(if (and org-bibtex-export-arbitrary-fields
org-bibtex-prefix)
- (mapcar
+ (mapcar
(lambda (kv)
(let ((key (car kv)) (val (cdr kv)))
(when (and (string-match org-bibtex-prefix key)
- (not (equalp
+ (not (equalp
(concat org-bibtex-prefix "TYPE") key)))
- (cons (downcase (replace-regexp-in-string
+ (cons (downcase (replace-regexp-in-string
org-bibtex-prefix "" key))
val))))
(org-entry-properties nil 'standard))
@@ -366,7 +366,7 @@ This variable is relevant only if `org-bibtex-export-tags-as-keywords` is t."
(org-bibtex-put org-bibtex-key-property
(if org-bibtex-autogen-keys
(let* ((entry (org-bibtex-headline))
- (key
+ (key
(with-temp-buffer
(insert entry)
(bibtex-generate-autokey))))
@@ -385,7 +385,7 @@ This variable is relevant only if `org-bibtex-export-tags-as-keywords` is t."
With optional argument OPTIONAL, also prompt for optional fields."
(flet ((val (key lst) (cdr (assoc key lst)))
(keyword (name) (intern (concat ":" (downcase name))))
- (name (keyword) (upcase (substring (symbol-name keyword) 1))))
+ (name (keyword) (substring (symbol-name keyword) 1)))
(dolist (field (append
(if org-bibtex-treat-headline-as-title
(remove :title (val :required (val type org-bibtex-types)))
@@ -530,22 +530,36 @@ With prefix argument OPTIONAL also prompt for optional fields."
With prefix argument OPTIONAL also prompt for optional fields."
(interactive) (org-map-entries (lambda () (org-bibtex-check optional))))
-(defun org-bibtex-create (&optional arg)
- "Create a new entry at the given level."
+(defun org-bibtex-create (&optional arg nonew)
+ "Create a new entry at the given level.
+With a prefix arg, query for optional fields as well.
+If nonew is t, add data to the headline of the entry at point."
(interactive "P")
(let* ((type (org-icompleting-read
- "Type: " (mapcar (lambda (type) (symbol-name (car type)))
- org-bibtex-types)))
- (type (if (keywordp type) type (intern type))))
+ "Type: " (mapcar (lambda (type)
+ (substring (symbol-name (car type)) 1))
+ org-bibtex-types)
+ nil nil (when nonew (org-bibtex-get "TYPE"))))
+ (type (if (keywordp type) type (intern (concat ":" type))))
+ (org-bibtex-treat-headline-as-title (if nonew nil t)))
(unless (assoc type org-bibtex-types)
(error "type:%s is not known" type))
- (org-insert-heading)
- (let ((title (org-bibtex-ask :title)))
- (insert title) (org-bibtex-put "TITLE" title))
+ (if nonew
+ (org-back-to-heading)
+ (org-insert-heading)
+ (let ((title (org-bibtex-ask :title)))
+ (insert title)
+ (org-bibtex-put "TITLE" title)))
(org-bibtex-put "TYPE" (substring (symbol-name type) 1))
(org-bibtex-fleshout type arg)
(mapc (lambda (tag) (org-toggle-tag tag t)) org-bibtex-tags)))
+(defun org-bibtex-create-in-current-entry (&optional arg)
+ "Add bibliographical data to the current entry.
+With a prefix arg, query for optional fields."
+ (interactive "P")
+ (org-bibtex-create arg t))
+
(defun org-bibtex-read ()
"Read a bibtex entry and save to `*org-bibtex-entries*'.
This uses `bibtex-parse-entry'."
@@ -588,11 +602,11 @@ This uses `bibtex-parse-entry'."
(:type nil)
(:key (org-bibtex-put org-bibtex-key-property (cdr pair)))
(:keywords (if org-bibtex-tags-are-keywords
- (mapc
+ (mapc
(lambda (kw)
(togtag
(replace-regexp-in-string
- "[^[:alnum:]_@#%]" ""
+ "[^[:alnum:]_@#%]" ""
(replace-regexp-in-string "[ \t]+" "_" kw))))
(split-string (cdr pair) ", *"))
(org-bibtex-put (car pair) (cdr pair))))
@@ -608,6 +622,21 @@ This uses `bibtex-parse-entry'."
(org-bibtex-write)
(error "yanked text does not appear to contain a bibtex entry"))))
+(defun org-bibtex-export-to-kill-ring ()
+ "Export current headline to kill ring as bibtex entry."
+ (interactive)
+ (kill-new (org-bibtex-headline)))
+
+(defun org-bibtex-search (string)
+ "Search for bibliographical entries in agenda files.
+This function relies `org-search-view' to locate results."
+ (interactive "sSearch string: ")
+ (let ((org-agenda-overriding-header "Bib search results:")
+ (org-agenda-search-view-always-boolean t))
+ (org-search-view nil
+ (format "%s +{:%sTYPE:}"
+ string org-bibtex-prefix))))
+
(provide 'org-bibtex)
;; arch-tag: 83987d5a-01b8-41c7-85bc-77700f1285f5