Merge pull request #567 from kaushalmodi/fix-links-to-headings-with-i…

…d-anchors

fix: org-id links to headings with ID as anchors

ox-hugo.el

@@ -80,8 +80,7 @@
 ;; https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=f636cf91b6cbe322eca56e23283f4614548c9d65
 (require 'org-refile nil :noerror)      ;For `org-get-outline-path'
 
-(require 'org-id)                       ;For `org-id-goto'
-(require 'org-agenda)                   ;For `org-find-top-headline'
+(require 'org-id)                       ;For `org-id-find'
 
 (declare-function org-hugo-pandoc-cite--parse-citations-maybe "ox-hugo-pandoc-cite")
 
@@ -2129,7 +2128,7 @@ and rewrite link paths to make blogging more seamless."
                            destination))))
              ;; (message "[org-hugo-link DBG] plain-text path: %s" path)
              (if (org-id-find-id-file raw-path)
-                 (let* ((anchor (org-hugo-link--heading-anchor-maybe link))
+                 (let* ((anchor (org-hugo-link--heading-anchor-maybe link info))
                         (anchor-str (if (org-string-nw-p anchor)
                                         (concat "#" anchor)
                                       "")))
@@ -2400,6 +2399,7 @@ and rewrite link paths to make blogging more seamless."
                                   (if (string-match ".*\\.org::\\(#.*\\)" raw-link)
                                       (match-string-no-properties 1 raw-link)
                                     "")))
+                             ;; (message "[org-hugo-link DBG] raw-link-minus-org-file: %s" raw-link-minus-org-file)
                              (format "{{< relref \"%s%s\" >}}"
                                      (file-name-sans-extension
                                       (file-name-nondirectory path1))
@@ -2450,22 +2450,30 @@ and rewrite link paths to make blogging more seamless."
               (format "[%s](%s)" path path)
             (format "<%s>" path)))))))))
 
+(defun org-hugo-link--heading-anchor-maybe (link info)
+  "Return anchor of the heading pointed to by LINK.
 
-(defun org-hugo-link--heading-anchor-maybe (link)
-  "Return heading pointed to by LINK."
-  (with-temp-buffer
-    (org-id-goto (org-element-property :path link))
-    ;; Thu Oct 21 21:29:17 EDT 2021 - kmodi
-    ;; It was necessary to set the major mode to `org-mode' after the
-    ;; `org-id-goto' jump. Otherwise, the temp buffer would remain
-    ;; in fundamental mode, and so the `org-find-top-headline'
-    ;; always returned nil.
-    (org-mode)
-    (let ((heading (org-find-top-headline)))
-      (kill-buffer (current-buffer))
-      (if heading
-          (org-hugo-slug heading :allow-double-hyphens)
-        ""))))
+INFO is a plist used as a communication channel."
+  ;; (message "dbg link id: %S" (org-element-property :path link))
+  (let* ((id-loc (org-id-find (org-element-property :path link)))
+         (id-file (car id-loc))
+         (id-pos (cdr id-loc))
+         (id-buffer (get-file-buffer id-file))) ;nil if `id-file' buffer is not already open
+    ;; (message "[org-hugo-link--heading-anchor-maybe DBG] id-loc: %S" id-loc)
+    (with-current-buffer (or id-buffer (find-file-noselect id-file :nowarn))
+      (org-export-get-environment)        ;Eval #+bind keywords, etc.
+      (goto-char id-pos)
+      ;; (org-show-context)
+      (let* ((elem (org-element-at-point))
+             (anchor (if (equal (org-element-type elem) 'headline)
+                         (org-hugo--get-anchor elem info)
+                       "")))    ;If it's a file ID and not a headline ID
+        ;; (message "[org-hugo-link--heading-anchor-maybe DBG] elem type: %S" (org-element-type elem))
+        ;; (message "[org-hugo-link--heading-anchor-maybe DBG] elem: %S" elem)
+        ;; (message "[org-hugo-link--heading-anchor-maybe DBG] anchor: %S" anchor)
+        (unless id-buffer ;Kill the buffer with ID if it wasn't open already
+          (kill-buffer (current-buffer)))
+        anchor))))
 
 ;;;;; Helpers
 (defun org-hugo--copy-resources-maybe (info)

test/site/content-org/issues/issue-542.org

@@ -0,0 +1,27 @@
+:PROPERTIES:
+:ID:       31c61d47-0afc-4d5c-9b60-6c154a1c518d
+:END:
+#+title: Issue # 542
+#+hugo_section: issues
+#+hugo_base_dir: ../../
+
+#+author:
+
+#+filetags: org_id link anchor heading
+
+#+macro: issue =ox-hugo= Issue #[[https://github.com/kaushalmodi/ox-hugo/issues/$1][$1]]
+
+#+begin_description
+Test links to headings whose anchors are derived from org-id's.
+#+end_description
+
+{{{issue(542)}}}
+
+- [[id:04e97225-6956-4554-b812-ee0e52921c7a][Link]] to a heading that has both CUSTOM_ID and ID set.
+- [[id:909536ed-b636-4bb9-9cc6-6a06992d8853][Link]] to a heading that has only the ID set.
+
+* Local Variables                                          :ARCHIVE:noexport:
+#+bind: org-hugo-anchor-functions (org-hugo-get-custom-id org-hugo-get-id org-hugo-get-heading-slug org-hugo-get-md5)
+# Local Variables:
+# org-export-allow-bind-keywords: t
+# End:

test/site/content-org/issues/issue-556.org

@@ -7,6 +7,8 @@
 
 #+author:
 
+#+filetags: org_id anchor heading
+
 #+macro: issue =ox-hugo= Issue #[[https://github.com/kaushalmodi/ox-hugo/issues/$1][$1]]
 
 #+begin_description

test/site/content/issues/issue-542.md

@@ -0,0 +1,11 @@
++++
+title = "Issue # 542"
+description = "Test links to headings whose anchors are derived from org-id's."
+tags = ["org-id", "link", "anchor", "heading"]
+draft = false
++++
+
+`ox-hugo` Issue #[542](https://github.com/kaushalmodi/ox-hugo/issues/542)
+
+-   [Link]({{< relref "issue-556.md#heading-abc" >}}) to a heading that has both CUSTOM_ID and ID set.
+-   [Link]({{< relref "issue-556.md#909536ed-b636-4bb9-9cc6-6a06992d8853" >}}) to a heading that has only the ID set.

test/site/content/issues/issue-556.md

@@ -5,6 +5,7 @@ description = """
   org-hugo-get-heading-slug` `org-hugo-get-md5` `precedence set in
   ~org-hugo-anchor-functions`.
   """
+tags = ["org-id", "anchor", "heading"]
 draft = false
 +++