huseyz / obsidian-wallabag

This plugin for Obsidian allows you to sync Wallabag items into Obsidian notes in various ways.
MIT License
69 stars 5 forks source link

Sync behaviour #21

Open gwutz opened 1 year ago

gwutz commented 1 year ago

Hi @huseyz ! I didn't found a Wiki for that project therefore I post my thoughts about that wonderful plugin here in order to get your point of view. First of all, as you already saw in my MR about the annotations, I have a specific workflow in mind in order to process information personally. I have set up a Wallabag server and this acts as my kitchen sink for reading and highlighting/annotate informations in my daily life. After that I want to process these informations/highlights into my obisidan vault as a long-living note. My requirements look more or less like:

Thinking about these (personal) requirements maybe it makes sense to change a bit the sync behaviour. What I have in mind is: always re-sync and overwrite the current wallabag note except when the note was synced before and is now deleted and when the note contains a special marker tag which blocks rewriting for the future.

What do you think about that?

Things, I didn't consider here: different workflows/styles with PDF annotations maybe. I see that the plugin also supports this and I didn't used it yet so maybe my plan above is flawed in this regard.

huseyz commented 1 year ago

Hi @gwutz,

Most of the plugin functionality is built around my own workflow, which is 1) Add articles to Wallabag 2) Sync to Obsidian 3) Read and take notes (I mostly annotate exported pdfs) in the created Obsidian note. Hence, the notes were designed to be immutable.

I'm happy to accommodate any other workflows such as yours with the condition that they're introduced as options, e.g., by having a setting to enable updating the existing notes.

peterrus commented 1 year ago

Just want to add that my workflow is very similar to @gwutz's so I welcome this feature. I notice there is a clear divide between the two workflows in this issue:

A. One annotates (optionally) in Wallabag and then downloads/updates locally to markdown/HTML. B. One downloads pdf's (once) and annotates locally.

It might be interesting to clearly delineate between the settings (in the settings screen) that apply to workflow A and the ones that apply to workflow B. Maybe the user will have to choose either workflow A or B and then only see the relevant settings, or we could give users the option to even use both.

Just some thoughts.

quantumgardener commented 1 month ago

Sorry, but I'm a little confused with what the plugin does. Are annotations synced? I don't see them in my notes and I'm wondering if I'm missing a setting.

huseyz commented 4 weeks ago

@quantumgardener annotations are technically synced, but it's not documented. Use the template variable https://github.com/huseyz/obsidian-wallabag/blob/180d6c542f5611d515bbce2222848dff64759a34/src/note/NoteTemplate.ts#L29

Maybe give it a try and see whether it fits your use.

quantumgardener commented 4 weeks ago

That works. Thanks.

jason-mehmel commented 1 week ago

@quantumgardener annotations are technically synced, but it's not documented. Use the template variable

https://github.com/huseyz/obsidian-wallabag/blob/180d6c542f5611d515bbce2222848dff64759a34/src/note/NoteTemplate.ts#L29

Maybe give it a try and see whether it fits your use.

Might be a dumb question: do we need to build our own templates if we're going to get this annotation feature in our imports from Wallabag? (As in, importing the annotations from Wallabag into the article import.)

huseyz commented 4 days ago

Yes, if you need any custom behavior, you need to create a template for yourself.

jason-mehmel commented 6 hours ago

Do those templates go in the same place as any other obsidian templates, or is there a specific wallabag template location?

~Jason pronouns: he / him / his @.*** | www.jasonmehmel.com

On Wed, 27 Nov 2024 at 11:37, Huseyin Zengin @.***> wrote:

Yes, if you need any custom behavior, you need to create a template for yourself.

— Reply to this email directly, view it on GitHub https://github.com/huseyz/obsidian-wallabag/issues/21#issuecomment-2504564684, or unsubscribe https://github.com/notifications/unsubscribe-auth/AA3UPJ3ZGFWL3JRS64TVTVL2CYGQHAVCNFSM6AAAAABQ3ROSPSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKMBUGU3DINRYGQ . You are receiving this because you commented.Message ID: @.***>