]> git.donarmstrong.com Git - org-ref.git/blobdiff - org-ref.org
make custom-id links have a message.
[org-ref.git] / org-ref.org
index b04c1a13be61997ae722b404ad6ad1c950d9b1d4..05828740cf76a05a5d81c8d8476965f5fe01bb47 100644 (file)
@@ -1102,24 +1102,77 @@ Now, we can put all the labels together which will give us a list of candidates.
 Let us make a helm function to insert a label link. This will help you enter unique labels.
 #+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.
@@ -1168,6 +1221,7 @@ 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)
 
@@ -1208,9 +1262,6 @@ Use C-u to insert a different kind of ref link.
                                                       (action . (lambda (x) x))))
                                      ":" label)))
                                   ))))))))
-
-
-
 #+END_SRC
 
 #+RESULTS:
@@ -3018,13 +3069,6 @@ To get a lighter weight message about the label, ref and cite links, we define a
                        (progn
                          (forward-line 4)
                          (point)))))
-
-      ;; maybe we have a CUSTOM-ID
-      (org-map-entries
-       (lambda () (when (string=
-                        label
-                        (org-entry-get (point) "CUSTOM_ID"))
-                   (throw 'result (org-get-heading)))))
       (beep)
       (throw 'result "!!! NO CONTEXT FOUND !!!"))))
 
@@ -3063,6 +3107,12 @@ To get a lighter weight message about the label, ref and cite links, we define a
                                (> count 1))
                        "s")))))
 
+        ((string= type "custom-id")
+         (save-excursion
+           (org-open-link-from-string
+            (format "[[#%s]]" (org-element-property :path object)))
+           (message "%s" (org-get-heading))))
+
          ;; check if the bibliography files exist.
         ((string= type "bibliography")
          (let* ((bibfile)
@@ -3071,24 +3121,26 @@ To get a lighter weight message about the label, ref and cite links, we define a
                 (link-string (org-element-property :path object))
                 (link-string-beginning)
                 (link-string-end))
-
            (save-excursion
              (goto-char (org-element-property :begin object))
              (search-forward link-string nil nil 1)
              (setq link-string-beginning (match-beginning 0))
              (setq link-string-end (match-end 0)))
 
+            ;; make sure we are in link and not before the :
+           (when (> link-string-beginning (point))
+             (goto-char link-string-beginning))
+
            ;; now if we have comma separated bibliographies
            ;; 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
@@ -3154,7 +3206,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)
@@ -3179,7 +3237,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"))))
 
@@ -3211,11 +3269,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)