X-Git-Url: https://git.donarmstrong.com/?p=org-ref.git;a=blobdiff_plain;f=org-ref.org;h=b5429942f7665d8347131bc13164b0963d7cfe47;hp=dbaf75be246913a0f9625ea94c7573a77ec7fb69;hb=c259c0584eafa5dfd5475ab1cb5007712b921e76;hpb=3044d6641e83953951a3a576abde2cc7e51dc553 diff --git a/org-ref.org b/org-ref.org index dbaf75b..b542994 100644 --- a/org-ref.org +++ b/org-ref.org @@ -12,6 +12,7 @@ This document is an experiment at creating a literate program to provide similar 4. Exportable links to LaTeX 5. Utility functions for dealing with bibtex files and org-files +Some additional features include 1. Get minibuffer messages for the cite/ref/label link under point With helm integration (default) you can: @@ -934,7 +935,7 @@ The label link provides a way to create labels in org-mode. We make it clickable ;; for tblname, it is not enough to get word boundary ;; tab-little and tab-little-2 match then. (count-matches (format "^#\\+tblname:\\s-*%s\\b[^-:]" label) (point-min) (point-max)) - (count-matches (format "\\label{%s}\\b" label) (point-min) (point-max)) + (count-matches (format "\\label{%s}" label) (point-min) (point-max)) ;; this is the org-format #+label: (count-matches (format "^#\\+label:\\s-*%s\\b[^-:]" label) (point-min) (point-max)) (let ((custom-id-count 0)) @@ -1063,7 +1064,7 @@ It would be nice to use completion to enter a ref link, where a list of labels i #+BEGIN_SRC emacs-lisp :tangle org-ref.el (defun org-ref-get-org-labels () - "find #+LABEL: labels" + "Return a list of #+LABEL: labels." (save-excursion (goto-char (point-min)) (let ((matches '())) @@ -1074,7 +1075,7 @@ matches))) #+BEGIN_SRC emacs-lisp :tangle org-ref.el (defun org-ref-get-custom-ids () - "return a list of custom_id properties in the buffer" + "Return a list of custom_id properties in the buffer." (let ((results '()) custom_id) (org-map-entries (lambda () @@ -1099,6 +1100,7 @@ Finally, we get the table names. #+BEGIN_SRC emacs-lisp :tangle org-ref.el (defun org-ref-get-tblnames () + "Return list of table names in the buffer." (org-element-map (org-element-parse-buffer 'element) 'table (lambda (table) (org-element-property :name table)))) @@ -1108,18 +1110,24 @@ Now, we can put all the labels together which will give us a list of candidates. #+BEGIN_SRC emacs-lisp :tangle org-ref.el (defun org-ref-get-labels () - "returns a list of labels in the buffer that you can make a ref link to. this is used to auto-complete ref links." + "Returns a list of labels in the buffer that you can make a ref link to. +This is used to auto-complete ref links and in helm menus." (save-excursion (save-restriction (widen) (goto-char (point-min)) (let ((matches '())) - (while (re-search-forward "label:\\([a-zA-z0-9:-]*\\)" (point-max) t) + ;; these are the label:stuff kinds + (while (re-search-forward "[^#+]label:\\([a-zA-z0-9:-]*\\)" (point-max) t) (add-to-list 'matches (match-string-no-properties 1) t)) - (append matches (org-ref-get-org-labels) (org-ref-get-latex-labels) (org-ref-get-tblnames) (org-ref-get-custom-ids)))))) + (append matches + (org-ref-get-org-labels) + (org-ref-get-latex-labels) + (org-ref-get-tblnames) + (org-ref-get-custom-ids)))))) #+END_SRC -Let us make a helm function to insert a label link. This will help you enter unique labels. +Let us make a helm function to insert a label link. This will help you enter unique labels by showing matching labels until they are all gone and you are left with a unique one. If you are on a link, it means you want to replace it. #+BEGIN_SRC emacs-lisp :tangle org-ref.el (defun org-ref-helm-insert-label-link () "Insert a label link. helm just shows you what labels already exist. @@ -1195,7 +1203,7 @@ If you are on a label link, replace it." helm-pattern)))))))))))) #+END_SRC -Now we create the completion function. This works from the org-machinery, e.g. if you type C-c C-l to insert a link, and use completion by pressing tab. +Now we create a completion function. This works from the org-machinery, e.g. if you type C-c C-l to insert a link, and use completion by pressing tab. #+BEGIN_SRC emacs-lisp :tangle org-ref.el (defun org-ref-complete-link (&optional arg) @@ -1220,10 +1228,14 @@ Another alternative ref insertion is to use helm. "Helm menu to insert ref links to labels in the document. If you are on link, replace with newly selected label. Use C-u to insert a different kind of ref link. +Use C-u C-u to insert a [[#custom-id]] link " (interactive) (let* ((labels (org-ref-get-labels)) - (contexts (mapcar 'org-ref-get-label-context labels)) + (bs (buffer-string)) + (contexts (with-temp-buffer + (insert bs) + (mapcar 'org-ref-get-label-context labels))) (cb (current-buffer))) (helm :input (thing-at-point 'word) @@ -1281,7 +1293,12 @@ Use C-u to insert a different kind of ref link. (candidates . ("ref" "eqref" "pageref" "nameref")) (action . (lambda (x) x)))) ":" label))) - )))))))) + ;; two prefixes, insert section custom-id link + ((equal helm-current-prefix-arg '(16)) + (insert + (format "[[#%s]]" label))) + )) + )))))) #+END_SRC #+RESULTS: @@ -3089,7 +3106,6 @@ To get a lighter weight message about the label, ref and cite links, we define a (progn (forward-line 4) (point))))) - (beep) (throw 'result "!!! NO CONTEXT FOUND !!!")))) @@ -3107,19 +3123,24 @@ To get a lighter weight message about the label, ref and cite links, we define a ;; message some context about the label we are referring to ((string= type "ref") - (message (org-ref-get-label-context - (org-element-property :path object)))) + (message "%scount: %s" + (org-ref-get-label-context + (org-element-property :path object)) + (org-ref-count-labels + (org-element-property :path object)))) ((string= type "eqref") - (message (org-ref-get-label-context - (org-element-property :path object)))) + (message "%scount: %s" + (org-ref-get-label-context + (org-element-property :path object)) + (org-ref-count-labels + (org-element-property :path object)))) ;; message the count ((string= type "label") (let ((count (org-ref-count-labels (org-element-property :path object)))) ;; get plurality on occurrence correct - (when (> count 1) (beep)) (message (concat (number-to-string count) " occurence" @@ -3170,7 +3191,6 @@ To get a lighter weight message about the label, ref and cite links, we define a (buffer-substring key-beginning key-end))) (if (file-exists-p bibfile) (message "%s exists." bibfile) - (beep) (message "!!! %s NOT FOUND !!!" bibfile)))) ))))) #+END_SRC @@ -3254,10 +3274,13 @@ C-u C-u will change the key at point to the selected keys. (replace-regexp-in-string (car (org-ref-get-bibtex-key-and-file)) ; key (mapconcat 'identity keys ",") ; new keys - (org-element-property :raw-link object) - ) + (org-element-property :raw-link object)) ;; replace space at end to avoid collapsing into next word. - last-char))) + last-char)) + ;; and we want to go to the end of the new link + (goto-char + (org-element-property :end (org-element-context))) + ) (t (message "Not found")))) @@ -3335,7 +3358,6 @@ This code provides a helm interface to things you can do when you click on a cit (insert-file-contents bibfile) (bibtex-search-entry key) (org-ref-bib-citation))) - (beep) "!!! No entry found !!!" ))) (defun org-ref-cite-candidates ()