-
Notifications
You must be signed in to change notification settings - Fork 24
org-roam integration #39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
I pushed a dedicated branch to test this feature to our Step 1 is implemented in The file |
|
Thanks for creating the branch. I traced it to this point here: https://github.com/org-noter/org-noter/blob/feature%2Forg-roam-integration/modules/org-noter-org-roam.el#L37 I create an org-roam node/file and then try to resolve the actual file path based on the ID that was created. But org-roam is returning nil. I suspect that this is a configuration problem. I'll dig into it tonight. |
|
I updated the test branch, @petermao. I had to specify explicit paths for org-roam properties to make sure it doesn't conflict with my existing org-roam installation.
|
|
@petermao, I updated the branch as well as the org-noter-with-emacs-basic-test test branch. I pinned org-mode to built in emacs version, which happens to be 9.5 in Emacs 28.2 To test full end to end flow:
|
|
Hey @dmitrym0 - @petermao pointed me to your work on org-roam integration, so thought I'd link this issue on the citar repo for reference. In particular, see Roshan's comment here: emacs-citar/citar#756 (comment) I am not currently using org-noter, so will have to find time when I can to wrap my head around the details, but hopefully what we're wanting to do makes sense. But, a high-level observation on this:
It's more complicated though. It's not just org-roam that has this preference. Denote does as well (and likely other org-based note packages), as does the default note "source" in citar: https://github.com/emacs-citar/citar#notes Also, org-roam v2 is more general, and does allow more than one note per file. It might suggest it's worth generalizing this more, and not tying it explicitly to org-roam? Our note API in citar seems to do a good job balancing generality and simplicity; citar-org-roam is a ~200 LOC implementation of it. https://github.com/emacs-citar/citar-org-roam/blob/main/citar-org-roam.el And here's the "source" plist. |
|
@bdarcus I'm not familiar with citar (yet?). I skimmed the issue you linked to. It seems to be about being able to find the notes file based on the original pdf document?
That is the goal here, with org-roam being the first implementation. In #32 I made it possible to hook into org-noter's file opening process. The next step is to create org-noter skeleton if needed (top level heading for the document, To summarize, there is very little org-roam specific here, the goal is to make it compatible with any note taking system. |
This reverts commit cb67c7a.
Problem
org-noter is very opinionated about where notes are to be stored. This makes using org-roam a bit of a challenge with org-noter. org-roam favours many small notes files over the combined file that org-noter prefers.
See #2 as well.
Solution
In #32, I introduced a hook that allows the file opening process to be overriden. By default, the hook is set to
org-noter--create-session-from-document-file-defaultwhich implements the standard org-noter opening process (mostlyNotes.orgfile).In this PR, I add
org-noter-org-roammodule. This module hasorg-noter--create-session-from-document-file-supporting-org-roamwhich supports the alternative org-roam workflow.This functionality has to be enabled by the user by setting the file opening hook like so:
(setq org-noter-create-session-from-document-hook '(org-noter--create-session-from-document-file-supporting-org-roam))Checklist
Steps to Test
(setq org-noter-create-session-from-document-hook '(org-noter--create-session-from-document-file-supporting-org-roam))M-x org-noter[Optional] Screenshots