"string to format an entry. Just the reference, no numbering at the beginning, etc... see the `org-ref-reftex-format-citation' docstring for the escape codes."
:type 'string
:group 'org-ref)
+
+(defcustom org-ref-open-notes-function
+ (lambda ()
+ (org-show-entry)
+ (show-branches)
+ (show-children)
+ (org-cycle '(64))
+ ;;(org-tree-to-indirect-buffer)
+ (outline-previous-visible-heading 1)
+ (recenter-top-bottom 0))
+ "User-defined way to open a notes entry. This is excecuted after the entry is found, with the cursor at the beginning of the headline. The default setting fully expands the notes, and moves the headline to the top of the buffer")
#+END_SRC
This next variable determines the citation types that are available in org-ref. Links for each one are automatically generated, and completion functions are automatically generated. Users may add to this list in their own init files.
I do not have plans to make a numbered bibliography with numbered citations anytime soon. This will require changing the way the citation links are exported, and keeping track of the numbers.
+*** An org bibliography
+You can export an org-file to an org-file or org-buffer (org-org-epxort-as-org). In this case, it would be useful convert the cite links to links to custom_ids, and the bibliography link to a first-level heading Bibliography with org-bibtex like headings for each entry. This code should enable this. Right now, it does not appear to work for org export though.
+
+First, we get the string for a single entry.
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
+(defun org-ref-get-bibtex-entry-org (key)
+ "returns an org string for the bibliography entry corresponding to key"
+ (let ((org-ref-bibliography-files (org-ref-find-bibliography))
+ (file) (entry) (bibtex-entry) (entry-type) (format))
+
+ (setq file (catch 'result
+ (loop for file in org-ref-bibliography-files do
+ (if (org-ref-key-in-file-p key (file-truename file))
+ (throw 'result file)
+ (message "%s not found in %s" key (file-truename file))))))
+
+ (with-temp-buffer
+ (insert-file-contents file)
+ (bibtex-search-entry key nil 0)
+ (setq entry (bibtex-parse-entry))
+ (format "** %s - %s
+ :PROPERTIES:
+ %s
+ :END:
+" (org-ref-reftex-get-bib-field "author" entry)
+(org-ref-reftex-get-bib-field "title" entry)
+(concat " :CUSTOM_ID: " (org-ref-reftex-get-bib-field "=key=" entry) "\n"
+ (mapconcat (lambda (element) (format " :%s: %s"
+ (upcase (car element))
+ (cdr element)))
+ entry
+ "\n"))))))
+#+END_SRC
+
+Now, we loop over the keys, and combine all the entries into a bibliography.
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
+(defun org-ref-get-org-bibliography ()
+ "Create an org bibliography when there are keys"
+ (let ((keys (org-ref-get-bibtex-keys)))
+ (when keys
+ (concat "* Bibliography
+"
+ (mapconcat (lambda (x) (org-ref-get-bibtex-entry-org x)) keys "\n")
+ "\n"))))
+#+END_SRC
+
+*** An ascii bibliography
+
+This function gets the html for one entry.
+
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
+(defun org-ref-get-bibtex-entry-ascii (key)
+ "returns an ascii string for the bibliography entry corresponding to key"
+
+ (format "[%s] %s" key (org-ref-get-bibtex-entry-citation key)))
+#+END_SRC
+
+Now, we map over the whole list of keys, and the whole bibliography, formatted as an unordered list.
+
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
+(defun org-ref-get-ascii-bibliography ()
+ "Create an html bibliography when there are keys"
+ (let ((keys (org-ref-get-bibtex-keys)))
+ (when keys
+ (concat
+"Bibliography
+=============
+"
+ (mapconcat (lambda (x) (org-ref-get-bibtex-entry-ascii x)) keys "\n")
+ "\n"))))
+#+END_SRC
+
+
*** the links
We use a link for the bibliography so that we can click on it to open the bibliography file. The link may have more than one bibliography file in it, separated by commas. Clicking opens the file under the cursor. The bibliographies should be full filenames with the bib extension. Clicking on this link makes reftex-default-bibliography local and sets it to the list of files in the link. We need this to use reftex's searching capability.
;; formatting code
(lambda (keyword desc format)
(cond
+ ((eq format 'org) (org-ref-get-org-bibliography))
+ ((eq format 'ascii) (org-ref-get-ascii-bibliography))
((eq format 'html) (org-ref-get-html-bibliography))
((eq format 'latex)
;; write out the latex bibliography command
- (format "\\bibliography{%s}" (replace-regexp-in-string "\\.bib" "" keyword))))))
+ (format "\\bibliography{%s}" (replace-regexp-in-string "\\.bib" "" (expand-file-name keyword)))))))
#+END_SRC
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
(lambda (arg) (message "Nothing implemented for clicking here."))
(lambda (keyword desc format)
(cond
+ ((eq format 'org) (org-ref-get-org-bibliography))
((eq format 'html) (org-ref-get-html-bibliography))
((eq format 'latex)
- ;; write out the latex bibliography command
- (format "\\printbibliography" keyword)))))
+ ;; write out the biblatex bibliography command
+ "\\printbibliography"))
+))
#+END_SRC
We also create a bibliographystyle link. There is nothing to do on clicking here, and we create it for consistency. This sets the style for latex export, so use something appropriate there, e.g. unsrt, plain, plainnat, ...
(interactive)
(let* ((object (org-element-context))
(link-string (org-element-property :path object)))
-
+ ;; you may click on the part before the citations. here we make
+ ;; sure to move to the beginning so you get the first citation.
+ (let ((cp (point)))
+ (goto-char (org-element-property :begin object))
+ (search-forward link-string (org-element-property :end object))
+ (goto-char (match-beginning 0))
+ ;; check if we clicked before the path and move as needed.
+ (unless (< cp (point))
+ (goto-char cp)))
+
(if (not (org-element-property :contents-begin object))
;; this means no description in the link
(progn
(defun org-ref-key-in-file-p (key filename)
"determine if the key is in the file"
(interactive "skey: \nsFile: ")
-
- (with-temp-buffer
- (insert-file-contents filename)
- (prog1
- (bibtex-search-entry key nil 0))))
+ (save-current-buffer
+ (let ((bibtex-files (list filename)))
+ (bibtex-search-entry key t))))
#+END_SRC
Finally, we want to know which file the key is in.
(defmacro org-ref-make-format-function (type)
`(defun ,(intern (format "org-ref-format-%s" type)) (keyword desc format)
(cond
+ ((eq format 'org)
+ (mapconcat
+ (lambda (key)
+ (format "[[#%s][%s]]" key key))
+ (org-ref-split-and-strip-string keyword) ","))
+
+ ((eq format 'ascii)
+ (concat "["
+ (mapconcat
+ (lambda (key)
+ (format "%s" key))
+ (org-ref-split-and-strip-string keyword) ",") "]"))
+
((eq format 'html)
(mapconcat
(lambda (key)
;; now look for entry in the notes file
(if org-ref-bibliography-notes
- (find-file org-ref-bibliography-notes)
+ (find-file-other-window org-ref-bibliography-notes)
(error "org-ref-bib-bibliography-notes is not set to anything"))
(goto-char (point-min))
;; put new entry in notes if we don't find it.
- (unless (re-search-forward (format ":Custom_ID: %s$" key) nil 'end)
+ (if (re-search-forward (format ":Custom_ID: %s$" key) nil 'end)
+ (funcall org-ref-open-notes-function)
+ ;; no entry found, so add one
(insert (format "\n** TODO %s - %s" year title))
(insert (format"
:PROPERTIES:
(save-buffer))))
#+END_SRC
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
+(defun org-ref-open-notes-from-reftex ()
+ "Call reftex, and open notes for selected entry."
+ (interactive)
+ (let ((bibtex-key )))
+
+ ;; now look for entry in the notes file
+ (if org-ref-bibliography-notes
+ (find-file-other-window org-ref-bibliography-notes)
+ (error "org-ref-bib-bibliography-notes is not set to anything"))
+
+ (goto-char (point-min))
+
+ (re-search-forward (format
+ ":Custom_ID: %s$"
+ (first (reftex-citation t)) nil 'end))
+ (funcall org-ref-open-notes-function))
+#+END_SRC
+
** open url in browser from bibtex
We bind this to a key here [[*key%20bindings%20for%20utilities][key bindings for utilities]].
(defalias 'orp 'org-ref-open-pdf-at-point)
(defalias 'oru 'org-ref-open-url-at-point)
(defalias 'orn 'org-ref-open-notes-at-point)
+(defalias 'ornr 'org-ref-open-notes-from-reftex)
(defalias 'orib 'org-ref-insert-bibliography-link)
(defalias 'oric 'org-ref-insert-cite-link)
projects / org-ref.git / blobdiff