CookBookFormat
<< | Cookbook-V1 | >>
Note: The recipes here are for PmWiki versions 0.6 and 1.0 only. For PmWiki 2.0 recipes, see Cookbook.
CookBookFormat
In order to have the users of pmwiki and its cookbooks make life easier, it would be helpful to this user that the cookbooks are easily readable, have a clear presentation on their goals and usage, and contain helpful clues on downloading and installing them in the user's pmwiki setup.
It would be a good idea to agree on some kind of format for the cookbook pages in order to keep them clear and easy to navigate through by the user. A cookbook usually contains a whole set of characteristic fields (not all are necessary):
- The goal of the cookbook
- The solution provided by the cookbook
- The files used to run the cookbook (downloadable)
- Installation procedures
- Configuration procedures
- Usage of the cookbook
- A link to an example
- Links to similar ideas ("See Also")
- A section open for discussion, comments, ideas or bug reports
- A list of the contributors
- Copyright notice
- A history of changes
These fields should be easily retrievable in the cookbooks as the user is looking for a piece of information.
We can build a standard template, CookBookTemplate, from which copies can be made and new cookbooks can start writing their cookbook information in an agreed format, and other cookbooks can adapt from. In the end, this could render us with a good library of readable and easily understandable cookbooks. A user can only benefit from it. I have given the CookBookTemplate a first try, but this suggestion is extremely open for discussion. --Anthony Liekens 29 August 2003
I've added a Discussion forum-section to CookBookTemplate, a place for everyone to add discuss. I felt this was a clearer heading than Comments, Bugs, i.e. I felt it was more clear that other people are welcome to add things there. If you disagree, just remove it... -- Christian Ridderström, 2003-11-30 pmwiki-2.3.32 -- Last modified by {{}}?