X-Git-Url: https://git.donarmstrong.com/?p=org-ref.git;a=blobdiff_plain;f=org-ref.org;h=04746fe9c643408730cdf07700fb42264061a121;hp=cde0cefc8f9086ff2e85e554049a85fb05d56c74;hb=828c6fdc6640c263e054136431ce74680970da11;hpb=56ba56b8a81178a301fb174d8d8c6623f9ed3e3b diff --git a/org-ref.org b/org-ref.org index cde0cef..04746fe 100644 --- a/org-ref.org +++ b/org-ref.org @@ -1100,26 +1100,79 @@ Now, we can put all the labels together which will give us a list of candidates. #+END_SRC Let us make a helm function to insert a label link. This will help you enter unique labels. -#+BEGIN_SRC emacs-lisp +#+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." + "Insert a label link. helm just shows you what labels already exist. +If you are on a label link, replace it." (interactive) (let* ((labels (org-ref-get-labels)) (cb (current-buffer))) (helm :sources `(((name . "Existing labels") (candidates . ,labels) + ;; 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) + (cond + ;; no prefix or on a link + ((equal helm-current-prefix-arg nil) + (let* ((object (org-element-context)) + (last-char (save-excursion + (goto-char (org-element-property :end object)) + (backward-char) + (if (looking-at " ") + " " + "")))) + (when (-contains? '("label") + (org-element-property :type object)) + ;; we are on a link, so replace it. + (setf + (buffer-substring + (org-element-property :begin object) + (org-element-property :end object)) + (concat + (replace-regexp-in-string + (org-element-property :path object) + label + (org-element-property :raw-link object)) + last-char))))) + ;; no prefix options defined + )))) + ;; no matching selection creates a new label ((name . "Create new label") (dummy) + ;; default action creates a new label, or replaces old one (action . (lambda (label) (switch-to-buffer ,cb) - (insert - (concat - "label:" - (or label - helm-pattern)))))))))) + (let* ((object (org-element-context)) + (last-char (save-excursion + (goto-char (org-element-property :end object)) + (backward-char) + (if (looking-at " ") + " " + "")))) + (if (-contains? '("label") + (org-element-property :type object)) + ;; we are on a link, so replace it. + (setf + (buffer-substring + (org-element-property :begin object) + (org-element-property :end object)) + (concat + (replace-regexp-in-string + (org-element-property :path object) + helm-pattern + (org-element-property :raw-link object)) + last-char)) + ;; new link + (insert + (concat + "label:" + (or label + 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. @@ -1142,19 +1195,24 @@ Alternatively, you may want to just call a function that inserts a link with com Another alternative ref insertion is to use helm. -#+BEGIN_SRC emacs-lisp +#+BEGIN_SRC emacs-lisp :tangle org-ref.el (defun org-ref-helm-insert-ref-link () "Helm menu to insert ref links to labels in the document. -Use C-u to insert a different kind of ref link." +If you are on link, replace with newly selected label. +Use C-u to insert a different kind of ref link. +" (interactive) (let* ((labels (org-ref-get-labels)) (contexts (mapcar 'org-ref-get-label-context labels)) (cb (current-buffer))) - (helm :sources `(((name . "Available labels to ref") + (helm :input (thing-at-point 'word) + :sources `(((name . "Available labels to ref") (candidates . ,(loop for label in labels for context in contexts -;; we do some kludgy adding spaces and bars to make it "easier" to see in helm. + ;; we do some kludgy adding spaces + ;; and bars to make it "easier" to + ;; see in helm. collect (cons (concat label "\n" (mapconcat @@ -1163,16 +1221,47 @@ Use C-u to insert a different kind of ref link." (split-string context "\n") "\n" ) "\n\n") label))) + ;; default action to replace or insert ref link. (action . (lambda (label) (switch-to-buffer ,cb) - (insert - (concat - (if helm-current-prefix-arg - (helm :sources '((name . "Ref link types") - (candidates . ("ref" "eqref" "pageref" "nameref")) - (action . (lambda (x) x)))) - "ref") - ":" label))))))))) + + (cond + ;; no prefix or on a link + ((equal helm-current-prefix-arg nil) + (let* ((object (org-element-context)) + (last-char (save-excursion + (goto-char (org-element-property :end object)) + (backward-char) + (if (looking-at " ") + " " + "")))) + (if (-contains? '("ref" "eqref" "pageref" "nameref") + (org-element-property :type object)) + ;; we are on a link, so replace it. + (setf + (buffer-substring + (org-element-property :begin object) + (org-element-property :end object)) + (concat + (replace-regexp-in-string + (org-element-property :path object) + label + (org-element-property :raw-link object)) + last-char)) + ;; insert a new link + (insert + (concat + "ref:" label)) + ))) + ;; one prefix, alternate ref link + ((equal helm-current-prefix-arg '(4)) + (insert + (concat + (helm :sources '((name . "Ref link types") + (candidates . ("ref" "eqref" "pageref" "nameref")) + (action . (lambda (x) x)))) + ":" label))) + )))))))) #+END_SRC #+RESULTS: @@ -3044,13 +3133,11 @@ To get a lighter weight message about the label, ref and cite links, we define a ;; we find the one clicked on. we want to ;; search forward to next comma from point (save-excursion - (goto-char link-string-beginning) (if (search-forward "," link-string-end 1 1) (setq key-end (- (match-end 0) 1)) ; we found a match (setq key-end (point)))) ; no comma found so take the point ;; and backward to previous comma from point (save-excursion - (goto-char link-string-beginning) (if (search-backward "," link-string-beginning 1 1) (setq key-beginning (+ (match-beginning 0) 1)) ; we found a match (setq key-beginning (point)))) ; no match found @@ -3116,7 +3203,13 @@ In the helm-bibtex buffer, C-u will give you a helm menu to select a new link ty C-u C-u will change the key at point to the selected keys. " - (let* ((object (org-element-context))) + (let* ((object (org-element-context)) + (last-char (save-excursion + (goto-char (org-element-property :end object)) + (backward-char) + (if (looking-at " ") + " " + "")))) (cond ;; case where we are in a link ((and (equal (org-element-type object) 'link) @@ -3131,8 +3224,6 @@ C-u C-u will change the key at point to the selected keys. (insert (concat "," (mapconcat 'identity keys ",")))) ;; double prefix, replace key at point ((equal helm-current-prefix-arg '(16)) - (car (org-ref-get-bibtex-key-and-file)) - (mapconcat 'identity keys ",")) (setf (buffer-substring (org-element-property :begin object) (org-element-property :end object)) @@ -3143,7 +3234,7 @@ C-u C-u will change the key at point to the selected keys. (org-element-property :raw-link object) ) ;; replace space at end to avoid collapsing into next word. - " "))) + last-char))) (t (message "Not found")))) @@ -3155,8 +3246,6 @@ C-u C-u will change the key at point to the selected keys. (-contains? org-ref-cite-types (org-element-property :type (org-element-context))))) - ;;(message-box "at end of a link") - ;; (goto-char (org-element-property :end object)) (while (looking-back " ") (backward-char)) (insert (concat "," (mapconcat 'identity keys ",")))) @@ -3177,11 +3266,19 @@ C-u C-u will change the key at point to the selected keys. (setq helm-bibtex-format-citation-functions '((org-mode . helm-bibtex-format-org-ref))) -(defun org-ref-helm-insert-cite-link () - "org-ref function to use helm on the bibliography defined in the org-file." - (interactive) - (let ((helm-bibtex-bibliography (org-ref-find-bibliography))) - (helm-bibtex))) +(defun org-ref-helm-insert-cite-link (arg) + "org-ref function to use helm-bibtex to insert a citation link. +With one prefix arg, insert a ref link. +With two prefix args, insert a label link." + (interactive "P") + (cond + ((equal arg nil) + (let ((helm-bibtex-bibliography (org-ref-find-bibliography))) + (helm-bibtex))) + ((equal arg '(4)) + (org-ref-helm-insert-ref-link)) + ((equal arg '(16)) + (org-ref-helm-insert-label-link)))) (require 'helm-bibtex)