search

splitbrain / dokuwiki-plugin-bureaucracy

Create forms and generate pages or emails from them
http://www.dokuwiki.org/plugin:bureaucracy
GNU General Public License v2.0
43 stars 47 forks source link

Documentation for new "script" action #218

Closed dregad closed 7 years ago

dregad commented 7 years ago

The new script action introduced in #209 / 2017-07-27 release looks promising, but the documentation available at https://www.dokuwiki.org/plugin:bureaucracy#script_mode is sorely lacking.

It would be great if more detailed docs could be provided, maybe with some sample usage.

Klap-in commented 7 years ago

@micgro42 could you write these docs please?

micgro42 commented 7 years ago

I linked the interface that has to be implemented and added an example script, that just logs the values of the parameters to DokuWiki's debug logs.

What else would be expected as documentation?

dregad commented 7 years ago

That's pretty good, thanks !

Between opening this issue and now, I spent some time trying to figure things out, and at the end of the day it was not as complex as I thought upon reading the doc.

I took the liberty of updating your example with a corresponding form and shortening the handler's PHPDoc comment.