Zettlr / Zettlr

Your One-Stop Publication Workbench
https://www.zettlr.com
GNU General Public License v3.0
10.17k stars 624 forks source link

Allow displaying both filename and title/H1 in file manager #5324

Open KeeperCyclone opened 1 month ago

KeeperCyclone commented 1 month ago

Description

As of Zettlr 3.2.0, "Markdown document name display" in the app settings allows a file's YAML title field or the first H1 header to be used as the document's displayed name in the file manager sidebar. This is important because the "filter files" feature acts directly on the names being displayed, thus the settings being used have a direct influence on filter results.

Proposed Changes

Add an option to allow all document information (filename, YAML title, and first H1) to be displayed in the file manager. Here's a mockup:

20240812114110.md\ The Library of Alexandria\ # The First Fire

Currently, only one of these is displayed at a time.

By including all information, the "filter files" function will be able to capture more notes. This will also ease the import of notes whose filenames look like titles, but may have different YAML titles or H1 headers.

Caveats

With more information being shown, it may clutter the interface, but with good visual hierarchy (boldfaced filename, everything else in regular and/or small font), plus the fact that it's an option, I don't believe it will actually present a major issue.

Do you Wish to Attempt Implementing this Yourself?

No

Zettlr Version

Stable (most recent version)

Your Platform

Operating System Version

Ubuntu 20.04.6 LTS

Additional Information

No response

boring-cyborg[bot] commented 1 month ago

Thanks so much for opening up your first issue here on the repository! 🎉 We would like to warmly welcome you to the community behind the app! ☺️ We'll check in soon and have a look at your issue. In the meantime, you can check your issue and make sure it aligns with our contribution guidelines! Here's the comprehensive list:

NOTE: Please do not share screen captures of buggy behavior on YouTube. If you have uploaded a video on YouTube and linked it already, don't worry! But, we would like to ask you to remove the video from YouTube and upload it directly to GitHub instead, by editing your comment. Read more here.

Enhancements

An enhancement takes a feature and improves or alters its behaviour. Please make sure to argue how your proposition will aid non-technical text workers, and why it can't be emulated easily with other features or apps!

Feature requests

Feature requests introduce whole new features into the app. This requires a lot of work, so these might be turned down if the implementation costs supersede the benefits we expect to see from implementing it. Please do not be disappointed if that happens. It likely has nothing to do with your great request but simply with us and our missing resources!

You can of course always ask someone to implement this feature, because a PR with a working new feature has much higher chances of being merged! :)

Bug reports

Please note that one of the main reasons for why bug reports cannot be addressed is that there's not enough information for us to find and fix the bug you describe, so make sure you try to pinpoint the bug as close as possible.

The ideal bug report for us has two qualities:

  1. The bug is always reproducible, at least within a certain context.
  2. We know exactly what specifically goes wrong, and there is consensus on what should happen instead.

Please note that if you encounter behaviour that does not align with your expectations of what would happen, this might as well be simply intended behaviour and we need to simply clarify why the behaviour is the way it is. This is not to be considered a bug and such issues may be closed! Suggest an enhancement instead!

But now, have a great day and thank you again!