[pmwiki-users] extra guidelines for recipe publishing

Hans design5 at softflow.co.uk
Mon Apr 9 04:18:41 CDT 2007


I know we have some guidelines to help publishing a new recipe on
pmwiki.org. But I need some additional help:

What is the best way to release a fairly complex recipe, which uses a
number of scripts, wiki pages, images and css, and possibly local
group configurations?

Standard recipe scripts can just go into the cookbook/ foder,
preferably the farm/cookbook folder (since PmWiki sees that in any
case).

To use more than one script I could create a recipe folder in
cookbook/, and put everything in it.

This can include a wikilib.d/ subfolder for default pages, which the
script can add as an additional pagestore to the WikiLibDirs array.

So far so good, only one folder, and the admin needs only one include_once
line to add to local/config.php, or a local/group.php file.

But any images and css needs to go into the pub/ folder, preferably
Farm/pub. So we need to create an extra subfolder in pub/.

So what is the best way for a recipe author to achieve that, in order
to give the wiki admin the most painless installation routine?
It seems to me if I bundle everything into a zip file, this could be
unzipped into the cookbook/ folder, and the recipe subfolder is
created automatically etc. But then it requires the admin to move at
least one folder out from there into pub/, possibly to move also a
Group.php file into local. Can there be a single step installation, so
the new recipe can work straight "out-of-the-box"?

I just released the ForumX recipe, which has such a complex setup
procedure. It also requires various other scripts to be installed,
which adds to complexity. I aim for recipes to be just added-on and
work, without requiring a lot of copying, configuring, building wiki
pages etc. To make PmWiki more accessible for wider users recipe
installation should be as painless as possible, preferably a one step
affair, comparable to a Pmwiki upgrade, which works for me with a single
copy operation.

Maybe all I am missing is some tricks how to construct a zip archive
with the correct path information for all files, which can unzip into
several folders, i.e. into cookbook/ and pub/ and creating a subfolder
in each.

You got any thoughts or advise on this?


 Hans




More information about the pmwiki-users mailing list