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

John Rankin john.rankin at affinity.co.nz
Thu Jan 22 23:13:11 CST 2009

>> Excellent idea, but let's first hear what others think. OTOH, if you are the 
>> author of the only recipe that ships with documentation, you can probably do 
>> what you feel is correct and common sense. :-)
>There are a lot of recipes and skins that include documentation, I think.
>At any rate, I think that what's good for PmWiki is likely also
>good for its recipes.
If I can sum up what has been an extensive and enlightening thread,
the draft proposal so far seems to be:

If recipe authors include documentation pages,

- call them PmWikiCookbook.RecipeName

- include a link to the recipe page on pmwiki.org

- include a link to a place where readers can see the recipe
  in action and (if appropriate) practice in a sandbox

- include a category of either [[!PmWiki recipe]] or 
  [[!PmWiki skin]]

- either place it in a recipe/wikilib.d directory (if the recipe
  includes other pages) or place it in ?? (I think this is still
  an open question, but we have rejected wikilib.d)

Feel free to correct this attempt at a summary.

John Rankin
Affinity Limited
T 64 4 495 3737
F 64 4 473 7991
john.rankin at affinity.co.nz

More information about the pmwiki-users mailing list