("inproceedings" . "%a, %t, %p, in %b, edited by %e, %u (%y)"))
("inproceedings" . "%a, %t, %p, in %b, edited by %e, %u (%y)"))
- "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."
+ "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."
- "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"
+ "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."
:type 'function
:group 'org-ref)
(defcustom org-ref-open-pdf-function
'org-ref-open-pdf-at-point
:type 'function
:group 'org-ref)
(defcustom org-ref-open-pdf-function
'org-ref-open-pdf-at-point
-"User-defined function to open a pdf from a link. The function must get the key at point, and derive a path to the pdf file, then open it. The default function is `org-ref-open-pdf-at-point'."
+"User-defined function to open a pdf from a link. The function must get the key at point, and derive a path to the pdf file, then open it. The default function is `org-ref-open-pdf-at-point'."
:type 'function
:group 'org-ref)
(defcustom org-ref-insert-cite-function
'org-ref-helm-insert-cite-link
:type 'function
:group 'org-ref)
(defcustom org-ref-insert-cite-function
'org-ref-helm-insert-cite-link
- "Function to call to insert citation links. The default is `org-ref-helm-insert-cite-link' which uses `helm-bibtex'. org-ref modifies helm-bibtex a little bit to give org-mode citations, and to reorder default actions. You may use `org-ref-insert-cite-link' if you like the reftex interface."
+ "Function to call to insert citation links. The default is `org-ref-helm-insert-cite-link' which uses `helm-bibtex'. `org-ref' modifies `helm-bibtex' a little bit to give `org-mode' citations, and to reorder default actions. You may use `org-ref-insert-cite-link' if you like the reftex interface."
:type 'function
:group 'org-ref)
(defcustom org-ref-cite-onclick-function
'org-ref-cite-click-helm
:type 'function
:group 'org-ref)
(defcustom org-ref-cite-onclick-function
'org-ref-cite-click-helm
- "Function that runs when you click on a cite link. The function must take no arguments. You may also use `org-ref-cite-onclick-minibuffer-menu' if you do not like helm. If you like `hydra', consider using `org-ref-cite-hydra'."
+ "Function that runs when you click on a cite link. The function must take no arguments. You may also use `org-ref-cite-onclick-minibuffer-menu' if you do not like helm. If you like `hydra', consider using `org-ref-cite-hydra'."
:type 'function
:group 'org-ref)
(defcustom org-ref-show-citation-on-enter t
:type 'function
:group 'org-ref)
(defcustom org-ref-show-citation-on-enter t
- "If non-nil add a hook function to show the citation summary in
- the minibuffer just by putting the cursor in a link"
+ "If non-nil add a hook function to show the citation summary in the minibuffer."
@@ -1509,7+1515,7 @@ falling back to what the user has set in org-ref-default-bibliography
(defun org-ref-citation-at-point ()
(defun org-ref-citation-at-point ()
- "give message of current citation at point"
+ "Give message of current citation at point."
(interactive)
(let* ((cb (current-buffer))
(results (org-ref-get-bibtex-key-and-file))
(interactive)
(let* ((cb (current-buffer))
(results (org-ref-get-bibtex-key-and-file))
@@ -1523,7+1529,7 @@ falling back to what the user has set in org-ref-default-bibliography
(defun org-ref-open-citation-at-point ()
(defun org-ref-open-citation-at-point ()
- "open bibtex file to key at point"
+ "Open bibtex file to key at point."
(interactive)
(let* ((cb (current-buffer))
(results (org-ref-get-bibtex-key-and-file))
(interactive)
(let* ((cb (current-buffer))
(results (org-ref-get-bibtex-key-and-file))
@@ -1535,15+1541,16 @@ falling back to what the user has set in org-ref-default-bibliography
;; *** cite menu
(defvar org-ref-cite-menu-funcs '()
;; *** cite menu
(defvar org-ref-cite-menu-funcs '()
- "Functions to run on cite click menu. Each entry is a list of (key menu-name function).
-The function must take no arguments and work on the key at point. Do not modify this variable, it is set to empty in the menu click function, and functions are conditionally added to it.")
+ "Functions to run on cite click menu.
+Each entry is a list of (key menu-name function).
+The function must take no arguments and work on the key at point. Do not modify this variable, it is set to empty in the menu click function, and functions are conditionally added to it.")
(defvar org-ref-user-cite-menu-funcs
'(("C" "rossref" org-ref-crossref-at-point)
("y" "Copy entry to file" org-ref-copy-entry-at-point-to-file)
- "user-defined functions to run on bibtex key at point.")
+ "User-defined functions to run on bibtex key at point.")
(defun org-ref-copy-entry-as-summary ()
(defun org-ref-copy-entry-as-summary ()
@@ -1556,7+1563,7 @@ The function must take no arguments and work on the key at point. Do not modify
(defun org-ref-copy-entry-at-point-to-file ()
"Copy the bibtex entry for the citation at point to NEW-FILE.
(defun org-ref-copy-entry-at-point-to-file ()
"Copy the bibtex entry for the citation at point to NEW-FILE.
-Prompt for NEW-FILE includes bib files in org-ref-default-bibliography, and bib files in current working directory. You can also specify a new file."
+Prompt for NEW-FILE includes bib files in `org-ref-default-bibliography', and bib files in current working directory. You can also specify a new file."
(interactive)
(let ((new-file (ido-completing-read
"Copy to bibfile: "
(interactive)
(let ((new-file (ido-completing-read
"Copy to bibfile: "
@@ -1597,45+1604,47 @@ Prompt for NEW-FILE includes bib files in org-ref-default-bibliography, and bib
;; **** functions that operate on key at point for click menu
(defun org-ref-wos-at-point ()
;; **** functions that operate on key at point for click menu
(defun org-ref-wos-at-point ()
- "open the doi in wos for bibtex key under point."
+ "Open the doi in wos for bibtex key under point."
(interactive)
(doi-utils-wos (org-ref-get-doi-at-point)))
(defun org-ref-wos-citing-at-point ()
(interactive)
(doi-utils-wos (org-ref-get-doi-at-point)))
(defun org-ref-wos-citing-at-point ()
- "open the doi in wos citing articles for bibtex key under point."
+ "Open the doi in wos citing articles for bibtex key under point."
-Provides a menu of context sensitive actions. If the bibtex entry has a pdf, you get an option to open it. If there is a doi, you get a lot of options."
+ "Action when a cite link is clicked on.
+Provides a menu of context sensitive actions. If the bibtex entry
+has a pdf, you get an option to open it. If there is a doi, you
+get a lot of options. LINK-STRING is used by the link function."
-If KEYWORDS is a list, it is converted to a comma-separated string. The KEYWORDS are added to the beginning of the field. Otherwise KEYWORDS should be a string of comma-separate keywords."
+If KEYWORDS is a list, it is converted to a comma-separated
+string. The KEYWORDS are added to the beginning of the
+field. Otherwise KEYWORDS should be a string of comma-separate
+keywords. Optional argument ARG prefix arg to replace keywords."
(interactive "sKeywords: \nP")
(bibtex-set-field
"keywords"
(interactive "sKeywords: \nP")
(bibtex-set-field
"keywords"
@@ -2958,9+2978,9 @@ Run this with the point in a bibtex entry."
@@ -3225,8+3245,7 @@ Checks for pdf and doi, and add appropriate functions."
(defvar org-ref-helm-user-candidates '()
"List of user-defined candidates to act when clicking on a cite link.
(defvar org-ref-helm-user-candidates '()
"List of user-defined candidates to act when clicking on a cite link.
-This is a list of cons cells '((\"description\" . action)). The action function should not take an argument, and should assume point is on the cite key of interest.
-")
+This is a list of cons cells '((\"description\" . action)). The action function should not take an argument, and should assume point is on the cite key of interest.")
;; example of adding your own function
(add-to-list
;; example of adding your own function
(add-to-list
@@ -3238,8+3257,14 @@ This is a list of cons cells '((\"description\" . action)). The action function
(defun org-ref-cite-click-helm (key)
"Open helm for actions on a cite link.
subtle points.
(defun org-ref-cite-click-helm (key)
"Open helm for actions on a cite link.
subtle points.
-1. get name and candidates before entering helm because we need the org-buffer.
-2. switch back to the org buffer before evaluating the action. most of them need the point and buffer."
+
+1. get name and candidates before entering helm because we need
+the org-buffer.
+
+2. switch back to the org buffer before evaluating the
+action. most of them need the point and buffer.
+
+KEY is returned for the selected item(s) in helm."