erykjj / jwlmanager

Multi-platform GUI for managing JW Library (.jwlibrary and .jwlplaylist) files: view, delete, edit, merge (via export/import), etc.
MIT License
66 stars 8 forks source link

Feature Request: Enhanced Markdown Export with Linked References for Obsidian Compatibility #194

Open SchneiderSam opened 3 days ago

SchneiderSam commented 3 days ago

Hi @erykjj

Again: I'd like to express my gratitude for your incredible work on JWL Manager! The Markdown export feature works seamlessly and has greatly enhanced my workflow, especially when importing JWL notes into Obsidian. I truly appreciate all the effort you put into making this tool so effective.

As I’ve been using JWL Manager for exporting extensive JWL notes, I’ve noticed a potential enhancement that could make working with these JWL notes in Obsidian even more powerful. Currently, the exported notes—for example in the Study Bible—appear as numerous orphan notes within Obsidian's GraphView, which makes it challenging to establish clear connections between them.

Feature Suggestion:

I’ve noticed that during the export process, two essential metadata elements are included: the Publication and, in cases like Study Bible notes, the Bible verse. Would it be possible to modify the Markdown export so that these metadata elements (Heading and Publication) are enclosed in double brackets (e.g., heading: [[2. Mose 22_18]] or publication: [[Rbi8-X]])? This would effectively create links to those references within Obsidian. I can only imagine the ingenious connections that are created on the notes. There would even be an interesting connection for the colors. Most people always use the colors in a certain context (e.g., color: [[3]]).

If you only want this to be optional, you could also activate or deactivate an option when exporting whether you want to have these double brackets or not.

Possible Challenges:

Special Characters in Bible Verses: Certain characters, like colons, aren't allowed in Obsidian titles. For instance, "2. Mose 22:18" could be formatted as:

Standardized Book Formatting: For publications, formats like nwt-X could simply be converted to [[nwt-X]], ensuring compatibility across notes.

Benefits:

  1. Improved Organization: Many orphan notes would automatically become connected, allowing for a much cleaner and organized GraphView in Obsidian or Logseq or other Markdown Tools.
  2. Enhanced Navigation: By linking notes to Bible verses or publications, users can navigate more intuitively between related notes.
  3. Powerful Knowledge Map: The ability to visualize and interact with these connections transforms the exported notes into a truly cohesive JWL knowledge map.

Thank you very much for considering this feature! I believe this addition would provide tremendous value to users who work with JWL Manager and Obsidian together. I would be more than happy to provide further details or test any potential implementations.

erykjj commented 2 days ago

@SchneiderSam This could easily be implemented, but I need to know a few things:

  1. the [[doube brackets]] are what you use for linking to other notes in Obsidian?
  2. would there be an issue if the [[double brackets]] were always included?
    1. would it detract in any way from the usefulness of the metadata section?
    2. how would it affect other markdown viewer/editor applications?
  3. which ones would most benefit from this? color, language, publication, document?
  4. for Bible notes, I could put 01001001 (Genesis 1:1) in the document attribute. would that work/help?
  5. the title attribute, if in square brackets, cannot contain special characters and needs to be modified? I could make it like the filename. would that work?
erykjj commented 2 days ago

Please test v6.0.0-beta3, which tries to implement some of the above suggestions.

Also, please test/report on the theme toggle and translations ;-)

SchneiderSam commented 2 days ago

Please test v6.0.0-beta3, which tries to implement some of the above suggestions.

@erykjj Works fine. Wow 🥳🥳

Two Tests:

1. theme toggle (light/dark mode)

works great and looks good

2. Markdown export:

the [[doube brackets]] are what you use for linking to other notes in Obsidian?

Yes, https://help.obsidian.md/Linking+notes+and+files/Internal+links

would there be an issue if the [[double brackets]] were always included?

I think the most important are: publication: "[[Rbi8-X]]" document: "[[66019020]]" and color: "[[2]]"

would it detract in any way from the usefulness of the metadata section?

I don't think so. But that is a very subjective opinion. 😅

how would it affect other markdown viewer/editor applications?

It's not a Markdown Basic Syntax. See https://www.markdownguide.org/basic-syntax/#links But other Tools like https://roamresearch.com/ and https://docs.logseq.com/#/page/aliases%20and%20external%20links are using this system with dubble Brackets also.

which ones would most benefit from this? color, language, publication, document?

color, publication, document are the most important ones. with title and language i am not so sure. Not wrong, but if it's unnecessary work, it's better not to start with. I don't see much benefit at the moment. not necessary is: guid, created, modified

for Bible notes, I could put 01001001 (Genesis 1:1) in the document attribute. would that work/help?

I think this will not work because the title does not allow special characters.

image

For the time being, I would prefer the title to remain as it is now. Simply adopt the title that is in the JWL heading. So as in beta3, in my example that would be: title: "[[lebendig]]"

the title attribute, if in square brackets, cannot contain special characters and needs to be modified? I could make it like the filename. would that work?

Let me check that tomorrow. Have to check this further.

SchneiderSam commented 1 day ago

Ok that doesn't work... i have To Check further... image

image

The Double Brackets Don't work on meta field...

SchneiderSam commented 1 day ago

I found a Solution... With These options it works well:

Internal links in Text and List type properties must be surrounded with quotes. Obsidian will automatically add these if you manually enter internal links into properties, but be careful to add them when using templating plugins.

document: "[[202017367]]"

https://help.obsidian.md/Editing+and+formatting/Properties

SchneiderSam commented 1 day ago

I have created a test vault for myself and created a new export. Please excuse the many posts, but my brain has not rested during the night...

I'll summarize briefly here. This is what I currently see with beta3

View Mode: image

Source Mode: image

Better would be: image image

But: I'm not sure whether it makes sense to display the title as a link (e.g. title: "[[lebendig]]"). You are welcome to leave it, but perhaps a further development of the export would be: a selective choice where you want to have links everywhere. But that's really not necessary for this version. The way you have planned it is really good.

How is the META heading created? This is not the case for every publication. Only with the Bible. Correct? That's fine, in the example 66019020 = Revelation 19:20

So I could create notes (e.g. 66019020) for myself later and then define an aliases (e.g. Revelation 19:20). Perfect.

SchneiderSam commented 1 day ago

Comment updated: https://github.com/erykjj/jwlmanager/issues/194#issuecomment-2460774369

erykjj commented 1 day ago

Thanks for all that, @SchneiderSam ! I will remove [[]] from the title and add "" around the remaining [[]].

erykjj commented 1 day ago

Should each individual tag also be in this format: "[[tag]]"?

erykjj commented 1 day ago

And would "[[nwtsty]]" be better than "[[nwtsty-E]]" (since there is a separate attribute for language)?

SchneiderSam commented 1 day ago

And would "[[nwtsty]]" be better than "[[nwtsty-E]]" (since there is a separate attribute for language)?

Good question. I think both options are ok. I don't currently have any special requirements.

SchneiderSam commented 1 day ago

Should each individual tag also be in this format: "[[tag]]"?

This is not necessary for obsidian. It automatically recognizes this as a tag. I have reformulated all my JWL tags. Example: #MoC/love

It Works great without brackets and Quotes

erykjj commented 4 hours ago

v6.0.0-beta4 is out. Please report if the attributes/properties in the markdown export are properly formatted (for Obsidian to handle) and if the cross-linking works ;-)