dokufreaks / plugin-meta

http://dokuwiki.org/plugin:meta
8 stars 7 forks source link

The documentation does not define "subkey" or provide enough examples #6

Open winakeytoheaven opened 4 years ago

winakeytoheaven commented 4 years ago

I needed to set the value of the "abstract" meta property and reference it from within the DIR plugin, something that seemed workable. I spent almost all day researching Dokuwiki's meta-data structures, experimenting with plugin-meta syntax and single-stepping through the plugin-meta code to finally discover that [1] the "abstract" meta-property is a "subkey" of the "description" meta-property and [2] the plugin-meta syntax for subkeys is untouched by its documentation. I finally discovered the proper syntax and was able to make the META and DIR plugins work together as desired. Whew.

I'm not complaining about the time because it was a geeky challenge and I learned a LOT, but this plugin's documentation should be more complete because not everybody has the time, developer background or software tools required to do what I did. I created my own account on dokuwiki.org thinking I could update the plugin-meta documentation with what I learned, but getting normal dokuwiki.org credentials doesn't give editing rights. Sigh.

Other points:

I would be happy to augment the documentation myself if I had a way to do that, obviously in collaboration with the plugin author/maintainer. I envision adding a table of examples to document the full spectrum of all the settable metadata properties (which is a small subset of all the properties which actually exist within Dokuwiki).

I wish I had time, now that I know more about how this plugin works, to offer some help with the code. That's another issue for another day. Sigh.

I like this plugin and I'm very happy it exists. Let me know how I can be involved in at least improving the documentation. Thanks.