X-Git-Url: https://git.donarmstrong.com/?p=org-ref.git;a=blobdiff_plain;f=org-ref.el;h=cc3ac5f65ef84530de44d446168f60b0b8cb1e8f;hp=87deb290285bd15b47a05e8535faadba807b627f;hb=6bf7673c665fc591126f30cfa5a62cbc7de73510;hpb=81c855c66c5650dbbcab6b47be8e6a18b8be3431 diff --git a/org-ref.el b/org-ref.el index 87deb29..cc3ac5f 100644 --- a/org-ref.el +++ b/org-ref.el @@ -915,6 +915,8 @@ ARG does nothing." ((eq format 'latex) (format "\\listoftables"))))) + +;; ** label link (defun org-ref-count-labels (label) "Counts number of matches for LABEL in the document." (+ (count-matches (format "label:%s\\b[^-:]" label) (point-min) (point-max)) @@ -931,7 +933,6 @@ ARG does nothing." (setq custom-id-count (+ 1 custom-id-count))))) custom-id-count))) -;; ** label link (org-add-link-type "label" (lambda (label) @@ -966,21 +967,21 @@ ARG does nothing." :type "ref" :link (concat "ref:" (org-element-property :name object)))) -;; it turns out this does not work. you can already store a link to a heading with a CUSTOM_ID ;; store link on heading with custom_id -; (when (and (equal (org-element-type object) 'headline) -; (org-entry-get (point) "CUSTOM_ID")) -; (org-store-link-props -; :type "ref" -; :link (concat "ref:" (org-entry-get (point) "CUSTOM_ID")))) + ;; this is not a ref link, but it is still what you want + (when (and (equal (org-element-type object) 'headline) + (org-entry-get (point) "CUSTOM_ID")) + (org-store-link-props + :type "custom_id" + :link (format "[[#%s]]" (org-entry-get (point) "CUSTOM_ID")))) ;; and to #+label: lines + (when (and (equal (org-element-type object) 'paragraph) (org-element-property :name object)) (org-store-link-props :type "ref" - :link (concat "ref:" (org-element-property :name object)))) -)) + :link (concat "ref:" (org-element-property :name object)))))) (add-hook 'org-store-link-functions 'org-label-store-link) @@ -991,10 +992,8 @@ ARG does nothing." "on clicking goto the label. Navigate back with C-c &" (org-mark-ring-push) ;; next search from beginning of the buffer - ;; it is possible you would not find the label if narrowing is in effect (widen) - (unless (or ;; our label links @@ -1010,20 +1009,15 @@ ARG does nothing." ;; #+label: name org-definition (progn (goto-char (point-min)) - (re-search-forward (format "^#\\+label:\\s-*\\(%s\\)\\b" label) nil t)) + (re-search-forward + (format "^#\\+label:\\s-*\\(%s\\)\\b" label) nil t)) ;; org tblname (progn (goto-char (point-min)) - (re-search-forward (format "^#\\+tblname:\\s-*\\(%s\\)\\b" label) nil t)) - -;; Commented out because these ref links do not actually translate correctly in LaTeX. -;; you need [[#label]] links. - ;; CUSTOM_ID -; (progn -; (goto-char (point-min)) -; (re-search-forward (format ":CUSTOM_ID:\s-*\\(%s\\)" label) nil t)) - ) + (re-search-forward + (format "^#\\+tblname:\\s-*\\(%s\\)\\b" label) nil t))) + ;; we did not find anything, so go back to where we came (org-mark-ring-goto) (error "%s not found" label)) @@ -1036,14 +1030,20 @@ ARG does nothing." ((eq format 'latex) (format "\\ref{%s}" keyword))))) + (defun org-ref-get-org-labels () "Return a list of #+LABEL: labels." (save-excursion (goto-char (point-min)) (let ((matches '())) (while (re-search-forward "^#\\+label:\\s-+\\(.*\\)\\b" (point-max) t) - (add-to-list 'matches (match-string-no-properties 1) t)) -matches))) + ;; do not do this for tables. We get those in `org-ref-get-tblnames'. + ;; who would have thought you have save match data here? Trust me. When + ;; I wrote this, you did. + (unless (save-match-data (equal (car (org-element-at-point)) 'table)) + (add-to-list 'matches (match-string-no-properties 1) t))) + matches))) + (defun org-ref-get-custom-ids () "Return a list of custom_id properties in the buffer." @@ -1053,7 +1053,8 @@ matches))) (let ((custom_id (org-entry-get (point) "CUSTOM_ID"))) (when (not (null custom_id)) (setq results (append results (list custom_id))))))) -results)) + results)) + (defun org-ref-get-latex-labels () "Return list of matchin LaTeX defined labels in buffer." @@ -1062,7 +1063,8 @@ results)) (let ((matches '())) (while (re-search-forward "\\\\label{\\([a-zA-z0-9:-]*\\)}" (point-max) t) (add-to-list 'matches (match-string-no-properties 1) t)) -matches))) + matches))) + (defun org-ref-get-tblnames () "Return list of table names in the buffer." @@ -1070,6 +1072,7 @@ matches))) (lambda (table) (org-element-property :name table)))) + (defun org-ref-get-labels () "Return a list of labels in the buffer that you can make a ref link to. This is used to complete ref links and in helm menus." @@ -1078,15 +1081,22 @@ This is used to complete ref links and in helm menus." (widen) (goto-char (point-min)) (let ((matches '())) - ;; these are the label:stuff kinds - (while (re-search-forward "[^#+]label:\\([a-zA-z0-9:-]*\\)" (point-max) t) + ;; these are the org-ref 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)) + ;; now add all the other kinds of labels. (append matches + ;; #+label: (org-ref-get-org-labels) + ;; \label{} (org-ref-get-latex-labels) + ;; #+tblname: and actually #+label (org-ref-get-tblnames) + ;; CUSTOM_IDs (org-ref-get-custom-ids)))))) + (defun org-ref-helm-insert-label-link () "Insert a label link. helm just shows you what labels already exist. If you are on a label link, replace it." @@ -1098,7 +1108,8 @@ If you are on a label link, replace it." ;; default action is to open to the label (action . (lambda (label) ;; unfortunately I do not have markers here - (org-open-link-from-string (format "ref:%s" label)))) + (org-open-link-from-string + (format "ref:%s" label)))) ;; if you select a label, replace current one (action . (lambda (label) (switch-to-buffer ,cb) @@ -1160,6 +1171,7 @@ If you are on a label link, replace it." (or label helm-pattern)))))))))))) + (defun org-ref-complete-link (&optional arg) "Completion function for ref links. Optional argument ARG Does nothing." @@ -1167,11 +1179,13 @@ Optional argument ARG Does nothing." (setq label (completing-read "label: " (org-ref-get-labels))) (format "ref:%s" label))) + (defun org-ref-insert-ref-link () "Completion function for a ref link." (interactive) (insert (org-ref-complete-link))) + (defun org-ref-helm-insert-ref-link () "Helm menu to insert ref links to labels in the document. If you are on link, replace with newly selected label. @@ -1270,20 +1284,14 @@ Use C-u C-u to insert a [[#custom-id]] link" ;; #+label: name org-definition (progn (goto-char (point-min)) - (re-search-forward (format "^#\\+label:\\s-*\\(%s\\)\\b" label) nil t)) + (re-search-forward + (format "^#\\+label:\\s-*\\(%s\\)\\b" label) nil t)) ;; org tblname (progn (goto-char (point-min)) - (re-search-forward (format "^#\\+tblname:\\s-*\\(%s\\)\\b" label) nil t)) - -;; Commented out because these ref links do not actually translate correctly in LaTeX. -;; you need [[#label]] links. - ;; CUSTOM_ID -; (progn -; (goto-char (point-min)) -; (re-search-forward (format ":CUSTOM_ID:\s-*\\(%s\\)" label) nil t)) - ) + (re-search-forward + (format "^#\\+tblname:\\s-*\\(%s\\)\\b" label) nil t))) ;; we did not find anything, so go back to where we came (org-mark-ring-goto) (error "%s not found" label)) @@ -1295,6 +1303,7 @@ Use C-u C-u to insert a [[#custom-id]] link" ((eq format 'latex) (format "\\pageref{%s}" keyword))))) + (defun org-pageref-complete-link (&optional arg) "Completion function for ref links. Optional argument ARG Does nothing." @@ -1302,11 +1311,13 @@ Optional argument ARG Does nothing." (setq label (completing-read "label: " (org-ref-get-labels))) (format "ref:%s" label))) + (defun org-pageref-insert-ref-link () "Insert a pageref link with completion." (interactive) (insert (org-pageref-complete-link))) + ;; *** nameref link (org-add-link-type "nameref" @@ -1403,7 +1414,9 @@ keyword we clicked on. We also strip the text properties." (setq key-beginning (+ (match-beginning 0) 1)) ; we found a match (setq key-beginning link-string-beginning))) ; no match found ;; save the key we clicked on. - (setq bibtex-key (org-ref-strip-string (buffer-substring key-beginning key-end))) + (setq bibtex-key + (org-ref-strip-string + (buffer-substring key-beginning key-end))) (set-text-properties 0 (length bibtex-key) nil bibtex-key) bibtex-key) ;; link with description. assume only one key @@ -2451,7 +2464,6 @@ Makes a new buffer with clickable links." (while (re-search-forward (format "[^#+]label:%s\\s-" label) nil t) (push (cons label (point-marker)) multiple-labels)) - (goto-char (point-min)) (while (re-search-forward (format "\\label{%s}\\s-?" label) nil t)