[xwiki-devs] Plugins and xwiki.cfg

[Erin Schnabel]

On 10/4/07, Vincent Massol <vincent at massol.net> wrote:
> Hi Erin,
>
> On Oct 4, 2007, at 3:23 AM, Erin Schnabel wrote:
>
> > I'm not even sure
> > anyone knows how to use most of the ones that are enabled. AND, as
> > they're plugins, they shouldn't be on or enabled unless they're
> > actually needed.
>
> I don't agree here for 2 reasons:
> 1) enabling a plugin isn't currently straightforward
> 2) you're talking about the standalone distribution which has an
> already made xwiki.cfg and that's fine since it's meant to work as is
> with a default choice of plugins and a default config in general. If
> you're talking about the WAR distribution, the xwiki.cfg is just an
> example and is expected to be modified by the user.


> > I propose a space: XWikiPluginGuide.
> >
> > Each plugin would have a page in the guide describing:  a) how to
> > enable the plugin, b) what options are used by the plugin, c) how to
> > invoke and use the plugin, and optionally d) who wrote the plugin and
> > the version information (which that document could retrieve via a
> > getVersion, getAuthor, or whatever call back to the plugin).
>
> I'm not sure I understand. We already have this on xwiki.org on
> Code.Plugins. Are you suggesting that this should be bundled inside
> the default wiki? If so we need to revisit the whole area of bundling
> documentation in the default wiki XAR since right now we're not
> bundling any and instead pointing users online at xwiki.org.

Well, I was hoping that the plugin could maintain it's own doc inside
itself. That way, it never is out of date. Deploy the plugin, get new
doc. *poof*

> > A lot of plugins have a place where they check to make sure that
> > document artifacts that they need exist.
>
> I don't understand that. Could you explain it more?