[pmwiki-users] Documentation of Recipes (was: Pre-announcing 2.2.0...)

[Petko Yotov]

On Wednesday 21 January 2009 20:05:59 john.rankin at affinity.co.nz wrote:
> > I dislike multiple wikilib.d/ directories added by recipes, for these
> > reasons: [...]
> >
> > I have a preference for adding the docs in the standard wikilib.d
> > directory
> > and not forcing a new one for two reasons:
> > * it is simpler;
> > * PmWiki runs slightly faster (considerably faster if 12 recipes add 12
> > custom
> > wikilib directories).
>
> Could you lead me by the hand a little please? First, I note the
> module guldelines state authors *should* use a local wikilib.d/
> (although I agree with your reasons not to).

Yes, the current version says "recommended" but does not say why. It is a 
wiki, we could change this. (I may be wrong though, the original author may 
have good reasons to recommend this configuration.)

> If we use the pmwiki/wikilib.d/ directory, how do recipe pages
> get in there

The same way files in the /pub and /cookbook directories get there : the 
administrator copies them from the archive. :-)

> and how do we avoid their being over-written when 
> upgrading pmwiki?

Like for the /pub and /skins directories, if the files have different names 
from the distribution files, they will not be overwritten when upgrading.

> > I prefer [[!PmWiki Recipe]] and/or [[!PmWiki Skin]]. Wikis could be used
> > for
> > other things like food recipes, or software packages and skins, we
> > shouldn't
> > occupy categories that might have other uses by the websites.
>
> That's cool, although I also agree with the comment that some
> site administrators may not like their categories to be augmented
> in this way. Any suggestions?

We could probably place links to PmWiki.InstalledRecipes which could display 
the pages via a "pagelist link={$FullName}".

Petko