Skip to content
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

More explanation and example on embedding #13

Open
fkgruber opened this issue Dec 28, 2024 · 4 comments
Open

More explanation and example on embedding #13

fkgruber opened this issue Dec 28, 2024 · 4 comments

Comments

@fkgruber
Copy link

Hi
I'm don't understand the purpose and difference between cloze and embedding. In fact I have been unable to get embedding working. Is there an example to try?

I tried following the demo but when I type org-srs-embed-dwim I get

Assertion failed: (not (string-prefix-p ".." relative))

thanks
F

@bohonghuang
Copy link
Owner

bohonghuang commented Dec 28, 2024

Simply put, embedded items enable you to convert notes into review items directly, allowing updates to sync automatically and avoiding separate maintenance of review entries. While it's complex to demonstrate textually, the README states you should be visiting a file within org-directory. If your point is at the start of a paragraph, running org-srs-embed-dwim will prompt you to add the question for review, similar to org-capture. After editing, press C-c C-c to create an embedded review item. See the demo in the README.

@fkgruber
Copy link
Author

Can the file be in a subdirectory within the org directory?

@fkgruber
Copy link
Author

what does the error:
(not (string-prefix-p ".." relative))

mean?

@bohonghuang
Copy link
Owner

Can the file be in a subdirectory within the org directory?

Yes. Any path prefixed with org-directory should work.

what does the error:
(not (string-prefix-p ".." relative))

It's just an assertion in the code to prevent unexpected situations. If the path to the buffer file doesn't prefix with the value of org-directory, Org-srs won't know where to store the exported review items.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants