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


On 8 Apr 2008, at 00:49, Walter Torres wrote:

Quoting chris <jugg@xxxxxxxxxxx>:



Yet if the Syntax page could be generated, rather than static, then
perhaps plugin's syntax could be inserted into the normal Syntax page
layout. Plugins could specify what heading their syntax falls under in 
the Syntax page, and whether they override the default syntax.  eg.
Control Macros syntax section could be appended to by other plugins
implementing such markup.  Other Syntax Highlighting plugins could be
inserted into the correct location (or even override the default Syntax 
Highlighting section).
Exactly! Yes, more work for the core developers (to create a framework to do this) and more work for the plugin developer, but it would make life a *lot* easier on wiki admins, especially the technically challenged admins.
I honestly don't think this is feasible. The syntax page shouldn't be like a badly done reference manual, one item after another, each unaware of the others and in some non-specific order. The page would be a mess.
Most of the above could be accomplished by plugin writers including a detailed & localised description of their plugin's syntax in the description field which does get placed on the wiki:syntax page. That will give you a list of plugins and their syntax and it wouldn't mess up the properly constructed description of the core wiki syntax.
From my experience, people don't bother too much with the wiki:syntax page anyway. They look at what people have done on other pages and work out how to reproduce it.
Potentially, the plugin could provide a localised wiki snippet/page describing itself for users. (Why not also for managers and admins?) Another plugin could "hijack" a namespace (a virtual namespace) and display the plugin pages in that namespace - also making the index, search and backlinks aware of the information and who has access to it.
But, why? isn't that the whole point of the internet. Provide a link and someone can follow it to find the information. What's the difference between clicking on a link to get another page on the wiki or a page from the web?
What maybe be reasonable is for each plugin to provide a clearly identifiable user page or section. The link provided in wiki:syntax going straight to that part of the page. The link provided in the plugin manager going to information pertinent to the wiki admin. 

plugin:someplugin#syntax
plugin:someplugin#admin

- Chris

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

Other related posts: