smoothbrain-ai / smoothbrain-anki

SmoothBrain is an Anki plugin that fetches Readwise highlights and makes flashcards using OpenAI GPT.
39 stars 6 forks source link

Create a custom notetype with most Readwise fields #14

Closed abdnh closed 1 year ago

abdnh commented 1 year ago

Closes #5 and depends on #13

Most document and highlight fields are added, except the following:

alexbowe commented 1 year ago

Just tested it and it works well :)

Would you mind explaining why each of the fields above isn't included (that doesn't already have a description)?

And to address the ones that do have a reason:

doc.title (readable_title is added instead; I'm not sure when they are different) Let's add it anyway

doc.cover_image_url (we can either add it as a remote image link or download the image to the user's media folder and add local link; I vote for either omitting it or adding it as a remote link.)

Remote link is good for now.

highlight.color (It would be nice to make this available so that the user can for example display the highlights in the same color by modifying the template, but I'm not sure yet how to choose the color in the Readwise website and how it's displayed there)

Let's add it anyway. I haven't worked out how to set it either, but maybe there is a way, or maybe there will be soon. Actually, let's try to add all of the other fields as well, if at all possible.

Also, I noticed that the "readable title" is just called "title" in the notes - let's keep them as exactly the same name as they are in Readwise.

abdnh commented 1 year ago

The main reason for not including most of those fields (besides my DRY demons I guess) is my thinking that they are not very useful to the end user, but you'd already said to add them for debugging purposes at least, and some users may know better how to use them, so I'll add them.

More specific notes:

Also, I noticed that the "readable title" is just called "title" in the notes - let's keep them as exactly the same name as they are in Readwise.

OK, will change that.

alexbowe commented 1 year ago

The main reason for not including most of those fields (besides my DRY demons I guess) is my thinking that they are not very useful to the end user, but you'd already said to add them for debugging purposes at least, and some users may know better how to use them, so I'll add them.

More specific notes:

  • doc.readwise_url: I felt this is redundant with highlight.readwise_url that also open to the same page.
  • doc.unique_url: This can either be the same as source_url or a link to the Readwise reader. Again, I just felt it's redundant so I was unsure whether to it add.
  • The highlight location fields: I couldn't see a use for them but now I realized location at least can be useful. It can for example used to change the review order of the new cards so that earlier highlights are reviewed first.

Thanks for the explanation! Yeah, some of them seem redundant, but I think they have slightly different semantics that other Readwise users might actually use.

Also, I noticed that the "readable title" is just called "title" in the notes - let's keep them as exactly the same name as they are in Readwise.

OK, will change that.

Great!