On Mon, Sep 26, 2011 at 5:17 PM, Daniel Nichter <[email protected]> wrote: > For user plugin docs, eventually I'd like to group the Plugins list by types > of plugins, like: > > Plugins > ********* > > Authentication > =========== > > * Auth All > * Auth PAM > * Auth Schema > > Functions > ======== > > * String Functions > * Utility Functions > > Protocols > ======= > > * Drizzle Protocol > * MySQL Protocol > > I think that's logically organized. Some plugins are actually modules that > provide many things, but the vast majority fall into simple categories. >
This would be a good start. Can I already assign my plugin into such a group? However, this is imho sub-optimal for two reasons: 1) My plugin provides JavaScript. However, it actually serves another important use case which is being a JSON parser. So I would like to have a chapter for using JavaScript in Drizzle (which in the future would contain other plugins too), but I would separately want to have a chapter that covers the use cases where JSON is involved. This chapter would include my js plugin and json_server, and more going forward. 2) The fact that Drizzle is implemented as plugins is an implementation detail. It shouldn't be strongly visible in the UI or documentation how the devs implement something. So the manual shouldn't be "Plugins -> String functions", it should just be "String functions" or "Functions -> String functions". What you propose above is similar to Apache httpd documentation. It works, but I've given some reasons why it's not perfect. I suppose my wishlist for writing plugin documentation is that I can write - one or more .rst files - the title/entry for the .rst file(s) may or may not be the same as the name of the plugin - freely designate each of them as belonging to a chapter in the manual, each could belong to different chapters. - it remains undefined how those chapters are ordered? (As a first solution, it could be that in the main docs directory one just writes an introduction page for each chapter where you can list links in whatever order manually.) henrik -- [email protected] +358-40-8211286 skype: henrik.ingo irc: hingo www.openlife.cc My LinkedIn profile: http://www.linkedin.com/profile/view?id=9522559 _______________________________________________ Mailing list: https://launchpad.net/~drizzle-discuss Post to : [email protected] Unsubscribe : https://launchpad.net/~drizzle-discuss More help : https://help.launchpad.net/ListHelp
