]> git.donarmstrong.com Git - org-ref.git/blobdiff - org-ref.org
remove interactive from functions that do not need it
[org-ref.git] / org-ref.org
index 5df116f501d0e6b1bfdddd379fed40fd76cf0b3d..e0c321698a9e8fef054d6a5ea4ad07f2fa88d2ec 100644 (file)
@@ -1631,7 +1631,6 @@ The first thing we need is to get the bibtex key we clicked on.
 point to get a comma, or the end of the link, and then backwards
 to get a comma, or the beginning of the link. that delimits the
 keyword we clicked on. We also strip the text properties."
 point to get a comma, or the end of the link, and then backwards
 to get a comma, or the beginning of the link. that delimits the
 keyword we clicked on. We also strip the text properties."
-  (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
   (let* ((object (org-element-context))
         (link-string (org-element-property :path object)))
     ;; you may click on the part before the citations. here we make
@@ -1685,7 +1684,6 @@ internal bibliographies
 
 falling back to what the user has set in org-ref-default-bibliography
 "
 
 falling back to what the user has set in org-ref-default-bibliography
 "
-  (interactive)
   (catch 'result
     (save-excursion
       (goto-char (point-min))
   (catch 'result
     (save-excursion
       (goto-char (point-min))
@@ -1745,7 +1743,6 @@ Finally, we want to know which file the key is in.
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
 (defun org-ref-get-bibtex-key-and-file (&optional key)
   "returns the bibtex key and file that it is in. If no key is provided, get one under point"
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
 (defun org-ref-get-bibtex-key-and-file (&optional key)
   "returns the bibtex key and file that it is in. If no key is provided, get one under point"
- (interactive)
  (let ((org-ref-bibliography-files (org-ref-find-bibliography))
        (file))
    (unless key
  (let ((org-ref-bibliography-files (org-ref-find-bibliography))
        (file))
    (unless key
@@ -1891,7 +1888,6 @@ Prompt for NEW-FILE includes bib files in org-ref-default-bibliography, and bib
 
 (defun org-ref-get-doi-at-point ()
   "Get doi for key at point."
 
 (defun org-ref-get-doi-at-point ()
   "Get doi for key at point."
-  (interactive)
   (let* ((results (org-ref-get-bibtex-key-and-file))
         (key (car results))
         (bibfile (cdr results))
   (let* ((results (org-ref-get-bibtex-key-and-file))
         (key (car results))
         (bibfile (cdr results))
@@ -2155,19 +2151,16 @@ We will want to generate formatting functions for each citation type. The reason
 We create the links by mapping the function onto the list of defined link types.
 
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
 We create the links by mapping the function onto the list of defined link types.
 
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
-;;;###autoload
 (defun org-ref-format-citation-description (desc)
   "Return formatted citation description.  If the cite link has a
 description, it is optional text for the citation command. You
 can specify pre and post text by separating these with ::, for
 example [[cite:key][pre text::post text]]."
 (defun org-ref-format-citation-description (desc)
   "Return formatted citation description.  If the cite link has a
 description, it is optional text for the citation command. You
 can specify pre and post text by separating these with ::, for
 example [[cite:key][pre text::post text]]."
-  (interactive)
   (cond
    ((string-match "::" desc)
     (format "[%s][%s]" (car (setq results (split-string desc "::"))) (cadr results)))
    (t (format "[%s]" desc))))
 
   (cond
    ((string-match "::" desc)
     (format "[%s][%s]" (car (setq results (split-string desc "::"))) (cadr results)))
    (t (format "[%s]" desc))))
 
-;;;###autoload
 (defun org-ref-define-citation-link (type &optional key)
   "Add a citation link of TYPE for org-ref.
 With optional KEY, set the reftex binding. For example:
 (defun org-ref-define-citation-link (type &optional key)
   "Add a citation link of TYPE for org-ref.
 With optional KEY, set the reftex binding. For example:
@@ -2207,7 +2200,6 @@ and the completion function."
 We need a convenient method to insert links. In reftex you use the keystroke C-c ], which gives you a minibuffer to search the bibtex files from. This function is bound to that same keystroke here [[*org-mode%20/%20reftex%20setup][org-mode / reftex setup]]. This function will append to a cite link if you call it while on a link.
 
 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
 We need a convenient method to insert links. In reftex you use the keystroke C-c ], which gives you a minibuffer to search the bibtex files from. This function is bound to that same keystroke here [[*org-mode%20/%20reftex%20setup][org-mode / reftex setup]]. This function will append to a cite link if you call it while on a link.
 
 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
-;;;###autoload
 (defun org-ref-insert-cite-link (alternative-cite)
   "Insert a default citation link using reftex. If you are on a link, it
 appends to the end of the link, otherwise, a new link is
 (defun org-ref-insert-cite-link (alternative-cite)
   "Insert a default citation link using reftex. If you are on a link, it
 appends to the end of the link, otherwise, a new link is
@@ -2272,7 +2264,6 @@ If you know the specific bibtex key, you may like to use completion directly. Yo
 Alternatively, you may shortcut the org-machinery with this command. You will be prompted for a citation type, and then offered key completion.
 
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
 Alternatively, you may shortcut the org-machinery with this command. You will be prompted for a citation type, and then offered key completion.
 
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
-;;;###autoload
 (defun org-ref-insert-cite-with-completion (type)
   "Insert a cite link with completion"
   (interactive (list (ido-completing-read "Type: " org-ref-cite-types)))
 (defun org-ref-insert-cite-with-completion (type)
   "Insert a cite link with completion"
   (interactive (list (ido-completing-read "Type: " org-ref-cite-types)))
@@ -2283,7 +2274,6 @@ Alternatively, you may shortcut the org-machinery with this command. You will be
 org-mode already defines a store link function for bibtex entries. It does not store the link I want though, it only stores a brief citation of the entry. I want a citation link. Here is a function to do that.
 
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
 org-mode already defines a store link function for bibtex entries. It does not store the link I want though, it only stores a brief citation of the entry. I want a citation link. Here is a function to do that.
 
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
-;;;###autoload
 (defun org-ref-store-bibtex-entry-link ()
   "Save a citation link to the current bibtex entry. Saves in the default link type."
   (interactive)
 (defun org-ref-store-bibtex-entry-link ()
   "Save a citation link to the current bibtex entry. Saves in the default link type."
   (interactive)
@@ -2513,7 +2503,6 @@ This assumes you are in an article."
 ** open pdf from bibtex
 We bind this to a key here: [[*key%20bindings%20for%20utilities][key bindings for utilities]].
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
 ** open pdf from bibtex
 We bind this to a key here: [[*key%20bindings%20for%20utilities][key bindings for utilities]].
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
-;;;###autoload
 (defun org-ref-open-bibtex-pdf ()
   "open pdf for a bibtex entry, if it exists. assumes point is in
 the entry of interest in the bibfile. but does not check that."
 (defun org-ref-open-bibtex-pdf ()
   "open pdf for a bibtex entry, if it exists. assumes point is in
 the entry of interest in the bibfile. but does not check that."
@@ -3217,7 +3206,7 @@ Sometimes it may be helpful to manually change the order of citations. These fun
    (setf (nth j keys) tempi))
   keys)
 
    (setf (nth j keys) tempi))
   keys)
 
-;;;###autoload
+
 (defun org-ref-swap-citation-link (direction)
  "move citation at point in direction +1 is to the right, -1 to the left"
  (interactive)
 (defun org-ref-swap-citation-link (direction)
  "move citation at point in direction +1 is to the right, -1 to the left"
  (interactive)
@@ -3304,7 +3293,7 @@ To get a lighter weight message about the label, ref and cite links, we define a
                          (point)))))
       (throw 'result "!!! NO CONTEXT FOUND !!!"))))
 
                          (point)))))
       (throw 'result "!!! NO CONTEXT FOUND !!!"))))
 
-;;;###autoload
+
 (defun org-ref-link-message ()
   "Print a minibuffer message about the link that point is on."
   (interactive)
 (defun org-ref-link-message ()
   "Print a minibuffer message about the link that point is on."
   (interactive)
@@ -3459,7 +3448,7 @@ These are in the keywords field, and are comma or semicolon separated."
         (split-string kstring "\\(,\\|;\\)[ \n]*\\|{\\|}" t)))
       keywords)))
 
         (split-string kstring "\\(,\\|;\\)[ \n]*\\|{\\|}" t)))
       keywords)))
 
-;;;###autoload
+
 (defun org-ref-set-bibtex-keywords (keywords &optional arg)
   "Add KEYWORDS to a bibtex entry.
 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."
 (defun org-ref-set-bibtex-keywords (keywords &optional arg)
   "Add KEYWORDS to a bibtex entry.
 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."
@@ -3480,7 +3469,7 @@ If KEYWORDS is a list, it is converted to a comma-separated string. The KEYWORDS
        (concat ", "  (bibtex-autokey-get-field "keywords"))))))
   (save-buffer))
 
        (concat ", "  (bibtex-autokey-get-field "keywords"))))))
   (save-buffer))
 
-;;;###autoload
+
 (defun helm-tag-bibtex-entry ()
   "Helm interface to add keywords to a bibtex entry.
 Run this with the point in a bibtex entry."
 (defun helm-tag-bibtex-entry ()
   "Helm interface to add keywords to a bibtex entry.
 Run this with the point in a bibtex entry."
@@ -3653,7 +3642,6 @@ With two prefix args, insert a label link."
    ((equal arg '(16))
     (org-ref-helm-insert-label-link))))
 
    ((equal arg '(16))
     (org-ref-helm-insert-label-link))))
 
-(require 'helm-bibtex)
 
 ;; add our own fallback entries where we want them. These appear in reverse order of adding in the menu
 (setq helm-bibtex-fallback-options
 
 ;; add our own fallback entries where we want them. These appear in reverse order of adding in the menu
 (setq helm-bibtex-fallback-options
@@ -3792,9 +3780,11 @@ This is a list of cons cells '((\"description\" . action)). The action function
  'org-ref-helm-user-candidates
  '("Example" . (lambda () (message-box "You did it!")))
  t)
  'org-ref-helm-user-candidates
  '("Example" . (lambda () (message-box "You did it!")))
  t)
-;;;###autoload
+
+;;;###qautoload
 (defun org-ref-cite-click-helm (key)
 (defun org-ref-cite-click-helm (key)
-  "subtle points.
+  "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."
   (interactive)
 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."
   (interactive)