akosbalasko / zoottelkeeper-obsidian-plugin

Obsidian plugin of Zoottelkeeper: An automated folder-level index file generator and maintainer.
182 stars 11 forks source link

Fence comments are way too chatty #80

Open geoelectric opened 2 years ago

geoelectric commented 2 years ago

My index notes look horrible in mobile—particularly for small folders—because the comments for where the index goes want to have a very verbose conversation with me.

D5D32DC4-FDD9-4682-8954-C8AAF707A920

Unless you anticipate some other app called Zoottelkeeper conflicting with your process I would think %% Zoottellkeeper Start %% and %% Zoottellkeeper End %% would be quite enough.

Even the Start & Ends are superfluous; as long as %% Zoottellkeeper %% appears twice it’s pretty obvious to both person and code which one is the start and which is the end. So why include the suffix at all? These comments don’t make the file look very good in edit mode so I’d think they should be as unobtrusive as possible.

And keep in mind these are file names we’re wrapping. Unless I’m Andy Matuschak they’re probably not going to be full sentences; they’ll be a single word or concept—i.e., short. Even if they were full sentence Matuschak notes they’d probably be shorter than that because they’d be a single assertion.

But in this case I’m just indexing my Daily Notes—and I’d bet you money that’s one of the main uses people get out of this because that’s a major functionality gap in Obsidian, automatic note creation without an automatic index. Upshot is my file names will always be exactly 10 characters long.

The plug-in comments should not be significantly longer than that, percents included. So %% Z %% is sounding pretty good to me as a sigil, and would still be unique in my vault, if I could configure it that way by defining my own text.

Also, this is just to serve the graph and all I want is the index. I’m totally cool with the plug-in rewriting the whole note each time if only I didn’t have to look at those comments. If I wanted to put other stuff around the index I’d embed the index into a different note, so I don’t need a fenced off area. “Create fence comments (Warning, overwrites note every time if false!)” would be false, if I had the setting.

Please make the fence comments much shorter, more configurable, and more optional. I don’t really want those comments in my notes at all but if they have to be there they definitely should not be 5x the line length of my content.