Project Task Page: Cookbook

Status: Running
Current Developers: Michael, Matt
Current "inflight" dev location:
Start Date: 29 October 2005
Major Milestone date: n/a
Expected End Date: n/a
End Date: n/a
Date this page last updated: 05 January 2007
Estimated effort so far: ??


Ongoing online documentation on the kamaelia website providing 'recipes' and tutorials on how to achieve particular goals.

Code fragments will usually consitute examples in the /Code/Python/Kamaelia/Examples/ part of the codebase.

The aim is to provide a resource from which users can learn how to achieve things using Kamaelia and gain overview and familiarity with the system and its capabilities.

This is an ongoing aspect of the more general need to document and the project accessible to potential developers and users. There is therefore no defined end point.


This section is largely about WHO has influenced this task to do WHAT, and where possible WHY. It is also about WHO to contact with regard to this task to influence what's going on.
  • Task Sponsor: Michael
  • Task Owner: Michael
  • Developers: Michael, Matt

  • Users: Michael, Matt
  • Interested third parties: none
  • Requirements:
    • MUST be understandable and useful to a comparative novice Kamaelia developer
    • SHOULD provide a good sense, to the unitiated, of the facilities available in Kamaelia
    • SHOULD cover all major facilities provided by Kamaelia
    • SHOULD use example code fragments, where possible, that form useful systems, and are of minimum complexity needed to demonstrate the point

Relevant Influencing factors:
  • .


This section is largely about WHAT has been produced, normally by WHO (in order to provide a point of contact)



Website pages:

Realistic possibilities arising as a result of activity on this task

  • Need for some tutorial style pages too
  • Pulling of the more detailed docstrings that have been written into the online component reference

Related Tasks

Tasks that directly enable this task (dependencies)

  • Wiki engine installed for managing the website

Sub Tasks

  • none

Task Log


None at present.

-- 05 January 2007, Matt


Kamaelia is an open source project originated from and guided by BBC Research. For more information browse the site or get in contact.

This is an ongoing community based development site. As a result the contents of this page is the opinions of the contributors of the pages involved not the organisations involved. Specificially, this page may contain personal views which are not the views of the BBC. (the site is powered by a wiki engine)

(C) Copyright 2008 Kamaelia Contributors, including the British Broadcasting Corporation, All Rights Reserved

This web site is powered by the same code created for the bicker manor project. For more details, contact Michael Sparks at BBC Research directly (cf contact)