[dokuwiki] Re: plugins: provide a syntax wiki page

Hi, I thought something during reading discussion between chris and Christopher.

I think definition of plugin's 'desc' value is so ambiguous that
descriptions of each plugin lack uniformity, which confuses admins and
visitors reading 'wiki:syntax' page.


When I made a plugin for the first time, I was at a loss, 'What should
be written in the desc ?  Only syntax or full explanation?' Of course,
I should have read documentations deeply and learned from other
plugins more, still, I thought the 'desc' field was liable to be
multiple meaning for plugin developers. In fact, many developers who
read
 http://wiki.splitbrain.org/wiki:plugins:syntax_tutorial
 tend to write an explanation of plugin without its syntax in 'desc'
value following examples there.

I suppose that 'desc' value should be split into more concrete
definition like 'syntax' and 'desc' (or more). These values will lead
plugin developers to write each description in an appropriate place.
These values also enables info plugin to display a table of only
syntax sorted by plugins' priority (Perhaps does chris want like
this?)

Ikuo
-- 
DokuWiki mailing list - more info at
http://wiki.splitbrain.org/wiki:mailinglist

Other related posts: