Search other org headings with a link to the current one

[CyberFox001]

Hello,

I have written a small Emacs Lisp function that will list all Org-mode headings that contain a link to the Org heading at the point. This function use Org-ql.

(defun my/org-ql-refs-to-this-heading (root)
    "List all headings with a link to current heading, search from folder `ROOT'."
    (interactive (list (read-directory-name "Search from: ")))
    (let ((files-to-search (directory-files-recursively root "\\.org$"))
          (current-heading-id (org-entry-get nil "id"))
          (current-heading-title (org-entry-get nil "ITEM")))
      (org-ql-search
        files-to-search
        (format "link:%s" (or current-heading-id current-heading-title))
        :title (format "Other heading linked to \"%s\"" current-heading-title))))

I'm not sure if this is the best way to do it, but it work.

[alphapapa]

Hi,

Thanks for sharing. That seems pretty good. Here's a similar one to consider: https://github.com/alphapapa/org-sidebar/blob/1e06d1b4ab5f0d09301712cdecb757c9437a7179/org-sidebar.el#L253 If you specify the query as a sexp and give the target/description argument, it may be optimized to a faster search.

[jwiegley]

@alphapapa I'm trying org-sidebar-backlinks now, but the query doesn't return even after several minutes. Meanwhile, Emacs resident size has climbed to 1.25 GB, which is quite a lot for Emacs. That said, the query above never completes within patience threshold either...

[alphapapa]

Hm, I just used that command recently, and it worked fine for me. I guess I would look at the query expression it's generating for the current entry and see if it works when called on one or a few buffers/files. Or if you want, you could step through org-ql--select with Edebug.

[jwiegley]

@alphapapa I let it run for a really long time until it finally ended, and it appears to be a bad interaction with projectile due to the number of Roam files I have in my agenda list:

       37568  98% - command-execute
       37503  97%  - funcall-interactively
       37502  97%   - execute-extended-command
       37502  97%    - apply
       37502  97%     - ad-Advice-execute-extended-command
       37500  97%      - #<subr execute-extended-command>
       37500  97%       - command-execute
       37500  97%        - funcall-interactively
       37500  97%         - org-sidebar-backlinks
       37482  97%          - org-sidebar-ql
       37482  97%           - org-sidebar
       37476  97%            - #<compiled 0x8268f927a3e097c>
       37476  97%             - org-ql-search
       37441  97%              - org-ql-select
       36319  94%               - #<subr F616e6f6e796d6f75732d6c616d626461_anonymous_lambda_4>
       30079  78%                - find-file-noselect
       23119  60%                 - find-file-noselect-1
       22195  57%                  - after-find-file
       14926  38%                   - run-hooks
        5528  14%                    + projectile-find-file-hook-function
        4798  12%                    + vc-refresh-state
        4039  10%                    + forge-bug-reference-setup
          65   0%                    + maybe-turn-on-whitespace
          57   0%                    + recentf-track-opened-file
           9   0%                    + auto-revert--global-adopt-current-buffer
           3   0%                    + bm-buffer-restore
        7096  18%                   + normal-mode
           1   0%                     make-auto-save-file-name
          65   0%                  + file-truename
          27   0%                  + insert-file-contents
        1725   4%                 + create-file-buffer
          93   0%                 + find-buffer-visiting
          36   0%                 + file-truename
          48   0%                + find-buffer-visiting
         351   0%               + #<compiled -0x17c2a5651e868be4>
           1   0%               + org-ql--query-predicate
          34   0%              + org-ql-view--header-line-format
           1   0%              + org-ql-view--display
           5   0%            + org-sidebar--display-buffers
           1   0%            + org-sidebar--prepare-buffer
          15   0%          + org-ql-search-directories-files
          65   0%  + byte-code
         534   1% + ...
         174   0% + timer-event-handler
           1   0% + org-appear--post-cmd