tgrosinger / crumbs-obsidian

Breadcrumb navigation in Obsidian.md
GNU General Public License v3.0
26 stars 0 forks source link

Better Documentation, and unexpected behavior #4

Open ksdavidc opened 1 year ago

ksdavidc commented 1 year ago

Describe the bug Insufficient documentation

Expected behavior A clear and concise description of what the program does.

For example: What triggers the crumbs to appear. In the video, it appears as if having a dot in the name of the file triggers it. But in my vault, I have 3 files, called test, test one, and test two. They are in different folders and in fact unrelated to each other except for the title, yet they trigger the crumbs. It would appear that having a file name that begins with the same characters as another file will trigger the crumbs.

However, this only seems to work on the way down. The sub files don't trigger the crumbs for the files above, like true breadcrumbs would.

I have no way to know if the quirks below are bugs or design, as there is no documentation.

Additional context

Created files: Pare Paren Parent Parent. Parent.child1

Note the following behavior:

The files above Parent. have one blank list item (no text, unclickable), that I assume refers to "Parent." below it.

There are some quirks with grandchildren.

Pare lists as children Paren, Parent, child1 and blank( Parent., I assume), but I would assume that Parent and child1 (aka Parent.child1) would be grandchildren. Paren lists Parent, child1, and blank as children. Parent lists child1 and blank odd one: Parent. has an extra breadcrumb and no blank and duplicates the entry for child1...not easily described in words, so here are screenshots:

Screen Shot 2023-06-28 at 3 41 15 AM Screen Shot 2023-06-28 at 3 41 23 AM Screen Shot 2023-06-28 at 3 41 34 AM

And, lastly, Parent.child1 has a blank entry, even though it shouldn't have any children. Screenshot

Screen Shot 2023-06-28 at 3 41 51 AM
ksdavidc commented 1 year ago

I will merely mention without elaboration that adding a grandchild Parent.child1.grandchild produces even further weird behavior (missing entries, extra entries, etc.).