Need suggestions for documenting bundles

The question is about Bundler plugin.

Note: I’m using the term “regular bundle” for what Bundler plugin docs call “bundle list”, just because I find it consistent with “filtered bundle”, thus easier to remember. Hopefully, this doesn’t introduce additional confusion.

I am thinking to document bundles, because for many of them, the informational load carried in their name (the title of the bundle tiddler) may not be good enough. Also, I want a consistent strategy that would work for all kinds of bundles.

The most logical place to store notes would be the text field of the bundle tiddler (especially that filtered bundles don’t use it), but by design regular bundles use it to list the tiddlers included in the bundle. So this option is out.

Filtered bundles may have a description field, and while reading the plugin docs, I did not find any reason why regular bundles can’t have such a field as well. Since the description of a bundle can be multiline, managing such a field would require a textarea. I know there’s another Wikilabs plugin that offers this functionality, yet without it reading/editing descriptions is an usability challenge.

This leaves me with the option of simply having a whole separate tiddler for the description and including it in the bundle. I can have a generic README tiddler, namespaced to the bundle, to avoid collisions.

The question is: for a foo.bundle, is it better to use something like README.foo.bundle or rather foo.bundle.README? Which option is more convenient and faster, for example for searching purposes, when multiple bundles are stored in the same wiki?

I personally would go with a .README suffix, because most tiddler lists are alphabetically sorted. So the 2 tiddlers will be listed together.

If the title would start with the README all the readme’s will be listed together. That makes it harder to identify if a bundle misses a README

Just my personal thoughts

1 Like