Project Task Page: Cookbook

Description

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.

Inputs

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:

• .

Outputs

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

Expected

• Webpages, rooted at http://kamaelia.sf.net/Cookbook
• ABitTorrentUtility
• PureTransformer
• SimpleBitTorrentExample
• TCPSystems
• bitTorrentHelper
• HTTPClient
• HTTPServer
• Graphlines 
• Pipelines 
• PipelinesAndGraphlines
• Backplanes
• Carousels
• DVB/RecordNamedChannel
• DVB/SingleChannelTransportStreamCapture
• DVB/TransportStreamCapture
• DVB/TransportStreamDemuxer

Actual

Website pages:

• index page - http://kamaelia.sf.net/Cookbook
• individual Cookbook pages (see sitemap)
  

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

• 29 October 2005 - Michael : Task status changed to running
• up to 05 January 2007 - Added developers: Michael, Matt
  
• up to 05 January 2007 - Michael : Written cookbook pages:
  
• index page
  
• ABitTorrentUtility
• PureTransformer
• SimpleBitTorrentExample
• TCPSystems
• bitTorrentHelper
• HTTPClient
• HTTPServer
• up to 05 January 2007 - Matt : Time spent: ~ 5 days. Written pages:
  
• Graphlines 
• Pipelines 
• PipelinesAndGraphlines
• Backplanes
• Carousels
• DVB/RecordNamedChannel
• DVB/SingleChannelTransportStreamCapture
• DVB/TransportStreamCapture
• DVB/TransportStreamDemuxer
• 05 January 2007 - Matt : Created this PTP page. Time spent: 1/4 day

Discussion

None at present.

-- 05 January 2007, Matt